#, fuzzy
msgid ""
msgstr ""
-"Project-Id-Version: libguestfs 1.5.13\n"
+"Project-Id-Version: libguestfs 1.7.7\n"
"Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
-"POT-Creation-Date: 2010-09-13 15:07+0200\n"
+"POT-Creation-Date: 2010-11-15 09:54+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"
"Content-Transfer-Encoding: ENCODING"
# type: =encoding
-#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:36 ../tools/virt-cat.pl:30 ../tools/virt-df.pl:32 ../tools/virt-edit.pl:31 ../tools/virt-list-filesystems.pl:28 ../tools/virt-list-partitions.pl:28 ../tools/virt-ls.pl:31 ../tools/virt-make-fs.pl:33 ../tools/virt-rescue.pl:29 ../tools/virt-resize.pl:38 ../tools/virt-tar.pl:30 ../tools/virt-win-reg.pl:34
+#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
msgid "utf8"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:38 ../tools/virt-cat.pl:32 ../tools/virt-df.pl:34 ../tools/virt-edit.pl:33 ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30 ../tools/virt-ls.pl:33 ../tools/virt-make-fs.pl:35 ../tools/virt-rescue.pl:31 ../tools/virt-resize.pl:40 ../tools/virt-tar.pl:32 ../tools/virt-win-reg.pl:36
+#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
msgid "NAME"
msgstr ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:42 ../tools/virt-cat.pl:36 ../tools/virt-df.pl:38 ../tools/virt-edit.pl:37 ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34 ../tools/virt-ls.pl:37 ../tools/virt-make-fs.pl:39 ../tools/virt-rescue.pl:35 ../tools/virt-resize.pl:44 ../tools/virt-tar.pl:36 ../tools/virt-win-reg.pl:40
+#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
msgid "SYNOPSIS"
msgstr ""
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:24 ../fish/guestfish.pod:115 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:16 ../inspector/virt-inspector.pl:48 ../tools/virt-cat.pl:42 ../tools/virt-df.pl:46 ../tools/virt-edit.pl:51 ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40 ../tools/virt-ls.pl:43 ../tools/virt-make-fs.pl:47 ../tools/virt-rescue.pl:51 ../tools/virt-resize.pl:50 ../tools/virt-tar.pl:73 ../tools/virt-win-reg.pl:64
+#: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
msgid "DESCRIPTION"
msgstr ""
# type: textblock
#: ../src/guestfs.pod:127
msgid ""
-"You can add a disk read-only using L</guestfs_add_drive_ro>, in which case "
+"The call you should use in modern code for adding drives is "
+"L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
+"specifying that the format is raw, do:"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs.pod:131
+#, no-wrap
+msgid ""
+" guestfs_add_drive_opts (g, filename,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
+" -1);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:135
+msgid "You can add a disk read-only using:"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs.pod:137
+#, no-wrap
+msgid ""
+" guestfs_add_drive_opts (g, filename,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
+" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
+" -1);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:142
+msgid ""
+"or by calling the older function L</guestfs_add_drive_ro>. In either case "
"libguestfs won't modify the file."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:130
+#: ../src/guestfs.pod:145
msgid ""
"Be extremely cautious if the disk image is in use, eg. if it is being used "
"by a virtual machine. Adding it read-write will almost certainly cause disk "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:134
+#: ../src/guestfs.pod:149
msgid ""
"You must add at least one disk image, and you may add multiple disk images. "
"In the API, the disk images are usually referred to as C</dev/sda> (for the "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:139
+#: ../src/guestfs.pod:154
msgid ""
"Once L</guestfs_launch> has been called you cannot add any more images. You "
"can call L</guestfs_list_devices> to get a list of the device names, in the "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:144
+#: ../src/guestfs.pod:159
msgid "MOUNTING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:146
+#: ../src/guestfs.pod:161
msgid ""
"Before you can read or write files, create directories and so on in a disk "
"image that contains filesystems, you have to mount those filesystems using "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:152
+#: ../src/guestfs.pod:167
#, no-wrap
msgid ""
" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:154
+#: ../src/guestfs.pod:169
msgid ""
"where C</dev/sda1> means literally the first partition (C<1>) of the first "
"disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:158
+#: ../src/guestfs.pod:173
msgid ""
"If you are given a disk image and you don't know what it contains then you "
"have to find out. Libguestfs can do that too: use "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:168
+#: ../src/guestfs.pod:183
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:171
+#: ../src/guestfs.pod:186
msgid "FILESYSTEM ACCESS AND MODIFICATION"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:173
+#: ../src/guestfs.pod:188
msgid ""
"The majority of the libguestfs API consists of fairly low-level calls for "
"accessing and modifying the files, directories, symlinks etc on mounted "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:179
+#: ../src/guestfs.pod:194
msgid ""
"Specify filenames as full paths, starting with C<\"/\"> and including the "
"mount point."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:182
+#: ../src/guestfs.pod:197
msgid ""
"For example, if you mounted a filesystem at C<\"/\"> and you want to read "
"the file called C<\"etc/passwd\"> then you could do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:185
+#: ../src/guestfs.pod:200
#, no-wrap
msgid ""
" char *data = guestfs_cat (g, \"/etc/passwd\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:187
+#: ../src/guestfs.pod:202
msgid ""
"This would return C<data> as a newly allocated buffer containing the full "
"content of that file (with some conditions: see also L</DOWNLOADING> below), "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:191
+#: ../src/guestfs.pod:206
msgid ""
"As another example, to create a top-level directory on that filesystem "
"called C<\"var\"> you would do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:194
+#: ../src/guestfs.pod:209
#, no-wrap
msgid ""
" guestfs_mkdir (g, \"/var\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:196
+#: ../src/guestfs.pod:211
msgid "To create a symlink you could do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:198
+#: ../src/guestfs.pod:213
#, no-wrap
msgid ""
" guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:201
+#: ../src/guestfs.pod:216
msgid ""
"Libguestfs will reject attempts to use relative paths and there is no "
"concept of a current working directory."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:204
+#: ../src/guestfs.pod:219
msgid ""
"Libguestfs can return errors in many situations: for example if the "
"filesystem isn't writable, or if a file or directory that you requested "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:210
+#: ../src/guestfs.pod:225
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:213
+#: ../src/guestfs.pod:228
msgid "PARTITIONING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:215
+#: ../src/guestfs.pod:230
msgid ""
"Libguestfs contains API calls to read, create and modify partition tables on "
"disk images."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:218
+#: ../src/guestfs.pod:233
msgid ""
"In the common case where you want to create a single partition covering the "
"whole disk, you should use the L</guestfs_part_disk> call:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:222
+#: ../src/guestfs.pod:237
#, no-wrap
msgid ""
" const char *parttype = \"mbr\";\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:227
+#: ../src/guestfs.pod:242
msgid ""
"Obviously this effectively wipes anything that was on that disk image "
"before."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:230
+#: ../src/guestfs.pod:245
msgid "LVM2"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:232
+#: ../src/guestfs.pod:247
msgid ""
"Libguestfs provides access to a large part of the LVM2 API, such as "
"L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:237
+#: ../src/guestfs.pod:252
msgid ""
"This author strongly recommends reading the LVM HOWTO, online at "
"L<http://tldp.org/HOWTO/LVM-HOWTO/>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:240
+#: ../src/guestfs.pod:255
msgid "DOWNLOADING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:242
+#: ../src/guestfs.pod:257
msgid ""
"Use L</guestfs_cat> to download small, text only files. This call is "
"limited to files which are less than 2 MB and which cannot contain any ASCII "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:247
+#: ../src/guestfs.pod:262
msgid ""
"L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
"bit data, since it returns a (pointer, size) pair. However it is still "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:251
+#: ../src/guestfs.pod:266
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:254
+#: ../src/guestfs.pod:269
msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:257
+#: ../src/guestfs.pod:272
msgid "UPLOADING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:259
+#: ../src/guestfs.pod:274
msgid ""
"It's often the case that you want to write a file or files to the disk "
"image."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:262
+#: ../src/guestfs.pod:277
msgid ""
"To write a small file with fixed content, use L</guestfs_write>. To create "
"a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:268
+#: ../src/guestfs.pod:283
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:271
+#: ../src/guestfs.pod:286
msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:273
+#: ../src/guestfs.pod:288
msgid ""
"However the fastest way to upload I<large numbers of arbitrary files> is to "
"turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:284
+#: ../src/guestfs.pod:299
msgid "COPYING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:286
+#: ../src/guestfs.pod:301
msgid ""
"There are various different commands for copying between files and devices "
"and in and out of the guest filesystem. These are summarised in the table "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:292
+#: ../src/guestfs.pod:307
msgid "B<file> to B<file>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:294
+#: ../src/guestfs.pod:309
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:297
+#: ../src/guestfs.pod:312
msgid "B<file or device> to B<file or device>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:299
+#: ../src/guestfs.pod:314
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:302
+#: ../src/guestfs.pod:317
msgid "Example: duplicate the contents of an LV:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:304
+#: ../src/guestfs.pod:319
#, no-wrap
msgid ""
" guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:306
+#: ../src/guestfs.pod:321
msgid ""
"The destination (C</dev/VG/Copy>) must be at least as large as the source "
"(C</dev/VG/Original>). To copy less than the whole source device, use "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:310
+#: ../src/guestfs.pod:325
msgid "B<file on the host> to B<file or device>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:312
+#: ../src/guestfs.pod:327
msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:314
+#: ../src/guestfs.pod:329
msgid "B<file or device> to B<file on the host>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:316
+#: ../src/guestfs.pod:331
msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:320
+#: ../src/guestfs.pod:335
msgid "LISTING FILES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:322
+#: ../src/guestfs.pod:337
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:325
+#: ../src/guestfs.pod:340
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:328
+#: ../src/guestfs.pod:343
msgid ""
"L</guestfs_readdir> is a programmatic way to get a list of files in a "
"directory, plus additional information about each one. It is more "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:332
+#: ../src/guestfs.pod:347
msgid ""
"L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
"files."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:335
+#: ../src/guestfs.pod:350
msgid "RUNNING COMMANDS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:337
+#: ../src/guestfs.pod:352
msgid ""
"Although libguestfs is primarily an API for manipulating files inside guest "
"images, we also provide some limited facilities for running commands inside "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:341
+#: ../src/guestfs.pod:356
msgid "There are many limitations to this:"
msgstr ""
# type: =item
-#: ../src/guestfs.pod:345 ../src/guestfs.pod:350 ../src/guestfs.pod:355 ../src/guestfs.pod:359 ../src/guestfs.pod:364 ../src/guestfs.pod:368 ../src/guestfs.pod:373 ../src/guestfs.pod:1223 ../src/guestfs.pod:1228 ../src/guestfs.pod:1232 ../src/guestfs.pod:1334 ../src/guestfs.pod:1338 ../src/guestfs.pod:1342 ../src/guestfs.pod:1347 ../src/guestfs.pod:1355 ../src/guestfs.pod:1374 ../src/guestfs.pod:1382 ../src/guestfs.pod:1612 ../src/guestfs.pod:1618 ../src/guestfs.pod:1623 ../src/guestfs.pod:1629 ../src/guestfs.pod:1736 ../src/guestfs.pod:1740 ../src/guestfs.pod:1744 ../src/guestfs.pod:1748 ../src/guestfs-actions.pod:14 ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:372 ../src/guestfs-actions.pod:380 ../src/guestfs-actions.pod:387 ../src/guestfs-actions.pod:394 ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:1261 ../src/guestfs-actions.pod:1265 ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:1281 ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1299 ../src/guestfs-actions.pod:1303 ../src/guestfs-actions.pod:1426 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1492 ../src/guestfs-actions.pod:1496 ../src/guestfs-actions.pod:1501 ../fish/guestfish.pod:309 ../fish/guestfish.pod:313 ../fish/guestfish.pod:317 ../fish/guestfish.pod:321 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:300 ../fish/guestfish-actions.pod:308 ../fish/guestfish-actions.pod:315 ../fish/guestfish-actions.pod:322 ../fish/guestfish-actions.pod:998 ../fish/guestfish-actions.pod:1002 ../fish/guestfish-actions.pod:1006 ../fish/guestfish-actions.pod:1010 ../fish/guestfish-actions.pod:1018 ../fish/guestfish-actions.pod:1022 ../fish/guestfish-actions.pod:1026 ../fish/guestfish-actions.pod:1036 ../fish/guestfish-actions.pod:1040 ../fish/guestfish-actions.pod:1044 ../fish/guestfish-actions.pod:1134 ../fish/guestfish-actions.pod:1138 ../fish/guestfish-actions.pod:1143 ../fish/guestfish-actions.pod:1148 ../fish/guestfish-actions.pod:1190 ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1199 ../tools/virt-resize.pl:324 ../tools/virt-resize.pl:329 ../tools/virt-resize.pl:339
+#: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod: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:1519 ../src/guestfs.pod:1524 ../src/guestfs.pod:1528 ../src/guestfs.pod:1638 ../src/guestfs.pod:1643 ../src/guestfs.pod:1647 ../src/guestfs.pod:1991 ../src/guestfs.pod:1997 ../src/guestfs.pod:2002 ../src/guestfs.pod:2008 ../src/guestfs.pod:2115 ../src/guestfs.pod:2119 ../src/guestfs.pod:2123 ../src/guestfs.pod:2127 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:376 ../fish/guestfish.pod:380 ../fish/guestfish.pod:384 ../fish/guestfish.pod:388 ../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 ../inspector/virt-inspector.pl:550 ../inspector/virt-inspector.pl:554 ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363
msgid "*"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:347
+#: ../src/guestfs.pod:362
msgid ""
"The kernel version that the command runs under will be different from what "
"it expects."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:352
+#: ../src/guestfs.pod:367
msgid ""
"If the command needs to communicate with daemons, then most likely they "
"won't be running."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:357
+#: ../src/guestfs.pod:372
msgid "The command will be running in limited memory."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:361
+#: ../src/guestfs.pod:376
msgid ""
"The network may not be available unless you enable it (see "
"L</guestfs_set_network>)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:366
+#: ../src/guestfs.pod:381
msgid "Only supports Linux guests (not Windows, BSD, etc)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:370
+#: ../src/guestfs.pod:385
msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:375
+#: ../src/guestfs.pod:390
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:380
+#: ../src/guestfs.pod:395
+msgid ""
+"I<Security:> It is not safe to run commands from untrusted, possibly "
+"malicious guests. These commands may attempt to exploit your program by "
+"sending unexpected output. They could also try to exploit the Linux kernel "
+"or qemu provided by the libguestfs appliance. They could use the network "
+"provided by the libguestfs appliance to bypass ordinary network partitions "
+"and firewalls. They could use the elevated privileges or different SELinux "
+"context of your program to their advantage."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:404
+msgid ""
+"A secure alternative is to use libguestfs to install a \"firstboot\" script "
+"(a script which runs when the guest next boots normally), and to have this "
+"script run the commands you want in the normal context of the running guest, "
+"network security and so on. For information about other security issues, "
+"see L</SECURITY>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:412
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:383
+#: ../src/guestfs.pod:415
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:386
+#: ../src/guestfs.pod:418
msgid "CONFIGURATION FILES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:388
+#: ../src/guestfs.pod:420
msgid ""
"To read and write configuration files in Linux guest filesystems, we "
"strongly recommend using Augeas. For example, Augeas understands how to "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:393
+#: ../src/guestfs.pod:425
msgid ""
"The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
"document Augeas itself here because there is excellent documentation on the "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:397
+#: ../src/guestfs.pod:429
msgid ""
"If you don't want to use Augeas (you fool!) then try calling "
"L</guestfs_read_lines> to get the file as a list of lines which you can "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:401
+#: ../src/guestfs.pod:433
msgid "SELINUX"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:403
+#: ../src/guestfs.pod:435
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:409
+#: ../src/guestfs.pod:441 ../src/guestfs.pod:1140 ../src/guestfs.pod:1271
msgid "1."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:411
+#: ../src/guestfs.pod:443
msgid "Before launching, do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:413
+#: ../src/guestfs.pod:445
#, no-wrap
msgid ""
" guestfs_set_selinux (g, 1);\n"
msgstr ""
# type: =item
-#: ../src/guestfs.pod:415
+#: ../src/guestfs.pod:447 ../src/guestfs.pod:1144 ../src/guestfs.pod:1275
msgid "2."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:417
+#: ../src/guestfs.pod:449
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:421
+#: ../src/guestfs.pod:453
#, no-wrap
msgid ""
" guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:423
+#: ../src/guestfs.pod:455
msgid ""
"(Older versions of C<load_policy> require you to specify the name of the "
"policy file)."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:426
+#: ../src/guestfs.pod:458 ../src/guestfs.pod:1281
msgid "3."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:428
+#: ../src/guestfs.pod:460
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:432
+#: ../src/guestfs.pod:464
#, no-wrap
msgid ""
" guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:436
+#: ../src/guestfs.pod:468
msgid "This will work for running commands and editing existing files."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:438
+#: ../src/guestfs.pod:470
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:442
+#: ../src/guestfs.pod:474
msgid "UMASK"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:444
+#: ../src/guestfs.pod:476
msgid ""
"Certain calls are affected by the current file mode creation mask (the "
"\"umask\"). In particular ones which create files or directories, such as "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:450
+#: ../src/guestfs.pod:482
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:453
+#: ../src/guestfs.pod:485
msgid ""
"There are two ways to avoid being affected by umask. Either set umask to 0 "
"(call C<guestfs_umask (g, 0)> early after launching). Or call "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:457
+#: ../src/guestfs.pod:489
msgid "For more information about umask, see L<umask(2)>."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:459 ../fish/guestfish.pod:559
+#: ../src/guestfs.pod:491 ../fish/guestfish.pod:669
msgid "ENCRYPTED DISKS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:461
+#: ../src/guestfs.pod:493
msgid ""
"Libguestfs allows you to access Linux guests which have been encrypted using "
"whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:467
+#: ../src/guestfs.pod:499
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:470
+#: ../src/guestfs.pod:502
msgid ""
"Then open these devices by calling L</guestfs_luks_open>. Obviously you "
"will require the passphrase!"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:473
+#: ../src/guestfs.pod:505
msgid ""
"Opening a LUKS device creates a new device mapper device called "
"C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:479
+#: ../src/guestfs.pod:511
msgid ""
"LVM volume groups on the device can be made visible by calling "
"L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:483
+#: ../src/guestfs.pod:515
msgid ""
"Use the reverse process to close a LUKS device. Unmount any logical volumes "
"on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:490
+#: ../src/guestfs.pod:522
msgid "INSPECTION"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:492
+#: ../src/guestfs.pod:524
msgid ""
"Libguestfs has APIs for inspecting an unknown disk image to find out if it "
"contains operating systems. (These APIs used to be in a separate Perl-only "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:498
+#: ../src/guestfs.pod:530
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:501
+#: ../src/guestfs.pod:533
msgid ""
"Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
"and certain heuristics, and returns a list of operating systems that were "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:510
+#: ../src/guestfs.pod:542
msgid ""
"For each root, you can then call various C<guestfs_inspect_get_*> functions "
"to get additional details about that operating system. For example, call "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:516
+#: ../src/guestfs.pod:548
msgid ""
"Un*x-like and Linux-based operating systems usually consist of several "
"filesystems which are mounted at boot time (for example, a separate boot "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:523
+#: ../src/guestfs.pod:555
#, no-wrap
msgid ""
" /boot => /dev/sda1\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:527
+#: ../src/guestfs.pod:559
msgid ""
"The caller can then make calls to L</guestfs_mount_options> to mount the "
"filesystems as suggested."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:530
+#: ../src/guestfs.pod:562
msgid ""
"Be careful to mount filesystems in the right order (eg. C</> before "
"C</usr>). Sorting the keys of the hash by length, shortest first, should "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:534
+#: ../src/guestfs.pod:566
msgid ""
"Inspection currently only works for some common operating systems. "
"Contributors are welcome to send patches for other operating systems that we "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:538
+#: ../src/guestfs.pod:570
msgid ""
"Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
"for more details. The L</guestfs_inspect_os> function just ignores any "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:542
+#: ../src/guestfs.pod:574
msgid ""
"A note on the implementation: The call L</guestfs_inspect_os> performs "
"inspection and caches the results in the guest handle. Subsequent calls to "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:549
+#: ../src/guestfs.pod:581
msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:551
+#: ../src/guestfs.pod:583
msgid ""
"Libguestfs can mount NTFS partitions. It does this using the "
"L<http://www.ntfs-3g.org/> driver."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:554
+#: ../src/guestfs.pod:586
msgid ""
"DOS and Windows still use drive letters, and the filesystems are always "
"treated as case insensitive by Windows itself, and therefore you might find "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:560
+#: ../src/guestfs.pod:592
msgid ""
"Drive letter mappings are outside the scope of libguestfs. You have to use "
"libguestfs to read the appropriate Windows Registry and configuration files, "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:565
+#: ../src/guestfs.pod:597
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:568
+#: ../src/guestfs.pod:600
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:571
+#: ../src/guestfs.pod:603
msgid ""
"Libguestfs also provides some help for decoding Windows Registry \"hive\" "
"files, through the library C<hivex> which is part of the libguestfs project "
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:579
+#: ../src/guestfs.pod:611
msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:581
+#: ../src/guestfs.pod:613
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:584
+#: ../src/guestfs.pod:616
msgid ""
"The API is broadly identical in all supported languages. This means that "
"the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:590
+#: ../src/guestfs.pod:622
msgid ""
"Error messages are automatically transformed into exceptions if the language "
"supports it."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:593
+#: ../src/guestfs.pod:625
msgid ""
"We don't try to \"object orientify\" parts of the API in OO languages, "
"although contributors are welcome to write higher level APIs above what we "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:599
+#: ../src/guestfs.pod:631
msgid "B<C++>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:601
+#: ../src/guestfs.pod:633
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:605
+#: ../src/guestfs.pod:637
msgid "B<C#>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:607
+#: ../src/guestfs.pod:639
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:610
+#: ../src/guestfs.pod:642
msgid "B<Haskell>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:612
+#: ../src/guestfs.pod:644
msgid ""
"This is the only language binding that is working but incomplete. Only "
"calls which return simple integers have been bound in Haskell, and we are "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:616
+#: ../src/guestfs.pod:648
msgid "B<Java>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:618
+#: ../src/guestfs.pod:650
msgid ""
"Full documentation is contained in the Javadoc which is distributed with "
"libguestfs."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:621
+#: ../src/guestfs.pod:653
msgid "B<OCaml>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:623
+#: ../src/guestfs.pod:655
msgid "For documentation see the file C<guestfs.mli>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:625
+#: ../src/guestfs.pod:657
msgid "B<Perl>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:627
+#: ../src/guestfs.pod:659
msgid "For documentation see L<Sys::Guestfs(3)>."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:629
+#: ../src/guestfs.pod:661
msgid "B<PHP>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:631
+#: ../src/guestfs.pod:663
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:634
+#: ../src/guestfs.pod:666
msgid "The PHP binding only works correctly on 64 bit machines."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:636
+#: ../src/guestfs.pod:668
msgid "B<Python>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:638
+#: ../src/guestfs.pod:670
msgid "For documentation do:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:640
+#: ../src/guestfs.pod:672
#, no-wrap
msgid ""
" $ python\n"
msgstr ""
# type: =item
-#: ../src/guestfs.pod:644
+#: ../src/guestfs.pod:676
msgid "B<Ruby>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:646
+#: ../src/guestfs.pod:678
msgid ""
"Use the Guestfs module. There is no Ruby-specific documentation, but you "
"can find examples written in Ruby in the libguestfs source."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:649
+#: ../src/guestfs.pod:681
msgid "B<shell scripts>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:651
+#: ../src/guestfs.pod:683
msgid "For documentation see L<guestfish(1)>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:655
+#: ../src/guestfs.pod:687
msgid "LIBGUESTFS GOTCHAS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:657
+#: ../src/guestfs.pod:689
msgid ""
"L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
"system [...] that works in the way it is documented but is counterintuitive "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:661
+#: ../src/guestfs.pod:693
msgid ""
"Since we developed libguestfs and the associated tools, there are several "
"things we would have designed differently, but are now stuck with for "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:669
+#: ../src/guestfs.pod:701
msgid "Autosync / forgetting to sync."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:671
+#: ../src/guestfs.pod:703
msgid ""
"When modifying a filesystem from C or another language, you B<must> unmount "
"all filesystems and call L</guestfs_sync> explicitly before you close the "
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:675
+#: ../src/guestfs.pod:707
#, no-wrap
msgid ""
" guestfs_set_autosync (g, 1);\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:677
+#: ../src/guestfs.pod:709
msgid ""
"to have the unmount/sync done automatically for you when the handle 'g' is "
"closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:681
+#: ../src/guestfs.pod:713
msgid ""
"If you forget to do this, then it is entirely possible that your changes "
"won't be written out, or will be partially written, or (very rarely) that "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:685
+#: ../src/guestfs.pod:717
msgid ""
"Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
"guestfish scripts that forget to sync will work just fine, which can make "
"this very puzzling if you are trying to debug a problem."
msgstr ""
+# type: textblock
+#: ../src/guestfs.pod:721
+msgid ""
+"Update: Autosync is enabled by default for all API users starting from "
+"libguestfs 1.5.24."
+msgstr ""
+
# type: =item
-#: ../src/guestfs.pod:689
+#: ../src/guestfs.pod:724
msgid "Mount option C<-o sync> should not be the default."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:691
+#: ../src/guestfs.pod:726
msgid ""
"If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
"However C<-o sync> does not add any reliability benefit, but does have a "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:695
+#: ../src/guestfs.pod:730
msgid ""
"The work around is to use L</guestfs_mount_options> and set the mount "
"options that you actually want to use."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:698
+#: ../src/guestfs.pod:733
msgid "Read-only should be the default."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:700
+#: ../src/guestfs.pod:735
msgid ""
"In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
"specify I<--rw> if you want to make changes to the image."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:703
+#: ../src/guestfs.pod:738
msgid "This would reduce the potential to corrupt live VM images."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:705
+#: ../src/guestfs.pod:740
msgid ""
"Note that many filesystems change the disk when you just mount and unmount, "
"even if you didn't perform any writes. You need to use "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:709
+#: ../src/guestfs.pod:744
msgid "guestfish command line is hard to use."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:711
+#: ../src/guestfs.pod:746
msgid ""
"C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
"examination). It tries to run a guestfish command C<disk.img> which doesn't "
msgstr ""
# type: =item
-#: ../src/guestfs.pod:718
+#: ../src/guestfs.pod:753
msgid "guestfish megabyte modifiers don't work right on all commands"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:720
+#: ../src/guestfs.pod:755
msgid ""
"In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
"other modifiers). What guestfish actually does is to multiply the number "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:727
+#: ../src/guestfs.pod:762
msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:729
+#: ../src/guestfs.pod:764
#, no-wrap
msgid ""
" lvcreate LV VG 100M\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:731
+#: ../src/guestfs.pod:766
msgid ""
"does not do what you might expect. Instead because L</guestfs_lvcreate> is "
"already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:736
+#: ../src/guestfs.pod:771
msgid ""
"This could be fixed in the generator by specially marking parameters and "
"return values which take bytes or other units."
msgstr ""
# type: =item
-#: ../src/guestfs.pod:739
-msgid "Library should return errno with error messages."
+#: ../src/guestfs.pod:774
+msgid "Ambiguity between devices and paths"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:776
+msgid ""
+"There is a subtle ambiguity in the API between a device name "
+"(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
+"called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:781
+msgid ""
+"In the current API we usually resolve this ambiguity by having two separate "
+"calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
+"Some API calls are ambiguous and (incorrectly) resolve the problem by "
+"detecting if the path supplied begins with C</dev/>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:741
+#: ../src/guestfs.pod:787
msgid ""
-"It would be a nice-to-have to be able to get the original value of 'errno' "
-"from inside the appliance along error paths (where set). Currently "
-"L<guestmount(1)> goes through hoops to try to reverse the error message "
-"string into an errno, see the function error() in fuse/guestmount.c."
+"To avoid both the ambiguity and the need to duplicate some calls, we could "
+"make paths/devices into structured names. One way to do this would be to "
+"use a notation like grub (C<hd(0,0)>), although nobody really likes this "
+"aspect of grub. Another way would be to use a structured type, equivalent "
+"to this OCaml type:"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs.pod:793
+#, no-wrap
+msgid ""
+" type path = Path of string | Device of int | Partition of int * int\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:795
+msgid "which would allow you to pass arguments like:"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs.pod:797
+#, no-wrap
+msgid ""
+" Path \"/foo/bar\"\n"
+" Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
+" Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
+" Path \"/dev/sdb2\" (* not a device *)\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:747
+#: ../src/guestfs.pod:802
msgid ""
-"In libguestfs 1.5.4, the protocol was changed so that the Linux errno is "
-"sent back from the daemon."
+"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:752
+#: ../src/guestfs.pod:807
msgid "PROTOCOL LIMITS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:754
+#: ../src/guestfs.pod:809
msgid ""
"Internally libguestfs uses a message-based protocol to pass API calls and "
"their responses to and from a small \"appliance\" (see L</INTERNALS> for "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:762
+#: ../src/guestfs.pod:817
msgid ""
"A simple call such as L</guestfs_cat> returns its result (the file data) in "
"a simple string. Because this string is at some point internally encoded as "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:768
+#: ../src/guestfs.pod:823
msgid ""
"In order to transfer large files into and out of the guest filesystem, you "
"need to use particular calls that support this. The sections L</UPLOADING> "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:772
+#: ../src/guestfs.pod:827
msgid ""
"You might also consider mounting the disk image using our FUSE filesystem "
"support (L<guestmount(1)>)."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:775
+#: ../src/guestfs.pod:830
msgid "KEYS AND PASSPHRASES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:777
+#: ../src/guestfs.pod:832
msgid ""
"Certain libguestfs calls take a parameter that contains sensitive key "
"material, passed in as a C string."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:780
+#: ../src/guestfs.pod:835
msgid ""
"In the future we would hope to change the libguestfs implementation so that "
"keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:785
+#: ../src/guestfs.pod:840
msgid ""
"Therefore you should be aware that any key parameter you pass to libguestfs "
"might end up being written out to the swap partition. If this is a concern, "
"scrub the swap partition or don't use libguestfs on encrypted devices."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:790
-msgid "CONNECTION MANAGEMENT"
-msgstr ""
-
# type: =head2
-#: ../src/guestfs.pod:792
-msgid "guestfs_h *"
+#: ../src/guestfs.pod:845
+msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:794
+#: ../src/guestfs.pod:847
msgid ""
-"C<guestfs_h> is the opaque type representing a connection handle. Create a "
-"handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
-"handle and release all resources used."
+"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:798
-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:801
-msgid "guestfs_create"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs.pod:803
-#, no-wrap
+#: ../src/guestfs.pod:850
msgid ""
-" guestfs_h *guestfs_create (void);\n"
-"\n"
+"Only use the handle from a single thread. Either use the handle exclusively "
+"from one thread, or provide your own mutex so that two threads cannot issue "
+"calls on the same handle at the same time."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:805
-msgid "Create a connection handle."
+#: ../src/guestfs.pod:854
+msgid ""
+"See the graphical program guestfs-browser for one possible architecture for "
+"multithreaded programs using libvirt and libguestfs."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:807
-msgid "You have to call L</guestfs_add_drive> on the handle at least once."
+# type: =head2
+#: ../src/guestfs.pod:857
+msgid "PATH"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:809
+#: ../src/guestfs.pod:859
msgid ""
-"This function returns a non-NULL pointer to a handle on success or NULL on "
-"error."
+"Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
+"internal path."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:812
-msgid "After configuring the handle, you have to call L</guestfs_launch>."
+#: ../src/guestfs.pod:862
+msgid ""
+"By default it looks for these in the directory C<$libdir/guestfs> "
+"(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:814
+#: ../src/guestfs.pod:865
msgid ""
-"You may also want to configure error handling for the handle. See L</ERROR "
-"HANDLING> section below."
+"Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
+"to change the directories that libguestfs will search in. The value is a "
+"colon-separated list of paths. The current directory is I<not> searched "
+"unless the path contains an empty element or C<.>. For example "
+"C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
+"then C</usr/lib/guestfs>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:817
-msgid "guestfs_close"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs.pod:819
-#, no-wrap
-msgid ""
-" void guestfs_close (guestfs_h *g);\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs.pod:821
-msgid "This closes the connection handle and frees up all resources used."
-msgstr ""
-
-# type: =head1
-#: ../src/guestfs.pod:823
-msgid "ERROR HANDLING"
+#: ../src/guestfs.pod:872
+msgid "QEMU WRAPPERS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:825
+#: ../src/guestfs.pod:874
msgid ""
-"The convention in all functions that return C<int> is that they return C<-1> "
-"to indicate an error. You can get additional information on errors by "
-"calling L</guestfs_last_error> and/or by setting up an error handler with "
-"L</guestfs_set_error_handler>."
+"If you want to compile your own qemu, run qemu from a non-standard location, "
+"or pass extra arguments to qemu, then you can write a shell-script wrapper "
+"around qemu."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:830
-msgid "The default error handler prints the information string to C<stderr>."
+#: ../src/guestfs.pod:878
+msgid ""
+"There is one important rule to remember: you I<must C<exec qemu>> as the "
+"last command in the shell script (so that qemu replaces the shell and "
+"becomes the direct child of the libguestfs-using program). If you don't do "
+"this, then the qemu process won't be cleaned up correctly."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:832
+#: ../src/guestfs.pod:883
msgid ""
-"Out of memory errors are handled differently. The default action is to call "
-"L<abort(3)>. If this is undesirable, then you can set a handler using "
-"L</guestfs_set_out_of_memory_handler>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs.pod:836
-msgid "guestfs_last_error"
+"Here is an example of a wrapper, where I have built my own copy of qemu from "
+"source:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:838
+#: ../src/guestfs.pod:886
#, no-wrap
msgid ""
-" const char *guestfs_last_error (guestfs_h *g);\n"
+" #!/bin/sh -\n"
+" qemudir=/home/rjones/d/qemu\n"
+" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
+"\"$@\"\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:840
+#: ../src/guestfs.pod:890
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>."
+"Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
+"then use it by setting the LIBGUESTFS_QEMU environment variable. For "
+"example:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:844
+# type: verbatim
+#: ../src/guestfs.pod:894
+#, no-wrap
msgid ""
-"The lifetime of the returned string is until the next error occurs, or "
-"L</guestfs_close> is called."
+" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:847
+#: ../src/guestfs.pod:896
msgid ""
-"The error string is not localized (ie. is always in English), because this "
-"makes searching for error messages in search engines give the largest number "
-"of results."
+"Note that libguestfs also calls qemu with the -help and -version options in "
+"order to determine features."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:851
-msgid "guestfs_set_error_handler"
+#: ../src/guestfs.pod:899
+msgid "ABI GUARANTEE"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:853
-#, no-wrap
-msgid ""
-" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
-" void *opaque,\n"
-" const char *msg);\n"
-" void guestfs_set_error_handler (guestfs_h *g,\n"
-" guestfs_error_handler_cb cb,\n"
-" void *opaque);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs.pod:901
+msgid ""
+"We guarantee the libguestfs ABI (binary interface), for public, high-level "
+"actions as outlined in this section. Although we will deprecate some "
+"actions, for example if they get replaced by newer calls, we will keep the "
+"old actions forever. This allows you the developer to program in confidence "
+"against the libguestfs API."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs.pod:907
+msgid "BLOCK DEVICE NAMING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:860
+#: ../src/guestfs.pod:909
msgid ""
-"The callback C<cb> will be called if there is an error. The parameters "
-"passed to the callback are an opaque data pointer and the error message "
-"string."
+"In the kernel there is now quite a profusion of schemata for naming block "
+"devices (in this context, by I<block device> I mean a physical or virtual "
+"hard drive). The original Linux IDE driver used names starting with "
+"C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
+"C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
+"replacement for the old IDE driver (particularly for SATA devices) those "
+"devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
+"machines with paravirtualized drivers. This has created several different "
+"naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
+"Xen PV disks."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:864
+#: ../src/guestfs.pod:921
msgid ""
-"Note that the message string C<msg> is freed as soon as the callback "
-"function returns, so if you want to stash it somewhere you must make your "
-"own copy."
+"As discussed above, libguestfs uses a qemu appliance running an embedded "
+"Linux kernel to access block devices. We can run a variety of appliances "
+"based on a variety of Linux kernels."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:868
-msgid "The default handler prints messages on C<stderr>."
+#: ../src/guestfs.pod:925
+msgid ""
+"This causes a problem for libguestfs because many API calls use device or "
+"partition names. Working scripts and the recipe (example) scripts that we "
+"make available over the internet could fail if the naming scheme changes."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:870
-msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
+#: ../src/guestfs.pod:930
+msgid ""
+"Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
+"Internally C</dev/sd*> names are translated, if necessary, to other names as "
+"required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
+"device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:872
-msgid "guestfs_get_error_handler"
+# type: textblock
+#: ../src/guestfs.pod:936
+msgid ""
+"Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
+"L</guestfs_list_partitions> and similar calls return the true names of the "
+"devices and partitions as known to the appliance."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:874
-#, no-wrap
+# type: =head3
+#: ../src/guestfs.pod:941
+msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:943
msgid ""
-" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
-" void **opaque_rtn);\n"
-"\n"
+"Usually this translation is transparent. However in some (very rare) cases "
+"you may need to know the exact algorithm. Such cases include where you use "
+"L</guestfs_config> to add a mixture of virtio and IDE devices to the "
+"qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
+"devices."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:877
-msgid "Returns the current error handler callback."
+#: ../src/guestfs.pod:949
+msgid ""
+"The algorithm is applied only to I<parameters> which are known to be either "
+"device or partition names. Return values from functions such as "
+"L</guestfs_list_devices> are never changed."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:879
-msgid "guestfs_set_out_of_memory_handler"
+# type: textblock
+#: ../src/guestfs.pod:957
+msgid "Is the string a parameter which is a device or partition name?"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:881
-#, no-wrap
-msgid ""
-" typedef void (*guestfs_abort_cb) (void);\n"
-" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
-" guestfs_abort_cb);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs.pod:961
+msgid "Does the string begin with C</dev/sd>?"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:885
+#: ../src/guestfs.pod:965
msgid ""
-"The callback C<cb> will be called if there is an out of memory situation. "
-"I<Note this callback must not return>."
+"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:888
-msgid "The default is to call L<abort(3)>."
+#: ../src/guestfs.pod:970
+msgid "Replace initial C</dev/sd> string with C</dev/hd>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:890
-msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
+#: ../src/guestfs.pod:972
+msgid "For example, change C</dev/sda2> to C</dev/hda2>."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:893
-msgid "guestfs_get_out_of_memory_handler"
+# type: textblock
+#: ../src/guestfs.pod:974
+msgid "If that named device exists, use it. If not, continue."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:895
-#, no-wrap
-msgid ""
-" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs.pod:978
+msgid "Replace initial C</dev/sd> string with C</dev/vd>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:897
-msgid "This returns the current out of memory handler."
+#: ../src/guestfs.pod:980
+msgid "If that named device exists, use it. If not, return an error."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:899
-msgid "PATH"
+# type: =head3
+#: ../src/guestfs.pod:984
+msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:901
+#: ../src/guestfs.pod:986
msgid ""
-"Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
-"internal path."
+"Although the standard naming scheme and automatic translation is useful for "
+"simple programs and guestfish scripts, for larger programs it is best not to "
+"rely on this mechanism."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:904
+#: ../src/guestfs.pod:990
msgid ""
-"By default it looks for these in the directory C<$libdir/guestfs> "
-"(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
+"Where possible for maximum future portability programs using libguestfs "
+"should use these future-proof techniques:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:907
+#: ../src/guestfs.pod:997
msgid ""
-"Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
-"to change the directories that libguestfs will search in. The value is a "
-"colon-separated list of paths. The current directory is I<not> searched "
-"unless the path contains an empty element or C<.>. For example "
-"C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
-"then C</usr/lib/guestfs>."
+"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
+msgid "Since those device names exist by definition, they will never be translated."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:1005
+msgid ""
+"Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
+"filesystem labels."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:914
-msgid "HIGH-LEVEL API ACTIONS"
+#: ../src/guestfs.pod:1010
+msgid "SECURITY"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:1012
+msgid ""
+"This section discusses security implications of using libguestfs, "
+"particularly with untrusted or malicious guests or disk images."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:916
-msgid "ABI GUARANTEE"
+#: ../src/guestfs.pod:1015
+msgid "GENERAL SECURITY CONSIDERATIONS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:918
+#: ../src/guestfs.pod:1017
msgid ""
-"We guarantee the libguestfs ABI (binary interface), for public, high-level "
-"actions as outlined in this section. Although we will deprecate some "
-"actions, for example if they get replaced by newer calls, we will keep the "
-"old actions forever. This allows you the developer to program in confidence "
-"against the libguestfs API."
+"Be careful with any files or data that you download from a guest (by "
+"\"download\" we mean not just the L</guestfs_download> command but any "
+"command that reads files, filenames, directories or anything else from a "
+"disk image). An attacker could manipulate the data to fool your program "
+"into doing the wrong thing. Consider cases such as:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:924 ../fish/guestfish.pod:926
-msgid "@ACTIONS@"
+#: ../src/guestfs.pod:1027
+msgid "the data (file etc) not being present"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:926
-msgid "STRUCTURES"
+# type: textblock
+#: ../src/guestfs.pod:1031
+msgid "being present but empty"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:928
-msgid "@STRUCTS@"
+#: ../src/guestfs.pod:1035
+msgid "being much larger than normal"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:930
-msgid "AVAILABILITY"
+# type: textblock
+#: ../src/guestfs.pod:1039
+msgid "containing arbitrary 8 bit data"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:932
-msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
+# type: textblock
+#: ../src/guestfs.pod:1043
+msgid "being in an unexpected character encoding"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:934
-msgid ""
-"Using L</guestfs_available> you can test availability of the following "
-"groups of functions. This test queries the appliance to see if the "
-"appliance you are currently using supports the functionality."
+#: ../src/guestfs.pod:1047
+msgid "containing homoglyphs."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs.pod:1051
+msgid "SECURITY OF MOUNTING FILESYSTEMS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:939
-msgid "@AVAILABILITY@"
+#: ../src/guestfs.pod:1053
+msgid ""
+"When you mount a filesystem under Linux, mistakes in the kernel filesystem "
+"(VFS) module can sometimes be escalated into exploits by deliberately "
+"creating a malicious, malformed filesystem. These exploits are very severe "
+"for two reasons. Firstly there are very many filesystem drivers in the "
+"kernel, and many of them are infrequently used and not much developer "
+"attention has been paid to the code. Linux userspace helps potential "
+"crackers by detecting the filesystem type and automatically choosing the "
+"right VFS driver, even if that filesystem type is obscure or unexpected for "
+"the administrator. Secondly, a kernel-level exploit is like a local root "
+"exploit (worse in some ways), giving immediate and total access to the "
+"system right down to the hardware level."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:941
-msgid "GUESTFISH supported COMMAND"
+# type: textblock
+#: ../src/guestfs.pod:1066
+msgid ""
+"That explains why you should never mount a filesystem from an untrusted "
+"guest on your host kernel. How about libguestfs? We run a Linux kernel "
+"inside a qemu virtual machine, usually running as a non-root user. The "
+"attacker would need to write a filesystem which first exploited the kernel, "
+"and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
+"the libguestfs protocol, and finally to be as serious as the host kernel "
+"exploit it would need to escalate its privileges to root. This multi-step "
+"escalation, performed by a static piece of data, is thought to be extremely "
+"hard to do, although we never say 'never' about security issues."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:943
+#: ../src/guestfs.pod:1077
msgid ""
-"In L<guestfish(3)> there is a handy interactive command C<supported> which "
-"prints out the available groups and whether they are supported by this build "
-"of libguestfs. Note however that you have to do C<run> first."
+"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:948
-msgid "SINGLE CALLS AT COMPILE TIME"
+#: ../src/guestfs.pod:1080
+msgid "PROTOCOL SECURITY"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:950
+#: ../src/guestfs.pod:1082
msgid ""
-"Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
-"function, such as:"
+"The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
+"defined upper message size. However a program that uses libguestfs must "
+"also take care - for example you can write a program that downloads a binary "
+"from a disk image and executes it locally, and no amount of protocol "
+"security will save you from the consequences."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:953
-#, no-wrap
-msgid ""
-" #define LIBGUESTFS_HAVE_DD 1\n"
-"\n"
+# type: =head2
+#: ../src/guestfs.pod:1088
+msgid "INSPECTION SECURITY"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:955
-msgid "if L</guestfs_dd> is available."
+#: ../src/guestfs.pod:1090
+msgid ""
+"Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
+"directly from the guest, and these could contain any 8 bit data. Callers "
+"should be careful to escape these before printing them to a structured file "
+"(for example, use HTML escaping if creating a web page)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:957
+#: ../src/guestfs.pod:1096
msgid ""
-"Before version 1.5.8, if you needed to test whether a single libguestfs "
-"function is available at compile time, we recommended using build tools such "
-"as autoconf or cmake. For example in autotools you could use:"
+"The inspection API parses guest configuration using two external libraries: "
+"Augeas (Linux configuration) and hivex (Windows Registry). Both are "
+"designed to be robust in the face of malicious data, although denial of "
+"service attacks are still possible, for example with oversized configuration "
+"files."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:962
-#, no-wrap
-msgid ""
-" AC_CHECK_LIB([guestfs],[guestfs_create])\n"
-" AC_CHECK_FUNCS([guestfs_dd])\n"
-"\n"
+# type: =head2
+#: ../src/guestfs.pod:1102
+msgid "RUNNING UNTRUSTED GUEST COMMANDS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:965
+#: ../src/guestfs.pod:1104
msgid ""
-"which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
-"in your program."
+"Be very cautious about running commands from the guest. By running a "
+"command in the guest, you are giving CPU time to a binary that you do not "
+"control, under the same user account as the library, albeit wrapped in qemu "
+"virtualization. More information and alternatives can be found in the "
+"section L</RUNNING COMMANDS>."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:968
-msgid "SINGLE CALLS AT RUN TIME"
+#: ../src/guestfs.pod:1110
+msgid "CVE-2010-3851"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:970
-msgid ""
-"Testing at compile time doesn't guarantee that a function really exists in "
-"the library. The reason is that you might be dynamically linked against a "
-"previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
-"This situation unfortunately results in a segmentation fault, which is a "
-"shortcoming of the C dynamic linking system itself."
+#: ../src/guestfs.pod:1112
+msgid "https://bugzilla.redhat.com/642934"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:977
+#: ../src/guestfs.pod:1114
msgid ""
-"You can use L<dlopen(3)> to test if a function is available at run time, as "
-"in this example program (note that you still need the compile time check as "
-"well):"
+"This security bug concerns the automatic disk format detection that qemu "
+"does on disk images."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:981
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:1117
msgid ""
-" #include <stdio.h>\n"
-" #include <stdlib.h>\n"
-" #include <unistd.h>\n"
-" #include <dlfcn.h>\n"
-" #include <guestfs.h>\n"
-" \n"
+"A raw disk image is just the raw bytes, there is no header. Other disk "
+"images like qcow2 contain a special header. Qemu deals with this by looking "
+"for one of the known headers, and if none is found then assuming the disk "
+"image must be raw."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:987
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:1122
msgid ""
-" main ()\n"
-" {\n"
-" #ifdef LIBGUESTFS_HAVE_DD\n"
-" void *dl;\n"
-" int has_function;\n"
-" \n"
+"This allows a guest which has been given a raw disk image to write some "
+"other header. At next boot (or when the disk image is accessed by "
+"libguestfs) qemu would do autodetection and think the disk image format was, "
+"say, qcow2 based on the header written by the guest."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:993
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:1127
msgid ""
-" /* Test if the function guestfs_dd is really available. */\n"
-" dl = dlopen (NULL, RTLD_LAZY);\n"
-" if (!dl) {\n"
-" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
-" exit (EXIT_FAILURE);\n"
-" }\n"
-" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
-" dlclose (dl);\n"
-" \n"
+"This in itself would not be a problem, but qcow2 offers many features, one "
+"of which is to allow a disk image to refer to another image (called the "
+"\"backing disk\"). It does this by placing the path to the backing disk "
+"into the qcow2 header. This path is not validated and could point to any "
+"host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
+"\"holes\" in the qcow2 disk image, which of course is completely under the "
+"control of the attacker."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1002
-#, no-wrap
-msgid ""
-" if (!has_function)\n"
-" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
-" else {\n"
-" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
-" /* Now it's safe to call\n"
-" guestfs_dd (g, \"foo\", \"bar\");\n"
-" */\n"
-" }\n"
-" #else\n"
-" printf (\"guestfs_dd function was not found at compile time\\n\");\n"
-" #endif\n"
-" }\n"
-"\n"
+# type: textblock
+#: ../src/guestfs.pod:1135
+msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1015
+#: ../src/guestfs.pod:1142
+msgid "You have enabled the network or have opened the disk in write mode."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:1146
msgid ""
-"You may think the above is an awful lot of hassle, and it is. There are "
-"other ways outside of the C linking system to ensure that this kind of "
-"incompatibility never arises, such as using package versioning:"
+"You are also running untrusted code from the guest (see L</RUNNING "
+"COMMANDS>)."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1020
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:1151
msgid ""
-" Requires: libguestfs >= 1.0.80\n"
-"\n"
+"The way to avoid this is to specify the expected disk format when adding "
+"disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
+"should always do this if the disk is raw format, and it's a good idea for "
+"other cases too."
msgstr ""
-# type: =end
-#: ../src/guestfs.pod:1022 ../src/guestfs.pod:1027
-msgid "html"
+# type: textblock
+#: ../src/guestfs.pod:1156
+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:1024
+#: ../src/guestfs.pod:1159
msgid ""
-"<!-- old anchor for the next section --> <a "
-"name=\"state_machine_and_low_level_event_api\"/>"
+"For libguestfs tools, use the I<--format> command line parameter as "
+"appropriate."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1029
-msgid "ARCHITECTURE"
+#: ../src/guestfs.pod:1162
+msgid "CONNECTION MANAGEMENT"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs.pod:1164
+msgid "guestfs_h *"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1031
+#: ../src/guestfs.pod:1166
msgid ""
-"Internally, libguestfs is implemented by running an appliance (a special "
-"type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
-"process of the main program."
+"C<guestfs_h> is the opaque type representing a connection handle. Create a "
+"handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
+"handle and release all resources used."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:1170
+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:1173
+msgid "guestfs_create"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1035
+#: ../src/guestfs.pod:1175
#, no-wrap
msgid ""
-" ___________________\n"
-" / \\\n"
-" | main program |\n"
-" | |\n"
-" | | child process / appliance\n"
-" | | __________________________\n"
-" | | / qemu \\\n"
-" +-------------------+ RPC | +-----------------+ |\n"
-" | libguestfs <--------------------> guestfsd | |\n"
-" | | | +-----------------+ |\n"
-" \\___________________/ | | Linux kernel | |\n"
-" | +--^--------------+ |\n"
-" \\_________|________________/\n"
-" |\n"
-" _______v______\n"
-" / \\\n"
-" | Device or |\n"
-" | disk image |\n"
-" \\______________/\n"
+" guestfs_h *guestfs_create (void);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1055
-msgid ""
-"The library, linked to the main program, creates the child process and hence "
-"the appliance in the L</guestfs_launch> function."
+#: ../src/guestfs.pod:1177
+msgid "Create a connection handle."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1058
+#: ../src/guestfs.pod:1179
msgid ""
-"Inside the appliance is a Linux kernel and a complete stack of userspace "
-"tools (such as LVM and ext2 programs) and a small controlling daemon called "
-"L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
-"calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
-"API calls and RPC calls to the daemon. Lastly the disk image(s) are "
-"attached to the qemu process which translates device access by the "
-"appliance's Linux kernel into accesses to the image."
+"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:1067
+#: ../src/guestfs.pod:1182
msgid ""
-"A common misunderstanding is that the appliance \"is\" the virtual machine. "
-"Although the disk image you are attached to might also be used by some "
-"virtual machine, libguestfs doesn't know or care about this. (But you will "
-"care if both libguestfs's qemu process and your virtual machine are trying "
-"to update the disk image at the same time, since these usually results in "
-"massive disk corruption)."
+"This function returns a non-NULL pointer to a handle on success or NULL on "
+"error."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1074
-msgid "STATE MACHINE"
+# type: textblock
+#: ../src/guestfs.pod:1185
+msgid "After configuring the handle, you have to call L</guestfs_launch>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1076
-msgid "libguestfs uses a state machine to model the child process:"
+#: ../src/guestfs.pod:1187
+msgid ""
+"You may also want to configure error handling for the handle. See L</ERROR "
+"HANDLING> section below."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs.pod:1190
+msgid "guestfs_close"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1078
+#: ../src/guestfs.pod:1192
#, no-wrap
msgid ""
-" |\n"
-" guestfs_create\n"
-" |\n"
-" |\n"
-" ____V_____\n"
-" / \\\n"
-" | CONFIG |\n"
-" \\__________/\n"
-" ^ ^ ^ \\\n"
-" / | \\ \\ guestfs_launch\n"
-" / | _\\__V______\n"
-" / | / \\\n"
-" / | | LAUNCHING |\n"
-" / | \\___________/\n"
-" / | /\n"
-" / | guestfs_launch\n"
-" / | /\n"
-" ______ / __|____V\n"
-" / \\ ------> / \\\n"
-" | BUSY | | READY |\n"
-" \\______/ <------ \\________/\n"
+" void guestfs_close (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1100
-msgid ""
-"The normal transitions are (1) CONFIG (when the handle is created, but there "
-"is no child process), (2) LAUNCHING (when the child process is booting up), "
-"(3) alternating between READY and BUSY as commands are issued to, and "
-"carried out by, the child process."
+#: ../src/guestfs.pod:1194
+msgid "This closes the connection handle and frees up all resources used."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1105
-msgid ""
-"The guest may be killed by L</guestfs_kill_subprocess>, or may die "
-"asynchronously at any time (eg. due to some internal error), and that causes "
-"the state to transition back to CONFIG."
+# type: =head1
+#: ../src/guestfs.pod:1196
+msgid "ERROR HANDLING"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1109
+#: ../src/guestfs.pod:1198
msgid ""
-"Configuration commands for qemu such as L</guestfs_add_drive> can only be "
-"issued when in the CONFIG state."
+"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:1112
+#: ../src/guestfs.pod:1201
msgid ""
-"The API offers one call that goes from CONFIG through LAUNCHING to READY. "
-"L</guestfs_launch> blocks until the child process is READY to accept "
-"commands (or until some failure or timeout). L</guestfs_launch> internally "
-"moves the state from CONFIG to LAUNCHING while it is running."
+"Additional information is available for errors: an error message string and "
+"optionally an error number (errno) if the thing that failed was a system "
+"call."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1118
+#: ../src/guestfs.pod:1205
msgid ""
-"API actions such as L</guestfs_mount> can only be issued when in the READY "
-"state. These API calls block waiting for the command to be carried out "
-"(ie. the state to transition to BUSY and then back to READY). There are no "
-"non-blocking versions, and no way to issue more than one command per handle "
-"at the same time."
+"You can get at the additional information about the last error on the handle "
+"by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
+"up an error handler with L</guestfs_set_error_handler>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1124
+#: ../src/guestfs.pod:1210
msgid ""
-"Finally, the child process sends asynchronous messages back to the main "
-"program, such as kernel log messages. You can register a callback to "
-"receive these messages."
+"When the handle is created, a default error handler is installed which "
+"prints the error message string to C<stderr>. For small short-running "
+"command line programs it is sufficient to do:"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1128
-msgid "SETTING CALLBACKS TO HANDLE EVENTS"
+# type: verbatim
+#: ../src/guestfs.pod:1214
+#, no-wrap
+msgid ""
+" if (guestfs_launch (g) == -1)\n"
+" exit (EXIT_FAILURE);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1130
+#: ../src/guestfs.pod:1217
msgid ""
-"The child process generates events in some situations. Current events "
-"include: receiving a log message, the child process exits."
+"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:1133
+#: ../src/guestfs.pod:1220
msgid ""
-"Use the C<guestfs_set_*_callback> functions to set a callback for different "
-"types of events."
+"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: textblock
-#: ../src/guestfs.pod:1136
+# type: verbatim
+#: ../src/guestfs.pod:1223
+#, no-wrap
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 "
-"that type. Cancel all callbacks of this type by calling this function with "
-"C<cb> set to C<NULL>."
+" g = guestfs_create ();\n"
+" \n"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1141
-msgid "guestfs_set_log_message_callback"
+# type: verbatim
+#: ../src/guestfs.pod:1225
+#, no-wrap
+msgid ""
+" /* This disables the default behaviour of printing errors\n"
+" on stderr. */\n"
+" guestfs_set_error_handler (g, NULL, NULL);\n"
+" \n"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1143
+#: ../src/guestfs.pod:1229
#, no-wrap
msgid ""
-" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
-" char *buf, int len);\n"
-" void guestfs_set_log_message_callback (guestfs_h *g,\n"
-" guestfs_log_message_cb cb,\n"
-" void *opaque);\n"
+" if (guestfs_launch (g) == -1) {\n"
+" /* Examine the error message and print it etc. */\n"
+" char *msg = guestfs_last_error (g);\n"
+" int errnum = guestfs_last_errno (g);\n"
+" fprintf (stderr, \"%s\\n\", msg);\n"
+" /* ... */\n"
+" }\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1149
+#: ../src/guestfs.pod:1237
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:1152
-msgid "Use this function to capture kernel messages and similar."
+"Out of memory errors are handled differently. The default action is to call "
+"L<abort(3)>. If this is undesirable, then you can set a handler using "
+"L</guestfs_set_out_of_memory_handler>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1154
+#: ../src/guestfs.pod:1241
msgid ""
-"Normally there is no log message handler, and log messages are just "
-"discarded."
+"L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
+"because there is no handle if this happens there is no way to get additional "
+"error information. However L</guestfs_create> is supposed to be a "
+"lightweight operation which can only fail because of insufficient memory (it "
+"returns NULL in this case)."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1157
-msgid "guestfs_set_subprocess_quit_callback"
+#: ../src/guestfs.pod:1247
+msgid "guestfs_last_error"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1159
+#: ../src/guestfs.pod:1249
#, no-wrap
msgid ""
-" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
-" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
-" guestfs_subprocess_quit_cb cb,\n"
-" void *opaque);\n"
+" const char *guestfs_last_error (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1164
+#: ../src/guestfs.pod:1251
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 "
-"corresponds to a transition from any state to the CONFIG state)."
+"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:1255
+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:1169
-msgid "guestfs_set_launch_done_callback"
+#: ../src/guestfs.pod:1258
+msgid "guestfs_last_errno"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1171
+#: ../src/guestfs.pod:1260
#, no-wrap
msgid ""
-" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
-" void guestfs_set_launch_done_callback (guestfs_h *g,\n"
-" guestfs_launch_done_cb cb,\n"
-" void *opaque);\n"
+" int guestfs_last_errno (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1176
-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 "
-"transition from LAUNCHING to the READY state)."
+#: ../src/guestfs.pod:1262
+msgid "This returns the last error number (errno) that happened on C<g>."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1180
-msgid "guestfs_set_close_callback"
+# type: textblock
+#: ../src/guestfs.pod:1264
+msgid "If successful, an errno integer not equal to zero is returned."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1182
-#, no-wrap
-msgid ""
-" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
-" void guestfs_set_close_callback (guestfs_h *g,\n"
-" guestfs_close_cb cb,\n"
-" void *opaque);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs.pod:1266
+msgid "If no error, this returns 0. This call can return 0 in three situations:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1187
+#: ../src/guestfs.pod:1273
+msgid "There has not been any error on the handle."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:1277
msgid ""
-"The callback function C<cb> will be called while the handle is being closed "
-"(synchronously from L</guestfs_close>)."
+"There has been an error but the errno was meaningless. This corresponds to "
+"the case where the error did not come from a failed system call, but for "
+"some other reason."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1190
+#: ../src/guestfs.pod:1283
msgid ""
-"Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
-"handles that are open when the program exits. This means that this callback "
-"might be called indirectly from L<exit(3)>, which can cause unexpected "
-"problems in higher-level languages (eg. if your HLL interpreter has already "
-"been cleaned up by the time this is called, and if your callback then jumps "
-"into some HLL function)."
+"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:1289
+msgid ""
+"Libguestfs tries to convert the errno from inside the applicance into a "
+"corresponding errno for the caller (not entirely trivial: the appliance "
+"might be running a completely different operating system from the library "
+"and error numbers are not standardized across Un*xen). If this could not be "
+"done, then the error is translated to C<EINVAL>. In practice this should "
+"only happen in very rare circumstances."
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1198
-msgid "guestfs_set_progress_callback"
+#: ../src/guestfs.pod:1297
+msgid "guestfs_set_error_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1200
+#: ../src/guestfs.pod:1299
#, no-wrap
msgid ""
-" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
-" int proc_nr, int serial,\n"
-" uint64_t position, uint64_t total);\n"
-" void guestfs_set_progress_callback (guestfs_h *g,\n"
-" guestfs_progress_cb cb,\n"
-" void *opaque);\n"
+" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
+" void *opaque,\n"
+" const char *msg);\n"
+" void guestfs_set_error_handler (guestfs_h *g,\n"
+" guestfs_error_handler_cb cb,\n"
+" void *opaque);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1207
+#: ../src/guestfs.pod:1306
msgid ""
-"Some long-running operations can generate progress messages. If this "
-"callback is registered, then it will be called each time a progress message "
-"is generated (usually two seconds after the operation started, and three "
-"times per second thereafter until it completes, although the frequency may "
-"change in future versions)."
+"The callback C<cb> will be called if there is an error. The parameters "
+"passed to the callback are an opaque data pointer and the error message "
+"string."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1213
+#: ../src/guestfs.pod:1310
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 "
-"in some way to the amount of data to be transferred (eg. in bytes or "
-"megabytes), and C<position> may be the portion which has been transferred."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs.pod:1219
-msgid "The only defined and stable parts of the API are:"
+"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:1225
+#: ../src/guestfs.pod:1313
msgid ""
-"The callback can display to the user some type of progress bar or indicator "
-"which shows the ratio of C<position>:C<total>."
+"Note that the message string C<msg> is freed as soon as the callback "
+"function returns, so if you want to stash it somewhere you must make your "
+"own copy."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1230
-msgid "0 E<lt>= C<position> E<lt>= C<total>"
+#: ../src/guestfs.pod:1317
+msgid "The default handler prints messages on C<stderr>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1234
-msgid ""
-"If any progress notification is sent during a call, then a final progress "
-"notification is always sent when C<position> = C<total>."
+#: ../src/guestfs.pod:1319
+msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1237
-msgid ""
-"This is to simplify caller code, so callers can easily set the progress "
-"indicator to \"100%\" at the end of the operation, without requiring special "
-"code to detect this case."
+# type: =head2
+#: ../src/guestfs.pod:1321
+msgid "guestfs_get_error_handler"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1243
+# type: verbatim
+#: ../src/guestfs.pod:1323
+#, no-wrap
msgid ""
-"The callback also receives the procedure number and serial number of the "
-"call. These are only useful for debugging protocol issues, and the callback "
-"can normally ignore them. The callback may want to print these numbers in "
-"error messages or debugging messages."
-msgstr ""
-
-# type: =head1
-#: ../src/guestfs.pod:1248
-msgid "PRIVATE DATA AREA"
+" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
+" void **opaque_rtn);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1250
-msgid ""
-"You can attach named pieces of private data to the libguestfs handle, and "
-"fetch them by name for the lifetime of the handle. This is called the "
-"private data area and is only available from the C API."
+#: ../src/guestfs.pod:1326
+msgid "Returns the current error handler callback."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1254
-msgid "To attach a named piece of data, use the following call:"
+# type: =head2
+#: ../src/guestfs.pod:1328
+msgid "guestfs_set_out_of_memory_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1256
+#: ../src/guestfs.pod:1330
#, no-wrap
msgid ""
-" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
+" typedef void (*guestfs_abort_cb) (void);\n"
+" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
+" guestfs_abort_cb);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1258
+#: ../src/guestfs.pod:1334
msgid ""
-"C<key> is the name to associate with this data, and C<data> is an arbitrary "
-"pointer (which can be C<NULL>). Any previous item with the same name is "
-"overwritten."
+"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:1262
-msgid ""
-"You can use any C<key> you want, but names beginning with an underscore "
-"character are reserved for internal libguestfs purposes (for implementing "
-"language bindings). It is recommended to prefix the name with some unique "
-"string to avoid collisions with other users."
+#: ../src/guestfs.pod:1337
+msgid "The default is to call L<abort(3)>."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1267
-msgid "To retrieve the pointer, use:"
+#: ../src/guestfs.pod:1339
+msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs.pod:1342
+msgid "guestfs_get_out_of_memory_handler"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1269
+#: ../src/guestfs.pod:1344
#, no-wrap
msgid ""
-" void *guestfs_get_private (guestfs_h *g, const char *key);\n"
+" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1271
-msgid ""
-"This function returns C<NULL> if either no data is found associated with "
-"C<key>, or if the user previously set the C<key>'s C<data> pointer to "
-"C<NULL>."
+#: ../src/guestfs.pod:1346
+msgid "This returns the current out of memory handler."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1275
-msgid ""
-"Libguestfs does not try to look at or interpret the C<data> pointer in any "
-"way. As far as libguestfs is concerned, it need not be a valid pointer at "
-"all. In particular, libguestfs does I<not> try to free the data when the "
-"handle is closed. If the data must be freed, then the caller must either "
-"free it before calling L</guestfs_close> or must set up a close callback to "
-"do it (see L</guestfs_set_close_callback>, and note that only one callback "
-"can be registered for a handle)."
+# type: =head1
+#: ../src/guestfs.pod:1348
+msgid "API CALLS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1283
-msgid ""
-"The private data area is implemented using a hash table, and should be "
-"reasonably efficient for moderate numbers of keys."
+#: ../src/guestfs.pod:1350 ../fish/guestfish.pod:907
+msgid "@ACTIONS@"
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1286
-msgid "BLOCK DEVICE NAMING"
+#: ../src/guestfs.pod:1352
+msgid "STRUCTURES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1288
-msgid ""
-"In the kernel there is now quite a profusion of schemata for naming block "
-"devices (in this context, by I<block device> I mean a physical or virtual "
-"hard drive). The original Linux IDE driver used names starting with "
-"C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
-"C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
-"replacement for the old IDE driver (particularly for SATA devices) those "
-"devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
-"machines with paravirtualized drivers. This has created several different "
-"naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
-"Xen PV disks."
+#: ../src/guestfs.pod:1354
+msgid "@STRUCTS@"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1300
-msgid ""
-"As discussed above, libguestfs uses a qemu appliance running an embedded "
-"Linux kernel to access block devices. We can run a variety of appliances "
-"based on a variety of Linux kernels."
+# type: =head1
+#: ../src/guestfs.pod:1356
+msgid "AVAILABILITY"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1304
-msgid ""
-"This causes a problem for libguestfs because many API calls use device or "
-"partition names. Working scripts and the recipe (example) scripts that we "
-"make available over the internet could fail if the naming scheme changes."
+# type: =head2
+#: ../src/guestfs.pod:1358
+msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1309
+#: ../src/guestfs.pod:1360
msgid ""
-"Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
-"Internally C</dev/sd*> names are translated, if necessary, to other names as "
-"required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
-"device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
+"Using L</guestfs_available> you can test availability of the following "
+"groups of functions. This test queries the appliance to see if the "
+"appliance you are currently using supports the functionality."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1315
-msgid ""
-"Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
-"L</guestfs_list_partitions> and similar calls return the true names of the "
-"devices and partitions as known to the appliance."
+#: ../src/guestfs.pod:1365
+msgid "@AVAILABILITY@"
msgstr ""
# type: =head2
-#: ../src/guestfs.pod:1320
-msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
+#: ../src/guestfs.pod:1367
+msgid "GUESTFISH supported COMMAND"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1322
+#: ../src/guestfs.pod:1369
msgid ""
-"Usually this translation is transparent. However in some (very rare) cases "
-"you may need to know the exact algorithm. Such cases include where you use "
-"L</guestfs_config> to add a mixture of virtio and IDE devices to the "
-"qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
-"devices."
+"In L<guestfish(3)> there is a handy interactive command C<supported> which "
+"prints out the available groups and whether they are supported by this build "
+"of libguestfs. Note however that you have to do C<run> first."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs.pod:1374
+msgid "SINGLE CALLS AT COMPILE TIME"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1328
+#: ../src/guestfs.pod:1376
msgid ""
-"The algorithm is applied only to I<parameters> which are known to be either "
-"device or partition names. Return values from functions such as "
-"L</guestfs_list_devices> are never changed."
+"Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
+"function, such as:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1336
-msgid "Is the string a parameter which is a device or partition name?"
+# type: verbatim
+#: ../src/guestfs.pod:1379
+#, no-wrap
+msgid ""
+" #define LIBGUESTFS_HAVE_DD 1\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1340
-msgid "Does the string begin with C</dev/sd>?"
+#: ../src/guestfs.pod:1381
+msgid "if L</guestfs_dd> is available."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1344
+#: ../src/guestfs.pod:1383
msgid ""
-"Does the named device exist? If so, we use that device. However if I<not> "
-"then we continue with this algorithm."
+"Before version 1.5.8, if you needed to test whether a single libguestfs "
+"function is available at compile time, we recommended using build tools such "
+"as autoconf or cmake. For example in autotools you could use:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1349
-msgid "Replace initial C</dev/sd> string with C</dev/hd>."
+# type: verbatim
+#: ../src/guestfs.pod:1388
+#, no-wrap
+msgid ""
+" AC_CHECK_LIB([guestfs],[guestfs_create])\n"
+" AC_CHECK_FUNCS([guestfs_dd])\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1351
-msgid "For example, change C</dev/sda2> to C</dev/hda2>."
+#: ../src/guestfs.pod:1391
+msgid ""
+"which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
+"in your program."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1353
-msgid "If that named device exists, use it. If not, continue."
+# type: =head2
+#: ../src/guestfs.pod:1394
+msgid "SINGLE CALLS AT RUN TIME"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1357
-msgid "Replace initial C</dev/sd> string with C</dev/vd>."
+#: ../src/guestfs.pod:1396
+msgid ""
+"Testing at compile time doesn't guarantee that a function really exists in "
+"the library. The reason is that you might be dynamically linked against a "
+"previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
+"This situation unfortunately results in a segmentation fault, which is a "
+"shortcoming of the C dynamic linking system itself."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1359
-msgid "If that named device exists, use it. If not, return an error."
+#: ../src/guestfs.pod:1403
+msgid ""
+"You can use L<dlopen(3)> to test if a function is available at run time, as "
+"in this example program (note that you still need the compile time check as "
+"well):"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1363
-msgid "PORTABILITY CONCERNS"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs.pod:1365
+# type: verbatim
+#: ../src/guestfs.pod:1407
+#, no-wrap
msgid ""
-"Although the standard naming scheme and automatic translation is useful for "
-"simple programs and guestfish scripts, for larger programs it is best not to "
-"rely on this mechanism."
+" #include <stdio.h>\n"
+" #include <stdlib.h>\n"
+" #include <unistd.h>\n"
+" #include <dlfcn.h>\n"
+" #include <guestfs.h>\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1369
+# type: verbatim
+#: ../src/guestfs.pod:1413
+#, no-wrap
msgid ""
-"Where possible for maximum future portability programs using libguestfs "
-"should use these future-proof techniques:"
+" main ()\n"
+" {\n"
+" #ifdef LIBGUESTFS_HAVE_DD\n"
+" void *dl;\n"
+" int has_function;\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1376
+# type: verbatim
+#: ../src/guestfs.pod:1419
+#, no-wrap
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:1379
-msgid "Since those device names exist by definition, they will never be translated."
+" /* Test if the function guestfs_dd is really available. */\n"
+" dl = dlopen (NULL, RTLD_LAZY);\n"
+" if (!dl) {\n"
+" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
+" exit (EXIT_FAILURE);\n"
+" }\n"
+" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
+" dlclose (dl);\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1384
+# type: verbatim
+#: ../src/guestfs.pod:1428
+#, no-wrap
msgid ""
-"Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
-"filesystem labels."
-msgstr ""
-
-# type: =head1
-#: ../src/guestfs.pod:1389
-msgid "INTERNALS"
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs.pod:1391
-msgid "COMMUNICATION PROTOCOL"
+" if (!has_function)\n"
+" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
+" else {\n"
+" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
+" /* Now it's safe to call\n"
+" guestfs_dd (g, \"foo\", \"bar\");\n"
+" */\n"
+" }\n"
+" #else\n"
+" printf (\"guestfs_dd function was not found at compile time\\n\");\n"
+" #endif\n"
+" }\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1393
+#: ../src/guestfs.pod:1441
msgid ""
-"Don't rely on using this protocol directly. This section documents how it "
-"currently works, but it may change at any time."
+"You may think the above is an awful lot of hassle, and it is. There are "
+"other ways outside of the C linking system to ensure that this kind of "
+"incompatibility never arises, such as using package versioning:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1396
+# type: verbatim
+#: ../src/guestfs.pod:1446
+#, no-wrap
msgid ""
-"The protocol used to talk between the library and the daemon running inside "
-"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
-"1014, RFC 1832, RFC 4506)."
+" Requires: libguestfs >= 1.0.80\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1400
-msgid ""
-"The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
-"this file is automatically generated)."
+# type: =head1
+#: ../src/guestfs.pod:1448
+msgid "CALLS WITH OPTIONAL ARGUMENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1403
+#: ../src/guestfs.pod:1450
msgid ""
-"There are two broad cases, ordinary functions that don't have any C<FileIn> "
-"and C<FileOut> parameters, which are handled with very simple request/reply "
-"messages. Then there are functions that have any C<FileIn> or C<FileOut> "
-"parameters, which use the same request and reply messages, but they may also "
-"be followed by files sent using a chunked encoding."
-msgstr ""
-
-# type: =head3
-#: ../src/guestfs.pod:1410
-msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs.pod:1412
-msgid "For ordinary functions, the request message is:"
+"A recent feature of the API is the introduction of calls which take optional "
+"arguments. In C these are declared 3 ways. The main way is as a call which "
+"takes variable arguments (ie. C<...>), as in this example:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1414
+#: ../src/guestfs.pod:1455
#, no-wrap
msgid ""
-" total length (header + arguments,\n"
-" but not including the length word itself)\n"
-" struct guestfs_message_header (encoded as XDR)\n"
-" struct guestfs_<foo>_args (encoded as XDR)\n"
+" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1419
+#: ../src/guestfs.pod:1457
msgid ""
-"The total length field allows the daemon to allocate a fixed size buffer "
-"into which it slurps the rest of the message. As a result, the total length "
-"is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
-"effective size of any request is limited to somewhere under this size."
+"Call this with a list of optional arguments, terminated by C<-1>. So to "
+"call with no optional arguments specified:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1425
+# type: verbatim
+#: ../src/guestfs.pod:1460
+#, no-wrap
msgid ""
-"Note also that many functions don't take any arguments, in which case the "
-"C<guestfs_I<foo>_args> is completely omitted."
+" guestfs_add_drive_opts (g, filename, -1);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1428
+#: ../src/guestfs.pod:1462
+msgid "With a single optional argument:"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs.pod:1464
+#, no-wrap
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."
+" guestfs_add_drive_opts (g, filename,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
+" -1);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1432
-msgid "The reply message for ordinary functions is:"
+#: ../src/guestfs.pod:1468
+msgid "With two:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1434
+#: ../src/guestfs.pod:1470
#, no-wrap
msgid ""
-" total length (header + ret,\n"
-" but not including the length word itself)\n"
-" struct guestfs_message_header (encoded as XDR)\n"
-" struct guestfs_<foo>_ret (encoded as XDR)\n"
+" guestfs_add_drive_opts (g, filename,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
+" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
+" -1);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1439
+#: ../src/guestfs.pod:1475
msgid ""
-"As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
-"functions that return no formal return values."
+"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
+"happen!"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1442
-msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
+# type: =head2
+#: ../src/guestfs.pod:1478
+msgid "USING va_list FOR OPTIONAL ARGUMENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1445
+#: ../src/guestfs.pod:1480
msgid ""
-"In the case of an error, a flag is set in the header, and the reply message "
-"is slightly changed:"
+"The second variant has the same name with the suffix C<_va>, which works the "
+"same way but takes a C<va_list>. See the C manual for details. For the "
+"example function, this is declared:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1448
+#: ../src/guestfs.pod:1484
#, no-wrap
msgid ""
-" total length (header + error,\n"
-" but not including the length word itself)\n"
-" struct guestfs_message_header (encoded as XDR)\n"
-" struct guestfs_message_error (encoded as XDR)\n"
+" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
+" va_list args);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1453
-msgid ""
-"The C<guestfs_message_error> structure contains the error message as a "
-"string."
-msgstr ""
-
-# type: =head3
-#: ../src/guestfs.pod:1456
-msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
+# type: =head2
+#: ../src/guestfs.pod:1487
+msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1458
+#: ../src/guestfs.pod:1489
msgid ""
-"A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
-"The normal request message is sent (see above). However this is followed by "
-"a sequence of file chunks."
+"The third variant is useful where you need to construct these calls. You "
+"pass in a structure where you fill in the optional fields. The structure "
+"has a bitmask as the first element which you must set to indicate which "
+"fields you have filled in. For our example function the structure and call "
+"are declared:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1462
+#: ../src/guestfs.pod:1495
#, no-wrap
msgid ""
-" total length (header + arguments,\n"
-" but not including the length word itself,\n"
-" and not including the chunks)\n"
-" struct guestfs_message_header (encoded as XDR)\n"
-" struct guestfs_<foo>_args (encoded as XDR)\n"
-" sequence of chunks for FileIn param #0\n"
-" sequence of chunks for FileIn param #1 etc.\n"
+" struct guestfs_add_drive_opts_argv {\n"
+" uint64_t bitmask;\n"
+" int readonly;\n"
+" const char *format;\n"
+" /* ... */\n"
+" };\n"
+" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
+" const struct guestfs_add_drive_opts_argv *optargs);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1470
-msgid "The \"sequence of chunks\" is:"
+#: ../src/guestfs.pod:1504
+msgid "You could call it like this:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1472
+#: ../src/guestfs.pod:1506
#, no-wrap
msgid ""
-" length of chunk (not including length word itself)\n"
-" struct guestfs_chunk (encoded as XDR)\n"
-" length of chunk\n"
-" struct guestfs_chunk (encoded as XDR)\n"
-" ...\n"
-" length of chunk\n"
-" struct guestfs_chunk (with data.data_len == 0)\n"
-"\n"
+" struct guestfs_add_drive_opts_argv optargs = {\n"
+" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
+" .readonly = 1,\n"
+" .format = \"qcow2\"\n"
+" };\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1480
+# type: verbatim
+#: ../src/guestfs.pod:1513
+#, no-wrap
msgid ""
-"The final chunk has the C<data_len> field set to zero. Additionally a flag "
-"is set in the final chunk to indicate either successful completion or early "
-"cancellation."
+" guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1484
-msgid ""
-"At time of writing there are no functions that have more than one FileIn "
-"parameter. However this is (theoretically) supported, by sending the "
-"sequence of chunks for each FileIn parameter one after another (from left to "
-"right)."
+#: ../src/guestfs.pod:1515 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
+msgid "Notes:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1489
-msgid ""
-"Both the library (sender) I<and> the daemon (receiver) may cancel the "
-"transfer. The library does this by sending a chunk with a special flag set "
-"to indicate cancellation. When the daemon sees this, it cancels the whole "
-"RPC, does I<not> send any reply, and goes back to reading the next request."
+#: ../src/guestfs.pod:1521
+msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1495
-msgid ""
-"The daemon may also cancel. It does this by writing a special word "
-"C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
-"the transfer, and if it gets it, it will cancel the transfer (it sends a "
-"cancel chunk). The special word is chosen so that even if cancellation "
-"happens right at the end of the transfer (after the library has finished "
-"writing and has started listening for the reply), the \"spurious\" cancel "
-"flag will not be confused with the reply message."
+#: ../src/guestfs.pod:1526
+msgid "You do not need to fill in all fields of the structure."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1504
+#: ../src/guestfs.pod:1530
msgid ""
-"This protocol allows the transfer of arbitrary sized files (no 32 bit "
-"limit), and also files where the size is not known in advance (eg. from "
-"pipes or sockets). However the chunks are rather small "
-"(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
-"to keep much in memory."
+"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: =head3
-#: ../src/guestfs.pod:1510
-msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
+# type: =head2
+#: ../src/guestfs.pod:1535
+msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1512
+#: ../src/guestfs.pod:1537
msgid ""
-"The protocol for FileOut parameters is exactly the same as for FileIn "
-"parameters, but with the roles of daemon and library reversed."
+"In other languages, optional arguments are expressed in the way that is "
+"natural for that language. We refer you to the language-specific "
+"documentation for more details on that."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1515
-#, no-wrap
-msgid ""
-" total length (header + ret,\n"
-" but not including the length word itself,\n"
-" and not including the chunks)\n"
-" struct guestfs_message_header (encoded as XDR)\n"
-" struct guestfs_<foo>_ret (encoded as XDR)\n"
-" sequence of chunks for FileOut param #0\n"
-" sequence of chunks for FileOut param #1 etc.\n"
-"\n"
+# type: textblock
+#: ../src/guestfs.pod:1541
+msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
msgstr ""
-# type: =head3
-#: ../src/guestfs.pod:1523
-msgid "INITIAL MESSAGE"
+# type: =head2
+#: ../src/guestfs.pod:1543
+msgid "SETTING CALLBACKS TO HANDLE EVENTS"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1525
+#: ../src/guestfs.pod:1545
msgid ""
-"When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
-"which indicates that the guest and daemon is alive. This is what "
-"L</guestfs_launch> waits for."
-msgstr ""
-
-# type: =head3
-#: ../src/guestfs.pod:1529
-msgid "PROGRESS NOTIFICATION MESSAGES"
+"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:1531
+#: ../src/guestfs.pod:1548
msgid ""
-"The daemon may send progress notification messages at any time. These are "
-"distinguished by the normal length word being replaced by "
-"C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
+"Use the C<guestfs_set_*_callback> functions to set a callback for different "
+"types of events."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1535
+#: ../src/guestfs.pod:1551
msgid ""
-"The library turns them into progress callbacks (see "
-"C<guestfs_set_progress_callback>) if there is a callback registered, or "
-"discards them if not."
+"Only I<one callback of each type> can be registered for each handle. "
+"Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
+"that type. Cancel all callbacks of this type by calling this function with "
+"C<cb> set to C<NULL>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1539
-msgid ""
-"The daemon self-limits the frequency of progress messages it sends (see "
-"C<daemon/proto.c:notify_progress>). Not all calls generate progress "
-"messages."
+# type: =head2
+#: ../src/guestfs.pod:1556
+msgid "guestfs_set_log_message_callback"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1543
-msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
+# type: verbatim
+#: ../src/guestfs.pod:1558
+#, no-wrap
+msgid ""
+" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
+" char *buf, int len);\n"
+" void guestfs_set_log_message_callback (guestfs_h *g,\n"
+" guestfs_log_message_cb cb,\n"
+" void *opaque);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1545
+#: ../src/guestfs.pod:1564
msgid ""
-"All high-level libguestfs actions are synchronous. If you want to use "
-"libguestfs asynchronously then you must create a thread."
+"The callback function C<cb> will be called whenever qemu or the guest writes "
+"anything to the console."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1548
-msgid ""
-"Only use the handle from a single thread. Either use the handle exclusively "
-"from one thread, or provide your own mutex so that two threads cannot issue "
-"calls on the same handle at the same time."
+#: ../src/guestfs.pod:1567
+msgid "Use this function to capture kernel messages and similar."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1552
+#: ../src/guestfs.pod:1569
msgid ""
-"See the graphical program guestfs-browser for one possible architecture for "
-"multithreaded programs using libvirt and libguestfs."
+"Normally there is no log message handler, and log messages are just "
+"discarded."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1555
-msgid "QEMU WRAPPERS"
+# type: =head2
+#: ../src/guestfs.pod:1572
+msgid "guestfs_set_subprocess_quit_callback"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1557
+# type: verbatim
+#: ../src/guestfs.pod:1574
+#, no-wrap
msgid ""
-"If you want to compile your own qemu, run qemu from a non-standard location, "
-"or pass extra arguments to qemu, then you can write a shell-script wrapper "
-"around qemu."
+" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
+" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
+" guestfs_subprocess_quit_cb cb,\n"
+" void *opaque);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1561
+#: ../src/guestfs.pod:1579
msgid ""
-"There is one important rule to remember: you I<must C<exec qemu>> as the "
-"last command in the shell script (so that qemu replaces the shell and "
-"becomes the direct child of the libguestfs-using program). If you don't do "
-"this, then the qemu process won't be cleaned up correctly."
+"The callback function C<cb> will be called when the child process quits, "
+"either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
+"corresponds to a transition from any state to the CONFIG state)."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1566
-msgid ""
-"Here is an example of a wrapper, where I have built my own copy of qemu from "
-"source:"
+# type: =head2
+#: ../src/guestfs.pod:1584
+msgid "guestfs_set_launch_done_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1569
+#: ../src/guestfs.pod:1586
#, no-wrap
msgid ""
-" #!/bin/sh -\n"
-" qemudir=/home/rjones/d/qemu\n"
-" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
-"\"$@\"\n"
+" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
+" void guestfs_set_launch_done_callback (guestfs_h *g,\n"
+" guestfs_launch_done_cb cb,\n"
+" void *opaque);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1573
+#: ../src/guestfs.pod:1591
msgid ""
-"Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
-"then use it by setting the LIBGUESTFS_QEMU environment variable. For "
-"example:"
+"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 "
+"transition from LAUNCHING to the READY state)."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs.pod:1595
+msgid "guestfs_set_close_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1577
+#: ../src/guestfs.pod:1597
#, no-wrap
msgid ""
-" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
+" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
+" void guestfs_set_close_callback (guestfs_h *g,\n"
+" guestfs_close_cb cb,\n"
+" void *opaque);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1579
+#: ../src/guestfs.pod:1602
msgid ""
-"Note that libguestfs also calls qemu with the -help and -version options in "
-"order to determine features."
-msgstr ""
-
-# type: =head1
-#: ../src/guestfs.pod:1582
-msgid "LIBGUESTFS VERSION NUMBERS"
+"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:1584
+#: ../src/guestfs.pod:1605
msgid ""
-"Since April 2010, libguestfs has started to make separate development and "
-"stable releases, along with corresponding branches in our git repository. "
-"These separate releases can be identified by version number:"
+"Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
+"handles that are open when the program exits. This means that this callback "
+"might be called indirectly from L<exit(3)>, which can cause unexpected "
+"problems in higher-level languages (eg. if your HLL interpreter has already "
+"been cleaned up by the time this is called, and if your callback then jumps "
+"into some HLL function)."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs.pod:1613
+msgid "guestfs_set_progress_callback"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1589
+#: ../src/guestfs.pod:1615
#, no-wrap
msgid ""
-" even numbers for stable: 1.2.x, 1.4.x, ...\n"
-" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
-" |\n"
-" v\n"
-" 1 . 3 . 5\n"
-" ^ ^\n"
-" | |\n"
-" | `-------- sub-version\n"
-" |\n"
-" `------ always '1' because we don't change the ABI\n"
+" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
+" int proc_nr, int serial,\n"
+" uint64_t position, uint64_t total);\n"
+" void guestfs_set_progress_callback (guestfs_h *g,\n"
+" guestfs_progress_cb cb,\n"
+" void *opaque);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1600
-msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
+#: ../src/guestfs.pod:1622
+msgid ""
+"Some long-running operations can generate progress messages. If this "
+"callback is registered, then it will be called each time a progress message "
+"is generated (usually two seconds after the operation started, and three "
+"times per second thereafter until it completes, although the frequency may "
+"change in future versions)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1602
+#: ../src/guestfs.pod:1628
msgid ""
-"As time passes we cherry pick fixes from the development branch and backport "
-"those into the stable branch, the effect being that the stable branch should "
-"get more stable and less buggy over time. So the stable releases are ideal "
-"for people who don't need new features but would just like the software to "
-"work."
+"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 "
+"in some way to the amount of data to be transferred (eg. in bytes or "
+"megabytes), and C<position> may be the portion which has been transferred."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1608
-msgid "Our criteria for backporting changes are:"
+#: ../src/guestfs.pod:1634
+msgid "The only defined and stable parts of the API are:"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1614
+#: ../src/guestfs.pod:1640
msgid ""
-"Documentation changes which don't affect any code are backported unless the "
-"documentation refers to a future feature which is not in stable."
+"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:1620
-msgid ""
-"Bug fixes which are not controversial, fix obvious problems, and have been "
-"well tested are backported."
+#: ../src/guestfs.pod:1645
+msgid "0 E<lt>= C<position> E<lt>= C<total>"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1625
+#: ../src/guestfs.pod:1649
msgid ""
-"Simple rearrangements of code which shouldn't affect how it works get "
-"backported. This is so that the code in the two branches doesn't get too "
-"far out of step, allowing us to backport future fixes more easily."
+"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:1631
+#: ../src/guestfs.pod:1652
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 "
-"important bug fix."
+"This is to simplify caller code, so callers can easily set the progress "
+"indicator to \"100%\" at the end of the operation, without requiring special "
+"code to detect this case."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1637
+#: ../src/guestfs.pod:1658
msgid ""
-"A new stable branch starts when we think the new features in development are "
-"substantial and compelling enough over the current stable branch to warrant "
-"it. When that happens we create new stable and development versions 1.N.0 "
-"and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
-"stable at this point, but by backporting fixes from development, that branch "
-"will stabilize over time."
+"The callback also receives the procedure number and serial number of the "
+"call. These are only useful for debugging protocol issues, and the callback "
+"can normally ignore them. The callback may want to print these numbers in "
+"error messages or debugging messages."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1645 ../fish/guestfish.pod:933 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:312 ../tools/virt-rescue.pl:226
-msgid "ENVIRONMENT VARIABLES"
+#: ../src/guestfs.pod:1663
+msgid "PRIVATE DATA AREA"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1649 ../fish/guestfish.pod:953
-msgid "LIBGUESTFS_APPEND"
+# type: textblock
+#: ../src/guestfs.pod:1665
+msgid ""
+"You can attach named pieces of private data to the libguestfs handle, and "
+"fetch them by name for the lifetime of the handle. This is called the "
+"private data area and is only available from the C API."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1651 ../fish/guestfish.pod:955
-msgid "Pass additional options to the guest kernel."
+#: ../src/guestfs.pod:1669
+msgid "To attach a named piece of data, use the following call:"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1653 ../fish/guestfish.pod:957
-msgid "LIBGUESTFS_DEBUG"
+# type: verbatim
+#: ../src/guestfs.pod:1671
+#, no-wrap
+msgid ""
+" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1655
+#: ../src/guestfs.pod:1673
msgid ""
-"Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
-"effect as calling C<guestfs_set_verbose (g, 1)>."
+"C<key> is the name to associate with this data, and C<data> is an arbitrary "
+"pointer (which can be C<NULL>). Any previous item with the same name is "
+"overwritten."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1658 ../fish/guestfish.pod:962
-msgid "LIBGUESTFS_MEMSIZE"
+# type: textblock
+#: ../src/guestfs.pod:1677
+msgid ""
+"You can use any C<key> you want, but names beginning with an underscore "
+"character are reserved for internal libguestfs purposes (for implementing "
+"language bindings). It is recommended to prefix the name with some unique "
+"string to avoid collisions with other users."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1660 ../fish/guestfish.pod:964
-msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
+#: ../src/guestfs.pod:1682
+msgid "To retrieve the pointer, use:"
msgstr ""
# type: verbatim
-#: ../src/guestfs.pod:1663 ../fish/guestfish.pod:967
+#: ../src/guestfs.pod:1684
#, no-wrap
msgid ""
-" LIBGUESTFS_MEMSIZE=700\n"
+" void *guestfs_get_private (guestfs_h *g, const char *key);\n"
"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1665 ../fish/guestfish.pod:969
-msgid "LIBGUESTFS_PATH"
-msgstr ""
-
# type: textblock
-#: ../src/guestfs.pod:1667
+#: ../src/guestfs.pod:1686
msgid ""
-"Set the path that libguestfs uses to search for kernel and initrd.img. See "
-"the discussion of paths in section PATH above."
+"This function returns C<NULL> if either no data is found associated with "
+"C<key>, or if the user previously set the C<key>'s C<data> pointer to "
+"C<NULL>."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1670 ../fish/guestfish.pod:974
-msgid "LIBGUESTFS_QEMU"
+# type: textblock
+#: ../src/guestfs.pod:1690
+msgid ""
+"Libguestfs does not try to look at or interpret the C<data> pointer in any "
+"way. As far as libguestfs is concerned, it need not be a valid pointer at "
+"all. In particular, libguestfs does I<not> try to free the data when the "
+"handle is closed. If the data must be freed, then the caller must either "
+"free it before calling L</guestfs_close> or must set up a close callback to "
+"do it (see L</guestfs_set_close_callback>, and note that only one callback "
+"can be registered for a handle)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1672 ../fish/guestfish.pod:976
+#: ../src/guestfs.pod:1698
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."
+"The private data area is implemented using a hash table, and should be "
+"reasonably efficient for moderate numbers of keys."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1676
-msgid "See also L</QEMU WRAPPERS> above."
-msgstr ""
-
-# type: =item
-#: ../src/guestfs.pod:1678 ../fish/guestfish.pod:980
-msgid "LIBGUESTFS_TRACE"
+# type: =end
+#: ../src/guestfs.pod:1701 ../src/guestfs.pod:1706
+msgid "html"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1680
+#: ../src/guestfs.pod:1703
msgid ""
-"Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
-"effect as calling C<guestfs_set_trace (g, 1)>."
+"<!-- old anchor for the next section --> <a "
+"name=\"state_machine_and_low_level_event_api\"/>"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1683 ../fish/guestfish.pod:989
-msgid "TMPDIR"
+# type: =head1
+#: ../src/guestfs.pod:1708
+msgid "ARCHITECTURE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1685 ../fish/guestfish.pod:991
-msgid "Location of temporary directory, defaults to C</tmp>."
+#: ../src/guestfs.pod:1710
+msgid ""
+"Internally, libguestfs is implemented by running an appliance (a special "
+"type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
+"process of the main program."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1687 ../fish/guestfish.pod:993
+# type: verbatim
+#: ../src/guestfs.pod:1714
+#, no-wrap
msgid ""
-"If libguestfs was compiled to use the supermin appliance then each handle "
-"will require rather a large amount of space in this directory for short "
-"periods of time (~ 80 MB). You can use C<$TMPDIR> to configure another "
-"directory to use in case C</tmp> is not large enough."
+" ___________________\n"
+" / \\\n"
+" | main program |\n"
+" | |\n"
+" | | child process / appliance\n"
+" | | __________________________\n"
+" | | / qemu \\\n"
+" +-------------------+ RPC | +-----------------+ |\n"
+" | libguestfs <--------------------> guestfsd | |\n"
+" | | | +-----------------+ |\n"
+" \\___________________/ | | Linux kernel | |\n"
+" | +--^--------------+ |\n"
+" \\_________|________________/\n"
+" |\n"
+" _______v______\n"
+" / \\\n"
+" | Device or |\n"
+" | disk image |\n"
+" \\______________/\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1695 ../fish/guestfish.pod:1051 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:178 ../inspector/virt-inspector.pl:846 ../tools/virt-cat.pl:163 ../tools/virt-df.pl:482 ../tools/virt-edit.pl:325 ../tools/virt-list-filesystems.pl:191 ../tools/virt-list-partitions.pl:229 ../tools/virt-ls.pl:210 ../tools/virt-make-fs.pl:527 ../tools/virt-rescue.pl:231 ../tools/virt-resize.pl:1390 ../tools/virt-tar.pl:257 ../tools/virt-win-reg.pl:461
-msgid "SEE ALSO"
+# type: textblock
+#: ../src/guestfs.pod:1734
+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:1697
+#: ../src/guestfs.pod:1737
msgid ""
-"L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
-"L<virt-edit(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
-"L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
-"L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
-"L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
+"Inside the appliance is a Linux kernel and a complete stack of userspace "
+"tools (such as LVM and ext2 programs) and a small controlling daemon called "
+"L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
+"calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
+"API calls and RPC calls to the daemon. Lastly the disk image(s) are "
+"attached to the qemu process which translates device access by the "
+"appliance's Linux kernel into accesses to the image."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1715
+#: ../src/guestfs.pod:1746
msgid ""
-"Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
-"L<lvm(8)>, L<disktype(1)>."
+"A common misunderstanding is that the appliance \"is\" the virtual machine. "
+"Although the disk image you are attached to might also be used by some "
+"virtual machine, libguestfs doesn't know or care about this. (But you will "
+"care if both libguestfs's qemu process and your virtual machine are trying "
+"to update the disk image at the same time, since these usually results in "
+"massive disk corruption)."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1722 ../tools/virt-make-fs.pl:541 ../tools/virt-win-reg.pl:476
-msgid "BUGS"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs.pod:1724
-msgid "To get a list of bugs against libguestfs use this link:"
+#: ../src/guestfs.pod:1753
+msgid "STATE MACHINE"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1726
-msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
+#: ../src/guestfs.pod:1755
+msgid "libguestfs uses a state machine to model the child process:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1728
-msgid "To report a new bug against libguestfs use this link:"
+# type: verbatim
+#: ../src/guestfs.pod:1757
+#, no-wrap
+msgid ""
+" |\n"
+" guestfs_create\n"
+" |\n"
+" |\n"
+" ____V_____\n"
+" / \\\n"
+" | CONFIG |\n"
+" \\__________/\n"
+" ^ ^ ^ \\\n"
+" / | \\ \\ guestfs_launch\n"
+" / | _\\__V______\n"
+" / | / \\\n"
+" / | | LAUNCHING |\n"
+" / | \\___________/\n"
+" / | /\n"
+" / | guestfs_launch\n"
+" / | /\n"
+" ______ / __|____V\n"
+" / \\ ------> / \\\n"
+" | BUSY | | READY |\n"
+" \\______/ <------ \\________/\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1730
-msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
+#: ../src/guestfs.pod:1779
+msgid ""
+"The normal transitions are (1) CONFIG (when the handle is created, but there "
+"is no child process), (2) LAUNCHING (when the child process is booting up), "
+"(3) alternating between READY and BUSY as commands are issued to, and "
+"carried out by, the child process."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1732
-msgid "When reporting a bug, please check:"
+#: ../src/guestfs.pod:1784
+msgid ""
+"The guest may be killed by L</guestfs_kill_subprocess>, or may die "
+"asynchronously at any time (eg. due to some internal error), and that causes "
+"the state to transition back to CONFIG."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1738
-msgid "That the bug hasn't been reported already."
+#: ../src/guestfs.pod:1788
+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:1742
-msgid "That you are testing a recent version."
+#: ../src/guestfs.pod:1791
+msgid ""
+"The API offers one call that goes from CONFIG through LAUNCHING to READY. "
+"L</guestfs_launch> blocks until the child process is READY to accept "
+"commands (or until some failure or timeout). L</guestfs_launch> internally "
+"moves the state from CONFIG to LAUNCHING while it is running."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1746
-msgid "Describe the bug accurately, and give a way to reproduce it."
+#: ../src/guestfs.pod:1797
+msgid ""
+"API actions such as L</guestfs_mount> can only be issued when in the READY "
+"state. These API calls block waiting for the command to be carried out "
+"(ie. the state to transition to BUSY and then back to READY). There are no "
+"non-blocking versions, and no way to issue more than one command per handle "
+"at the same time."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1750
+#: ../src/guestfs.pod:1803
msgid ""
-"Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
-"bug report."
+"Finally, the child process sends asynchronous messages back to the main "
+"program, such as kernel log messages. You can register a callback to "
+"receive these messages."
msgstr ""
# type: =head1
-#: ../src/guestfs.pod:1755 ../fish/guestfish.pod:1067 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:189 ../inspector/virt-inspector.pl:855
-msgid "AUTHORS"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs.pod:1757 ../fish/guestfish.pod:1069 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:191
-msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
+#: ../src/guestfs.pod:1807
+msgid "INTERNALS"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1759 ../fish/guestfish.pod:1071 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:193 ../inspector/virt-inspector.pl:861 ../tools/virt-cat.pl:177 ../tools/virt-df.pl:495 ../tools/virt-edit.pl:341 ../tools/virt-list-filesystems.pl:207 ../tools/virt-list-partitions.pl:244 ../tools/virt-ls.pl:225 ../tools/virt-make-fs.pl:556 ../tools/virt-rescue.pl:245 ../tools/virt-resize.pl:1411 ../tools/virt-tar.pl:272 ../tools/virt-win-reg.pl:491
-msgid "COPYRIGHT"
+# type: =head2
+#: ../src/guestfs.pod:1809
+msgid "COMMUNICATION PROTOCOL"
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1761 ../fish/guestfish.pod:1073
-msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
+#: ../src/guestfs.pod:1811
+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:1764
+#: ../src/guestfs.pod:1814
msgid ""
-"This library is free software; you can redistribute it and/or modify it "
-"under the terms of the GNU Lesser General Public License as published by the "
-"Free Software Foundation; either version 2 of the License, or (at your "
-"option) any later version."
+"The protocol used to talk between the library and the daemon running inside "
+"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
+"1014, RFC 1832, RFC 4506)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1769
+#: ../src/guestfs.pod:1818
msgid ""
-"This library is distributed in the hope that it will be useful, but WITHOUT "
-"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
-"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
-"for more details."
+"The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
+"this file is automatically generated)."
msgstr ""
# type: textblock
-#: ../src/guestfs.pod:1774
+#: ../src/guestfs.pod:1821
msgid ""
-"You should have received a copy of the GNU Lesser General Public License "
-"along with this library; if not, write to the Free Software Foundation, "
-"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
+"There are two broad cases, ordinary functions that don't have any C<FileIn> "
+"and C<FileOut> parameters, which are handled with very simple request/reply "
+"messages. Then there are functions that have any C<FileIn> or C<FileOut> "
+"parameters, which use the same request and reply messages, but they may also "
+"be followed by files sent using a chunked encoding."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1
-msgid "guestfs_add_cdrom"
+# type: =head3
+#: ../src/guestfs.pod:1828
+msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs.pod:1830
+msgid "For ordinary functions, the request message is:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3
+#: ../src/guestfs.pod:1832
#, no-wrap
msgid ""
-" int guestfs_add_cdrom (guestfs_h *g,\n"
-"\t\tconst char *filename);\n"
+" total length (header + arguments,\n"
+" but not including the length word itself)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_<foo>_args (encoded as XDR)\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:5
-msgid "This function adds a virtual CD-ROM disk image to the guest."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:7
-msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:1488 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1186
-msgid "Notes:"
+#: ../src/guestfs.pod:1837
+msgid ""
+"The total length field allows the daemon to allocate a fixed size buffer "
+"into which it slurps the rest of the message. As a result, the total length "
+"is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
+"effective size of any request is limited to somewhere under this size."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:16
+#: ../src/guestfs.pod:1843
msgid ""
-"This call checks for the existence of C<filename>. This stops you from "
-"specifying other types of drive which are supported by qemu such as C<nbd:> "
-"and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
-"instead."
+"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-actions.pod:23
+#: ../src/guestfs.pod:1846
msgid ""
-"If you just want to add an ISO file (often you use this as an efficient way "
-"to transfer large files into the guest), then you should probably use "
-"C<guestfs_add_drive_ro> instead."
+"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-actions.pod:29 ../src/guestfs-actions.pod:63 ../src/guestfs-actions.pod:92 ../src/guestfs-actions.pod:103 ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:124 ../src/guestfs-actions.pod:135 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:255 ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:302 ../src/guestfs-actions.pod:324 ../src/guestfs-actions.pod:339 ../src/guestfs-actions.pod:403 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:441 ../src/guestfs-actions.pod:453 ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:560 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:717 ../src/guestfs-actions.pod:734 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:824 ../src/guestfs-actions.pod:839 ../src/guestfs-actions.pod:855 ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:883 ../src/guestfs-actions.pod:916 ../src/guestfs-actions.pod:974 ../src/guestfs-actions.pod:996 ../src/guestfs-actions.pod:1027 ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:1146 ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1794 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1972 ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:2409 ../src/guestfs-actions.pod:2421 ../src/guestfs-actions.pod:2438 ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:2514 ../src/guestfs-actions.pod:2524 ../src/guestfs-actions.pod:2535 ../src/guestfs-actions.pod:2547 ../src/guestfs-actions.pod:2577 ../src/guestfs-actions.pod:2641 ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2692 ../src/guestfs-actions.pod:2712 ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2757 ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:2785 ../src/guestfs-actions.pod:2794 ../src/guestfs-actions.pod:2827 ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2850 ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2876 ../src/guestfs-actions.pod:2956 ../src/guestfs-actions.pod:2973 ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:3028 ../src/guestfs-actions.pod:3043 ../src/guestfs-actions.pod:3058 ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3093 ../src/guestfs-actions.pod:3107 ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3136 ../src/guestfs-actions.pod:3167 ../src/guestfs-actions.pod:3195 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:3227 ../src/guestfs-actions.pod:3236 ../src/guestfs-actions.pod:3250 ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3272 ../src/guestfs-actions.pod:3284 ../src/guestfs-actions.pod:3316 ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3345 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:3370 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3441 ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:3477 ../src/guestfs-actions.pod:3491 ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3680 ../src/guestfs-actions.pod:3699 ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3725 ../src/guestfs-actions.pod:3759 ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4042 ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4062 ../src/guestfs-actions.pod:4073 ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:4093 ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4140 ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:4171 ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:4240 ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4316 ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4353 ../src/guestfs-actions.pod:4365 ../src/guestfs-actions.pod:4377 ../src/guestfs-actions.pod:4393 ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:4447 ../src/guestfs-actions.pod:4470 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4675 ../src/guestfs-actions.pod:4685 ../src/guestfs-actions.pod:4695 ../src/guestfs-actions.pod:4714 ../src/guestfs-actions.pod:4724 ../src/guestfs-actions.pod:4734 ../src/guestfs-actions.pod:4744 ../src/guestfs-actions.pod:4756 ../src/guestfs-actions.pod:4806 ../src/guestfs-actions.pod:4820 ../src/guestfs-actions.pod:4833 ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4860 ../src/guestfs-actions.pod:4870 ../src/guestfs-actions.pod:4887 ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4928 ../src/guestfs-actions.pod:4963 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:4988 ../src/guestfs-actions.pod:5016 ../src/guestfs-actions.pod:5120 ../src/guestfs-actions.pod:5135 ../src/guestfs-actions.pod:5146 ../src/guestfs-actions.pod:5192 ../src/guestfs-actions.pod:5202 ../src/guestfs-actions.pod:5239 ../src/guestfs-actions.pod:5266 ../src/guestfs-actions.pod:5308 ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5404 ../src/guestfs-actions.pod:5430
-msgid "This function returns 0 on success or -1 on error."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:31
-msgid "guestfs_add_drive"
+#: ../src/guestfs.pod:1850
+msgid "The reply message for ordinary functions is:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:33
+#: ../src/guestfs.pod:1852
#, no-wrap
msgid ""
-" int guestfs_add_drive (guestfs_h *g,\n"
-"\t\tconst char *filename);\n"
+" total length (header + ret,\n"
+" but not including the length word itself)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_<foo>_ret (encoded as XDR)\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:36 ../fish/guestfish-actions.pod:32
+#: ../src/guestfs.pod:1857
msgid ""
-"This function adds a virtual machine disk image C<filename> to the guest. "
-"The first time you call this function, the disk appears as IDE disk 0 "
-"(C</dev/sda>) in the guest, the second time as C</dev/sdb>, and so on."
+"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-actions.pod:41 ../fish/guestfish-actions.pod:37
-msgid ""
-"You don't necessarily need to be root when using libguestfs. However you "
-"obviously do need sufficient permissions to access the filename for whatever "
-"operations you want to perform (ie. read access if you just want to read the "
-"image or write access if you want to modify the image)."
+#: ../src/guestfs.pod:1860
+msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:47 ../fish/guestfish-actions.pod:43
+#: ../src/guestfs.pod:1863
msgid ""
-"This is equivalent to the qemu parameter C<-drive "
-"file=filename,cache=off,if=...>."
+"In the case of an error, a flag is set in the header, and the reply message "
+"is slightly changed:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:50 ../fish/guestfish-actions.pod:46
+# type: verbatim
+#: ../src/guestfs.pod:1866
+#, no-wrap
msgid ""
-"C<cache=off> is omitted in cases where it is not supported by the underlying "
-"filesystem."
+" total length (header + error,\n"
+" but not including the length word itself)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_message_error (encoded as XDR)\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:53 ../src/guestfs-actions.pod:82
+#: ../src/guestfs.pod:1871
msgid ""
-"C<if=...> is set at compile time by the configuration option C<./configure "
-"--with-drive-if=...>. In the rare case where you might need to change this "
-"at run time, use C<guestfs_add_drive_with_if> or "
-"C<guestfs_add_drive_ro_with_if>."
+"The C<guestfs_message_error> structure contains the error message as a "
+"string."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:87
-msgid ""
-"Note that this call checks for the existence of C<filename>. This stops you "
-"from specifying other types of drive which are supported by qemu such as "
-"C<nbd:> and C<http:> URLs. To specify those, use the general "
-"C<guestfs_config> call instead."
+# type: =head3
+#: ../src/guestfs.pod:1874
+msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:65
-msgid "guestfs_add_drive_ro"
+# type: textblock
+#: ../src/guestfs.pod:1876
+msgid ""
+"A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
+"The normal request message is sent (see above). However this is followed by "
+"a sequence of file chunks."
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:67
+#: ../src/guestfs.pod:1880
#, no-wrap
msgid ""
-" int guestfs_add_drive_ro (guestfs_h *g,\n"
-"\t\tconst char *filename);\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:70 ../fish/guestfish-actions.pod:63
-msgid "This adds a drive in snapshot mode, making it effectively read-only."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:73 ../fish/guestfish-actions.pod:66
-msgid ""
-"Note that writes to the device are allowed, and will be seen for the "
-"duration of the guestfs handle, but they are written to a temporary file "
-"which is discarded as soon as the guestfs handle is closed. We don't "
-"currently have any method to enable changes to be committed, although qemu "
-"can support this."
+" total length (header + arguments,\n"
+" but not including the length word itself,\n"
+" and not including the chunks)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_<foo>_args (encoded as XDR)\n"
+" sequence of chunks for FileIn param #0\n"
+" sequence of chunks for FileIn param #1 etc.\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:72
-msgid ""
-"This is equivalent to the qemu parameter C<-drive "
-"file=filename,snapshot=on,if=...>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:94
-msgid "guestfs_add_drive_ro_with_if"
+#: ../src/guestfs.pod:1888
+msgid "The \"sequence of chunks\" is:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:96
+#: ../src/guestfs.pod:1890
#, no-wrap
msgid ""
-" int guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
-"\t\tconst char *filename,\n"
-"\t\tconst char *iface);\n"
+" length of chunk (not including length word itself)\n"
+" struct guestfs_chunk (encoded as XDR)\n"
+" length of chunk\n"
+" struct guestfs_chunk (encoded as XDR)\n"
+" ...\n"
+" length of chunk\n"
+" struct guestfs_chunk (with data.data_len == 0)\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:100
+#: ../src/guestfs.pod:1898
msgid ""
-"This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
-"QEMU interface emulation to use at run time."
+"The final chunk has the C<data_len> field set to zero. Additionally a flag "
+"is set in the final chunk to indicate either successful completion or early "
+"cancellation."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:105
-msgid "guestfs_add_drive_with_if"
+# type: textblock
+#: ../src/guestfs.pod:1902
+msgid ""
+"At time of writing there are no functions that have more than one FileIn "
+"parameter. However this is (theoretically) supported, by sending the "
+"sequence of chunks for each FileIn parameter one after another (from left to "
+"right)."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:107
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:1907
msgid ""
-" int guestfs_add_drive_with_if (guestfs_h *g,\n"
-"\t\tconst char *filename,\n"
-"\t\tconst char *iface);\n"
-"\n"
+"Both the library (sender) I<and> the daemon (receiver) may cancel the "
+"transfer. The library does this by sending a chunk with a special flag set "
+"to indicate cancellation. When the daemon sees this, it cancels the whole "
+"RPC, does I<not> send any reply, and goes back to reading the next request."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:111
+#: ../src/guestfs.pod:1913
msgid ""
-"This is the same as C<guestfs_add_drive> but it allows you to specify the "
-"QEMU interface emulation to use at run time."
+"The daemon may also cancel. It does this by writing a special word "
+"C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
+"the transfer, and if it gets it, it will cancel the transfer (it sends a "
+"cancel chunk). The special word is chosen so that even if cancellation "
+"happens right at the end of the transfer (after the library has finished "
+"writing and has started listening for the reply), the \"spurious\" cancel "
+"flag will not be confused with the reply message."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:116
-msgid "guestfs_aug_clear"
+# type: textblock
+#: ../src/guestfs.pod:1922
+msgid ""
+"This protocol allows the transfer of arbitrary sized files (no 32 bit "
+"limit), and also files where the size is not known in advance (eg. from "
+"pipes or sockets). However the chunks are rather small "
+"(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
+"to keep much in memory."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:118
-#, no-wrap
-msgid ""
-" int guestfs_aug_clear (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
-"\n"
+# type: =head3
+#: ../src/guestfs.pod:1928
+msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:121 ../fish/guestfish-actions.pod:103
+#: ../src/guestfs.pod:1930
msgid ""
-"Set the value associated with C<path> to C<NULL>. This is the same as the "
-"L<augtool(1)> C<clear> command."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:126
-msgid "guestfs_aug_close"
+"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-actions.pod:128
+#: ../src/guestfs.pod:1933
#, no-wrap
msgid ""
-" int guestfs_aug_close (guestfs_h *g);\n"
+" total length (header + ret,\n"
+" but not including the length word itself,\n"
+" and not including the chunks)\n"
+" struct guestfs_message_header (encoded as XDR)\n"
+" struct guestfs_<foo>_ret (encoded as XDR)\n"
+" sequence of chunks for FileOut param #0\n"
+" sequence of chunks for FileOut param #1 etc.\n"
"\n"
msgstr ""
+# type: =head3
+#: ../src/guestfs.pod:1941
+msgid "INITIAL MESSAGE"
+msgstr ""
+
# type: textblock
-#: ../src/guestfs-actions.pod:130
+#: ../src/guestfs.pod:1943
msgid ""
-"Close the current Augeas handle and free up any resources used by it. After "
-"calling this, you have to call C<guestfs_aug_init> again before you can use "
-"any other Augeas functions."
+"When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
+"which indicates that the guest and daemon is alive. This is what "
+"L</guestfs_launch> waits for."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:137
-msgid "guestfs_aug_defnode"
+# type: =head3
+#: ../src/guestfs.pod:1947
+msgid "PROGRESS NOTIFICATION MESSAGES"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:139
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:1949
msgid ""
-" struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n"
-"\t\tconst char *name,\n"
-"\t\tconst char *expr,\n"
-"\t\tconst char *val);\n"
-"\n"
+"The daemon may send progress notification messages at any time. These are "
+"distinguished by the normal length word being replaced by "
+"C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:144 ../fish/guestfish-actions.pod:119
-msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
+#: ../src/guestfs.pod:1953
+msgid ""
+"The library turns them into progress callbacks (see "
+"C<guestfs_set_progress_callback>) if there is a callback registered, or "
+"discards them if not."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:147
+#: ../src/guestfs.pod:1957
msgid ""
-"If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
-"calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
-"containing that single node."
+"The daemon self-limits the frequency of progress messages it sends (see "
+"C<daemon/proto.c:notify_progress>). Not all calls generate progress "
+"messages."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:126
-msgid ""
-"On success this returns a pair containing the number of nodes in the "
-"nodeset, and a boolean flag if a node was created."
+# type: =head1
+#: ../src/guestfs.pod:1961
+msgid "LIBGUESTFS VERSION NUMBERS"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:155
+#: ../src/guestfs.pod:1963
msgid ""
-"This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
-"an error. I<The caller must call C<guestfs_free_int_bool> after use>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:159
-msgid "guestfs_aug_defvar"
+"Since April 2010, libguestfs has started to make separate development and "
+"stable releases, along with corresponding branches in our git repository. "
+"These separate releases can be identified by version number:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:161
+#: ../src/guestfs.pod:1968
#, no-wrap
msgid ""
-" int guestfs_aug_defvar (guestfs_h *g,\n"
-"\t\tconst char *name,\n"
-"\t\tconst char *expr);\n"
+" even numbers for stable: 1.2.x, 1.4.x, ...\n"
+" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
+" |\n"
+" v\n"
+" 1 . 3 . 5\n"
+" ^ ^\n"
+" | |\n"
+" | `-------- sub-version\n"
+" |\n"
+" `------ always '1' because we don't change the ABI\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:134
-msgid ""
-"Defines an Augeas variable C<name> whose value is the result of evaluating "
-"C<expr>. If C<expr> is NULL, then C<name> is undefined."
+#: ../src/guestfs.pod:1979
+msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:138
+#: ../src/guestfs.pod:1981
msgid ""
-"On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
-"evaluates to something which is not a nodeset."
+"As time passes we cherry pick fixes from the development branch and backport "
+"those into the stable branch, the effect being that the stable branch should "
+"get more stable and less buggy over time. So the stable releases are ideal "
+"for people who don't need new features but would just like the software to "
+"work."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:172 ../src/guestfs-actions.pod:313 ../src/guestfs-actions.pod:467 ../src/guestfs-actions.pod:492 ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:523 ../src/guestfs-actions.pod:1013 ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:1510 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1622 ../src/guestfs-actions.pod:1665 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2119 ../src/guestfs-actions.pod:2137 ../src/guestfs-actions.pod:3430 ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3853 ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:5276 ../src/guestfs-actions.pod:5286 ../src/guestfs-actions.pod:5296
-msgid "On error this function returns -1."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:174
-msgid "guestfs_aug_get"
+#: ../src/guestfs.pod:1987
+msgid "Our criteria for backporting changes are:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:176
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:1993
msgid ""
-" char *guestfs_aug_get (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
-"\n"
+"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-actions.pod:179 ../fish/guestfish-actions.pod:145
+#: ../src/guestfs.pod:1999
msgid ""
-"Look up the value associated with C<path>. If C<path> matches exactly one "
-"node, the C<value> is returned."
+"Bug fixes which are not controversial, fix obvious problems, and have been "
+"well tested are backported."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:182 ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:625 ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:786 ../src/guestfs-actions.pod:899 ../src/guestfs-actions.pod:928 ../src/guestfs-actions.pod:942 ../src/guestfs-actions.pod:958 ../src/guestfs-actions.pod:1041 ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:1459 ../src/guestfs-actions.pod:1473 ../src/guestfs-actions.pod:1549 ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:1701 ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2021 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2913 ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3552 ../src/guestfs-actions.pod:3831 ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4501 ../src/guestfs-actions.pod:4515 ../src/guestfs-actions.pod:4536 ../src/guestfs-actions.pod:5069 ../src/guestfs-actions.pod:5085 ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5248 ../src/guestfs-actions.pod:5478
+#: ../src/guestfs.pod:2004
msgid ""
-"This function returns a string, or NULL on error. I<The caller must free "
-"the returned string after use>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:185
-msgid "guestfs_aug_init"
+"Simple rearrangements of code which shouldn't affect how it works get "
+"backported. This is so that the code in the two branches doesn't get too "
+"far out of step, allowing us to backport future fixes more easily."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:187
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:2010
msgid ""
-" int guestfs_aug_init (guestfs_h *g,\n"
-"\t\tconst char *root,\n"
-"\t\tint flags);\n"
-"\n"
+"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 "
+"important bug fix."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:191 ../fish/guestfish-actions.pod:152
+#: ../src/guestfs.pod:2016
msgid ""
-"Create a new Augeas handle for editing configuration files. If there was "
-"any previous Augeas handle associated with this guestfs session, then it is "
-"closed."
+"A new stable branch starts when we think the new features in development are "
+"substantial and compelling enough over the current stable branch to warrant "
+"it. When that happens we create new stable and development versions 1.N.0 "
+"and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
+"stable at this point, but by backporting fixes from development, that branch "
+"will stabilize over time."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:195
-msgid "You must call this before using any other C<guestfs_aug_*> commands."
+# type: =head1
+#: ../src/guestfs.pod:2024 ../fish/guestfish.pod:914 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
+msgid "ENVIRONMENT VARIABLES"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:198 ../fish/guestfish-actions.pod:159
-msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
+# type: =item
+#: ../src/guestfs.pod:2028 ../fish/guestfish.pod:940
+msgid "LIBGUESTFS_APPEND"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:201 ../fish/guestfish-actions.pod:162
-msgid ""
-"The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
-"logical I<or> of the following integers:"
+#: ../src/guestfs.pod:2030 ../fish/guestfish.pod:942
+msgid "Pass additional options to the guest kernel."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:207 ../fish/guestfish-actions.pod:168
-msgid "C<AUG_SAVE_BACKUP> = 1"
+#: ../src/guestfs.pod:2032 ../fish/guestfish.pod:944
+msgid "LIBGUESTFS_DEBUG"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:209 ../fish/guestfish-actions.pod:170
-msgid "Keep the original file with a C<.augsave> extension."
+#: ../src/guestfs.pod:2034
+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-actions.pod:211 ../fish/guestfish-actions.pod:172
-msgid "C<AUG_SAVE_NEWFILE> = 2"
+#: ../src/guestfs.pod:2037 ../fish/guestfish.pod:949
+msgid "LIBGUESTFS_MEMSIZE"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:213 ../fish/guestfish-actions.pod:174
+#: ../src/guestfs.pod:2039 ../fish/guestfish.pod:951
+msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs.pod:2042 ../fish/guestfish.pod:954
+#, no-wrap
msgid ""
-"Save changes into a file with extension C<.augnew>, and do not overwrite "
-"original. Overrides C<AUG_SAVE_BACKUP>."
+" LIBGUESTFS_MEMSIZE=700\n"
+"\n"
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:216 ../fish/guestfish-actions.pod:177
-msgid "C<AUG_TYPE_CHECK> = 4"
+#: ../src/guestfs.pod:2044 ../fish/guestfish.pod:956
+msgid "LIBGUESTFS_PATH"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:218 ../fish/guestfish-actions.pod:179
-msgid "Typecheck lenses (can be expensive)."
+#: ../src/guestfs.pod:2046
+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-actions.pod:220 ../fish/guestfish-actions.pod:181
-msgid "C<AUG_NO_STDINC> = 8"
+#: ../src/guestfs.pod:2049 ../fish/guestfish.pod:961
+msgid "LIBGUESTFS_QEMU"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:222 ../fish/guestfish-actions.pod:183
-msgid "Do not use standard load path for modules."
+#: ../src/guestfs.pod:2051 ../fish/guestfish.pod:963
+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:2055
+msgid "See also L</QEMU WRAPPERS> above."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:224 ../fish/guestfish-actions.pod:185
-msgid "C<AUG_SAVE_NOOP> = 16"
+#: ../src/guestfs.pod:2057 ../fish/guestfish.pod:967
+msgid "LIBGUESTFS_TRACE"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:226 ../fish/guestfish-actions.pod:187
-msgid "Make save a no-op, just record what would have been changed."
+#: ../src/guestfs.pod:2059
+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-actions.pod:228 ../fish/guestfish-actions.pod:189
-msgid "C<AUG_NO_LOAD> = 32"
+#: ../src/guestfs.pod:2062 ../fish/guestfish.pod:976
+msgid "TMPDIR"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:230
-msgid "Do not load the tree in C<guestfs_aug_init>."
+#: ../src/guestfs.pod:2064 ../fish/guestfish.pod:978
+msgid "Location of temporary directory, defaults to C</tmp>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:234
-msgid "To close the handle, you can call C<guestfs_aug_close>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:236 ../fish/guestfish-actions.pod:197
-msgid "To find out more about Augeas, see L<http://augeas.net/>."
+#: ../src/guestfs.pod:2066 ../fish/guestfish.pod:980
+msgid ""
+"If libguestfs was compiled to use the supermin appliance then the real "
+"appliance is cached in this directory, shared between all handles belonging "
+"to the same EUID. You can use C<$TMPDIR> to configure another directory to "
+"use in case C</tmp> is not large enough."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:240
-msgid "guestfs_aug_insert"
+# type: =head1
+#: ../src/guestfs.pod:2074 ../fish/guestfish.pod:1038 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../inspector/virt-inspector.pl:536 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486 ../tools/virt-list-filesystems.pl:186 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254
+msgid "SEE ALSO"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:242
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:2076
msgid ""
-" int guestfs_aug_insert (guestfs_h *g,\n"
-"\t\tconst char *augpath,\n"
-"\t\tconst char *label,\n"
-"\t\tint before);\n"
-"\n"
+"L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
+"L<virt-edit(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
+"L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
+"L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
+"L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:203
+#: ../src/guestfs.pod:2094
msgid ""
-"Create a new sibling C<label> for C<path>, inserting it into the tree before "
-"or after C<path> (depending on the boolean flag C<before>)."
+"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:2101 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
+msgid "BUGS"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:251 ../fish/guestfish-actions.pod:207
-msgid ""
-"C<path> must match exactly one existing node in the tree, and C<label> must "
-"be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
+#: ../src/guestfs.pod:2103
+msgid "To get a list of bugs against libguestfs use this link:"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:257
-msgid "guestfs_aug_load"
+# type: textblock
+#: ../src/guestfs.pod:2105
+msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:259
-#, no-wrap
-msgid ""
-" int guestfs_aug_load (guestfs_h *g);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs.pod:2107
+msgid "To report a new bug against libguestfs use this link:"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:215
-msgid "Load files into the tree."
+#: ../src/guestfs.pod:2109
+msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:263 ../fish/guestfish-actions.pod:217
-msgid "See C<aug_load> in the Augeas documentation for the full gory details."
+#: ../src/guestfs.pod:2111
+msgid "When reporting a bug, please check:"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:268
-msgid "guestfs_aug_ls"
+# type: textblock
+#: ../src/guestfs.pod:2117
+msgid "That the bug hasn't been reported already."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:270
-#, no-wrap
-msgid ""
-" char **guestfs_aug_ls (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs.pod:2121
+msgid "That you are testing a recent version."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:273
-msgid ""
-"This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
-"sorting the resulting nodes into alphabetical order."
+#: ../src/guestfs.pod:2125
+msgid "Describe the bug accurately, and give a way to reproduce it."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:276 ../src/guestfs-actions.pod:289 ../src/guestfs-actions.pod:417 ../src/guestfs-actions.pod:802 ../src/guestfs-actions.pod:1053 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1157 ../src/guestfs-actions.pod:1173 ../src/guestfs-actions.pod:1404 ../src/guestfs-actions.pod:1738 ../src/guestfs-actions.pod:1751 ../src/guestfs-actions.pod:1767 ../src/guestfs-actions.pod:1804 ../src/guestfs-actions.pod:1825 ../src/guestfs-actions.pod:1887 ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:2093 ../src/guestfs-actions.pod:2259 ../src/guestfs-actions.pod:2462 ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2561 ../src/guestfs-actions.pod:2890 ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:3808 ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4598 ../src/guestfs-actions.pod:4650 ../src/guestfs-actions.pod:4766 ../src/guestfs-actions.pod:4787 ../src/guestfs-actions.pod:5161 ../src/guestfs-actions.pod:5178 ../src/guestfs-actions.pod:5216 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:5441 ../src/guestfs-actions.pod:5457 ../src/guestfs-actions.pod:5497 ../src/guestfs-actions.pod:5513
+#: ../src/guestfs.pod:2129
msgid ""
-"This function returns a NULL-terminated array of strings (like "
-"L<environ(3)>), or NULL if there was an error. I<The caller must free the "
-"strings and the array after use>."
+"Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
+"bug report."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:280
-msgid "guestfs_aug_match"
+# type: =head1
+#: ../src/guestfs.pod:2134 ../fish/guestfish.pod:1055 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 ../inspector/virt-inspector.pl:546
+msgid "AUTHORS"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:282
-#, no-wrap
-msgid ""
-" char **guestfs_aug_match (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs.pod:2136 ../fish/guestfish.pod:1057 ../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:2138 ../fish/guestfish.pod:1059 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../inspector/virt-inspector.pl:560 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269
+msgid "COPYRIGHT"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:285 ../fish/guestfish-actions.pod:231
-msgid ""
-"Returns a list of paths which match the path expression C<path>. The "
-"returned paths are sufficiently qualified so that they match exactly one "
-"node in the current tree."
+#: ../src/guestfs.pod:2140 ../fish/guestfish.pod:1061 ../fuse/guestmount.pod:250
+msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:293
-msgid "guestfs_aug_mv"
+# type: textblock
+#: ../src/guestfs.pod:2143
+msgid ""
+"This library is free software; you can redistribute it and/or modify it "
+"under the terms of the GNU Lesser General Public License as published by the "
+"Free Software Foundation; either version 2 of the License, or (at your "
+"option) any later version."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:295
-#, no-wrap
+# type: textblock
+#: ../src/guestfs.pod:2148
msgid ""
-" int guestfs_aug_mv (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
-"\n"
+"This library is distributed in the hope that it will be useful, but WITHOUT "
+"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
+"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
+"for more details."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:299 ../fish/guestfish-actions.pod:239
+#: ../src/guestfs.pod:2153
msgid ""
-"Move the node C<src> to C<dest>. C<src> must match exactly one node. "
-"C<dest> is overwritten if it exists."
+"You should have received a copy of the GNU Lesser General Public License "
+"along with this library; if not, write to the Free Software Foundation, "
+"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:304
-msgid "guestfs_aug_rm"
+#: ../src/guestfs-actions.pod:1
+msgid "guestfs_add_cdrom"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:306
+#: ../src/guestfs-actions.pod:3
#, no-wrap
msgid ""
-" int guestfs_aug_rm (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
+" int\n"
+" guestfs_add_cdrom (guestfs_h *g,\n"
+" const char *filename);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:309 ../fish/guestfish-actions.pod:246
-msgid "Remove C<path> and all of its children."
+#: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
+msgid "This function adds a virtual CD-ROM disk image to the guest."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:311 ../fish/guestfish-actions.pod:248
-msgid "On success this returns the number of entries which were removed."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:315
-msgid "guestfs_aug_save"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:317
-#, no-wrap
-msgid ""
-" int guestfs_aug_save (guestfs_h *g);\n"
-"\n"
+#: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
+msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:254
-msgid "This writes all pending changes to disk."
+#: ../src/guestfs-actions.pod:17
+msgid ""
+"This call checks for the existence of C<filename>. This stops you from "
+"specifying other types of drive which are supported by qemu such as C<nbd:> "
+"and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
+"instead."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:321
+#: ../src/guestfs-actions.pod:24
msgid ""
-"The flags which were passed to C<guestfs_aug_init> affect exactly how files "
-"are saved."
+"If you just want to add an ISO file (often you use this as an efficient way "
+"to transfer large files into the guest), then you should probably use "
+"C<guestfs_add_drive_ro> instead."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:326
-msgid "guestfs_aug_set"
+# type: textblock
+#: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262 ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3064 ../src/guestfs-actions.pod:3084 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3223 ../src/guestfs-actions.pod:3236 ../src/guestfs-actions.pod:3250 ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3373 ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3433 ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3507 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3561 ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3609 ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:3638 ../src/guestfs-actions.pod:3653 ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:3763 ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3796 ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3865 ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3899 ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:3944 ../src/guestfs-actions.pod:3959 ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4059 ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:4097 ../src/guestfs-actions.pod:4109 ../src/guestfs-actions.pod:4126 ../src/guestfs-actions.pod:4139 ../src/guestfs-actions.pod:4154 ../src/guestfs-actions.pod:4169 ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4219 ../src/guestfs-actions.pod:4239 ../src/guestfs-actions.pod:4253 ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4319 ../src/guestfs-actions.pod:4356 ../src/guestfs-actions.pod:4370 ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:4433 ../src/guestfs-actions.pod:4567 ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4646 ../src/guestfs-actions.pod:4664 ../src/guestfs-actions.pod:4696 ../src/guestfs-actions.pod:4762 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4792 ../src/guestfs-actions.pod:4806 ../src/guestfs-actions.pod:5095 ../src/guestfs-actions.pod:5114 ../src/guestfs-actions.pod:5128 ../src/guestfs-actions.pod:5140 ../src/guestfs-actions.pod:5154 ../src/guestfs-actions.pod:5166 ../src/guestfs-actions.pod:5180 ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5217 ../src/guestfs-actions.pod:5236 ../src/guestfs-actions.pod:5255 ../src/guestfs-actions.pod:5273 ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5314 ../src/guestfs-actions.pod:5333 ../src/guestfs-actions.pod:5354 ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5442 ../src/guestfs-actions.pod:5461 ../src/guestfs-actions.pod:5485 ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5515 ../src/guestfs-actions.pod:5534 ../src/guestfs-actions.pod:5571 ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5620 ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5874 ../src/guestfs-actions.pod:5887 ../src/guestfs-actions.pod:5909 ../src/guestfs-actions.pod:5922 ../src/guestfs-actions.pod:5935 ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:6022 ../src/guestfs-actions.pod:6039 ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6071 ../src/guestfs-actions.pod:6088 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6171 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6243 ../src/guestfs-actions.pod:6272 ../src/guestfs-actions.pod:6303 ../src/guestfs-actions.pod:6422 ../src/guestfs-actions.pod:6440 ../src/guestfs-actions.pod:6454 ../src/guestfs-actions.pod:6509 ../src/guestfs-actions.pod:6522 ../src/guestfs-actions.pod:6567 ../src/guestfs-actions.pod:6600 ../src/guestfs-actions.pod:6654 ../src/guestfs-actions.pod:6680 ../src/guestfs-actions.pod:6746 ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6794
+msgid "This function returns 0 on success or -1 on error."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:328
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
msgid ""
-" int guestfs_aug_set (guestfs_h *g,\n"
-"\t\tconst char *augpath,\n"
-"\t\tconst char *val);\n"
-"\n"
+"This function is deprecated. In new code, use the C<add_drive_opts> call "
+"instead."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:332 ../fish/guestfish-actions.pod:263
-msgid "Set the value associated with C<path> to C<val>."
+#: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942 ../src/guestfs-actions.pod:6688 ../src/guestfs-actions.pod:6857 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156 ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:4427 ../fish/guestfish-actions.pod:4524
+msgid ""
+"Deprecated functions will not be removed from the API, but the fact that "
+"they are deprecated indicates that there are problems with correct use of "
+"these functions."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:334
-msgid ""
-"In the Augeas API, it is possible to clear a node by setting the value to "
-"NULL. Due to an oversight in the libguestfs API you cannot do that with "
-"this call. Instead you must use the C<guestfs_aug_clear> call."
+#: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3066 ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:5392 ../src/guestfs-actions.pod:5502 ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6090 ../src/guestfs-actions.pod:6602
+msgid "(Added in 0.3)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:341
-msgid "guestfs_available"
+#: ../src/guestfs-actions.pod:41
+msgid "guestfs_add_domain"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:343
+#: ../src/guestfs-actions.pod:43
#, no-wrap
msgid ""
-" int guestfs_available (guestfs_h *g,\n"
-"\t\tchar *const *groups);\n"
+" int\n"
+" guestfs_add_domain (guestfs_h *g,\n"
+" const char *dom,\n"
+" ...);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:274
+#: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
msgid ""
-"This command is used to check the availability of some groups of "
-"functionality in the appliance, which not all builds of the libguestfs "
-"appliance will be able to provide."
+"You may supply a list of optional arguments to this call. Use zero or more "
+"of the following pairs of parameters, and terminate the list with C<-1> on "
+"its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:350
+# type: verbatim
+#: ../src/guestfs-actions.pod:53
+#, no-wrap
msgid ""
-"The libguestfs groups, and the functions that those groups correspond to, "
-"are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
-"runtime by calling C<guestfs_available_all_groups>."
+" GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
+" GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
+" GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:355 ../fish/guestfish-actions.pod:283
+#: ../src/guestfs-actions.pod:57
msgid ""
-"The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
-"\"augeas\"]> would check for the availability of the Linux inotify functions "
-"and Augeas (configuration file editing) functions."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:288
-msgid "The command returns no error if I<all> requested groups are available."
+"This function adds the disk(s) attached to the named libvirt domain C<dom>. "
+"It works by connecting to libvirt, requesting the domain and domain XML from "
+"libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
+"one."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:362 ../fish/guestfish-actions.pod:290
+#: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
msgid ""
-"It fails with an error if one or more of the requested groups is unavailable "
-"in the appliance."
+"The number of disks added is returned. This operation is atomic: if an "
+"error is returned, then no disks are added."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:365 ../fish/guestfish-actions.pod:293
+#: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
msgid ""
-"If an unknown group name is included in the list of groups then an error is "
-"always returned."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:296
-msgid "I<Notes:>"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:374
-msgid "You must call C<guestfs_launch> before calling this function."
+"This function does some minimal checks to make sure the libvirt domain is "
+"not running (unless C<readonly> is true). In a future version we will try "
+"to acquire the libvirt lock on each disk."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:304
+#: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
msgid ""
-"The reason is because we don't know what groups are supported by the "
-"appliance/daemon until it is running and can be queried."
+"Disks must be accessible locally. This often means that adding disks from a "
+"remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
+"unless those disks are accessible via the same device path locally too."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:310
+#: ../src/guestfs-actions.pod:74
msgid ""
-"If a group of functions is available, this does not necessarily mean that "
-"they will work. You still have to check for errors when calling individual "
-"API functions even if they are available."
+"The optional C<libvirturi> parameter sets the libvirt URI (see "
+"L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
+"default libvirt URI (or one set through an environment variable, see the "
+"libvirt documentation for full details). If you are using the C API "
+"directly then it is more flexible to create the libvirt connection object "
+"yourself, get the domain object, and call C<guestfs_add_libvirt_dom>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:317
+#: ../src/guestfs-actions.pod:82
msgid ""
-"It is usually the job of distro packagers to build complete functionality "
-"into the libguestfs appliance. Upstream libguestfs, if built from source "
-"with all requirements satisfied, will support everything."
+"The other optional parameters are passed directly through to "
+"C<guestfs_add_drive_opts>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:396
-msgid ""
-"This call was added in version C<1.0.80>. In previous versions of "
-"libguestfs all you could do would be to speculatively execute a command to "
-"find out if the daemon implemented it. See also C<guestfs_version>."
+#: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003 ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:4342 ../src/guestfs-actions.pod:4470 ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:4902 ../src/guestfs-actions.pod:6198 ../src/guestfs-actions.pod:6613 ../src/guestfs-actions.pod:6626 ../src/guestfs-actions.pod:6639
+msgid "On error this function returns -1."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:405
-msgid "guestfs_available_all_groups"
+#: ../src/guestfs-actions.pod:87
+msgid "guestfs_add_domain_va"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:407
+#: ../src/guestfs-actions.pod:89
#, no-wrap
msgid ""
-" char **guestfs_available_all_groups (guestfs_h *g);\n"
+" int\n"
+" guestfs_add_domain_va (guestfs_h *g,\n"
+" const char *dom,\n"
+" va_list args);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:409
-msgid ""
-"This command returns a list of all optional groups that this daemon knows "
-"about. Note this returns both supported and unsupported groups. To find "
-"out which ones the daemon can actually support you have to call "
-"C<guestfs_available> on each member of the returned list."
+#: ../src/guestfs-actions.pod:94
+msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:415
-msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
+#: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
+msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:421
-msgid "guestfs_base64_in"
+#: ../src/guestfs-actions.pod:98
+msgid "guestfs_add_domain_argv"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:423
+#: ../src/guestfs-actions.pod:100
#, no-wrap
msgid ""
-" int guestfs_base64_in (guestfs_h *g,\n"
-"\t\tconst char *base64file,\n"
-"\t\tconst char *filename);\n"
+" int\n"
+" guestfs_add_domain_argv (guestfs_h *g,\n"
+" const char *dom,\n"
+" const struct guestfs_add_domain_argv *optargs);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:427 ../fish/guestfish-actions.pod:347
-msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
+#: ../src/guestfs-actions.pod:105
+msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:432
-msgid "guestfs_base64_out"
+#: ../src/guestfs-actions.pod:109
+msgid "guestfs_add_drive"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:434
+#: ../src/guestfs-actions.pod:111
#, no-wrap
msgid ""
-" int guestfs_base64_out (guestfs_h *g,\n"
-"\t\tconst char *filename,\n"
-"\t\tconst char *base64file);\n"
+" int\n"
+" guestfs_add_drive (guestfs_h *g,\n"
+" const char *filename);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:356
+#: ../src/guestfs-actions.pod:115
msgid ""
-"This command downloads the contents of C<filename>, writing it out to local "
-"file C<base64file> encoded as base64."
+"This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
+"optional parameters, so the disk is added writable, with the format being "
+"detected automatically."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:119
+msgid ""
+"Automatic detection of the format opens you up to a potential security hole "
+"when dealing with untrusted raw-format images. See CVE-2010-3851 and "
+"RHBZ#642934. Specifying the format closes this security hole. Therefore "
+"you should think about replacing calls to this function with calls to "
+"C<guestfs_add_drive_opts>, and specifying the format."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:443
-msgid "guestfs_blockdev_flushbufs"
+#: ../src/guestfs-actions.pod:130
+msgid "guestfs_add_drive_opts"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:445
+#: ../src/guestfs-actions.pod:132
#, no-wrap
msgid ""
-" int guestfs_blockdev_flushbufs (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_add_drive_opts (guestfs_h *g,\n"
+" const char *filename,\n"
+" ...);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:448 ../fish/guestfish-actions.pod:365
-msgid "This tells the kernel to flush internal buffers associated with C<device>."
+# type: verbatim
+#: ../src/guestfs-actions.pod:142
+#, no-wrap
+msgid ""
+" GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
+" GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:451 ../src/guestfs-actions.pod:465 ../src/guestfs-actions.pod:477 ../src/guestfs-actions.pod:490 ../src/guestfs-actions.pod:505 ../src/guestfs-actions.pod:521 ../src/guestfs-actions.pod:532 ../src/guestfs-actions.pod:547 ../src/guestfs-actions.pod:558 ../src/guestfs-actions.pod:569 ../fish/guestfish-actions.pod:368 ../fish/guestfish-actions.pod:379 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:398 ../fish/guestfish-actions.pod:410 ../fish/guestfish-actions.pod:423 ../fish/guestfish-actions.pod:431 ../fish/guestfish-actions.pod:442 ../fish/guestfish-actions.pod:450 ../fish/guestfish-actions.pod:458
-msgid "This uses the L<blockdev(8)> command."
+#: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
+msgid ""
+"This function adds a virtual machine disk image C<filename> to libguestfs. "
+"The first time you call this function, the disk appears as C</dev/sda>, the "
+"second time as C</dev/sdb>, and so on."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:455
-msgid "guestfs_blockdev_getbsz"
+# type: textblock
+#: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
+msgid ""
+"You don't necessarily need to be root when using libguestfs. However you "
+"obviously do need sufficient permissions to access the filename for whatever "
+"operations you want to perform (ie. read access if you just want to read the "
+"image or write access if you want to modify the image)."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:457
-#, no-wrap
-msgid ""
-" int guestfs_blockdev_getbsz (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
+msgid "This call checks that C<filename> exists."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:460 ../fish/guestfish-actions.pod:374
-msgid "This returns the block size of a device."
+#: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
+msgid "The optional arguments are:"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
+msgid "C<readonly>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:462 ../src/guestfs-actions.pod:544 ../fish/guestfish-actions.pod:376 ../fish/guestfish-actions.pod:439
+#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
msgid ""
-"(Note this is different from both I<size in blocks> and I<filesystem block "
-"size>)."
+"If true then the image is treated as read-only. Writes are still allowed, "
+"but they are stored in a temporary snapshot overlay which is discarded at "
+"the end. The disk that you add is not modified."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:469
-msgid "guestfs_blockdev_getro"
+# type: =item
+#: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
+msgid "C<format>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:471
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:171
msgid ""
-" int guestfs_blockdev_getro (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+"This forces the image format. If you omit this (or use C<guestfs_add_drive> "
+"or C<guestfs_add_drive_ro>) then the format is automatically detected. "
+"Possible formats include C<raw> and C<qcow2>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:474 ../fish/guestfish-actions.pod:385
+#: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
msgid ""
-"Returns a boolean indicating if the block device is read-only (true if "
-"read-only, false if not)."
+"Automatic detection of the format opens you up to a potential security hole "
+"when dealing with untrusted raw-format images. See CVE-2010-3851 and "
+"RHBZ#642934. Specifying the format closes this security hole."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:479 ../src/guestfs-actions.pod:1087 ../src/guestfs-actions.pod:1099 ../src/guestfs-actions.pod:1531 ../src/guestfs-actions.pod:1539 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1642 ../src/guestfs-actions.pod:1654 ../src/guestfs-actions.pod:1673 ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:2273 ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:2307 ../src/guestfs-actions.pod:2320 ../src/guestfs-actions.pod:2332 ../src/guestfs-actions.pod:2345 ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:2366 ../src/guestfs-actions.pod:2377 ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:3522
-msgid "This function returns a C truth value on success or -1 on error."
+# type: =item
+#: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
+msgid "C<iface>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:182
+msgid ""
+"This rarely-used option lets you emulate the behaviour of the deprecated "
+"C<guestfs_add_drive_with_if> call (q.v.)"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:189
+msgid "(Added in 1.5.23)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:481
-msgid "guestfs_blockdev_getsize64"
+#: ../src/guestfs-actions.pod:191
+msgid "guestfs_add_drive_opts_va"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:483
+#: ../src/guestfs-actions.pod:193
#, no-wrap
msgid ""
-" int64_t guestfs_blockdev_getsize64 (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_add_drive_opts_va (guestfs_h *g,\n"
+" const char *filename,\n"
+" va_list args);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:486 ../fish/guestfish-actions.pod:394
-msgid "This returns the size of the device in bytes."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:488
-msgid "See also C<guestfs_blockdev_getsz>."
+#: ../src/guestfs-actions.pod:198
+msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:494
-msgid "guestfs_blockdev_getss"
+#: ../src/guestfs-actions.pod:202
+msgid "guestfs_add_drive_opts_argv"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:496
+#: ../src/guestfs-actions.pod:204
#, no-wrap
msgid ""
-" int guestfs_blockdev_getss (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_add_drive_opts_argv (guestfs_h *g,\n"
+" const char *filename,\n"
+" const struct guestfs_add_drive_opts_argv "
+"*optargs);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:404
-msgid ""
-"This returns the size of sectors on a block device. Usually 512, but can be "
-"larger for modern devices."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:502
-msgid ""
-"(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
-"that)."
+#: ../src/guestfs-actions.pod:209
+msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:509
-msgid "guestfs_blockdev_getsz"
+#: ../src/guestfs-actions.pod:213
+msgid "guestfs_add_drive_ro"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:511
+#: ../src/guestfs-actions.pod:215
#, no-wrap
msgid ""
-" int64_t guestfs_blockdev_getsz (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_add_drive_ro (guestfs_h *g,\n"
+" const char *filename);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:514 ../fish/guestfish-actions.pod:416
+#: ../src/guestfs-actions.pod:219
msgid ""
-"This returns the size of the device in units of 512-byte sectors (even if "
-"the sectorsize isn't 512 bytes ... weird)."
+"This function is the equivalent of calling C<guestfs_add_drive_opts> with "
+"the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
+"disk is added read-only, with the format being detected automatically."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:517
-msgid ""
-"See also C<guestfs_blockdev_getss> for the real sector size of the device, "
-"and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
+#: ../src/guestfs-actions.pod:226
+msgid "(Added in 1.0.38)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:525
-msgid "guestfs_blockdev_rereadpt"
+#: ../src/guestfs-actions.pod:228
+msgid "guestfs_add_drive_ro_with_if"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:527
+#: ../src/guestfs-actions.pod:230
#, no-wrap
msgid ""
-" int guestfs_blockdev_rereadpt (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
+" const char *filename,\n"
+" const char *iface);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:530 ../fish/guestfish-actions.pod:429
-msgid "Reread the partition table on C<device>."
+#: ../src/guestfs-actions.pod:235
+msgid ""
+"This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
+"QEMU interface emulation to use at run time."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2303
+msgid "(Added in 1.0.84)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:536
-msgid "guestfs_blockdev_setbsz"
+#: ../src/guestfs-actions.pod:249
+msgid "guestfs_add_drive_with_if"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:538
+#: ../src/guestfs-actions.pod:251
#, no-wrap
msgid ""
-" int guestfs_blockdev_setbsz (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint blocksize);\n"
+" int\n"
+" guestfs_add_drive_with_if (guestfs_h *g,\n"
+" const char *filename,\n"
+" const char *iface);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:542 ../fish/guestfish-actions.pod:437
-msgid "This sets the block size of a device."
+#: ../src/guestfs-actions.pod:256
+msgid ""
+"This is the same as C<guestfs_add_drive> but it allows you to specify the "
+"QEMU interface emulation to use at run time."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:551
-msgid "guestfs_blockdev_setro"
+#: ../src/guestfs-actions.pod:270
+msgid "guestfs_aug_clear"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:553
+#: ../src/guestfs-actions.pod:272
#, no-wrap
msgid ""
-" int guestfs_blockdev_setro (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_aug_clear (guestfs_h *g,\n"
+" const char *augpath);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:556 ../fish/guestfish-actions.pod:448
-msgid "Sets the block device named C<device> to read-only."
+#: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
+msgid ""
+"Set the value associated with C<path> to C<NULL>. This is the same as the "
+"L<augtool(1)> C<clear> command."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
+msgid "(Added in 1.3.4)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:562
-msgid "guestfs_blockdev_setrw"
+#: ../src/guestfs-actions.pod:283
+msgid "guestfs_aug_close"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:564
+#: ../src/guestfs-actions.pod:285
#, no-wrap
msgid ""
-" int guestfs_blockdev_setrw (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_aug_close (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:456
-msgid "Sets the block device named C<device> to read-write."
+#: ../src/guestfs-actions.pod:288
+msgid ""
+"Close the current Augeas handle and free up any resources used by it. After "
+"calling this, you have to call C<guestfs_aug_init> again before you can use "
+"any other Augeas functions."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:4953
+msgid "(Added in 0.7)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:573
-msgid "guestfs_case_sensitive_path"
+#: ../src/guestfs-actions.pod:297
+msgid "guestfs_aug_defnode"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:575
+#: ../src/guestfs-actions.pod:299
#, no-wrap
msgid ""
-" char *guestfs_case_sensitive_path (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" struct guestfs_int_bool *\n"
+" guestfs_aug_defnode (guestfs_h *g,\n"
+" const char *name,\n"
+" const char *expr,\n"
+" const char *val);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:464
-msgid ""
-"This can be used to resolve case insensitive paths on a filesystem which is "
-"case sensitive. The use case is to resolve paths which you have read from "
-"Windows configuration files or the Windows Registry, to the true path."
+#: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
+msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:583 ../fish/guestfish-actions.pod:469
+#: ../src/guestfs-actions.pod:308
msgid ""
-"The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
-"(and probably others), which is that although the underlying filesystem is "
-"case-insensitive, the driver exports the filesystem to Linux as "
-"case-sensitive."
+"If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
+"calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
+"containing that single node."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:588 ../fish/guestfish-actions.pod:474
+#: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
msgid ""
-"One consequence of this is that special directories such as C<c:\\windows> "
-"may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
-"precise details of how they were created. In Windows itself this would not "
-"be a problem."
+"On success this returns a pair containing the number of nodes in the "
+"nodeset, and a boolean flag if a node was created."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:480
+#: ../src/guestfs-actions.pod:316
msgid ""
-"Bug or feature? You decide: "
-"L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
+"This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
+"an error. I<The caller must call C<guestfs_free_int_bool> after use>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:597 ../fish/guestfish-actions.pod:483
-msgid ""
-"This function resolves the true case of each element in the path and returns "
-"the case-sensitive path."
+# type: =head2
+#: ../src/guestfs-actions.pod:322
+msgid "guestfs_aug_defvar"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:600
+# type: verbatim
+#: ../src/guestfs-actions.pod:324
+#, no-wrap
msgid ""
-"Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
-"C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
-"how the directories were originally created under Windows)."
+" int\n"
+" guestfs_aug_defvar (guestfs_h *g,\n"
+" const char *name,\n"
+" const char *expr);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:605 ../fish/guestfish-actions.pod:491
-msgid "I<Note>: This function does not handle drive names, backslashes etc."
+#: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
+msgid ""
+"Defines an Augeas variable C<name> whose value is the result of evaluating "
+"C<expr>. If C<expr> is NULL, then C<name> is undefined."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:608
-msgid "See also C<guestfs_realpath>."
+#: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
+msgid ""
+"On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
+"evaluates to something which is not a nodeset."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:613
-msgid "guestfs_cat"
+#: ../src/guestfs-actions.pod:340
+msgid "guestfs_aug_get"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:615
+#: ../src/guestfs-actions.pod:342
#, no-wrap
msgid ""
-" char *guestfs_cat (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_aug_get (guestfs_h *g,\n"
+" const char *augpath);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:618 ../src/guestfs-actions.pod:3884 ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:2989
-msgid "Return the contents of the file named C<path>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:620
+#: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
msgid ""
-"Note that this function cannot correctly handle binary files (specifically, "
-"files containing C<\\0> character which is treated as end of string). For "
-"those you need to use the C<guestfs_read_file> or C<guestfs_download> "
-"functions which have a more complex interface."
+"Look up the value associated with C<path>. If C<path> matches exactly one "
+"node, the C<value> is returned."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:628 ../src/guestfs-actions.pod:789 ../src/guestfs-actions.pod:806 ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:1073 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1177 ../src/guestfs-actions.pod:1408 ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1808 ../src/guestfs-actions.pod:1829 ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:1869 ../src/guestfs-actions.pod:3747 ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3876 ../src/guestfs-actions.pod:4602 ../src/guestfs-actions.pod:4654 ../src/guestfs-actions.pod:4770 ../src/guestfs-actions.pod:4791 ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5333 ../src/guestfs-actions.pod:5356 ../src/guestfs-actions.pod:5372 ../src/guestfs-actions.pod:5445 ../src/guestfs-actions.pod:5461 ../src/guestfs-actions.pod:5501 ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:507 ../fish/guestfish-actions.pod:642 ../fish/guestfish-actions.pod:654 ../fish/guestfish-actions.pod:836 ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:913 ../fish/guestfish-actions.pod:923 ../fish/guestfish-actions.pod:1118 ../fish/guestfish-actions.pod:1391 ../fish/guestfish-actions.pod:1401 ../fish/guestfish-actions.pod:1429 ../fish/guestfish-actions.pod:1444 ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:1473 ../fish/guestfish-actions.pod:2891 ../fish/guestfish-actions.pod:2967 ../fish/guestfish-actions.pod:2982 ../fish/guestfish-actions.pod:3543 ../fish/guestfish-actions.pod:3589 ../fish/guestfish-actions.pod:3674 ../fish/guestfish-actions.pod:3689 ../fish/guestfish-actions.pod:4072 ../fish/guestfish-actions.pod:4090 ../fish/guestfish-actions.pod:4107 ../fish/guestfish-actions.pod:4117 ../fish/guestfish-actions.pod:4165 ../fish/guestfish-actions.pod:4175 ../fish/guestfish-actions.pod:4204 ../fish/guestfish-actions.pod:4214
+#: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341 ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268 ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2548 ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3195 ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:3715 ../src/guestfs-actions.pod:3825 ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4681 ../src/guestfs-actions.pod:4851 ../src/guestfs-actions.pod:5029 ../src/guestfs-actions.pod:5078 ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:5674 ../src/guestfs-actions.pod:5698 ../src/guestfs-actions.pod:6362 ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6399 ../src/guestfs-actions.pod:6579 ../src/guestfs-actions.pod:6851
msgid ""
-"Because of the message protocol, there is a transfer limit of somewhere "
-"between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
+"This function returns a string, or NULL on error. I<The caller must free "
+"the returned string after use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:631
-msgid "guestfs_checksum"
+#: ../src/guestfs-actions.pod:354
+msgid "guestfs_aug_init"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:633
+#: ../src/guestfs-actions.pod:356
#, no-wrap
msgid ""
-" char *guestfs_checksum (guestfs_h *g,\n"
-"\t\tconst char *csumtype,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_aug_init (guestfs_h *g,\n"
+" const char *root,\n"
+" int flags);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:637 ../fish/guestfish-actions.pod:514
-msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
+#: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
+msgid ""
+"Create a new Augeas handle for editing configuration files. If there was "
+"any previous Augeas handle associated with this guestfs session, then it is "
+"closed."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:640 ../fish/guestfish-actions.pod:517
-msgid ""
-"The type of checksum to compute is given by the C<csumtype> parameter which "
-"must have one of the following values:"
+#: ../src/guestfs-actions.pod:365
+msgid "You must call this before using any other C<guestfs_aug_*> commands."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:645 ../fish/guestfish-actions.pod:522
-msgid "C<crc>"
+# type: textblock
+#: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
+msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:647 ../fish/guestfish-actions.pod:524
+#: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
msgid ""
-"Compute the cyclic redundancy check (CRC) specified by POSIX for the "
-"C<cksum> command."
+"The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
+"logical I<or> of the following integers:"
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:650 ../fish/guestfish-actions.pod:527
-msgid "C<md5>"
+#: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
+msgid "C<AUG_SAVE_BACKUP> = 1"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:529
-msgid "Compute the MD5 hash (using the C<md5sum> program)."
+#: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
+msgid "Keep the original file with a C<.augsave> extension."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:654 ../fish/guestfish-actions.pod:531
-msgid "C<sha1>"
+#: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
+msgid "C<AUG_SAVE_NEWFILE> = 2"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:656 ../fish/guestfish-actions.pod:533
-msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
+#: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
+msgid ""
+"Save changes into a file with extension C<.augnew>, and do not overwrite "
+"original. Overrides C<AUG_SAVE_BACKUP>."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:535
-msgid "C<sha224>"
+#: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
+msgid "C<AUG_TYPE_CHECK> = 4"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:660 ../fish/guestfish-actions.pod:537
-msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
+#: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
+msgid "Typecheck lenses (can be expensive)."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:662 ../fish/guestfish-actions.pod:539
-msgid "C<sha256>"
+#: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
+msgid "C<AUG_NO_STDINC> = 8"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:664 ../fish/guestfish-actions.pod:541
-msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
+#: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
+msgid "Do not use standard load path for modules."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:666 ../fish/guestfish-actions.pod:543
-msgid "C<sha384>"
+#: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
+msgid "C<AUG_SAVE_NOOP> = 16"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:668 ../fish/guestfish-actions.pod:545
-msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
+#: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
+msgid "Make save a no-op, just record what would have been changed."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:547
-msgid "C<sha512>"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:549
-msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
+#: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
+msgid "C<AUG_NO_LOAD> = 32"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:676 ../fish/guestfish-actions.pod:553
-msgid "The checksum is returned as a printable string."
+#: ../src/guestfs-actions.pod:400
+msgid "Do not load the tree in C<guestfs_aug_init>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:678
-msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
+#: ../src/guestfs-actions.pod:404
+msgid "To close the handle, you can call C<guestfs_aug_close>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:680
-msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
+#: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
+msgid "To find out more about Augeas, see L<http://augeas.net/>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:685
-msgid "guestfs_checksum_device"
+#: ../src/guestfs-actions.pod:412
+msgid "guestfs_aug_insert"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:687
+#: ../src/guestfs-actions.pod:414
#, no-wrap
msgid ""
-" char *guestfs_checksum_device (guestfs_h *g,\n"
-"\t\tconst char *csumtype,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_aug_insert (guestfs_h *g,\n"
+" const char *augpath,\n"
+" const char *label,\n"
+" int before);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:691
+#: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
msgid ""
-"This call computes the MD5, SHAx or CRC checksum of the contents of the "
-"device named C<device>. For the types of checksums supported see the "
-"C<guestfs_checksum> command."
+"Create a new sibling C<label> for C<path>, inserting it into the tree before "
+"or after C<path> (depending on the boolean flag C<before>)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
+msgid ""
+"C<path> must match exactly one existing node in the tree, and C<label> must "
+"be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:698
-msgid "guestfs_checksums_out"
+#: ../src/guestfs-actions.pod:432
+msgid "guestfs_aug_load"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:700
+#: ../src/guestfs-actions.pod:434
#, no-wrap
msgid ""
-" int guestfs_checksums_out (guestfs_h *g,\n"
-"\t\tconst char *csumtype,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *sumsfile);\n"
+" int\n"
+" guestfs_aug_load (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:705 ../fish/guestfish-actions.pod:571
-msgid ""
-"This command computes the checksums of all regular files in C<directory> and "
-"then emits a list of those checksums to the local output file C<sumsfile>."
+#: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
+msgid "Load files into the tree."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:709 ../fish/guestfish-actions.pod:575
-msgid ""
-"This can be used for verifying the integrity of a virtual machine. However "
-"to be properly secure you should pay attention to the output of the checksum "
-"command (it uses the ones from GNU coreutils). In particular when the "
-"filename is not printable, coreutils uses a special backslash syntax. For "
-"more information, see the GNU coreutils info file."
+#: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
+msgid "See C<aug_load> in the Augeas documentation for the full gory details."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:719
-msgid "guestfs_chmod"
+#: ../src/guestfs-actions.pod:446
+msgid "guestfs_aug_ls"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:721
+#: ../src/guestfs-actions.pod:448
#, no-wrap
msgid ""
-" int guestfs_chmod (guestfs_h *g,\n"
-"\t\tint mode,\n"
-"\t\tconst char *path);\n"
+" char **\n"
+" guestfs_aug_ls (guestfs_h *g,\n"
+" const char *augpath);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:725 ../fish/guestfish-actions.pod:589
+#: ../src/guestfs-actions.pod:452
msgid ""
-"Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
-"supported."
+"This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
+"sorting the resulting nodes into alphabetical order."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:592
+#: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471 ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183 ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370 ../src/guestfs-actions.pod:2573 ../src/guestfs-actions.pod:2754 ../src/guestfs-actions.pod:2860 ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3282 ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:4303 ../src/guestfs-actions.pod:4823 ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5714 ../src/guestfs-actions.pod:5775 ../src/guestfs-actions.pod:5830 ../src/guestfs-actions.pod:5976 ../src/guestfs-actions.pod:6000 ../src/guestfs-actions.pod:6472 ../src/guestfs-actions.pod:6492 ../src/guestfs-actions.pod:6539 ../src/guestfs-actions.pod:6704 ../src/guestfs-actions.pod:6723 ../src/guestfs-actions.pod:6808 ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6873 ../src/guestfs-actions.pod:6892
msgid ""
-"I<Note>: When using this command from guestfish, C<mode> by default would be "
-"decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
-"C<700>."
+"This function returns a NULL-terminated array of strings (like "
+"L<environ(3)>), or NULL if there was an error. I<The caller must free the "
+"strings and the array after use>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3193 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3225 ../fish/guestfish-actions.pod:596 ../fish/guestfish-actions.pod:2407 ../fish/guestfish-actions.pod:2477 ../fish/guestfish-actions.pod:2487 ../fish/guestfish-actions.pod:2497
-msgid "The mode actually set is affected by the umask."
+#: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2969 ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3578 ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:4307 ../src/guestfs-actions.pod:4764 ../src/guestfs-actions.pod:5142 ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5168 ../src/guestfs-actions.pod:5576 ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:6227 ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6659 ../src/guestfs-actions.pod:6692
+msgid "(Added in 0.8)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:736
-msgid "guestfs_chown"
+#: ../src/guestfs-actions.pod:461
+msgid "guestfs_aug_match"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:738
+#: ../src/guestfs-actions.pod:463
#, no-wrap
msgid ""
-" int guestfs_chown (guestfs_h *g,\n"
-"\t\tint owner,\n"
-"\t\tint group,\n"
-"\t\tconst char *path);\n"
+" char **\n"
+" guestfs_aug_match (guestfs_h *g,\n"
+" const char *augpath);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:743 ../fish/guestfish-actions.pod:602
-msgid "Change the file owner to C<owner> and group to C<group>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:2434 ../fish/guestfish-actions.pod:604 ../fish/guestfish-actions.pod:1935
+#: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
msgid ""
-"Only numeric uid and gid are supported. If you want to use names, you will "
-"need to locate and parse the password file yourself (Augeas support makes "
-"this relatively easy)."
+"Returns a list of paths which match the path expression C<path>. The "
+"returned paths are sufficiently qualified so that they match exactly one "
+"node in the current tree."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:751
-msgid "guestfs_command"
+#: ../src/guestfs-actions.pod:477
+msgid "guestfs_aug_mv"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:753
+#: ../src/guestfs-actions.pod:479
#, no-wrap
msgid ""
-" char *guestfs_command (guestfs_h *g,\n"
-"\t\tchar *const *arguments);\n"
+" int\n"
+" guestfs_aug_mv (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:756 ../fish/guestfish-actions.pod:612
+#: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
msgid ""
-"This call runs a command from the guest filesystem. The filesystem must be "
-"mounted, and must contain a compatible operating system (ie. something "
-"Linux, with the same or compatible processor architecture)."
+"Move the node C<src> to C<dest>. C<src> must match exactly one node. "
+"C<dest> is overwritten if it exists."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:761
+# type: =head2
+#: ../src/guestfs-actions.pod:491
+msgid "guestfs_aug_rm"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:493
+#, no-wrap
msgid ""
-"The single parameter is an argv-style list of arguments. The first element "
-"is the name of the program to run. Subsequent elements are parameters. The "
-"list must be non-empty (ie. must contain a program name). Note that the "
-"command runs directly, and is I<not> invoked via the shell (see "
-"C<guestfs_sh>)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:768 ../fish/guestfish-actions.pod:624
-msgid "The return value is anything printed to I<stdout> by the command."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:627
-msgid ""
-"If the command returns a non-zero exit status, then this function returns an "
-"error message. The error message string is the content of I<stderr> from "
-"the command."
+" int\n"
+" guestfs_aug_rm (guestfs_h *g,\n"
+" const char *augpath);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:775 ../fish/guestfish-actions.pod:631
-msgid ""
-"The C<$PATH> environment variable will contain at least C</usr/bin> and "
-"C</bin>. If you require a program from another location, you should provide "
-"the full path in the first parameter."
+#: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
+msgid "Remove C<path> and all of its children."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:780 ../fish/guestfish-actions.pod:636
-msgid ""
-"Shared libraries and data files required by the program must be available on "
-"filesystems which are mounted in the correct places. It is the caller's "
-"responsibility to ensure all filesystems that are needed are mounted at the "
-"right locations."
+#: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
+msgid "On success this returns the number of entries which were removed."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:792
-msgid "guestfs_command_lines"
+#: ../src/guestfs-actions.pod:505
+msgid "guestfs_aug_save"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:794
+#: ../src/guestfs-actions.pod:507
#, no-wrap
msgid ""
-" char **guestfs_command_lines (guestfs_h *g,\n"
-"\t\tchar *const *arguments);\n"
+" int\n"
+" guestfs_aug_save (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:797
-msgid ""
-"This is the same as C<guestfs_command>, but splits the result into a list of "
-"lines."
+#: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
+msgid "This writes all pending changes to disk."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:800
-msgid "See also: C<guestfs_sh_lines>"
+#: ../src/guestfs-actions.pod:512
+msgid ""
+"The flags which were passed to C<guestfs_aug_init> affect exactly how files "
+"are saved."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:809
-msgid "guestfs_config"
+#: ../src/guestfs-actions.pod:519
+msgid "guestfs_aug_set"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:811
+#: ../src/guestfs-actions.pod:521
#, no-wrap
msgid ""
-" int guestfs_config (guestfs_h *g,\n"
-"\t\tconst char *qemuparam,\n"
-"\t\tconst char *qemuvalue);\n"
+" int\n"
+" guestfs_aug_set (guestfs_h *g,\n"
+" const char *augpath,\n"
+" const char *val);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:815 ../fish/guestfish-actions.pod:661
-msgid ""
-"This can be used to add arbitrary qemu command line parameters of the form "
-"C<-param value>. Actually it's not quite arbitrary - we prevent you from "
-"setting some parameters which would interfere with parameters that we use."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:820 ../fish/guestfish-actions.pod:666
-msgid "The first character of C<param> string must be a C<-> (dash)."
+#: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
+msgid "Set the value associated with C<path> to C<val>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:668
-msgid "C<value> can be NULL."
+#: ../src/guestfs-actions.pod:528
+msgid ""
+"In the Augeas API, it is possible to clear a node by setting the value to "
+"NULL. Due to an oversight in the libguestfs API you cannot do that with "
+"this call. Instead you must use the C<guestfs_aug_clear> call."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:826
-msgid "guestfs_copy_size"
+#: ../src/guestfs-actions.pod:537
+msgid "guestfs_available"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:828
+#: ../src/guestfs-actions.pod:539
#, no-wrap
msgid ""
-" int guestfs_copy_size (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest,\n"
-"\t\tint64_t size);\n"
+" int\n"
+" guestfs_available (guestfs_h *g,\n"
+" char *const *groups);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:674
+#: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
msgid ""
-"This command copies exactly C<size> bytes from one source device or file "
-"C<src> to another destination device or file C<dest>."
+"This command is used to check the availability of some groups of "
+"functionality in the appliance, which not all builds of the libguestfs "
+"appliance will be able to provide."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:677
+#: ../src/guestfs-actions.pod:547
msgid ""
-"Note this will fail if the source is too short or if the destination is not "
-"large enough."
+"The libguestfs groups, and the functions that those groups correspond to, "
+"are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
+"runtime by calling C<guestfs_available_all_groups>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:841 ../src/guestfs-actions.pod:976 ../src/guestfs-actions.pod:1348 ../src/guestfs-actions.pod:1367 ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5406
+#: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
msgid ""
-"This long-running command can generate progress notification messages so "
-"that the caller can display a progress bar or indicator. To receive these "
-"messages, the caller must register a progress callback. See "
-"L<guestfs(3)/guestfs_set_progress_callback>."
+"The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
+"\"augeas\"]> would check for the availability of the Linux inotify functions "
+"and Augeas (configuration file editing) functions."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:846
-msgid "guestfs_cp"
+# type: textblock
+#: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
+msgid "The command returns no error if I<all> requested groups are available."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:848
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
msgid ""
-" int guestfs_cp (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
-"\n"
+"It fails with an error if one or more of the requested groups is unavailable "
+"in the appliance."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:684
+#: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
msgid ""
-"This copies a file from C<src> to C<dest> where C<dest> is either a "
-"destination filename or destination directory."
+"If an unknown group name is included in the list of groups then an error is "
+"always returned."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:857
-msgid "guestfs_cp_a"
+# type: textblock
+#: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
+msgid "I<Notes:>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:859
-#, no-wrap
-msgid ""
-" int guestfs_cp_a (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:571
+msgid "You must call C<guestfs_launch> before calling this function."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:863 ../fish/guestfish-actions.pod:691
+#: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
msgid ""
-"This copies a file or directory from C<src> to C<dest> recursively using the "
-"C<cp -a> command."
+"The reason is because we don't know what groups are supported by the "
+"appliance/daemon until it is running and can be queried."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:868
-msgid "guestfs_dd"
+# type: textblock
+#: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
+msgid ""
+"If a group of functions is available, this does not necessarily mean that "
+"they will work. You still have to check for errors when calling individual "
+"API functions even if they are available."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:870
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
msgid ""
-" int guestfs_dd (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
-"\n"
+"It is usually the job of distro packagers to build complete functionality "
+"into the libguestfs appliance. Upstream libguestfs, if built from source "
+"with all requirements satisfied, will support everything."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:874 ../fish/guestfish-actions.pod:698
+#: ../src/guestfs-actions.pod:593
msgid ""
-"This command copies from one source device or file C<src> to another "
-"destination device or file C<dest>. Normally you would use this to copy to "
-"or from a device or partition, for example to duplicate a filesystem."
+"This call was added in version C<1.0.80>. In previous versions of "
+"libguestfs all you could do would be to speculatively execute a command to "
+"find out if the daemon implemented it. See also C<guestfs_version>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:879
-msgid ""
-"If the destination is a device, it must be as large or larger than the "
-"source file or device, otherwise the copy will fail. This command cannot do "
-"partial copies (see C<guestfs_copy_size>)."
+#: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
+msgid "(Added in 1.0.80)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:885
-msgid "guestfs_debug"
+#: ../src/guestfs-actions.pod:604
+msgid "guestfs_available_all_groups"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:887
+#: ../src/guestfs-actions.pod:606
#, no-wrap
msgid ""
-" char *guestfs_debug (guestfs_h *g,\n"
-"\t\tconst char *subcmd,\n"
-"\t\tchar *const *extraargs);\n"
+" char **\n"
+" guestfs_available_all_groups (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:891
+#: ../src/guestfs-actions.pod:609
msgid ""
-"The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
-"guestfs daemon) that runs inside the qemu subprocess."
+"This command returns a list of all optional groups that this daemon knows "
+"about. Note this returns both supported and unsupported groups. To find "
+"out which ones the daemon can actually support you have to call "
+"C<guestfs_available> on each member of the returned list."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:715
-msgid ""
-"There is no comprehensive help for this command. You have to look at the "
-"file C<daemon/debug.c> in the libguestfs source to find out what you can do."
+#: ../src/guestfs-actions.pod:615
+msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:621
+msgid "(Added in 1.3.15)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:902
-msgid "guestfs_debug_upload"
+#: ../src/guestfs-actions.pod:623
+msgid "guestfs_base64_in"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:904
+#: ../src/guestfs-actions.pod:625
#, no-wrap
msgid ""
-" int guestfs_debug_upload (guestfs_h *g,\n"
-"\t\tconst char *filename,\n"
-"\t\tconst char *tmpname,\n"
-"\t\tint mode);\n"
+" int\n"
+" guestfs_base64_in (guestfs_h *g,\n"
+" const char *base64file,\n"
+" const char *filename);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:909
-msgid ""
-"The C<guestfs_debug_upload> command uploads a file to the libguestfs "
-"appliance."
+#: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
+msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:726
-msgid ""
-"There is no comprehensive help for this command. You have to look at the "
-"file C<daemon/debug.c> in the libguestfs source to find out what it is for."
+#: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
+msgid "(Added in 1.3.5)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:918
-msgid "guestfs_df"
+#: ../src/guestfs-actions.pod:637
+msgid "guestfs_base64_out"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:920
+#: ../src/guestfs-actions.pod:639
#, no-wrap
msgid ""
-" char *guestfs_df (guestfs_h *g);\n"
+" int\n"
+" guestfs_base64_out (guestfs_h *g,\n"
+" const char *filename,\n"
+" const char *base64file);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:736
-msgid "This command runs the C<df> command to report disk space used."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:924 ../src/guestfs-actions.pod:938 ../fish/guestfish-actions.pod:738 ../fish/guestfish-actions.pod:749
+#: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
msgid ""
-"This command is mostly useful for interactive sessions. It is I<not> "
-"intended that you try to parse the output string. Use C<statvfs> from "
-"programs."
+"This command downloads the contents of C<filename>, writing it out to local "
+"file C<base64file> encoded as base64."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:931
-msgid "guestfs_df_h"
+#: ../src/guestfs-actions.pod:651
+msgid "guestfs_blockdev_flushbufs"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:933
+#: ../src/guestfs-actions.pod:653
#, no-wrap
msgid ""
-" char *guestfs_df_h (guestfs_h *g);\n"
+" int\n"
+" guestfs_blockdev_flushbufs (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:746
-msgid ""
-"This command runs the C<df -h> command to report disk space used in "
-"human-readable format."
+#: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
+msgid "This tells the kernel to flush internal buffers associated with C<device>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454 ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498 ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517 ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
+msgid "This uses the L<blockdev(8)> command."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
+msgid "(Added in 0.9.3)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:945
-msgid "guestfs_dmesg"
+#: ../src/guestfs-actions.pod:666
+msgid "guestfs_blockdev_getbsz"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:947
+#: ../src/guestfs-actions.pod:668
#, no-wrap
msgid ""
-" char *guestfs_dmesg (guestfs_h *g);\n"
+" int\n"
+" guestfs_blockdev_getbsz (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:949 ../fish/guestfish-actions.pod:757
-msgid ""
-"This returns the kernel messages (C<dmesg> output) from the guest kernel. "
-"This is sometimes useful for extended debugging of problems."
+#: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
+msgid "This returns the block size of a device."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:953
+#: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
msgid ""
-"Another way to get the same information is to enable verbose messages with "
-"C<guestfs_set_verbose> or by setting the environment variable "
-"C<LIBGUESTFS_DEBUG=1> before running the program."
+"(Note this is different from both I<size in blocks> and I<filesystem block "
+"size>)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:961
-msgid "guestfs_download"
+#: ../src/guestfs-actions.pod:683
+msgid "guestfs_blockdev_getro"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:963
+#: ../src/guestfs-actions.pod:685
#, no-wrap
msgid ""
-" int guestfs_download (guestfs_h *g,\n"
-"\t\tconst char *remotefilename,\n"
-"\t\tconst char *filename);\n"
+" int\n"
+" guestfs_blockdev_getro (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:967 ../fish/guestfish-actions.pod:770
+#: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
msgid ""
-"Download file C<remotefilename> and save it as C<filename> on the local "
-"machine."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:4984 ../fish/guestfish-actions.pod:773 ../fish/guestfish-actions.pod:3843
-msgid "C<filename> can also be a named pipe."
+"Returns a boolean indicating if the block device is read-only (true if "
+"read-only, false if not)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:972
-msgid "See also C<guestfs_upload>, C<guestfs_cat>."
+#: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2877 ../src/guestfs-actions.pod:2891 ../src/guestfs-actions.pod:2906 ../src/guestfs-actions.pod:2920 ../src/guestfs-actions.pod:2936 ../src/guestfs-actions.pod:2951 ../src/guestfs-actions.pod:2967 ../src/guestfs-actions.pod:2981 ../src/guestfs-actions.pod:2994 ../src/guestfs-actions.pod:3008 ../src/guestfs-actions.pod:3023 ../src/guestfs-actions.pod:3038 ../src/guestfs-actions.pod:4452
+msgid "This function returns a C truth value on success or -1 on error."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:981
-msgid "guestfs_drop_caches"
+#: ../src/guestfs-actions.pod:698
+msgid "guestfs_blockdev_getsize64"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:983
+#: ../src/guestfs-actions.pod:700
#, no-wrap
msgid ""
-" int guestfs_drop_caches (guestfs_h *g,\n"
-"\t\tint whattodrop);\n"
+" int64_t\n"
+" guestfs_blockdev_getsize64 (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:986 ../fish/guestfish-actions.pod:783
-msgid ""
-"This instructs the guest kernel to drop its page cache, and/or dentries and "
-"inode caches. The parameter C<whattodrop> tells the kernel what precisely "
-"to drop, see L<http://linux-mm.org/Drop_Caches>"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:991 ../fish/guestfish-actions.pod:788
-msgid "Setting C<whattodrop> to 3 should drop everything."
+#: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
+msgid "This returns the size of the device in bytes."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:790
-msgid ""
-"This automatically calls L<sync(2)> before the operation, so that the "
-"maximum guest memory is freed."
+#: ../src/guestfs-actions.pod:706
+msgid "See also C<guestfs_blockdev_getsz>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:998
-msgid "guestfs_du"
+#: ../src/guestfs-actions.pod:714
+msgid "guestfs_blockdev_getss"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1000
+#: ../src/guestfs-actions.pod:716
#, no-wrap
msgid ""
-" int64_t guestfs_du (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_blockdev_getss (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1003 ../fish/guestfish-actions.pod:797
+#: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
msgid ""
-"This command runs the C<du -s> command to estimate file space usage for "
-"C<path>."
+"This returns the size of sectors on a block device. Usually 512, but can be "
+"larger for modern devices."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1006 ../fish/guestfish-actions.pod:800
+#: ../src/guestfs-actions.pod:723
msgid ""
-"C<path> can be a file or a directory. If C<path> is a directory then the "
-"estimate includes the contents of the directory and all subdirectories "
-"(recursively)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1010 ../fish/guestfish-actions.pod:804
-msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
+"(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
+"that)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1015
-msgid "guestfs_e2fsck_f"
+#: ../src/guestfs-actions.pod:732
+msgid "guestfs_blockdev_getsz"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1017
+#: ../src/guestfs-actions.pod:734
#, no-wrap
msgid ""
-" int guestfs_e2fsck_f (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int64_t\n"
+" guestfs_blockdev_getsz (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1020 ../fish/guestfish-actions.pod:811
+#: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
msgid ""
-"This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
-"on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
-"clean (C<-f>)."
+"This returns the size of the device in units of 512-byte sectors (even if "
+"the sectorsize isn't 512 bytes ... weird)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1024
+#: ../src/guestfs-actions.pod:741
msgid ""
-"This command is only needed because of C<guestfs_resize2fs> (q.v.). "
-"Normally you should use C<guestfs_fsck>."
+"See also C<guestfs_blockdev_getss> for the real sector size of the device, "
+"and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1029
-msgid "guestfs_echo_daemon"
+#: ../src/guestfs-actions.pod:751
+msgid "guestfs_blockdev_rereadpt"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1031
+#: ../src/guestfs-actions.pod:753
#, no-wrap
msgid ""
-" char *guestfs_echo_daemon (guestfs_h *g,\n"
-"\t\tchar *const *words);\n"
+" int\n"
+" guestfs_blockdev_rereadpt (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1034 ../fish/guestfish-actions.pod:822
-msgid ""
-"This command concatenates the list of C<words> passed with single spaces "
-"between them and returns the resulting string."
+#: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
+msgid "Reread the partition table on C<device>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1037 ../fish/guestfish-actions.pod:825
-msgid "You can use this command to test the connection through to the daemon."
+# type: =head2
+#: ../src/guestfs-actions.pod:765
+msgid "guestfs_blockdev_setbsz"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:767
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_blockdev_setbsz (guestfs_h *g,\n"
+" const char *device,\n"
+" int blocksize);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1039
-msgid "See also C<guestfs_ping_daemon>."
+#: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
+msgid "This sets the block size of a device."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1044
-msgid "guestfs_egrep"
+#: ../src/guestfs-actions.pod:783
+msgid "guestfs_blockdev_setro"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1046
+#: ../src/guestfs-actions.pod:785
#, no-wrap
msgid ""
-" char **guestfs_egrep (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_blockdev_setro (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1050 ../fish/guestfish-actions.pod:833
-msgid "This calls the external C<egrep> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
+msgid "Sets the block device named C<device> to read-only."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1060
-msgid "guestfs_egrepi"
+#: ../src/guestfs-actions.pod:797
+msgid "guestfs_blockdev_setrw"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1062
+#: ../src/guestfs-actions.pod:799
#, no-wrap
msgid ""
-" char **guestfs_egrepi (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_blockdev_setrw (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1066 ../fish/guestfish-actions.pod:843
-msgid "This calls the external C<egrep -i> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
+msgid "Sets the block device named C<device> to read-write."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1076
-msgid "guestfs_equal"
+#: ../src/guestfs-actions.pod:811
+msgid "guestfs_case_sensitive_path"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1078
+#: ../src/guestfs-actions.pod:813
#, no-wrap
msgid ""
-" int guestfs_equal (guestfs_h *g,\n"
-"\t\tconst char *file1,\n"
-"\t\tconst char *file2);\n"
+" char *\n"
+" guestfs_case_sensitive_path (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1082 ../fish/guestfish-actions.pod:853
+#: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
msgid ""
-"This compares the two files C<file1> and C<file2> and returns true if their "
-"content is exactly equal, or false otherwise."
+"This can be used to resolve case insensitive paths on a filesystem which is "
+"case sensitive. The use case is to resolve paths which you have read from "
+"Windows configuration files or the Windows Registry, to the true path."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1085 ../fish/guestfish-actions.pod:856
-msgid "The external L<cmp(1)> program is used for the comparison."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1089
-msgid "guestfs_exists"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1091
-#, no-wrap
+#: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
msgid ""
-" int guestfs_exists (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
+"(and probably others), which is that although the underlying filesystem is "
+"case-insensitive, the driver exports the filesystem to Linux as "
+"case-sensitive."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:862
+#: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
msgid ""
-"This returns C<true> if and only if there is a file, directory (or anything) "
-"with the given C<path> name."
+"One consequence of this is that special directories such as C<c:\\windows> "
+"may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
+"precise details of how they were created. In Windows itself this would not "
+"be a problem."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1097
-msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1101
-msgid "guestfs_fallocate"
+#: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
+msgid ""
+"Bug or feature? You decide: "
+"L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1103
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
msgid ""
-" int guestfs_fallocate (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint len);\n"
-"\n"
+"This function resolves the true case of each element in the path and returns "
+"the case-sensitive path."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1107 ../src/guestfs-actions.pod:1130 ../fish/guestfish-actions.pod:871 ../fish/guestfish-actions.pod:890
+#: ../src/guestfs-actions.pod:839
msgid ""
-"This command preallocates a file (containing zero bytes) named C<path> of "
-"size C<len> bytes. If the file exists already, it is overwritten."
+"Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
+"C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
+"how the directories were originally created under Windows)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1111 ../fish/guestfish-actions.pod:875
-msgid ""
-"Do not confuse this with the guestfish-specific C<alloc> command which "
-"allocates a file in the host and attaches it as a device."
+#: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
+msgid "I<Note>: This function does not handle drive names, backslashes etc."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1117 ../fish/guestfish-actions.pod:879
-msgid ""
-"This function is deprecated. In new code, use the C<fallocate64> call "
-"instead."
+#: ../src/guestfs-actions.pod:847
+msgid "See also C<guestfs_realpath>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1120 ../src/guestfs-actions.pod:1555 ../src/guestfs-actions.pod:1573 ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:882 ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1253 ../fish/guestfish-actions.pod:4096 ../fish/guestfish-actions.pod:4193
-msgid ""
-"Deprecated functions will not be removed from the API, but the fact that "
-"they are deprecated indicates that there are problems with correct use of "
-"these functions."
+#: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6384
+msgid "(Added in 1.0.75)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1124
-msgid "guestfs_fallocate64"
+#: ../src/guestfs-actions.pod:854
+msgid "guestfs_cat"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1126
+#: ../src/guestfs-actions.pod:856
#, no-wrap
msgid ""
-" int guestfs_fallocate64 (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint64_t len);\n"
+" char *\n"
+" guestfs_cat (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1134
-msgid ""
-"Note that this call allocates disk blocks for the file. To create a sparse "
-"file use C<guestfs_truncate_size> instead."
+#: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:4939 ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3271
+msgid "Return the contents of the file named C<path>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1137
+#: ../src/guestfs-actions.pod:862
msgid ""
-"The deprecated call C<guestfs_fallocate> does the same, but owing to an "
-"oversight it only allowed 30 bit lengths to be specified, effectively "
-"limiting the maximum size of files created through that call to 1GB."
+"Note that this function cannot correctly handle binary files (specifically, "
+"files containing C<\\0> character which is treated as end of string). For "
+"those you need to use the C<guestfs_read_file> or C<guestfs_download> "
+"functions which have a more complex interface."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1142 ../fish/guestfish-actions.pod:902
-msgid ""
-"Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
-"commands which create a file in the host and attach it as a device."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1148
-msgid "guestfs_fgrep"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1150
-#, no-wrap
+#: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254 ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300 ../src/guestfs-actions.pod:4721 ../src/guestfs-actions.pod:4747 ../src/guestfs-actions.pod:4878 ../src/guestfs-actions.pod:4904 ../src/guestfs-actions.pod:4928 ../src/guestfs-actions.pod:5779 ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:6004 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:6682 ../src/guestfs-actions.pod:6708 ../src/guestfs-actions.pod:6727 ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6831 ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:6896 ../fish/guestfish-actions.pod:582 ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729 ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462 ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3141 ../fish/guestfish-actions.pod:3156 ../fish/guestfish-actions.pod:3232 ../fish/guestfish-actions.pod:3249 ../fish/guestfish-actions.pod:3264 ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3893 ../fish/guestfish-actions.pod:3978 ../fish/guestfish-actions.pod:3993 ../fish/guestfish-actions.pod:4403 ../fish/guestfish-actions.pod:4421 ../fish/guestfish-actions.pod:4438 ../fish/guestfish-actions.pod:4448 ../fish/guestfish-actions.pod:4496 ../fish/guestfish-actions.pod:4506 ../fish/guestfish-actions.pod:4535 ../fish/guestfish-actions.pod:4545
msgid ""
-" char **guestfs_fgrep (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tconst char *path);\n"
-"\n"
+"Because of the message protocol, there is a transfer limit of somewhere "
+"between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:910
-msgid "This calls the external C<fgrep> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3119 ../src/guestfs-actions.pod:3181 ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3286 ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3705 ../src/guestfs-actions.pod:4827 ../src/guestfs-actions.pod:4841 ../src/guestfs-actions.pod:6543 ../src/guestfs-actions.pod:6557
+msgid "(Added in 0.4)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1164
-msgid "guestfs_fgrepi"
+#: ../src/guestfs-actions.pod:875
+msgid "guestfs_checksum"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1166
+#: ../src/guestfs-actions.pod:877
#, no-wrap
msgid ""
-" char **guestfs_fgrepi (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_checksum (guestfs_h *g,\n"
+" const char *csumtype,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:920
-msgid "This calls the external C<fgrep -i> program and returns the matching lines."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1180
-msgid "guestfs_file"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1182
-#, no-wrap
-msgid ""
-" char *guestfs_file (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+#: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
+msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1185 ../fish/guestfish-actions.pod:930
+#: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
msgid ""
-"This call uses the standard L<file(1)> command to determine the type or "
-"contents of the file."
+"The type of checksum to compute is given by the C<csumtype> parameter which "
+"must have one of the following values:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1188 ../fish/guestfish-actions.pod:933
-msgid ""
-"This call will also transparently look inside various types of compressed "
-"file."
+# type: =item
+#: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
+msgid "C<crc>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1191 ../fish/guestfish-actions.pod:936
+#: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
msgid ""
-"The exact command which runs is C<file -zb path>. Note in particular that "
-"the filename is not prepended to the output (the C<-b> option)."
+"Compute the cyclic redundancy check (CRC) specified by POSIX for the "
+"C<cksum> command."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1195
-msgid ""
-"This command can also be used on C</dev/> devices (and partitions, LV "
-"names). You can for example use this to determine if a device contains a "
-"filesystem, although it's usually better to use C<guestfs_vfs_type>."
+# type: =item
+#: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
+msgid "C<md5>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:945
-msgid ""
-"If the C<path> does not begin with C</dev/> then this command only works for "
-"the content of regular files. For other file types (directory, symbolic "
-"link etc) it will just return the string C<directory> etc."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1208
-msgid "guestfs_file_architecture"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1210
-#, no-wrap
-msgid ""
-" char *guestfs_file_architecture (guestfs_h *g,\n"
-"\t\tconst char *filename);\n"
-"\n"
+#: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
+msgid "Compute the MD5 hash (using the C<md5sum> program)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1213 ../fish/guestfish-actions.pod:954
-msgid ""
-"This detects the architecture of the binary C<filename>, and returns it if "
-"known."
+# type: =item
+#: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
+msgid "C<sha1>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1216 ../fish/guestfish-actions.pod:957
-msgid "Currently defined architectures are:"
+#: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
+msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:1220 ../fish/guestfish-actions.pod:961
-msgid "\"i386\""
+#: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
+msgid "C<sha224>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1222 ../fish/guestfish-actions.pod:963
-msgid ""
-"This string is returned for all 32 bit i386, i486, i586, i686 binaries "
-"irrespective of the precise processor requirements of the binary."
+#: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
+msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:1225 ../fish/guestfish-actions.pod:966
-msgid "\"x86_64\""
+#: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
+msgid "C<sha256>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1227 ../fish/guestfish-actions.pod:968
-msgid "64 bit x86-64."
+#: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
+msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:1229 ../fish/guestfish-actions.pod:970
-msgid "\"sparc\""
+#: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
+msgid "C<sha384>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1231 ../fish/guestfish-actions.pod:972
-msgid "32 bit SPARC."
+#: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
+msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
msgstr ""
# type: =item
-#: ../src/guestfs-actions.pod:1233 ../fish/guestfish-actions.pod:974
-msgid "\"sparc64\""
+#: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
+msgid "C<sha512>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1235 ../fish/guestfish-actions.pod:976
-msgid "64 bit SPARC V9 and above."
+#: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
+msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:1237 ../fish/guestfish-actions.pod:978
-msgid "\"ia64\""
+# type: textblock
+#: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
+msgid "The checksum is returned as a printable string."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1239 ../fish/guestfish-actions.pod:980
-msgid "Intel Itanium."
+#: ../src/guestfs-actions.pod:923
+msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:1241 ../fish/guestfish-actions.pod:982
-msgid "\"ppc\""
+# type: textblock
+#: ../src/guestfs-actions.pod:925
+msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1243 ../fish/guestfish-actions.pod:984
-msgid "32 bit Power PC."
+#: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2922 ../src/guestfs-actions.pod:2983 ../src/guestfs-actions.pod:3010 ../src/guestfs-actions.pod:6245
+msgid "(Added in 1.0.2)"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:1245 ../fish/guestfish-actions.pod:986
-msgid "\"ppc64\""
+# type: =head2
+#: ../src/guestfs-actions.pod:932
+msgid "guestfs_checksum_device"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1247 ../fish/guestfish-actions.pod:988
-msgid "64 bit Power PC."
+# type: verbatim
+#: ../src/guestfs-actions.pod:934
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_checksum_device (guestfs_h *g,\n"
+" const char *csumtype,\n"
+" const char *device);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1251 ../fish/guestfish-actions.pod:992
-msgid "Libguestfs may return other architecture strings in future."
+#: ../src/guestfs-actions.pod:939
+msgid ""
+"This call computes the MD5, SHAx or CRC checksum of the contents of the "
+"device named C<device>. For the types of checksums supported see the "
+"C<guestfs_checksum> command."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1253 ../fish/guestfish-actions.pod:994
-msgid "The function works on at least the following types of files:"
+#: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:4417 ../src/guestfs-actions.pod:4454 ../src/guestfs-actions.pod:4472 ../src/guestfs-actions.pod:4648 ../src/guestfs-actions.pod:6159 ../src/guestfs-actions.pod:6173 ../src/guestfs-actions.pod:6569
+msgid "(Added in 1.3.2)"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1259 ../fish/guestfish-actions.pod:1000
-msgid "many types of Un*x and Linux binary"
+# type: =head2
+#: ../src/guestfs-actions.pod:948
+msgid "guestfs_checksums_out"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1263 ../fish/guestfish-actions.pod:1004
-msgid "many types of Un*x and Linux shared library"
+# type: verbatim
+#: ../src/guestfs-actions.pod:950
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_checksums_out (guestfs_h *g,\n"
+" const char *csumtype,\n"
+" const char *directory,\n"
+" const char *sumsfile);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1267 ../fish/guestfish-actions.pod:1008
-msgid "Windows Win32 and Win64 binaries"
+#: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
+msgid ""
+"This command computes the checksums of all regular files in C<directory> and "
+"then emits a list of those checksums to the local output file C<sumsfile>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:1012
-msgid "Windows Win32 and Win64 DLLs"
+#: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
+msgid ""
+"This can be used for verifying the integrity of a virtual machine. However "
+"to be properly secure you should pay attention to the output of the checksum "
+"command (it uses the ones from GNU coreutils). In particular when the "
+"filename is not printable, coreutils uses a special backslash syntax. For "
+"more information, see the GNU coreutils info file."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1273 ../fish/guestfish-actions.pod:1014
-msgid "Win32 binaries and DLLs return C<i386>."
+#: ../src/guestfs-actions.pod:970
+msgid "(Added in 1.3.7)"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1275 ../fish/guestfish-actions.pod:1016
-msgid "Win64 binaries and DLLs return C<x86_64>."
+# type: =head2
+#: ../src/guestfs-actions.pod:972
+msgid "guestfs_chmod"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:1020
-msgid "Linux kernel modules"
+# type: verbatim
+#: ../src/guestfs-actions.pod:974
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_chmod (guestfs_h *g,\n"
+" int mode,\n"
+" const char *path);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1283 ../fish/guestfish-actions.pod:1024
-msgid "Linux new-style initrd images"
+#: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
+msgid ""
+"Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
+"supported."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1287 ../fish/guestfish-actions.pod:1028
-msgid "some non-x86 Linux vmlinuz kernels"
+#: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
+msgid ""
+"I<Note>: When using this command from guestfish, C<mode> by default would be "
+"decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
+"C<700>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:1032
-msgid "What it can't do currently:"
+#: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:4057 ../src/guestfs-actions.pod:4076 ../src/guestfs-actions.pod:4095 ../fish/guestfish-actions.pod:671 ../fish/guestfish-actions.pod:2631 ../fish/guestfish-actions.pod:2716 ../fish/guestfish-actions.pod:2726 ../fish/guestfish-actions.pod:2736
+msgid "The mode actually set is affected by the umask."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:1038
-msgid "static libraries (libfoo.a)"
+# type: =head2
+#: ../src/guestfs-actions.pod:992
+msgid "guestfs_chown"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1301 ../fish/guestfish-actions.pod:1042
-msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
+# type: verbatim
+#: ../src/guestfs-actions.pod:994
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_chown (guestfs_h *g,\n"
+" int owner,\n"
+" int group,\n"
+" const char *path);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:1046
-msgid "x86 Linux vmlinuz kernels"
+#: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
+msgid "Change the file owner to C<owner> and group to C<group>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1307 ../fish/guestfish-actions.pod:1048
+#: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2109
msgid ""
-"x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
-"compressed code, and are horribly hard to unpack. If you want to find the "
-"architecture of a kernel, use the architecture of the associated initrd or "
-"kernel module(s) instead."
+"Only numeric uid and gid are supported. If you want to use names, you will "
+"need to locate and parse the password file yourself (Augeas support makes "
+"this relatively easy)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1317
-msgid "guestfs_filesize"
+#: ../src/guestfs-actions.pod:1010
+msgid "guestfs_command"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1319
+#: ../src/guestfs-actions.pod:1012
#, no-wrap
msgid ""
-" int64_t guestfs_filesize (guestfs_h *g,\n"
-"\t\tconst char *file);\n"
+" char *\n"
+" guestfs_command (guestfs_h *g,\n"
+" char *const *arguments);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1322 ../fish/guestfish-actions.pod:1059
-msgid "This command returns the size of C<file> in bytes."
+#: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
+msgid ""
+"This call runs a command from the guest filesystem. The filesystem must be "
+"mounted, and must contain a compatible operating system (ie. something "
+"Linux, with the same or compatible processor architecture)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1324
+#: ../src/guestfs-actions.pod:1021
msgid ""
-"To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
-"C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
-"devices, use C<guestfs_blockdev_getsize64>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1330
-msgid "guestfs_fill"
+"The single parameter is an argv-style list of arguments. The first element "
+"is the name of the program to run. Subsequent elements are parameters. The "
+"list must be non-empty (ie. must contain a program name). Note that the "
+"command runs directly, and is I<not> invoked via the shell (see "
+"C<guestfs_sh>)."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1332
-#, no-wrap
-msgid ""
-" int guestfs_fill (guestfs_h *g,\n"
-"\t\tint c,\n"
-"\t\tint len,\n"
-"\t\tconst char *path);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
+msgid "The return value is anything printed to I<stdout> by the command."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:1069
+#: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
msgid ""
-"This command creates a new file called C<path>. The initial content of the "
-"file is C<len> octets of C<c>, where C<c> must be a number in the range "
-"C<[0..255]>."
+"If the command returns a non-zero exit status, then this function returns an "
+"error message. The error message string is the content of I<stderr> from "
+"the command."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1341
+#: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
msgid ""
-"To fill a file with zero bytes (sparsely), it is much more efficient to use "
-"C<guestfs_truncate_size>. To create a file with a pattern of repeating "
-"bytes use C<guestfs_fill_pattern>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1353
-msgid "guestfs_fill_pattern"
+"The C<$PATH> environment variable will contain at least C</usr/bin> and "
+"C</bin>. If you require a program from another location, you should provide "
+"the full path in the first parameter."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1355
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
msgid ""
-" int guestfs_fill_pattern (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tint len,\n"
-"\t\tconst char *path);\n"
-"\n"
+"Shared libraries and data files required by the program must be available on "
+"filesystems which are mounted in the correct places. It is the caller's "
+"responsibility to ensure all filesystems that are needed are mounted at the "
+"right locations."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1360
-msgid ""
-"This function is like C<guestfs_fill> except that it creates a new file of "
-"length C<len> containing the repeating pattern of bytes in C<pattern>. The "
-"pattern is truncated if necessary to ensure the length of the file is "
-"exactly C<len> bytes."
+#: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072 ../src/guestfs-actions.pod:1535
+msgid "(Added in 0.9.1)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1372
-msgid "guestfs_find"
+#: ../src/guestfs-actions.pod:1054
+msgid "guestfs_command_lines"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1374
+#: ../src/guestfs-actions.pod:1056
#, no-wrap
msgid ""
-" char **guestfs_find (guestfs_h *g,\n"
-"\t\tconst char *directory);\n"
+" char **\n"
+" guestfs_command_lines (guestfs_h *g,\n"
+" char *const *arguments);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:1091
+#: ../src/guestfs-actions.pod:1060
msgid ""
-"This command lists out all files and directories, recursively, starting at "
-"C<directory>. It is essentially equivalent to running the shell command "
-"C<find directory -print> but some post-processing happens on the output, "
-"described below."
+"This is the same as C<guestfs_command>, but splits the result into a list of "
+"lines."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1382 ../fish/guestfish-actions.pod:1096
-msgid ""
-"This returns a list of strings I<without any prefix>. Thus if the directory "
-"structure was:"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:1099
-#, no-wrap
-msgid ""
-" /tmp/a\n"
-" /tmp/b\n"
-" /tmp/c/d\n"
-"\n"
+#: ../src/guestfs-actions.pod:1063
+msgid "See also: C<guestfs_sh_lines>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1389
-msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
+# type: =head2
+#: ../src/guestfs-actions.pod:1074
+msgid "guestfs_config"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1392 ../fish/guestfish-actions.pod:1106
+#: ../src/guestfs-actions.pod:1076
#, no-wrap
msgid ""
-" a\n"
-" b\n"
-" c\n"
-" c/d\n"
+" int\n"
+" guestfs_config (guestfs_h *g,\n"
+" const char *qemuparam,\n"
+" const char *qemuvalue);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1397 ../fish/guestfish-actions.pod:1111
-msgid "If C<directory> is not a directory, then this command returns an error."
+#: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
+msgid ""
+"This can be used to add arbitrary qemu command line parameters of the form "
+"C<-param value>. Actually it's not quite arbitrary - we prevent you from "
+"setting some parameters which would interfere with parameters that we use."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1400 ../fish/guestfish-actions.pod:1114
-msgid "The returned list is sorted."
+#: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
+msgid "The first character of C<param> string must be a C<-> (dash)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1402
-msgid "See also C<guestfs_find0>."
+#: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
+msgid "C<value> can be NULL."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1411
-msgid "guestfs_find0"
+#: ../src/guestfs-actions.pod:1094
+msgid "guestfs_copy_size"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1413
+#: ../src/guestfs-actions.pod:1096
#, no-wrap
msgid ""
-" int guestfs_find0 (guestfs_h *g,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *files);\n"
+" int\n"
+" guestfs_copy_size (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" int64_t size);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1417 ../fish/guestfish-actions.pod:1125
+#: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
msgid ""
-"This command lists out all files and directories, recursively, starting at "
-"C<directory>, placing the resulting list in the external file called "
-"C<files>."
+"This command copies exactly C<size> bytes from one source device or file "
+"C<src> to another destination device or file C<dest>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1421
+#: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
msgid ""
-"This command works the same way as C<guestfs_find> with the following "
-"exceptions:"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:1136
-msgid "The resulting list is written to an external file."
+"Note this will fail if the source is too short or if the destination is not "
+"large enough."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:1140
+#: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6767
msgid ""
-"Items (filenames) in the result are separated by C<\\0> characters. See "
-"L<find(1)> option I<-print0>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1437 ../fish/guestfish-actions.pod:1145
-msgid "This command is not limited in the number of names that it can return."
+"This long-running command can generate progress notification messages so "
+"that the caller can display a progress bar or indicator. To receive these "
+"messages, the caller must register a progress callback. See "
+"L<guestfs(3)/guestfs_set_progress_callback>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1442 ../fish/guestfish-actions.pod:1150
-msgid "The result list is not sorted."
+#: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3718 ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:6476 ../src/guestfs-actions.pod:6496 ../src/guestfs-actions.pod:6582
+msgid "(Added in 1.0.87)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1448
-msgid "guestfs_findfs_label"
+#: ../src/guestfs-actions.pod:1117
+msgid "guestfs_cp"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1450
+#: ../src/guestfs-actions.pod:1119
#, no-wrap
msgid ""
-" char *guestfs_findfs_label (guestfs_h *g,\n"
-"\t\tconst char *label);\n"
+" int\n"
+" guestfs_cp (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1453 ../fish/guestfish-actions.pod:1160
+#: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
msgid ""
-"This command searches the filesystems and returns the one which has the "
-"given label. An error is returned if no such filesystem can be found."
+"This copies a file from C<src> to C<dest> where C<dest> is either a "
+"destination filename or destination directory."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1457
-msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
+#: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4321 ../src/guestfs-actions.pod:4698
+msgid "(Added in 1.0.18)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1462
-msgid "guestfs_findfs_uuid"
+#: ../src/guestfs-actions.pod:1131
+msgid "guestfs_cp_a"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1464
+#: ../src/guestfs-actions.pod:1133
#, no-wrap
msgid ""
-" char *guestfs_findfs_uuid (guestfs_h *g,\n"
-"\t\tconst char *uuid);\n"
+" int\n"
+" guestfs_cp_a (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1467 ../fish/guestfish-actions.pod:1170
+#: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
msgid ""
-"This command searches the filesystems and returns the one which has the "
-"given UUID. An error is returned if no such filesystem can be found."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1471
-msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
+"This copies a file or directory from C<src> to C<dest> recursively using the "
+"C<cp -a> command."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1476
-msgid "guestfs_fsck"
+#: ../src/guestfs-actions.pod:1145
+msgid "guestfs_dd"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1478
+#: ../src/guestfs-actions.pod:1147
#, no-wrap
msgid ""
-" int guestfs_fsck (guestfs_h *g,\n"
-"\t\tconst char *fstype,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_dd (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1482 ../fish/guestfish-actions.pod:1180
-msgid ""
-"This runs the filesystem checker (fsck) on C<device> which should have "
-"filesystem type C<fstype>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1485 ../fish/guestfish-actions.pod:1183
+#: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
msgid ""
-"The returned integer is the status. See L<fsck(8)> for the list of status "
-"codes from C<fsck>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:1192
-msgid "Multiple status codes can be summed together."
+"This command copies from one source device or file C<src> to another "
+"destination device or file C<dest>. Normally you would use this to copy to "
+"or from a device or partition, for example to duplicate a filesystem."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1498 ../fish/guestfish-actions.pod:1196
+#: ../src/guestfs-actions.pod:1157
msgid ""
-"A non-zero return code can mean \"success\", for example if errors have been "
-"corrected on the filesystem."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1503 ../fish/guestfish-actions.pod:1201
-msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1508 ../fish/guestfish-actions.pod:1206
-msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
+"If the destination is a device, it must be as large or larger than the "
+"source file or device, otherwise the copy will fail. This command cannot do "
+"partial copies (see C<guestfs_copy_size>)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1512
-msgid "guestfs_get_append"
+#: ../src/guestfs-actions.pod:1165
+msgid "guestfs_df"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1514
+#: ../src/guestfs-actions.pod:1167
#, no-wrap
msgid ""
-" const char *guestfs_get_append (guestfs_h *g);\n"
+" char *\n"
+" guestfs_df (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1516 ../fish/guestfish-actions.pod:1212
-msgid ""
-"Return the additional kernel options which are added to the guest kernel "
-"command line."
+#: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
+msgid "This command runs the C<df> command to report disk space used."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1519 ../fish/guestfish-actions.pod:1215
-msgid "If C<NULL> then no options are added."
+#: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189 ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
+msgid ""
+"This command is mostly useful for interactive sessions. It is I<not> "
+"intended that you try to parse the output string. Use C<statvfs> from "
+"programs."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1521
-msgid ""
-"This function returns a string which may be NULL. There is no way to return "
-"an error from this function. The string is owned by the guest handle and "
-"must I<not> be freed."
+#: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325 ../src/guestfs-actions.pod:3828 ../src/guestfs-actions.pod:4221 ../src/guestfs-actions.pod:5983 ../src/guestfs-actions.pod:6007 ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6628 ../src/guestfs-actions.pod:6641
+msgid "(Added in 1.0.54)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1525
-msgid "guestfs_get_autosync"
+#: ../src/guestfs-actions.pod:1181
+msgid "guestfs_df_h"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1527
+#: ../src/guestfs-actions.pod:1183
#, no-wrap
msgid ""
-" int guestfs_get_autosync (guestfs_h *g);\n"
+" char *\n"
+" guestfs_df_h (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1529 ../fish/guestfish-actions.pod:1221
-msgid "Get the autosync flag."
+#: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
+msgid ""
+"This command runs the C<df -h> command to report disk space used in "
+"human-readable format."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1533
-msgid "guestfs_get_direct"
+#: ../src/guestfs-actions.pod:1198
+msgid "guestfs_dmesg"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1535
+#: ../src/guestfs-actions.pod:1200
#, no-wrap
msgid ""
-" int guestfs_get_direct (guestfs_h *g);\n"
+" char *\n"
+" guestfs_dmesg (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1227
-msgid "Return the direct appliance mode flag."
+#: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
+msgid ""
+"This returns the kernel messages (C<dmesg> output) from the guest kernel. "
+"This is sometimes useful for extended debugging of problems."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1207
+msgid ""
+"Another way to get the same information is to enable verbose messages with "
+"C<guestfs_set_verbose> or by setting the environment variable "
+"C<LIBGUESTFS_DEBUG=1> before running the program."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1541
-msgid "guestfs_get_e2label"
+#: ../src/guestfs-actions.pod:1217
+msgid "guestfs_download"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1543
+#: ../src/guestfs-actions.pod:1219
#, no-wrap
msgid ""
-" char *guestfs_get_e2label (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_download (guestfs_h *g,\n"
+" const char *remotefilename,\n"
+" const char *filename);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1233
-msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
+#: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
+msgid ""
+"Download file C<remotefilename> and save it as C<filename> on the local "
+"machine."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1236
-msgid ""
-"This function is deprecated. In new code, use the C<vfs_label> call "
-"instead."
+#: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6239 ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4151
+msgid "C<filename> can also be a named pipe."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1229
+msgid "See also C<guestfs_upload>, C<guestfs_cat>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1559
-msgid "guestfs_get_e2uuid"
+#: ../src/guestfs-actions.pod:1240
+msgid "guestfs_download_offset"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1561
+#: ../src/guestfs-actions.pod:1242
#, no-wrap
msgid ""
-" char *guestfs_get_e2uuid (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_download_offset (guestfs_h *g,\n"
+" const char *remotefilename,\n"
+" const char *filename,\n"
+" int64_t offset,\n"
+" int64_t size);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1564 ../fish/guestfish-actions.pod:1247
-msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
+#: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
+msgid ""
+"C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
+"region must be within the file or device)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1250
-msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
+#: ../src/guestfs-actions.pod:1255
+msgid ""
+"Note that there is no limit on the amount of data that can be downloaded "
+"with this call, unlike with C<guestfs_pread>, and this call always reads the "
+"full amount unless an error occurs."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1260
+msgid "See also C<guestfs_download>, C<guestfs_pread>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6274
+msgid "(Added in 1.5.17)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1577
-msgid "guestfs_get_memsize"
+#: ../src/guestfs-actions.pod:1271
+msgid "guestfs_drop_caches"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1579
+#: ../src/guestfs-actions.pod:1273
#, no-wrap
msgid ""
-" int guestfs_get_memsize (guestfs_h *g);\n"
+" int\n"
+" guestfs_drop_caches (guestfs_h *g,\n"
+" int whattodrop);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1261
-msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
+#: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
+msgid ""
+"This instructs the guest kernel to drop its page cache, and/or dentries and "
+"inode caches. The parameter C<whattodrop> tells the kernel what precisely "
+"to drop, see L<http://linux-mm.org/Drop_Caches>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1584
-msgid ""
-"If C<guestfs_set_memsize> was not called on this handle, and if "
-"C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
-"value for memsize."
+#: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
+msgid "Setting C<whattodrop> to 3 should drop everything."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1588 ../src/guestfs-actions.pod:1651 ../src/guestfs-actions.pod:4237 ../src/guestfs-actions.pod:4329 ../fish/guestfish-actions.pod:1268 ../fish/guestfish-actions.pod:1317 ../fish/guestfish-actions.pod:3268 ../fish/guestfish-actions.pod:3345
-msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
+#: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
+msgid ""
+"This automatically calls L<sync(2)> before the operation, so that the "
+"maximum guest memory is freed."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1593
-msgid "guestfs_get_network"
+#: ../src/guestfs-actions.pod:1291
+msgid "guestfs_du"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1595
+#: ../src/guestfs-actions.pod:1293
#, no-wrap
msgid ""
-" int guestfs_get_network (guestfs_h *g);\n"
+" int64_t\n"
+" guestfs_du (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1275
-msgid "This returns the enable network flag."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1601
-msgid "guestfs_get_path"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1603
-#, no-wrap
-msgid ""
-" const char *guestfs_get_path (guestfs_h *g);\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1281
-msgid "Return the current search path."
+#: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
+msgid ""
+"This command runs the C<du -s> command to estimate file space usage for "
+"C<path>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1283
+#: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
msgid ""
-"This is always non-NULL. If it wasn't set already, then this will return "
-"the default path."
+"C<path> can be a file or a directory. If C<path> is a directory then the "
+"estimate includes the contents of the directory and all subdirectories "
+"(recursively)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1610 ../src/guestfs-actions.pod:1633
-msgid ""
-"This function returns a string, or NULL on error. The string is owned by "
-"the guest handle and must I<not> be freed."
+#: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
+msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1613
-msgid "guestfs_get_pid"
+#: ../src/guestfs-actions.pod:1311
+msgid "guestfs_e2fsck_f"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1615
+#: ../src/guestfs-actions.pod:1313
#, no-wrap
msgid ""
-" int guestfs_get_pid (guestfs_h *g);\n"
+" int\n"
+" guestfs_e2fsck_f (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1290
+#: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
msgid ""
-"Return the process ID of the qemu subprocess. If there is no qemu "
-"subprocess, then this will return an error."
+"This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
+"on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
+"clean (C<-f>)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1293
-msgid "This is an internal call used for debugging and testing."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1624
-msgid "guestfs_get_qemu"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1626
-#, no-wrap
+#: ../src/guestfs-actions.pod:1321
msgid ""
-" const char *guestfs_get_qemu (guestfs_h *g);\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1299
-msgid "Return the current qemu binary."
+"This command is only needed because of C<guestfs_resize2fs> (q.v.). "
+"Normally you should use C<guestfs_fsck>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1301
-msgid ""
-"This is always non-NULL. If it wasn't set already, then this will return "
-"the default qemu binary name."
+#: ../src/guestfs-actions.pod:1326
+msgid "(Added in 1.0.29)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1636
-msgid "guestfs_get_recovery_proc"
+#: ../src/guestfs-actions.pod:1328
+msgid "guestfs_echo_daemon"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1638
+#: ../src/guestfs-actions.pod:1330
#, no-wrap
msgid ""
-" int guestfs_get_recovery_proc (guestfs_h *g);\n"
+" char *\n"
+" guestfs_echo_daemon (guestfs_h *g,\n"
+" char *const *words);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1308
-msgid "Return the recovery process enabled flag."
+#: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
+msgid ""
+"This command concatenates the list of C<words> passed with single spaces "
+"between them and returns the resulting string."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1644
-msgid "guestfs_get_selinux"
+# type: textblock
+#: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
+msgid "You can use this command to test the connection through to the daemon."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1646
-#, no-wrap
-msgid ""
-" int guestfs_get_selinux (guestfs_h *g);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:1339
+msgid "See also C<guestfs_ping_daemon>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1648
-msgid ""
-"This returns the current setting of the selinux flag which is passed to the "
-"appliance at boot time. See C<guestfs_set_selinux>."
+#: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:5487
+msgid "(Added in 1.0.69)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1656
-msgid "guestfs_get_state"
+#: ../src/guestfs-actions.pod:1346
+msgid "guestfs_egrep"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1658
+#: ../src/guestfs-actions.pod:1348
#, no-wrap
msgid ""
-" int guestfs_get_state (guestfs_h *g);\n"
+" char **\n"
+" guestfs_egrep (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1660 ../fish/guestfish-actions.pod:1324
-msgid ""
-"This returns the current state as an opaque integer. This is only useful "
-"for printing debug and internal error messages."
+#: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
+msgid "This calls the external C<egrep> program and returns the matching lines."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:2282 ../src/guestfs-actions.pod:2305 ../src/guestfs-actions.pod:2354 ../src/guestfs-actions.pod:2375 ../fish/guestfish-actions.pod:1327 ../fish/guestfish-actions.pod:1819 ../fish/guestfish-actions.pod:1837 ../fish/guestfish-actions.pod:1875 ../fish/guestfish-actions.pod:1891
-msgid "For more information on states, see L<guestfs(3)>."
+#: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171 ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442 ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:3225 ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3252 ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:5032 ../src/guestfs-actions.pod:5081 ../src/guestfs-actions.pod:5851 ../src/guestfs-actions.pod:5863 ../src/guestfs-actions.pod:5876 ../src/guestfs-actions.pod:5889 ../src/guestfs-actions.pod:5911 ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:5937 ../src/guestfs-actions.pod:5950 ../src/guestfs-actions.pod:6711 ../src/guestfs-actions.pod:6730 ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6880 ../src/guestfs-actions.pod:6899
+msgid "(Added in 1.0.66)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1667
-msgid "guestfs_get_trace"
+#: ../src/guestfs-actions.pod:1365
+msgid "guestfs_egrepi"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1669
+#: ../src/guestfs-actions.pod:1367
#, no-wrap
msgid ""
-" int guestfs_get_trace (guestfs_h *g);\n"
+" char **\n"
+" guestfs_egrepi (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1333
-msgid "Return the command trace flag."
+#: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
+msgid "This calls the external C<egrep -i> program and returns the matching lines."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1675
-msgid "guestfs_get_umask"
+#: ../src/guestfs-actions.pod:1384
+msgid "guestfs_equal"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1677
+#: ../src/guestfs-actions.pod:1386
#, no-wrap
msgid ""
-" int guestfs_get_umask (guestfs_h *g);\n"
+" int\n"
+" guestfs_equal (guestfs_h *g,\n"
+" const char *file1,\n"
+" const char *file2);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1679
-msgid ""
-"Return the current umask. By default the umask is C<022> unless it has been "
-"set by calling C<guestfs_umask>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1684
-msgid "guestfs_get_verbose"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1686
-#, no-wrap
+#: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
msgid ""
-" int guestfs_get_verbose (guestfs_h *g);\n"
-"\n"
+"This compares the two files C<file1> and C<file2> and returns true if their "
+"content is exactly equal, or false otherwise."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1346
-msgid "This returns the verbose messages flag."
+#: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
+msgid "The external L<cmp(1)> program is used for the comparison."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1692
-msgid "guestfs_getcon"
+#: ../src/guestfs-actions.pod:1400
+msgid "guestfs_exists"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1694
+#: ../src/guestfs-actions.pod:1402
#, no-wrap
msgid ""
-" char *guestfs_getcon (guestfs_h *g);\n"
+" int\n"
+" guestfs_exists (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1696 ../fish/guestfish-actions.pod:1352
-msgid "This gets the SELinux security context of the daemon."
+#: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
+msgid ""
+"This returns C<true> if and only if there is a file, directory (or anything) "
+"with the given C<path> name."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1698
-msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
+#: ../src/guestfs-actions.pod:1409
+msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1704
-msgid "guestfs_getxattrs"
+#: ../src/guestfs-actions.pod:1415
+msgid "guestfs_fallocate"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1706
+#: ../src/guestfs-actions.pod:1417
#, no-wrap
msgid ""
-" struct guestfs_xattr_list *guestfs_getxattrs (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_fallocate (guestfs_h *g,\n"
+" const char *path,\n"
+" int len);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1709 ../fish/guestfish-actions.pod:1361
-msgid "This call lists the extended attributes of the file or directory C<path>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1712 ../fish/guestfish-actions.pod:1364
+#: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
msgid ""
-"At the system call level, this is a combination of the L<listxattr(2)> and "
-"L<getxattr(2)> calls."
+"This command preallocates a file (containing zero bytes) named C<path> of "
+"size C<len> bytes. If the file exists already, it is overwritten."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1715
-msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
+#: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
+msgid ""
+"Do not confuse this with the guestfish-specific C<alloc> command which "
+"allocates a file in the host and attaches it as a device."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1717 ../src/guestfs-actions.pod:2449 ../src/guestfs-actions.pod:2944
+#: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
msgid ""
-"This function returns a C<struct guestfs_xattr_list *> (see "
-"E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
-"must call C<guestfs_free_xattr_list> after use>."
+"This function is deprecated. In new code, use the C<fallocate64> call "
+"instead."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1722
-msgid "guestfs_glob_expand"
+#: ../src/guestfs-actions.pod:1441
+msgid "guestfs_fallocate64"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1724
+#: ../src/guestfs-actions.pod:1443
#, no-wrap
msgid ""
-" char **guestfs_glob_expand (guestfs_h *g,\n"
-"\t\tconst char *pattern);\n"
+" int\n"
+" guestfs_fallocate64 (guestfs_h *g,\n"
+" const char *path,\n"
+" int64_t len);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1373
+#: ../src/guestfs-actions.pod:1452
msgid ""
-"This command searches for all the pathnames matching C<pattern> according to "
-"the wildcard expansion rules used by the shell."
+"Note that this call allocates disk blocks for the file. To create a sparse "
+"file use C<guestfs_truncate_size> instead."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1731 ../fish/guestfish-actions.pod:1377
-msgid "If no paths match, then this returns an empty list (note: not an error)."
+#: ../src/guestfs-actions.pod:1455
+msgid ""
+"The deprecated call C<guestfs_fallocate> does the same, but owing to an "
+"oversight it only allowed 30 bit lengths to be specified, effectively "
+"limiting the maximum size of files created through that call to 1GB."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1380
+#: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
msgid ""
-"It is just a wrapper around the C L<glob(3)> function with flags "
-"C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
+"Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
+"commands which create a file in the host and attach it as a device."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1466
+msgid "(Added in 1.3.17)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1742
-msgid "guestfs_grep"
+#: ../src/guestfs-actions.pod:1468
+msgid "guestfs_fgrep"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1744
+#: ../src/guestfs-actions.pod:1470
#, no-wrap
msgid ""
-" char **guestfs_grep (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" char **\n"
+" guestfs_fgrep (guestfs_h *g,\n"
+" const char *pattern,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1388
-msgid "This calls the external C<grep> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
+msgid "This calls the external C<fgrep> program and returns the matching lines."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1758
-msgid "guestfs_grepi"
+#: ../src/guestfs-actions.pod:1487
+msgid "guestfs_fgrepi"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1760
+#: ../src/guestfs-actions.pod:1489
#, no-wrap
msgid ""
-" char **guestfs_grepi (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" char **\n"
+" guestfs_fgrepi (guestfs_h *g,\n"
+" const char *pattern,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1764 ../fish/guestfish-actions.pod:1398
-msgid "This calls the external C<grep -i> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
+msgid "This calls the external C<fgrep -i> program and returns the matching lines."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1774
-msgid "guestfs_grub_install"
+#: ../src/guestfs-actions.pod:1506
+msgid "guestfs_file"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1776
+#: ../src/guestfs-actions.pod:1508
#, no-wrap
msgid ""
-" int guestfs_grub_install (guestfs_h *g,\n"
-"\t\tconst char *root,\n"
-"\t\tconst char *device);\n"
+" char *\n"
+" guestfs_file (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1780 ../fish/guestfish-actions.pod:1408
+#: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
msgid ""
-"This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
-"the root directory being C<root>."
+"This call uses the standard L<file(1)> command to determine the type or "
+"contents of the file."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1783 ../fish/guestfish-actions.pod:1411
+#: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
msgid ""
-"Note: If grub-install reports the error \"No suitable drive was found in the "
-"generated device map.\" it may be that you need to create a "
-"C</boot/grub/device.map> file first that contains the mapping between grub "
-"device names and Linux device names. It is usually sufficient to create a "
-"file containing:"
+"This call will also transparently look inside various types of compressed "
+"file."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1418
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
msgid ""
-" (hd0) /dev/vda\n"
-"\n"
+"The exact command which runs is C<file -zb path>. Note in particular that "
+"the filename is not prepended to the output (the C<-b> option)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1792 ../fish/guestfish-actions.pod:1420
-msgid "replacing C</dev/vda> with the name of the installation device."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:1796
-msgid "guestfs_head"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1798
-#, no-wrap
+#: ../src/guestfs-actions.pod:1522
msgid ""
-" char **guestfs_head (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"This command can also be used on C</dev/> devices (and partitions, LV "
+"names). You can for example use this to determine if a device contains a "
+"filesystem, although it's usually better to use C<guestfs_vfs_type>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1426
+#: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
msgid ""
-"This command returns up to the first 10 lines of a file as a list of "
-"strings."
+"If the C<path> does not begin with C</dev/> then this command only works for "
+"the content of regular files. For other file types (directory, symbolic "
+"link etc) it will just return the string C<directory> etc."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1811
-msgid "guestfs_head_n"
+#: ../src/guestfs-actions.pod:1537
+msgid "guestfs_file_architecture"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1813
+#: ../src/guestfs-actions.pod:1539
#, no-wrap
msgid ""
-" char **guestfs_head_n (guestfs_h *g,\n"
-"\t\tint nrlines,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_file_architecture (guestfs_h *g,\n"
+" const char *filename);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1436
+#: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
msgid ""
-"If the parameter C<nrlines> is a positive number, this returns the first "
-"C<nrlines> lines of the file C<path>."
+"This detects the architecture of the binary C<filename>, and returns it if "
+"known."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1439
-msgid ""
-"If the parameter C<nrlines> is a negative number, this returns lines from "
-"the file C<path>, excluding the last C<nrlines> lines."
+#: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
+msgid "Currently defined architectures are:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:4785 ../fish/guestfish-actions.pod:1442 ../fish/guestfish-actions.pod:3687
-msgid "If the parameter C<nrlines> is zero, this returns an empty list."
+# type: =item
+#: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
+msgid "\"i386\""
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1832
-msgid "guestfs_hexdump"
+# type: textblock
+#: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
+msgid ""
+"This string is returned for all 32 bit i386, i486, i586, i686 binaries "
+"irrespective of the precise processor requirements of the binary."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1834
-#, no-wrap
-msgid ""
-" char *guestfs_hexdump (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+# type: =item
+#: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
+msgid "\"x86_64\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1451
-msgid ""
-"This runs C<hexdump -C> on the given C<path>. The result is the "
-"human-readable, canonical hex dump of the file."
+#: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
+msgid "64 bit x86-64."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1846
-msgid "guestfs_initrd_cat"
+# type: =item
+#: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
+msgid "\"sparc\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1848
-#, no-wrap
-msgid ""
-" char *guestfs_initrd_cat (guestfs_h *g,\n"
-"\t\tconst char *initrdpath,\n"
-"\t\tconst char *filename,\n"
-"\t\tsize_t *size_r);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
+msgid "32 bit SPARC."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1853 ../fish/guestfish-actions.pod:1461
-msgid ""
-"This command unpacks the file C<filename> from the initrd file called "
-"C<initrdpath>. The filename must be given I<without> the initial C</> "
-"character."
+# type: =item
+#: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
+msgid "\"sparc64\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1465
-msgid ""
-"For example, in guestfish you could use the following command to examine the "
-"boot script (usually called C</init>) contained in a Linux initrd or "
-"initramfs image:"
+#: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
+msgid "64 bit SPARC V9 and above."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1469
-#, no-wrap
-msgid ""
-" initrd-cat /boot/initrd-<version>.img init\n"
-"\n"
+# type: =item
+#: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
+msgid "\"ia64\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1863
-msgid "See also C<guestfs_initrd_list>."
+#: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
+msgid "Intel Itanium."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
+msgid "\"ppc\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:3743 ../src/guestfs-actions.pod:3872
-msgid ""
-"This function returns a buffer, or NULL on error. The size of the returned "
-"buffer is written to C<*size_r>. I<The caller must free the returned buffer "
-"after use>."
+#: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
+msgid "32 bit Power PC."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1872
-msgid "guestfs_initrd_list"
+# type: =item
+#: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
+msgid "\"ppc64\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1874
-#, no-wrap
-msgid ""
-" char **guestfs_initrd_list (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
+msgid "64 bit Power PC."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1480
-msgid "This command lists out files contained in an initrd."
+#: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
+msgid "Libguestfs may return other architecture strings in future."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1879 ../fish/guestfish-actions.pod:1482
-msgid ""
-"The files are listed without any initial C</> character. The files are "
-"listed in the order they appear (not necessarily alphabetical). Directory "
-"names are listed as separate items."
+#: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
+msgid "The function works on at least the following types of files:"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1883 ../fish/guestfish-actions.pod:1486
-msgid ""
-"Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
-"initrd. We I<only> support the newer initramfs format (compressed cpio "
-"files)."
+#: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
+msgid "many types of Un*x and Linux binary"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1891
-msgid "guestfs_inotify_add_watch"
+# type: textblock
+#: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
+msgid "many types of Un*x and Linux shared library"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1893
-#, no-wrap
-msgid ""
-" int64_t guestfs_inotify_add_watch (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint mask);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
+msgid "Windows Win32 and Win64 binaries"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1897 ../fish/guestfish-actions.pod:1494
-msgid "Watch C<path> for the events listed in C<mask>."
+#: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
+msgid "Windows Win32 and Win64 DLLs"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1899 ../fish/guestfish-actions.pod:1496
-msgid ""
-"Note that if C<path> is a directory then events within that directory are "
-"watched, but this does I<not> happen recursively (in subdirectories)."
+#: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
+msgid "Win32 binaries and DLLs return C<i386>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1903 ../fish/guestfish-actions.pod:1500
-msgid ""
-"Note for non-C or non-Linux callers: the inotify events are defined by the "
-"Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
+#: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
+msgid "Win64 binaries and DLLs return C<x86_64>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1909
-msgid "guestfs_inotify_close"
+# type: textblock
+#: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
+msgid "Linux kernel modules"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1911
-#, no-wrap
-msgid ""
-" int guestfs_inotify_close (guestfs_h *g);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
+msgid "Linux new-style initrd images"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1913 ../fish/guestfish-actions.pod:1508
-msgid ""
-"This closes the inotify handle which was previously opened by inotify_init. "
-"It removes all watches, throws away any pending events, and deallocates all "
-"resources."
+#: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
+msgid "some non-x86 Linux vmlinuz kernels"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1919
-msgid "guestfs_inotify_files"
+# type: textblock
+#: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
+msgid "What it can't do currently:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1921
-#, no-wrap
-msgid ""
-" char **guestfs_inotify_files (guestfs_h *g);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
+msgid "static libraries (libfoo.a)"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1923
-msgid ""
-"This function is a helpful wrapper around C<guestfs_inotify_read> which just "
-"returns a list of pathnames of objects that were touched. The returned "
-"pathnames are sorted and deduplicated."
+#: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
+msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1931
-msgid "guestfs_inotify_init"
+# type: textblock
+#: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
+msgid "x86 Linux vmlinuz kernels"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1933
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
msgid ""
-" int guestfs_inotify_init (guestfs_h *g,\n"
-"\t\tint maxevents);\n"
-"\n"
+"x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
+"compressed code, and are horribly hard to unpack. If you want to find the "
+"architecture of a kernel, use the architecture of the associated initrd or "
+"kernel module(s) instead."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1936 ../fish/guestfish-actions.pod:1524
-msgid ""
-"This command creates a new inotify handle. The inotify subsystem can be "
-"used to notify events which happen to objects in the guest filesystem."
+#: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2577 ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2738 ../src/guestfs-actions.pod:2798 ../src/guestfs-actions.pod:2864 ../src/guestfs-actions.pod:2996
+msgid "(Added in 1.5.3)"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1940
-msgid ""
-"C<maxevents> is the maximum number of events which will be queued up between "
-"calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
-"passed as C<0>, then the kernel (or previously set) default is used. For "
-"Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
-"throws away events, but records the fact that it threw them away by setting "
-"a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
-"C<guestfs_inotify_read>)."
+# type: =head2
+#: ../src/guestfs-actions.pod:1649
+msgid "guestfs_filesize"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1950
+# type: verbatim
+#: ../src/guestfs-actions.pod:1651
+#, no-wrap
msgid ""
-"Before any events are generated, you have to add some watches to the "
-"internal watch list. See: C<guestfs_inotify_add_watch>, "
-"C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
+" int64_t\n"
+" guestfs_filesize (guestfs_h *g,\n"
+" const char *file);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1956
-msgid ""
-"Queued up events should be read periodically by calling "
-"C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
-"wrapper around C<guestfs_inotify_read>). If you don't read the events out "
-"often enough then you risk the internal queue overflowing."
+#: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
+msgid "This command returns the size of C<file> in bytes."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1963
+#: ../src/guestfs-actions.pod:1657
msgid ""
-"The handle should be closed after use by calling C<guestfs_inotify_close>. "
-"This also removes any watches automatically."
+"To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
+"C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
+"devices, use C<guestfs_blockdev_getsize64>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1967 ../fish/guestfish-actions.pod:1555
-msgid ""
-"See also L<inotify(7)> for an overview of the inotify interface as exposed "
-"by the Linux kernel, which is roughly what we expose via libguestfs. Note "
-"that there is one global inotify handle per libguestfs instance."
+#: ../src/guestfs-actions.pod:1663
+msgid "(Added in 1.0.82)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1974
-msgid "guestfs_inotify_read"
+#: ../src/guestfs-actions.pod:1665
+msgid "guestfs_fill"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1976
+#: ../src/guestfs-actions.pod:1667
#, no-wrap
msgid ""
-" struct guestfs_inotify_event_list *guestfs_inotify_read (guestfs_h *g);\n"
+" int\n"
+" guestfs_fill (guestfs_h *g,\n"
+" int c,\n"
+" int len,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1978 ../fish/guestfish-actions.pod:1564
+#: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
msgid ""
-"Return the complete queue of events that have happened since the previous "
-"read call."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1981 ../fish/guestfish-actions.pod:1567
-msgid "If no events have happened, this returns an empty list."
+"This command creates a new file called C<path>. The initial content of the "
+"file is C<len> octets of C<c>, where C<c> must be a number in the range "
+"C<[0..255]>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1569
+#: ../src/guestfs-actions.pod:1677
msgid ""
-"I<Note>: In order to make sure that all events have been read, you must call "
-"this function repeatedly until it returns an empty list. The reason is that "
-"the call will read events up to the maximum appliance-to-host message size "
-"and leave remaining events in the queue."
+"To fill a file with zero bytes (sparsely), it is much more efficient to use "
+"C<guestfs_truncate_size>. To create a file with a pattern of repeating "
+"bytes use C<guestfs_fill_pattern>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1989
-msgid ""
-"This function returns a C<struct guestfs_inotify_event_list *> (see "
-"E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
-"must call C<guestfs_free_inotify_event_list> after use>."
+#: ../src/guestfs-actions.pod:1689
+msgid "(Added in 1.0.79)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:1994
-msgid "guestfs_inotify_rm_watch"
+#: ../src/guestfs-actions.pod:1691
+msgid "guestfs_fill_pattern"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:1996
+#: ../src/guestfs-actions.pod:1693
#, no-wrap
msgid ""
-" int guestfs_inotify_rm_watch (guestfs_h *g,\n"
-"\t\tint wd);\n"
+" int\n"
+" guestfs_fill_pattern (guestfs_h *g,\n"
+" const char *pattern,\n"
+" int len,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:1999
+#: ../src/guestfs-actions.pod:1699
msgid ""
-"Remove a previously defined inotify watch. See "
-"C<guestfs_inotify_add_watch>."
+"This function is like C<guestfs_fill> except that it creates a new file of "
+"length C<len> containing the repeating pattern of bytes in C<pattern>. The "
+"pattern is truncated if necessary to ensure the length of the file is "
+"exactly C<len> bytes."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1711
+msgid "(Added in 1.3.12)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2004
-msgid "guestfs_inspect_get_arch"
+#: ../src/guestfs-actions.pod:1713
+msgid "guestfs_find"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2006
+#: ../src/guestfs-actions.pod:1715
#, no-wrap
msgid ""
-" char *guestfs_inspect_get_arch (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" char **\n"
+" guestfs_find (guestfs_h *g,\n"
+" const char *directory);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2009 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:2102 ../src/guestfs-actions.pod:2126 ../src/guestfs-actions.pod:2144 ../src/guestfs-actions.pod:2174 ../src/guestfs-actions.pod:2195
+#: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
msgid ""
-"This function should only be called with a root device string as returned by "
-"C<guestfs_inspect_os>."
+"This command lists out all files and directories, recursively, starting at "
+"C<directory>. It is essentially equivalent to running the shell command "
+"C<find directory -print> but some post-processing happens on the output, "
+"described below."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2012
+#: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
msgid ""
-"This returns the architecture of the inspected operating system. The "
-"possible return values are listed under C<guestfs_file_architecture>."
+"This returns a list of strings I<without any prefix>. Thus if the directory "
+"structure was:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1593
+# type: verbatim
+#: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
+#, no-wrap
msgid ""
-"If the architecture could not be determined, then the string C<unknown> is "
-"returned."
+" /tmp/a\n"
+" /tmp/b\n"
+" /tmp/c/d\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2019 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2117 ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2257 ../fish/guestfish-actions.pod:1596 ../fish/guestfish-actions.pod:1642 ../fish/guestfish-actions.pod:1681 ../fish/guestfish-actions.pod:1736 ../fish/guestfish-actions.pod:1767 ../fish/guestfish-actions.pod:1801
-msgid "Please read L<guestfs(3)/INSPECTION> for more details."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2024
-msgid "guestfs_inspect_get_distro"
+#: ../src/guestfs-actions.pod:1731
+msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2026
+#: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
#, no-wrap
msgid ""
-" char *guestfs_inspect_get_distro (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" a\n"
+" b\n"
+" c\n"
+" c/d\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1605
-msgid "This returns the distro (distribution) of the inspected operating system."
+#: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
+msgid "If C<directory> is not a directory, then this command returns an error."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1608
-msgid "Currently defined distros are:"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:2039 ../fish/guestfish-actions.pod:1612
-msgid "\"debian\""
+#: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
+msgid "The returned list is sorted."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2041 ../fish/guestfish-actions.pod:1614
-msgid "Debian or a Debian-derived distro such as Ubuntu."
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:2043 ../fish/guestfish-actions.pod:1616
-msgid "\"fedora\""
+#: ../src/guestfs-actions.pod:1744
+msgid "See also C<guestfs_find0>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2045 ../fish/guestfish-actions.pod:1618
-msgid "Fedora."
+#: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3655 ../src/guestfs-actions.pod:5116
+msgid "(Added in 1.0.27)"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:2047 ../fish/guestfish-actions.pod:1620
-msgid "\"redhat-based\""
+# type: =head2
+#: ../src/guestfs-actions.pod:1755
+msgid "guestfs_find0"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2049 ../fish/guestfish-actions.pod:1622
-msgid "Some Red Hat-derived distro."
+# type: verbatim
+#: ../src/guestfs-actions.pod:1757
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_find0 (guestfs_h *g,\n"
+" const char *directory,\n"
+" const char *files);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:2051 ../fish/guestfish-actions.pod:1624
-msgid "\"rhel\""
+# type: textblock
+#: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
+msgid ""
+"This command lists out all files and directories, recursively, starting at "
+"C<directory>, placing the resulting list in the external file called "
+"C<files>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1626
-msgid "Red Hat Enterprise Linux and some derivatives."
+#: ../src/guestfs-actions.pod:1766
+msgid ""
+"This command works the same way as C<guestfs_find> with the following "
+"exceptions:"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2207 ../fish/guestfish-actions.pod:1628 ../fish/guestfish-actions.pod:1754
-msgid "\"windows\""
+# type: textblock
+#: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
+msgid "The resulting list is written to an external file."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2057 ../fish/guestfish-actions.pod:1630
+#: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
msgid ""
-"Windows does not have distributions. This string is returned if the OS type "
-"is Windows."
+"Items (filenames) in the result are separated by C<\\0> characters. See "
+"L<find(1)> option I<-print0>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1633 ../fish/guestfish-actions.pod:1758
-msgid "\"unknown\""
+# type: textblock
+#: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
+msgid "This command is not limited in the number of names that it can return."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2062 ../fish/guestfish-actions.pod:1635
-msgid "The distro could not be determined."
+#: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
+msgid "The result list is not sorted."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2217 ../fish/guestfish-actions.pod:1639 ../fish/guestfish-actions.pod:1764
-msgid ""
-"Future versions of libguestfs may return other strings here. The caller "
-"should be prepared to handle any string."
+#: ../src/guestfs-actions.pod:1793
+msgid "(Added in 1.0.74)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2074
-msgid "guestfs_inspect_get_filesystems"
+#: ../src/guestfs-actions.pod:1795
+msgid "guestfs_findfs_label"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2076
+#: ../src/guestfs-actions.pod:1797
#, no-wrap
msgid ""
-" char **guestfs_inspect_get_filesystems (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" char *\n"
+" guestfs_findfs_label (guestfs_h *g,\n"
+" const char *label);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2082 ../fish/guestfish-actions.pod:1651
+#: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
msgid ""
-"This returns a list of all the filesystems that we think are associated with "
-"this operating system. This includes the root filesystem, other ordinary "
-"filesystems, and non-mounted devices like swap partitions."
+"This command searches the filesystems and returns the one which has the "
+"given label. An error is returned if no such filesystem can be found."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1656
-msgid ""
-"In the case of a multi-boot virtual machine, it is possible for a filesystem "
-"to be shared between operating systems."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2090
-msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also "
-"C<guestfs_inspect_get_mountpoints>."
+#: ../src/guestfs-actions.pod:1805
+msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2097
-msgid "guestfs_inspect_get_major_version"
+#: ../src/guestfs-actions.pod:1812
+msgid "guestfs_findfs_uuid"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2099
+#: ../src/guestfs-actions.pod:1814
#, no-wrap
msgid ""
-" int guestfs_inspect_get_major_version (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" char *\n"
+" guestfs_findfs_uuid (guestfs_h *g,\n"
+" const char *uuid);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2105 ../fish/guestfish-actions.pod:1669
-msgid "This returns the major version number of the inspected operating system."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1672
+#: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
msgid ""
-"Windows uses a consistent versioning scheme which is I<not> reflected in the "
-"popular public names used by the operating system. Notably the operating "
-"system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
-"1). You can find out the real versions corresponding to releases of Windows "
-"by consulting Wikipedia or MSDN."
+"This command searches the filesystems and returns the one which has the "
+"given UUID. An error is returned if no such filesystem can be found."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2115 ../src/guestfs-actions.pod:2132 ../fish/guestfish-actions.pod:1679 ../fish/guestfish-actions.pod:1693
-msgid "If the version could not be determined, then C<0> is returned."
+#: ../src/guestfs-actions.pod:1822
+msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2121
-msgid "guestfs_inspect_get_minor_version"
+#: ../src/guestfs-actions.pod:1829
+msgid "guestfs_fsck"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2123
+#: ../src/guestfs-actions.pod:1831
#, no-wrap
msgid ""
-" int guestfs_inspect_get_minor_version (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" int\n"
+" guestfs_fsck (guestfs_h *g,\n"
+" const char *fstype,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2129 ../fish/guestfish-actions.pod:1690
-msgid "This returns the minor version number of the inspected operating system."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2134
+#: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also "
-"C<guestfs_inspect_get_major_version>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2139
-msgid "guestfs_inspect_get_mountpoints"
+"This runs the filesystem checker (fsck) on C<device> which should have "
+"filesystem type C<fstype>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2141
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
msgid ""
-" char **guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
-"\n"
+"The returned integer is the status. See L<fsck(8)> for the list of status "
+"codes from C<fsck>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1705
-msgid ""
-"This returns a hash of where we think the filesystems associated with this "
-"operating system should be mounted. Callers should note that this is at "
-"best an educated guess made by reading configuration files such as "
-"C</etc/fstab>."
+#: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
+msgid "Multiple status codes can be summed together."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1710
+#: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
msgid ""
-"Each element in the returned hashtable has a key which is the path of the "
-"mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
-"mounted there (eg. C</dev/sda1>)."
+"A non-zero return code can mean \"success\", for example if errors have been "
+"corrected on the filesystem."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2157 ../fish/guestfish-actions.pod:1715
-msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
+#: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
+msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2160
-msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also "
-"C<guestfs_inspect_get_filesystems>."
+#: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
+msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:3380 ../src/guestfs-actions.pod:4902
-msgid ""
-"This function returns a NULL-terminated array of strings, or NULL if there "
-"was an error. The array of strings will always have length C<2n+1>, where "
-"C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
-"caller must free the strings and the array after use>."
+#: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6753
+msgid "(Added in 1.0.16)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2169
-msgid "guestfs_inspect_get_product_name"
+#: ../src/guestfs-actions.pod:1868
+msgid "guestfs_get_append"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2171
+#: ../src/guestfs-actions.pod:1870
#, no-wrap
msgid ""
-" char *guestfs_inspect_get_product_name (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" const char *\n"
+" guestfs_get_append (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2177 ../fish/guestfish-actions.pod:1728
+#: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
msgid ""
-"This returns the product name of the inspected operating system. The "
-"product name is generally some freeform string which can be displayed to the "
-"user, but should not be parsed by programs."
+"Return the additional kernel options which are added to the guest kernel "
+"command line."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2182 ../fish/guestfish-actions.pod:1733
+#: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
+msgid "If C<NULL> then no options are added."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1878
msgid ""
-"If the product name could not be determined, then the string C<unknown> is "
-"returned."
+"This function returns a string which may be NULL. There is no way to return "
+"an error from this function. The string is owned by the guest handle and "
+"must I<not> be freed."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4794 ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5625 ../src/guestfs-actions.pod:5644 ../src/guestfs-actions.pod:5660 ../src/guestfs-actions.pod:5677 ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6796
+msgid "(Added in 1.0.26)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2190
-msgid "guestfs_inspect_get_type"
+#: ../src/guestfs-actions.pod:1884
+msgid "guestfs_get_autosync"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2192
+#: ../src/guestfs-actions.pod:1886
#, no-wrap
msgid ""
-" char *guestfs_inspect_get_type (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" int\n"
+" guestfs_get_autosync (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2198 ../fish/guestfish-actions.pod:1745
-msgid ""
-"This returns the type of the inspected operating system. Currently defined "
-"types are:"
+#: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
+msgid "Get the autosync flag."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:2203 ../fish/guestfish-actions.pod:1750
-msgid "\"linux\""
+# type: =head2
+#: ../src/guestfs-actions.pod:1895
+msgid "guestfs_get_direct"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2205 ../fish/guestfish-actions.pod:1752
-msgid "Any Linux-based operating system."
+# type: verbatim
+#: ../src/guestfs-actions.pod:1897
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_direct (guestfs_h *g);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1756
-msgid "Any Microsoft Windows operating system."
+#: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
+msgid "Return the direct appliance mode flag."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2213 ../fish/guestfish-actions.pod:1760
-msgid "The operating system type could not be determined."
+#: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5298
+msgid "(Added in 1.0.72)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2225
-msgid "guestfs_inspect_os"
+#: ../src/guestfs-actions.pod:1906
+msgid "guestfs_get_e2label"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2227
+#: ../src/guestfs-actions.pod:1908
#, no-wrap
msgid ""
-" char **guestfs_inspect_os (guestfs_h *g);\n"
+" char *\n"
+" guestfs_get_e2label (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1773
-msgid ""
-"This function uses other libguestfs functions and certain heuristics to "
-"inspect the disk(s) (usually disks belonging to a virtual machine), looking "
-"for operating systems."
+#: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
+msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1777
-msgid "The list returned is empty if no operating systems were found."
+#: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
+msgid ""
+"This function is deprecated. In new code, use the C<vfs_label> call "
+"instead."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2235 ../fish/guestfish-actions.pod:1779
-msgid ""
-"If one operating system was found, then this returns a list with a single "
-"element, which is the name of the root filesystem of this operating system. "
-"It is also possible for this function to return a list containing more than "
-"one element, indicating a dual-boot or multi-boot virtual machine, with each "
-"element being the root filesystem of one of the operating systems."
+#: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:5316 ../src/guestfs-actions.pod:5335
+msgid "(Added in 1.0.15)"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2242
+# type: =head2
+#: ../src/guestfs-actions.pod:1927
+msgid "guestfs_get_e2uuid"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:1929
+#, no-wrap
msgid ""
-"You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
-"functions in order to query further information about each operating system, "
-"such as the name and version."
+" char *\n"
+" guestfs_get_e2uuid (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2247
-msgid ""
-"This function uses other libguestfs features such as C<guestfs_mount_ro> and "
-"C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
-"the contents. This should be called with no disks currently mounted. The "
-"function may also use Augeas, so any existing Augeas handle will be closed."
+#: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
+msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1797
-msgid ""
-"This function cannot decrypt encrypted disks. The caller must do that first "
-"(supplying the necessary keys) if the disk is encrypted."
+#: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
+msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2263
-msgid "guestfs_is_blockdev"
+#: ../src/guestfs-actions.pod:1948
+msgid "guestfs_get_memsize"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2265
+#: ../src/guestfs-actions.pod:1950
#, no-wrap
msgid ""
-" int guestfs_is_blockdev (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_get_memsize (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2268 ../fish/guestfish-actions.pod:1807
+#: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
+msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1956
msgid ""
-"This returns C<true> if and only if there is a block device with the given "
-"C<path> name."
+"If C<guestfs_set_memsize> was not called on this handle, and if "
+"C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
+"value for memsize."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2294 ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:2343 ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2399
-msgid "See also C<guestfs_stat>."
+#: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388 ../fish/guestfish-actions.pod:3558 ../fish/guestfish-actions.pod:3645
+msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:4061 ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4099 ../src/guestfs-actions.pod:4111 ../src/guestfs-actions.pod:4128 ../src/guestfs-actions.pod:4141 ../src/guestfs-actions.pod:5019 ../src/guestfs-actions.pod:5356 ../src/guestfs-actions.pod:5599 ../src/guestfs-actions.pod:6200
+msgid "(Added in 1.0.55)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2275
-msgid "guestfs_is_busy"
+#: ../src/guestfs-actions.pod:1967
+msgid "guestfs_get_network"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2277
+#: ../src/guestfs-actions.pod:1969
#, no-wrap
msgid ""
-" int guestfs_is_busy (guestfs_h *g);\n"
+" int\n"
+" guestfs_get_network (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2279 ../fish/guestfish-actions.pod:1816
-msgid ""
-"This returns true iff this handle is busy processing a command (in the "
-"C<BUSY> state)."
+#: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
+msgid "This returns the enable network flag."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5375
+msgid "(Added in 1.5.4)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2286
-msgid "guestfs_is_chardev"
+#: ../src/guestfs-actions.pod:1978
+msgid "guestfs_get_path"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2288
+#: ../src/guestfs-actions.pod:1980
#, no-wrap
msgid ""
-" int guestfs_is_chardev (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" const char *\n"
+" guestfs_get_path (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2291 ../fish/guestfish-actions.pod:1825
+#: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
+msgid "Return the current search path."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
msgid ""
-"This returns C<true> if and only if there is a character device with the "
-"given C<path> name."
+"This is always non-NULL. If it wasn't set already, then this will return "
+"the default path."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
+msgid ""
+"This function returns a string, or NULL on error. The string is owned by "
+"the guest handle and must I<not> be freed."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2298
-msgid "guestfs_is_config"
+#: ../src/guestfs-actions.pod:1993
+msgid "guestfs_get_pid"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2300
+#: ../src/guestfs-actions.pod:1995
#, no-wrap
msgid ""
-" int guestfs_is_config (guestfs_h *g);\n"
+" int\n"
+" guestfs_get_pid (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2302 ../fish/guestfish-actions.pod:1834
+#: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
msgid ""
-"This returns true iff this handle is being configured (in the C<CONFIG> "
-"state)."
+"Return the process ID of the qemu subprocess. If there is no qemu "
+"subprocess, then this will return an error."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
+msgid "This is an internal call used for debugging and testing."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2005
+msgid "(Added in 1.0.56)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2309
-msgid "guestfs_is_dir"
+#: ../src/guestfs-actions.pod:2007
+msgid "guestfs_get_qemu"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2311
+#: ../src/guestfs-actions.pod:2009
#, no-wrap
msgid ""
-" int guestfs_is_dir (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" const char *\n"
+" guestfs_get_qemu (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1843
+#: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
+msgid "Return the current qemu binary."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
msgid ""
-"This returns C<true> if and only if there is a directory with the given "
-"C<path> name. Note that it returns false for other objects like files."
+"This is always non-NULL. If it wasn't set already, then this will return "
+"the default qemu binary name."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5420
+msgid "(Added in 1.0.6)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2322
-msgid "guestfs_is_fifo"
+#: ../src/guestfs-actions.pod:2022
+msgid "guestfs_get_recovery_proc"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2324
+#: ../src/guestfs-actions.pod:2024
#, no-wrap
msgid ""
-" int guestfs_is_fifo (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_get_recovery_proc (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2327 ../fish/guestfish-actions.pod:1853
-msgid ""
-"This returns C<true> if and only if there is a FIFO (named pipe) with the "
-"given C<path> name."
+#: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
+msgid "Return the recovery process enabled flag."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3353 ../src/guestfs-actions.pod:3753 ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:4724 ../src/guestfs-actions.pod:5067 ../src/guestfs-actions.pod:5444 ../src/guestfs-actions.pod:6103 ../src/guestfs-actions.pod:6123 ../src/guestfs-actions.pod:6305
+msgid "(Added in 1.0.77)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2334
-msgid "guestfs_is_file"
+#: ../src/guestfs-actions.pod:2033
+msgid "guestfs_get_selinux"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2336
+#: ../src/guestfs-actions.pod:2035
#, no-wrap
msgid ""
-" int guestfs_is_file (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_get_selinux (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2339 ../fish/guestfish-actions.pod:1862
+#: ../src/guestfs-actions.pod:2038
msgid ""
-"This returns C<true> if and only if there is a regular file with the given "
-"C<path> name. Note that it returns false for other objects like "
-"directories."
+"This returns the current setting of the selinux flag which is passed to the "
+"appliance at boot time. See C<guestfs_set_selinux>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109 ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5517
+msgid "(Added in 1.0.67)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2347
-msgid "guestfs_is_launching"
+#: ../src/guestfs-actions.pod:2048
+msgid "guestfs_get_state"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2349
+#: ../src/guestfs-actions.pod:2050
#, no-wrap
msgid ""
-" int guestfs_is_launching (guestfs_h *g);\n"
+" int\n"
+" guestfs_get_state (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2351 ../fish/guestfish-actions.pod:1872
+#: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
msgid ""
-"This returns true iff this handle is launching the subprocess (in the "
-"C<LAUNCHING> state)."
+"This returns the current state as an opaque integer. This is only useful "
+"for printing debug and internal error messages."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:2889 ../src/guestfs-actions.pod:2918 ../src/guestfs-actions.pod:2979 ../src/guestfs-actions.pod:3006 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:1991 ../fish/guestfish-actions.pod:2009 ../fish/guestfish-actions.pod:2047 ../fish/guestfish-actions.pod:2063
+msgid "For more information on states, see L<guestfs(3)>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2358
-msgid "guestfs_is_lv"
+#: ../src/guestfs-actions.pod:2062
+msgid "guestfs_get_trace"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2360
+#: ../src/guestfs-actions.pod:2064
#, no-wrap
msgid ""
-" int guestfs_is_lv (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_get_trace (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1881
-msgid ""
-"This command tests whether C<device> is a logical volume, and returns true "
-"iff this is the case."
+#: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
+msgid "Return the command trace flag."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2368
-msgid "guestfs_is_ready"
+#: ../src/guestfs-actions.pod:2073
+msgid "guestfs_get_umask"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2370
+#: ../src/guestfs-actions.pod:2075
#, no-wrap
msgid ""
-" int guestfs_is_ready (guestfs_h *g);\n"
+" int\n"
+" guestfs_get_umask (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1888
+#: ../src/guestfs-actions.pod:2078
msgid ""
-"This returns true iff this handle is ready to accept commands (in the "
-"C<READY> state)."
+"Return the current umask. By default the umask is C<022> unless it has been "
+"set by calling C<guestfs_umask>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2379
-msgid "guestfs_is_socket"
+#: ../src/guestfs-actions.pod:2085
+msgid "guestfs_get_verbose"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2381
+#: ../src/guestfs-actions.pod:2087
#, no-wrap
msgid ""
-" int guestfs_is_socket (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_get_verbose (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1897
-msgid ""
-"This returns C<true> if and only if there is a Unix domain socket with the "
-"given C<path> name."
+#: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
+msgid "This returns the verbose messages flag."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2391
-msgid "guestfs_is_symlink"
+#: ../src/guestfs-actions.pod:2096
+msgid "guestfs_getcon"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2393
+#: ../src/guestfs-actions.pod:2098
#, no-wrap
msgid ""
-" int guestfs_is_symlink (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_getcon (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2396 ../fish/guestfish-actions.pod:1906
-msgid ""
-"This returns C<true> if and only if there is a symbolic link with the given "
-"C<path> name."
+#: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
+msgid "This gets the SELinux security context of the daemon."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2103
+msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2403
-msgid "guestfs_kill_subprocess"
+#: ../src/guestfs-actions.pod:2111
+msgid "guestfs_getxattrs"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2405
+#: ../src/guestfs-actions.pod:2113
#, no-wrap
msgid ""
-" int guestfs_kill_subprocess (guestfs_h *g);\n"
+" struct guestfs_xattr_list *\n"
+" guestfs_getxattrs (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2407 ../fish/guestfish-actions.pod:1915
-msgid "This kills the qemu subprocess. You should never need to call this."
+#: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
+msgid "This call lists the extended attributes of the file or directory C<path>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2411
-msgid "guestfs_launch"
+# type: textblock
+#: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
+msgid ""
+"At the system call level, this is a combination of the L<listxattr(2)> and "
+"L<getxattr(2)> calls."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2413
-#, no-wrap
-msgid ""
-" int guestfs_launch (guestfs_h *g);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:2123
+msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1921
+#: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3749
msgid ""
-"Internally libguestfs is implemented by running a virtual machine using "
-"L<qemu(1)>."
+"This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
+"an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2418 ../fish/guestfish-actions.pod:1924
-msgid ""
-"You should call this after configuring the handle (eg. adding drives) but "
-"before performing any actions."
+#: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:3303 ../src/guestfs-actions.pod:5097 ../src/guestfs-actions.pod:5536 ../src/guestfs-actions.pod:6861
+msgid "(Added in 1.0.59)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2423
-msgid "guestfs_lchown"
+#: ../src/guestfs-actions.pod:2131
+msgid "guestfs_glob_expand"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2425
+#: ../src/guestfs-actions.pod:2133
#, no-wrap
msgid ""
-" int guestfs_lchown (guestfs_h *g,\n"
-"\t\tint owner,\n"
-"\t\tint group,\n"
-"\t\tconst char *path);\n"
+" char **\n"
+" guestfs_glob_expand (guestfs_h *g,\n"
+" const char *pattern);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2430
+#: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
msgid ""
-"Change the file owner to C<owner> and group to C<group>. This is like "
-"C<guestfs_chown> but if C<path> is a symlink then the link itself is "
-"changed, not the target."
+"This command searches for all the pathnames matching C<pattern> according to "
+"the wildcard expansion rules used by the shell."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2440
-msgid "guestfs_lgetxattrs"
+# type: textblock
+#: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
+msgid "If no paths match, then this returns an empty list (note: not an error)."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2442
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
msgid ""
-" struct guestfs_xattr_list *guestfs_lgetxattrs (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"It is just a wrapper around the C L<glob(3)> function with flags "
+"C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2445
-msgid ""
-"This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
-"then it returns the extended attributes of the link itself."
+#: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:5718
+msgid "(Added in 1.0.50)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2454
-msgid "guestfs_list_devices"
+#: ../src/guestfs-actions.pod:2154
+msgid "guestfs_grep"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2456
+#: ../src/guestfs-actions.pod:2156
#, no-wrap
msgid ""
-" char **guestfs_list_devices (guestfs_h *g);\n"
+" char **\n"
+" guestfs_grep (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2458 ../fish/guestfish-actions.pod:1951
-msgid "List all the block devices."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1953
-msgid "The full block device names are returned, eg. C</dev/sda>"
+#: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
+msgid "This calls the external C<grep> program and returns the matching lines."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2466
-msgid "guestfs_list_partitions"
+#: ../src/guestfs-actions.pod:2173
+msgid "guestfs_grepi"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2468
+#: ../src/guestfs-actions.pod:2175
#, no-wrap
msgid ""
-" char **guestfs_list_partitions (guestfs_h *g);\n"
+" char **\n"
+" guestfs_grepi (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1959
-msgid "List all the partitions detected on all block devices."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1961
-msgid "The full partition device names are returned, eg. C</dev/sda1>"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2474
-msgid ""
-"This does not return logical volumes. For that you will need to call "
-"C<guestfs_lvs>."
+#: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
+msgid "This calls the external C<grep -i> program and returns the matching lines."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2481
-msgid "guestfs_ll"
+#: ../src/guestfs-actions.pod:2192
+msgid "guestfs_grub_install"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2483
+#: ../src/guestfs-actions.pod:2194
#, no-wrap
msgid ""
-" char *guestfs_ll (guestfs_h *g,\n"
-"\t\tconst char *directory);\n"
+" int\n"
+" guestfs_grub_install (guestfs_h *g,\n"
+" const char *root,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1970
+#: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
msgid ""
-"List the files in C<directory> (relative to the root directory, there is no "
-"cwd) in the format of 'ls -la'."
+"This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
+"the root directory being C<root>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1973
+#: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
msgid ""
-"This command is mostly useful for interactive sessions. It is I<not> "
-"intended that you try to parse the output string."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2495
-msgid "guestfs_ln"
+"Note: If grub-install reports the error \"No suitable drive was found in the "
+"generated device map.\" it may be that you need to create a "
+"C</boot/grub/device.map> file first that contains the mapping between grub "
+"device names and Linux device names. It is usually sufficient to create a "
+"file containing:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2497
+#: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
#, no-wrap
msgid ""
-" int guestfs_ln (guestfs_h *g,\n"
-"\t\tconst char *target,\n"
-"\t\tconst char *linkname);\n"
+" (hd0) /dev/vda\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2501 ../fish/guestfish-actions.pod:1980
-msgid "This command creates a hard link using the C<ln> command."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2505
-msgid "guestfs_ln_f"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:2507
-#, no-wrap
-msgid ""
-" int guestfs_ln_f (guestfs_h *g,\n"
-"\t\tconst char *target,\n"
-"\t\tconst char *linkname);\n"
-"\n"
+#: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
+msgid "replacing C</dev/vda> with the name of the installation device."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2511 ../fish/guestfish-actions.pod:1986
-msgid ""
-"This command creates a hard link using the C<ln -f> command. The C<-f> "
-"option removes the link (C<linkname>) if it exists already."
+#: ../src/guestfs-actions.pod:2215
+msgid "(Added in 1.0.17)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2516
-msgid "guestfs_ln_s"
+#: ../src/guestfs-actions.pod:2217
+msgid "guestfs_head"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2518
+#: ../src/guestfs-actions.pod:2219
#, no-wrap
msgid ""
-" int guestfs_ln_s (guestfs_h *g,\n"
-"\t\tconst char *target,\n"
-"\t\tconst char *linkname);\n"
+" char **\n"
+" guestfs_head (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1993
-msgid "This command creates a symbolic link using the C<ln -s> command."
+#: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
+msgid ""
+"This command returns up to the first 10 lines of a file as a list of "
+"strings."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2526
-msgid "guestfs_ln_sf"
+#: ../src/guestfs-actions.pod:2235
+msgid "guestfs_head_n"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2528
+#: ../src/guestfs-actions.pod:2237
#, no-wrap
msgid ""
-" int guestfs_ln_sf (guestfs_h *g,\n"
-"\t\tconst char *target,\n"
-"\t\tconst char *linkname);\n"
+" char **\n"
+" guestfs_head_n (guestfs_h *g,\n"
+" int nrlines,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1999
+#: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
msgid ""
-"This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
-"option removes the link (C<linkname>) if it exists already."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2537
-msgid "guestfs_lremovexattr"
+"If the parameter C<nrlines> is a positive number, this returns the first "
+"C<nrlines> lines of the file C<path>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2539
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
msgid ""
-" int guestfs_lremovexattr (guestfs_h *g,\n"
-"\t\tconst char *xattr,\n"
-"\t\tconst char *path);\n"
-"\n"
+"If the parameter C<nrlines> is a negative number, this returns lines from "
+"the file C<path>, excluding the last C<nrlines> lines."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2543
-msgid ""
-"This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
-"link, then it removes an extended attribute of the link itself."
+#: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:5998 ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:3991
+msgid "If the parameter C<nrlines> is zero, this returns an empty list."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2549
-msgid "guestfs_ls"
+#: ../src/guestfs-actions.pod:2259
+msgid "guestfs_hexdump"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2551
+#: ../src/guestfs-actions.pod:2261
#, no-wrap
msgid ""
-" char **guestfs_ls (guestfs_h *g,\n"
-"\t\tconst char *directory);\n"
+" char *\n"
+" guestfs_hexdump (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:2014
+#: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
msgid ""
-"List the files in C<directory> (relative to the root directory, there is no "
-"cwd). The '.' and '..' entries are not returned, but hidden files are "
-"shown."
+"This runs C<hexdump -C> on the given C<path>. The result is the "
+"human-readable, canonical hex dump of the file."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2558
-msgid ""
-"This command is mostly useful for interactive sessions. Programs should "
-"probably use C<guestfs_readdir> instead."
+#: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5782 ../src/guestfs-actions.pod:5837
+msgid "(Added in 1.0.22)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2565
-msgid "guestfs_lsetxattr"
+#: ../src/guestfs-actions.pod:2276
+msgid "guestfs_initrd_cat"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2567
+#: ../src/guestfs-actions.pod:2278
#, no-wrap
msgid ""
-" int guestfs_lsetxattr (guestfs_h *g,\n"
-"\t\tconst char *xattr,\n"
-"\t\tconst char *val,\n"
-"\t\tint vallen,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_initrd_cat (guestfs_h *g,\n"
+" const char *initrdpath,\n"
+" const char *filename,\n"
+" size_t *size_r);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2573
+#: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
msgid ""
-"This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
-"then it sets an extended attribute of the link itself."
+"This command unpacks the file C<filename> from the initrd file called "
+"C<initrdpath>. The filename must be given I<without> the initial C</> "
+"character."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2579
-msgid "guestfs_lstat"
+# type: textblock
+#: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
+msgid ""
+"For example, in guestfish you could use the following command to examine the "
+"boot script (usually called C</init>) contained in a Linux initrd or "
+"initramfs image:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2581
+#: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
#, no-wrap
msgid ""
-" struct guestfs_stat *guestfs_lstat (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" initrd-cat /boot/initrd-<version>.img init\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2584 ../src/guestfs-actions.pod:4567 ../fish/guestfish-actions.pod:2033 ../fish/guestfish-actions.pod:3522
-msgid "Returns file information for the given C<path>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2586
-msgid ""
-"This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
-"link, then the link is stat-ed, not the file it refers to."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:2039
-msgid "This is the same as the C<lstat(2)> system call."
+#: ../src/guestfs-actions.pod:2294
+msgid "See also C<guestfs_initrd_list>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2592 ../src/guestfs-actions.pod:4571
+#: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4717 ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:4924
msgid ""
-"This function returns a C<struct guestfs_stat *>, or NULL if there was an "
-"error. I<The caller must call C<guestfs_free_stat> after use>."
+"This function returns a buffer, or NULL on error. The size of the returned "
+"buffer is written to C<*size_r>. I<The caller must free the returned buffer "
+"after use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2596
-msgid "guestfs_lstatlist"
+#: ../src/guestfs-actions.pod:2305
+msgid "guestfs_initrd_list"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2598
+#: ../src/guestfs-actions.pod:2307
#, no-wrap
msgid ""
-" struct guestfs_stat_list *guestfs_lstatlist (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tchar *const *names);\n"
+" char **\n"
+" guestfs_initrd_list (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2602
-msgid ""
-"This call allows you to perform the C<guestfs_lstat> operation on multiple "
-"files, where all files are in the directory C<path>. C<names> is the list "
-"of files from this directory."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2606 ../fish/guestfish-actions.pod:2049
-msgid ""
-"On return you get a list of stat structs, with a one-to-one correspondence "
-"to the C<names> list. If any name did not exist or could not be lstat'd, "
-"then the C<ino> field of that structure is set to C<-1>."
+#: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
+msgid "This command lists out files contained in an initrd."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2611
+#: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
msgid ""
-"This call is intended for programs that want to efficiently list a directory "
-"contents without making many round-trips. See also C<guestfs_lxattrlist> "
-"for a similarly efficient call for getting extended attributes. Very long "
-"directory listings might cause the protocol message size to be exceeded, "
-"causing this call to fail. The caller must split up such requests into "
-"smaller groups of names."
+"The files are listed without any initial C</> character. The files are "
+"listed in the order they appear (not necessarily alphabetical). Directory "
+"names are listed as separate items."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2619
+#: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
msgid ""
-"This function returns a C<struct guestfs_stat_list *> (see "
-"E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
-"must call C<guestfs_free_stat_list> after use>."
+"Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
+"initrd. We I<only> support the newer initramfs format (compressed cpio "
+"files)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2624
-msgid "guestfs_luks_add_key"
+#: ../src/guestfs-actions.pod:2327
+msgid "guestfs_inotify_add_watch"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2626
+#: ../src/guestfs-actions.pod:2329
#, no-wrap
msgid ""
-" int guestfs_luks_add_key (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *key,\n"
-"\t\tconst char *newkey,\n"
-"\t\tint keyslot);\n"
+" int64_t\n"
+" guestfs_inotify_add_watch (guestfs_h *g,\n"
+" const char *path,\n"
+" int mask);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:2066
-msgid ""
-"This command adds a new key on LUKS device C<device>. C<key> is any "
-"existing key, and is used to access the device. C<newkey> is the new key to "
-"add. C<keyslot> is the key slot that will be replaced."
+#: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
+msgid "Watch C<path> for the events listed in C<mask>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2637
+#: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
msgid ""
-"Note that if C<keyslot> already contains a key, then this command will "
-"fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
+"Note that if C<path> is a directory then events within that directory are "
+"watched, but this does I<not> happen recursively (in subdirectories)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2643 ../src/guestfs-actions.pod:2677 ../src/guestfs-actions.pod:2697 ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2759
+#: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
msgid ""
-"This function takes a key or passphrase parameter which could contain "
-"sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
-"information."
+"Note for non-C or non-Linux callers: the inotify events are defined by the "
+"Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2647
-msgid "guestfs_luks_close"
+#: ../src/guestfs-actions.pod:2348
+msgid "guestfs_inotify_close"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2649
+#: ../src/guestfs-actions.pod:2350
#, no-wrap
msgid ""
-" int guestfs_luks_close (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_inotify_close (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2652
+#: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
msgid ""
-"This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
-"or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
-"LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
-"underlying block device."
+"This closes the inotify handle which was previously opened by inotify_init. "
+"It removes all watches, throws away any pending events, and deallocates all "
+"resources."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2660
-msgid "guestfs_luks_format"
+#: ../src/guestfs-actions.pod:2361
+msgid "guestfs_inotify_files"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2662
+#: ../src/guestfs-actions.pod:2363
#, no-wrap
msgid ""
-" int guestfs_luks_format (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *key,\n"
-"\t\tint keyslot);\n"
+" char **\n"
+" guestfs_inotify_files (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2667 ../fish/guestfish-actions.pod:2092
-msgid ""
-"This command erases existing data on C<device> and formats the device as a "
-"LUKS encrypted device. C<key> is the initial key, which is added to key "
-"slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2674 ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2796 ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:4108 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4449 ../src/guestfs-actions.pod:4472 ../src/guestfs-actions.pod:5411 ../fish/guestfish-actions.pod:2100 ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2184 ../fish/guestfish-actions.pod:2699 ../fish/guestfish-actions.pod:3163 ../fish/guestfish-actions.pod:3421 ../fish/guestfish-actions.pod:3437 ../fish/guestfish-actions.pod:3452 ../fish/guestfish-actions.pod:4140
+#: ../src/guestfs-actions.pod:2366
msgid ""
-"B<This command is dangerous. Without careful use you can easily destroy all "
-"your data>."
+"This function is a helpful wrapper around C<guestfs_inotify_read> which just "
+"returns a list of pathnames of objects that were touched. The returned "
+"pathnames are sorted and deduplicated."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2681
-msgid "guestfs_luks_format_cipher"
+#: ../src/guestfs-actions.pod:2376
+msgid "guestfs_inotify_init"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2683
+#: ../src/guestfs-actions.pod:2378
#, no-wrap
msgid ""
-" int guestfs_luks_format_cipher (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *key,\n"
-"\t\tint keyslot,\n"
-"\t\tconst char *cipher);\n"
+" int\n"
+" guestfs_inotify_init (guestfs_h *g,\n"
+" int maxevents);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2689
+#: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
msgid ""
-"This command is the same as C<guestfs_luks_format> but it also allows you to "
-"set the C<cipher> used."
+"This command creates a new inotify handle. The inotify subsystem can be "
+"used to notify events which happen to objects in the guest filesystem."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2701
-msgid "guestfs_luks_kill_slot"
+# type: textblock
+#: ../src/guestfs-actions.pod:2386
+msgid ""
+"C<maxevents> is the maximum number of events which will be queued up between "
+"calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
+"passed as C<0>, then the kernel (or previously set) default is used. For "
+"Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
+"throws away events, but records the fact that it threw them away by setting "
+"a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
+"C<guestfs_inotify_read>)."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2703
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:2396
msgid ""
-" int guestfs_luks_kill_slot (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *key,\n"
-"\t\tint keyslot);\n"
-"\n"
+"Before any events are generated, you have to add some watches to the "
+"internal watch list. See: C<guestfs_inotify_add_watch>, "
+"C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:2120
+#: ../src/guestfs-actions.pod:2402
msgid ""
-"This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
-"device C<device>. C<key> must be one of the I<other> keys."
+"Queued up events should be read periodically by calling "
+"C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
+"wrapper around C<guestfs_inotify_read>). If you don't read the events out "
+"often enough then you risk the internal queue overflowing."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2409
+msgid ""
+"The handle should be closed after use by calling C<guestfs_inotify_close>. "
+"This also removes any watches automatically."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
+msgid ""
+"See also L<inotify(7)> for an overview of the inotify interface as exposed "
+"by the Linux kernel, which is roughly what we expose via libguestfs. Note "
+"that there is one global inotify handle per libguestfs instance."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2718
-msgid "guestfs_luks_open"
+#: ../src/guestfs-actions.pod:2422
+msgid "guestfs_inotify_read"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2720
+#: ../src/guestfs-actions.pod:2424
#, no-wrap
msgid ""
-" int guestfs_luks_open (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *key,\n"
-"\t\tconst char *mapname);\n"
+" struct guestfs_inotify_event_list *\n"
+" guestfs_inotify_read (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:2131
+#: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
msgid ""
-"This command opens a block device which has been encrypted according to the "
-"Linux Unified Key Setup (LUKS) standard."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2728 ../fish/guestfish-actions.pod:2134
-msgid "C<device> is the encrypted block device or partition."
+"Return the complete queue of events that have happened since the previous "
+"read call."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:2136
-msgid ""
-"The caller must supply one of the keys associated with the LUKS block "
-"device, in the C<key> parameter."
+#: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
+msgid "If no events have happened, this returns an empty list."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2733 ../fish/guestfish-actions.pod:2139
+#: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
msgid ""
-"This creates a new block device called C</dev/mapper/mapname>. Reads and "
-"writes to this block device are decrypted from and encrypted to the "
-"underlying C<device> respectively."
+"I<Note>: In order to make sure that all events have been read, you must call "
+"this function repeatedly until it returns an empty list. The reason is that "
+"the call will read events up to the maximum appliance-to-host message size "
+"and leave remaining events in the queue."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2737
+#: ../src/guestfs-actions.pod:2438
msgid ""
-"If this block device contains LVM volume groups, then calling "
-"C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
-"visible."
+"This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
+"there was an error. I<The caller must call "
+"C<guestfs_free_inotify_event_list> after use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2747
-msgid "guestfs_luks_open_ro"
+#: ../src/guestfs-actions.pod:2444
+msgid "guestfs_inotify_rm_watch"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2749
+#: ../src/guestfs-actions.pod:2446
#, no-wrap
msgid ""
-" int guestfs_luks_open_ro (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *key,\n"
-"\t\tconst char *mapname);\n"
+" int\n"
+" guestfs_inotify_rm_watch (guestfs_h *g,\n"
+" int wd);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2754
+#: ../src/guestfs-actions.pod:2450
msgid ""
-"This is the same as C<guestfs_luks_open> except that a read-only mapping is "
-"created."
+"Remove a previously defined inotify watch. See "
+"C<guestfs_inotify_add_watch>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2763
-msgid "guestfs_lvcreate"
+#: ../src/guestfs-actions.pod:2457
+msgid "guestfs_inspect_get_arch"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2765
+#: ../src/guestfs-actions.pod:2459
#, no-wrap
msgid ""
-" int guestfs_lvcreate (guestfs_h *g,\n"
-"\t\tconst char *logvol,\n"
-"\t\tconst char *volgroup,\n"
-"\t\tint mbytes);\n"
+" char *\n"
+" guestfs_inspect_get_arch (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2770 ../fish/guestfish-actions.pod:2164
+#: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486 ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2612 ../src/guestfs-actions.pod:2633 ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2764 ../src/guestfs-actions.pod:2806
msgid ""
-"This creates an LVM logical volume called C<logvol> on the volume group "
-"C<volgroup>, with C<size> megabytes."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2775
-msgid "guestfs_lvm_clear_filter"
+"This function should only be called with a root device string as returned by "
+"C<guestfs_inspect_os>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2777
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:2466
msgid ""
-" int guestfs_lvm_clear_filter (guestfs_h *g);\n"
-"\n"
+"This returns the architecture of the inspected operating system. The "
+"possible return values are listed under C<guestfs_file_architecture>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2779
+#: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
msgid ""
-"This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
-"see every block device."
+"If the architecture could not be determined, then the string C<unknown> is "
+"returned."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2818 ../fish/guestfish-actions.pod:2174 ../fish/guestfish-actions.pod:2205
-msgid "This command also clears the LVM cache and performs a volume group scan."
+#: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2600 ../src/guestfs-actions.pod:2682 ../src/guestfs-actions.pod:2711 ../src/guestfs-actions.pod:2733 ../src/guestfs-actions.pod:2752 ../src/guestfs-actions.pod:2793 ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2856 ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:1772 ../fish/guestfish-actions.pod:1832 ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:1873 ../fish/guestfish-actions.pod:1886 ../fish/guestfish-actions.pod:1921 ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:1971
+msgid "Please read L<guestfs(3)/INSPECTION> for more details."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2787
-msgid "guestfs_lvm_remove_all"
+#: ../src/guestfs-actions.pod:2480
+msgid "guestfs_inspect_get_distro"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2789
+#: ../src/guestfs-actions.pod:2482
#, no-wrap
msgid ""
-" int guestfs_lvm_remove_all (guestfs_h *g);\n"
+" char *\n"
+" guestfs_inspect_get_distro (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:2181
-msgid ""
-"This command removes all LVM logical volumes, volume groups and physical "
-"volumes."
+#: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
+msgid "This returns the distro (distribution) of the inspected operating system."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2799
-msgid "guestfs_lvm_set_filter"
+# type: textblock
+#: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
+msgid "Currently defined distros are:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2801
-#, no-wrap
-msgid ""
-" int guestfs_lvm_set_filter (guestfs_h *g,\n"
-"\t\tchar *const *devices);\n"
-"\n"
+# type: =item
+#: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
+msgid "\"archlinux\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2804 ../fish/guestfish-actions.pod:2191
-msgid ""
-"This sets the LVM device filter so that LVM will only be able to \"see\" the "
-"block devices in the list C<devices>, and will ignore all other attached "
-"block devices."
+#: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
+msgid "Arch Linux."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:2195
-msgid ""
-"Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
-"get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
-"there are two types of duplication possible: either cloned PVs/VGs which "
-"have identical UUIDs; or VGs that are not cloned but just happen to have the "
-"same name. In normal operation you cannot create this situation, but you "
-"can do it outside LVM, eg. by cloning disk images or by bit twiddling "
-"inside the LVM metadata."
+# type: =item
+#: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
+msgid "\"debian\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2821 ../fish/guestfish-actions.pod:2208
-msgid "You can filter whole block devices or individual partitions."
+#: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
+msgid "Debian or a Debian-derived distro such as Ubuntu."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
+msgid "\"fedora\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:2210
-msgid ""
-"You cannot use this if any VG is currently in use (eg. contains a mounted "
-"filesystem), even if you are not filtering out that VG."
+#: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
+msgid "Fedora."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2829
-msgid "guestfs_lvremove"
+# type: =item
+#: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
+msgid "\"gentoo\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2831
-#, no-wrap
-msgid ""
-" int guestfs_lvremove (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
+msgid "Gentoo."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
+msgid "\"meego\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:2218
-msgid ""
-"Remove an LVM logical volume C<device>, where C<device> is the path to the "
-"LV, such as C</dev/VG/LV>."
+#: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
+msgid "MeeGo."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
+msgid "\"pardus\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:2221
-msgid ""
-"You can also remove all LVs in a volume group by specifying the VG name, "
-"C</dev/VG>."
+#: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
+msgid "Pardus."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2842
-msgid "guestfs_lvrename"
+# type: =item
+#: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
+msgid "\"redhat-based\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2844
-#, no-wrap
-msgid ""
-" int guestfs_lvrename (guestfs_h *g,\n"
-"\t\tconst char *logvol,\n"
-"\t\tconst char *newlogvol);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
+msgid "Some Red Hat-derived distro."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
+msgid "\"rhel\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:2228
-msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
+#: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
+msgid "Red Hat Enterprise Linux and some derivatives."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2852
-msgid "guestfs_lvresize"
+# type: =item
+#: ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2776 ../fish/guestfish-actions.pod:1715 ../fish/guestfish-actions.pod:1904
+msgid "\"windows\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2854
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
msgid ""
-" int guestfs_lvresize (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint mbytes);\n"
-"\n"
+"Windows does not have distributions. This string is returned if the OS type "
+"is Windows."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:2533 ../fish/guestfish-actions.pod:1720
+msgid "\"ubuntu\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2858 ../fish/guestfish-actions.pod:2234
-msgid ""
-"This resizes (expands or shrinks) an existing LVM logical volume to "
-"C<mbytes>. When reducing, data in the reduced part is lost."
+#: ../src/guestfs-actions.pod:2535 ../fish/guestfish-actions.pod:1722
+msgid "Ubuntu."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2864
-msgid "guestfs_lvresize_free"
+# type: =item
+#: ../src/guestfs-actions.pod:2537 ../src/guestfs-actions.pod:2784 ../fish/guestfish-actions.pod:1724 ../fish/guestfish-actions.pod:1912
+msgid "\"unknown\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2866
-#, no-wrap
-msgid ""
-" int guestfs_lvresize_free (guestfs_h *g,\n"
-"\t\tconst char *lv,\n"
-"\t\tint percent);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1726
+msgid "The distro could not be determined."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:2242
+#: ../src/guestfs-actions.pod:2543 ../src/guestfs-actions.pod:2790 ../fish/guestfish-actions.pod:1730 ../fish/guestfish-actions.pod:1918
msgid ""
-"This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
-"remaining free space in the volume group. Commonly you would call this with "
-"pc = 100 which expands the logical volume as much as possible, using all "
-"remaining free space in the volume group."
+"Future versions of libguestfs may return other strings here. The caller "
+"should be prepared to handle any string."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2878
-msgid "guestfs_lvs"
+#: ../src/guestfs-actions.pod:2553
+msgid "guestfs_inspect_get_filesystems"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2880
+#: ../src/guestfs-actions.pod:2555
#, no-wrap
msgid ""
-" char **guestfs_lvs (guestfs_h *g);\n"
+" char **\n"
+" guestfs_inspect_get_filesystems (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:2252
+#: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1742
msgid ""
-"List all the logical volumes detected. This is the equivalent of the "
-"L<lvs(8)> command."
+"This returns a list of all the filesystems that we think are associated with "
+"this operating system. This includes the root filesystem, other ordinary "
+"filesystems, and non-mounted devices like swap partitions."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2885 ../fish/guestfish-actions.pod:2255
+#: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1747
msgid ""
-"This returns a list of the logical volume device names "
-"(eg. C</dev/VolGroup00/LogVol00>)."
+"In the case of a multi-boot virtual machine, it is possible for a filesystem "
+"to be shared between operating systems."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2888
-msgid "See also C<guestfs_lvs_full>."
+#: ../src/guestfs-actions.pod:2570
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"C<guestfs_inspect_get_mountpoints>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2894
-msgid "guestfs_lvs_full"
+#: ../src/guestfs-actions.pod:2579
+msgid "guestfs_inspect_get_major_version"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2896
+#: ../src/guestfs-actions.pod:2581
#, no-wrap
msgid ""
-" struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *g);\n"
+" int\n"
+" guestfs_inspect_get_major_version (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:2264
-msgid ""
-"List all the logical volumes detected. This is the equivalent of the "
-"L<lvs(8)> command. The \"full\" version includes all fields."
+#: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1760
+msgid "This returns the major version number of the inspected operating system."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2901
+#: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1763
msgid ""
-"This function returns a C<struct guestfs_lvm_lv_list *> (see "
-"E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
-"must call C<guestfs_free_lvm_lv_list> after use>."
+"Windows uses a consistent versioning scheme which is I<not> reflected in the "
+"popular public names used by the operating system. Notably the operating "
+"system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
+"1). You can find out the real versions corresponding to releases of Windows "
+"by consulting Wikipedia or MSDN."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:1784
+msgid "If the version could not be determined, then C<0> is returned."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2906
-msgid "guestfs_lvuuid"
+#: ../src/guestfs-actions.pod:2606
+msgid "guestfs_inspect_get_minor_version"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2908
+#: ../src/guestfs-actions.pod:2608
#, no-wrap
msgid ""
-" char *guestfs_lvuuid (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_inspect_get_minor_version (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2911 ../fish/guestfish-actions.pod:2271
-msgid "This command returns the UUID of the LVM LV C<device>."
+#: ../src/guestfs-actions.pod:2615 ../fish/guestfish-actions.pod:1781
+msgid "This returns the minor version number of the inspected operating system."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2620
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"C<guestfs_inspect_get_major_version>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2916
-msgid "guestfs_lxattrlist"
+#: ../src/guestfs-actions.pod:2627
+msgid "guestfs_inspect_get_mountpoints"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2918
+#: ../src/guestfs-actions.pod:2629
#, no-wrap
msgid ""
-" struct guestfs_xattr_list *guestfs_lxattrlist (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tchar *const *names);\n"
+" char **\n"
+" guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2277
+#: ../src/guestfs-actions.pod:2636 ../fish/guestfish-actions.pod:1796
msgid ""
-"This call allows you to get the extended attributes of multiple files, where "
-"all files are in the directory C<path>. C<names> is the list of files from "
-"this directory."
+"This returns a hash of where we think the filesystems associated with this "
+"operating system should be mounted. Callers should note that this is at "
+"best an educated guess made by reading configuration files such as "
+"C</etc/fstab>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2926 ../fish/guestfish-actions.pod:2281
+#: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1801
msgid ""
-"On return you get a flat list of xattr structs which must be interpreted "
-"sequentially. The first xattr struct always has a zero-length C<attrname>. "
-"C<attrval> in this struct is zero-length to indicate there was an error "
-"doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
-"number (the number of following attributes for this file, which could be "
-"C<\"0\">). Then after the first xattr struct are the zero or more "
-"attributes for the first named file. This repeats for the second and "
-"subsequent files."
+"Each element in the returned hashtable has a key which is the path of the "
+"mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
+"mounted there (eg. C</dev/sda1>)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1806
+msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2936
+#: ../src/guestfs-actions.pod:2649
msgid ""
-"This call is intended for programs that want to efficiently list a directory "
-"contents without making many round-trips. See also C<guestfs_lstatlist> for "
-"a similarly efficient call for getting standard stats. Very long directory "
-"listings might cause the protocol message size to be exceeded, causing this "
-"call to fail. The caller must split up such requests into smaller groups of "
-"names."
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"C<guestfs_inspect_get_filesystems>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2652 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:4283 ../src/guestfs-actions.pod:6139
+msgid ""
+"This function returns a NULL-terminated array of strings, or NULL if there "
+"was an error. The array of strings will always have length C<2n+1>, where "
+"C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
+"caller must free the strings and the array after use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2949
-msgid "guestfs_mkdir"
+#: ../src/guestfs-actions.pod:2660
+msgid "guestfs_inspect_get_package_format"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2951
+#: ../src/guestfs-actions.pod:2662
#, no-wrap
msgid ""
-" int guestfs_mkdir (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_inspect_get_package_format (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2303
-msgid "Create a directory named C<path>."
+#: ../src/guestfs-actions.pod:2669
+msgid ""
+"This function and C<guestfs_inspect_get_package_management> return the "
+"package format and package management tool used by the inspected operating "
+"system. For example for Fedora these functions would return C<rpm> (package "
+"format) and C<yum> (package management)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1825
+msgid ""
+"This returns the string C<unknown> if we could not determine the package "
+"format I<or> if the operating system does not have a real packaging system "
+"(eg. Windows)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2679 ../fish/guestfish-actions.pod:1829
+msgid ""
+"Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
+"Future versions of libguestfs may return other strings."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2958
-msgid "guestfs_mkdir_mode"
+#: ../src/guestfs-actions.pod:2687
+msgid "guestfs_inspect_get_package_management"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2960
+#: ../src/guestfs-actions.pod:2689
#, no-wrap
msgid ""
-" int guestfs_mkdir_mode (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint mode);\n"
+" char *\n"
+" guestfs_inspect_get_package_management (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2964 ../fish/guestfish-actions.pod:2309
+#: ../src/guestfs-actions.pod:2696
msgid ""
-"This command creates a directory, setting the initial permissions of the "
-"directory to C<mode>."
+"C<guestfs_inspect_get_package_format> and this function return the package "
+"format and package management tool used by the inspected operating system. "
+"For example for Fedora these functions would return C<rpm> (package format) "
+"and C<yum> (package management)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2312
+#: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1847
msgid ""
-"For common Linux filesystems, the actual mode which is set will be C<mode & "
-"~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
-"other ways."
+"This returns the string C<unknown> if we could not determine the package "
+"management tool I<or> if the operating system does not have a real packaging "
+"system (eg. Windows)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2971
-msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
+#: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1851
+msgid ""
+"Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
+"derivatives), C<portage>, C<pisi>, C<pacman>. Future versions of libguestfs "
+"may return other strings."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2975
-msgid "guestfs_mkdir_p"
+#: ../src/guestfs-actions.pod:2716
+msgid "guestfs_inspect_get_product_name"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2977
+#: ../src/guestfs-actions.pod:2718
#, no-wrap
msgid ""
-" int guestfs_mkdir_p (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_inspect_get_product_name (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2980 ../fish/guestfish-actions.pod:2322
+#: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:1865
msgid ""
-"Create a directory named C<path>, creating any parent directories as "
-"necessary. This is like the C<mkdir -p> shell command."
+"This returns the product name of the inspected operating system. The "
+"product name is generally some freeform string which can be displayed to the "
+"user, but should not be parsed by programs."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
+msgid ""
+"If the product name could not be determined, then the string C<unknown> is "
+"returned."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:2985
-msgid "guestfs_mkdtemp"
+#: ../src/guestfs-actions.pod:2740
+msgid "guestfs_inspect_get_roots"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:2987
+#: ../src/guestfs-actions.pod:2742
#, no-wrap
msgid ""
-" char *guestfs_mkdtemp (guestfs_h *g,\n"
-"\t\tconst char *template);\n"
+" char **\n"
+" guestfs_inspect_get_roots (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2990 ../fish/guestfish-actions.pod:2329
+#: ../src/guestfs-actions.pod:2745
msgid ""
-"This command creates a temporary directory. The C<template> parameter "
-"should be a full pathname for the temporary directory name with the final "
-"six characters being \"XXXXXX\"."
+"This function is a convenient way to get the list of root devices, as "
+"returned from a previous call to C<guestfs_inspect_os>, but without redoing "
+"the whole inspection process."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2334
+#: ../src/guestfs-actions.pod:2749
msgid ""
-"For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
-"being suitable for Windows filesystems."
+"This returns an empty list if either no root devices were found or the "
+"caller has not called C<guestfs_inspect_os>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:2758
+msgid "guestfs_inspect_get_type"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:2760
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_inspect_get_type (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:2998 ../fish/guestfish-actions.pod:2337
-msgid "The name of the temporary directory that was created is returned."
+#: ../src/guestfs-actions.pod:2767 ../fish/guestfish-actions.pod:1895
+msgid ""
+"This returns the type of the inspected operating system. Currently defined "
+"types are:"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1900
+msgid "\"linux\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2340
-msgid "The temporary directory is created with mode 0700 and is owned by root."
+#: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1902
+msgid "Any Linux-based operating system."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2343
-msgid ""
-"The caller is responsible for deleting the temporary directory and its "
-"contents after use."
+#: ../src/guestfs-actions.pod:2778 ../fish/guestfish-actions.pod:1906
+msgid "Any Microsoft Windows operating system."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:2780 ../fish/guestfish-actions.pod:1908
+msgid "\"freebsd\""
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2346
-msgid "See also: L<mkdtemp(3)>"
+#: ../src/guestfs-actions.pod:2782 ../fish/guestfish-actions.pod:1910
+msgid "FreeBSD."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2786 ../fish/guestfish-actions.pod:1914
+msgid "The operating system type could not be determined."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3012
-msgid "guestfs_mke2fs_J"
+#: ../src/guestfs-actions.pod:2800
+msgid "guestfs_inspect_get_windows_systemroot"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3014
+#: ../src/guestfs-actions.pod:2802
#, no-wrap
msgid ""
-" int guestfs_mke2fs_J (guestfs_h *g,\n"
-"\t\tconst char *fstype,\n"
-"\t\tint blocksize,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *journal);\n"
+" char *\n"
+" guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2352
+#: ../src/guestfs-actions.pod:2809 ../fish/guestfish-actions.pod:1930
msgid ""
-"This creates an ext2/3/4 filesystem on C<device> with an external journal on "
-"C<journal>. It is equivalent to the command:"
+"This returns the Windows systemroot of the inspected guest. The systemroot "
+"is a directory path such as C</WINDOWS>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3024 ../fish/guestfish-actions.pod:2356
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1933
msgid ""
-" mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
-"\n"
+"This call assumes that the guest is Windows and that the systemroot could be "
+"determined by inspection. If this is not the case then an error is "
+"returned."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3026
-msgid "See also C<guestfs_mke2journal>."
+#: ../src/guestfs-actions.pod:2821
+msgid "(Added in 1.5.25)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3030
-msgid "guestfs_mke2fs_JL"
+#: ../src/guestfs-actions.pod:2823
+msgid "guestfs_inspect_os"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3032
+#: ../src/guestfs-actions.pod:2825
#, no-wrap
msgid ""
-" int guestfs_mke2fs_JL (guestfs_h *g,\n"
-"\t\tconst char *fstype,\n"
-"\t\tint blocksize,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *label);\n"
+" char **\n"
+" guestfs_inspect_os (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2364
+#: ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1943
msgid ""
-"This creates an ext2/3/4 filesystem on C<device> with an external journal on "
-"the journal labeled C<label>."
+"This function uses other libguestfs functions and certain heuristics to "
+"inspect the disk(s) (usually disks belonging to a virtual machine), looking "
+"for operating systems."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3041
-msgid "See also C<guestfs_mke2journal_L>."
+#: ../src/guestfs-actions.pod:2832 ../fish/guestfish-actions.pod:1947
+msgid "The list returned is empty if no operating systems were found."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3045
-msgid "guestfs_mke2fs_JU"
+# type: textblock
+#: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:1949
+msgid ""
+"If one operating system was found, then this returns a list with a single "
+"element, which is the name of the root filesystem of this operating system. "
+"It is also possible for this function to return a list containing more than "
+"one element, indicating a dual-boot or multi-boot virtual machine, with each "
+"element being the root filesystem of one of the operating systems."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3047
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:2841
msgid ""
-" int guestfs_mke2fs_JU (guestfs_h *g,\n"
-"\t\tconst char *fstype,\n"
-"\t\tint blocksize,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *uuid);\n"
-"\n"
+"You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
+"functions in order to query further information about each operating system, "
+"such as the name and version."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2373
+#: ../src/guestfs-actions.pod:2846
msgid ""
-"This creates an ext2/3/4 filesystem on C<device> with an external journal on "
-"the journal with UUID C<uuid>."
+"This function uses other libguestfs features such as C<guestfs_mount_ro> and "
+"C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
+"the contents. This should be called with no disks currently mounted. The "
+"function may also use Augeas, so any existing Augeas handle will be closed."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3056
-msgid "See also C<guestfs_mke2journal_U>."
+#: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1967
+msgid ""
+"This function cannot decrypt encrypted disks. The caller must do that first "
+"(supplying the necessary keys) if the disk is encrypted."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2858 ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3175
+msgid "See also C<guestfs_list_filesystems>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3060
-msgid "guestfs_mke2journal"
+#: ../src/guestfs-actions.pod:2866
+msgid "guestfs_is_blockdev"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3062
+#: ../src/guestfs-actions.pod:2868
#, no-wrap
msgid ""
-" int guestfs_mke2journal (guestfs_h *g,\n"
-"\t\tint blocksize,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_is_blockdev (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2382
+#: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:1979
msgid ""
-"This creates an ext2 external journal on C<device>. It is equivalent to the "
-"command:"
+"This returns C<true> if and only if there is a block device with the given "
+"C<path> name."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2385
-#, no-wrap
-msgid ""
-" mke2fs -O journal_dev -b blocksize device\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2904 ../src/guestfs-actions.pod:2934 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:2965 ../src/guestfs-actions.pod:3021 ../src/guestfs-actions.pod:3036
+msgid "See also C<guestfs_stat>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:2879 ../src/guestfs-actions.pod:2908 ../src/guestfs-actions.pod:2953 ../src/guestfs-actions.pod:3025 ../src/guestfs-actions.pod:3040
+msgid "(Added in 1.5.10)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3073
-msgid "guestfs_mke2journal_L"
+#: ../src/guestfs-actions.pod:2881
+msgid "guestfs_is_busy"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3075
+#: ../src/guestfs-actions.pod:2883
#, no-wrap
msgid ""
-" int guestfs_mke2journal_L (guestfs_h *g,\n"
-"\t\tint blocksize,\n"
-"\t\tconst char *label,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_is_busy (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2391
-msgid "This creates an ext2 external journal on C<device> with label C<label>."
+#: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1988
+msgid ""
+"This returns true iff this handle is busy processing a command (in the "
+"C<BUSY> state)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3084
-msgid "guestfs_mke2journal_U"
+#: ../src/guestfs-actions.pod:2895
+msgid "guestfs_is_chardev"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3086
+#: ../src/guestfs-actions.pod:2897
#, no-wrap
msgid ""
-" int guestfs_mke2journal_U (guestfs_h *g,\n"
-"\t\tint blocksize,\n"
-"\t\tconst char *uuid,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_is_chardev (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3091 ../fish/guestfish-actions.pod:2397
-msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
+#: ../src/guestfs-actions.pod:2901 ../fish/guestfish-actions.pod:1997
+msgid ""
+"This returns C<true> if and only if there is a character device with the "
+"given C<path> name."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3095
-msgid "guestfs_mkfifo"
+#: ../src/guestfs-actions.pod:2910
+msgid "guestfs_is_config"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3097
+#: ../src/guestfs-actions.pod:2912
#, no-wrap
msgid ""
-" int guestfs_mkfifo (guestfs_h *g,\n"
-"\t\tint mode,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_is_config (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3101
+#: ../src/guestfs-actions.pod:2915 ../fish/guestfish-actions.pod:2006
msgid ""
-"This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
-"is just a convenient wrapper around C<guestfs_mknod>."
+"This returns true iff this handle is being configured (in the C<CONFIG> "
+"state)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3109
-msgid "guestfs_mkfs"
+#: ../src/guestfs-actions.pod:2924
+msgid "guestfs_is_dir"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3111
+#: ../src/guestfs-actions.pod:2926
#, no-wrap
msgid ""
-" int guestfs_mkfs (guestfs_h *g,\n"
-"\t\tconst char *fstype,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_is_dir (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3115 ../fish/guestfish-actions.pod:2413
+#: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2015
msgid ""
-"This creates a filesystem on C<device> (usually a partition or LVM logical "
-"volume). The filesystem type is C<fstype>, for example C<ext3>."
+"This returns C<true> if and only if there is a directory with the given "
+"C<path> name. Note that it returns false for other objects like files."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3121
-msgid "guestfs_mkfs_b"
+#: ../src/guestfs-actions.pod:2940
+msgid "guestfs_is_fifo"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3123
+#: ../src/guestfs-actions.pod:2942
#, no-wrap
msgid ""
-" int guestfs_mkfs_b (guestfs_h *g,\n"
-"\t\tconst char *fstype,\n"
-"\t\tint blocksize,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_is_fifo (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3128
+#: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2025
msgid ""
-"This call is similar to C<guestfs_mkfs>, but it allows you to control the "
-"block size of the resulting filesystem. Supported block sizes depend on the "
-"filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2426
-msgid ""
-"For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
-"cluster size."
+"This returns C<true> if and only if there is a FIFO (named pipe) with the "
+"given C<path> name."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3138
-msgid "guestfs_mkmountpoint"
+#: ../src/guestfs-actions.pod:2955
+msgid "guestfs_is_file"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3140
+#: ../src/guestfs-actions.pod:2957
#, no-wrap
msgid ""
-" int guestfs_mkmountpoint (guestfs_h *g,\n"
-"\t\tconst char *exemptpath);\n"
+" int\n"
+" guestfs_is_file (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3143
+#: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2034
msgid ""
-"C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
-"that can be used to create extra mountpoints before mounting the first "
-"filesystem."
+"This returns C<true> if and only if there is a regular file with the given "
+"C<path> name. Note that it returns false for other objects like "
+"directories."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2437
+# type: =head2
+#: ../src/guestfs-actions.pod:2971
+msgid "guestfs_is_launching"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:2973
+#, no-wrap
msgid ""
-"These calls are I<only> necessary in some very limited circumstances, mainly "
-"the case where you want to mount a mix of unrelated and/or read-only "
-"filesystems together."
+" int\n"
+" guestfs_is_launching (guestfs_h *g);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2441
+#: ../src/guestfs-actions.pod:2976 ../fish/guestfish-actions.pod:2044
msgid ""
-"For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
-"an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
-"inside that. You can unpack this as follows in guestfish:"
+"This returns true iff this handle is launching the subprocess (in the "
+"C<LAUNCHING> state)."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:2985
+msgid "guestfs_is_lv"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2446
+#: ../src/guestfs-actions.pod:2987
#, no-wrap
msgid ""
-" add-ro Fedora-11-i686-Live.iso\n"
-" run\n"
-" mkmountpoint /cd\n"
-" mkmountpoint /squash\n"
-" mkmountpoint /ext3\n"
-" mount /dev/sda /cd\n"
-" mount-loop /cd/LiveOS/squashfs.img /squash\n"
-" mount-loop /squash/LiveOS/ext3fs.img /ext3\n"
+" int\n"
+" guestfs_is_lv (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3165 ../fish/guestfish-actions.pod:2455
-msgid "The inner filesystem is now unpacked under the /ext3 mountpoint."
+#: ../src/guestfs-actions.pod:2991 ../fish/guestfish-actions.pod:2053
+msgid ""
+"This command tests whether C<device> is a logical volume, and returns true "
+"iff this is the case."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3169
-msgid "guestfs_mknod"
+#: ../src/guestfs-actions.pod:2998
+msgid "guestfs_is_ready"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3171
+#: ../src/guestfs-actions.pod:3000
#, no-wrap
msgid ""
-" int guestfs_mknod (guestfs_h *g,\n"
-"\t\tint mode,\n"
-"\t\tint devmajor,\n"
-"\t\tint devminor,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_is_ready (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2461
+#: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2060
msgid ""
-"This call creates block or character special devices, or named pipes "
-"(FIFOs)."
+"This returns true iff this handle is ready to accept commands (in the "
+"C<READY> state)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2464
+# type: =head2
+#: ../src/guestfs-actions.pod:3012
+msgid "guestfs_is_socket"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:3014
+#, no-wrap
msgid ""
-"The C<mode> parameter should be the mode, using the standard constants. "
-"C<devmajor> and C<devminor> are the device major and minor numbers, only "
-"used when creating block and character special devices."
+" int\n"
+" guestfs_is_socket (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3185
+#: ../src/guestfs-actions.pod:3018 ../fish/guestfish-actions.pod:2069
msgid ""
-"Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
-"S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
-"regular file). These constants are available in the standard Linux header "
-"files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
-"C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
-"the appropriate constant for you."
+"This returns C<true> if and only if there is a Unix domain socket with the "
+"given C<path> name."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3197
-msgid "guestfs_mknod_b"
+#: ../src/guestfs-actions.pod:3027
+msgid "guestfs_is_symlink"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3199
+#: ../src/guestfs-actions.pod:3029
#, no-wrap
msgid ""
-" int guestfs_mknod_b (guestfs_h *g,\n"
-"\t\tint mode,\n"
-"\t\tint devmajor,\n"
-"\t\tint devminor,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_is_symlink (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3205
+#: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2078
msgid ""
-"This call creates a block device node called C<path> with mode C<mode> and "
-"device major/minor C<devmajor> and C<devminor>. It is just a convenient "
-"wrapper around C<guestfs_mknod>."
+"This returns C<true> if and only if there is a symbolic link with the given "
+"C<path> name."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3213
-msgid "guestfs_mknod_c"
+#: ../src/guestfs-actions.pod:3042
+msgid "guestfs_kill_subprocess"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3215
+#: ../src/guestfs-actions.pod:3044
#, no-wrap
msgid ""
-" int guestfs_mknod_c (guestfs_h *g,\n"
-"\t\tint mode,\n"
-"\t\tint devmajor,\n"
-"\t\tint devminor,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_kill_subprocess (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3221
-msgid ""
-"This call creates a char device node called C<path> with mode C<mode> and "
-"device major/minor C<devmajor> and C<devminor>. It is just a convenient "
-"wrapper around C<guestfs_mknod>."
+#: ../src/guestfs-actions.pod:3047 ../fish/guestfish-actions.pod:2087
+msgid "This kills the qemu subprocess. You should never need to call this."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3229
-msgid "guestfs_mkswap"
+#: ../src/guestfs-actions.pod:3053
+msgid "guestfs_launch"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3231
+#: ../src/guestfs-actions.pod:3055
#, no-wrap
msgid ""
-" int guestfs_mkswap (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_launch (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2503
-msgid "Create a swap partition on C<device>."
+#: ../src/guestfs-actions.pod:3058 ../fish/guestfish-actions.pod:2095
+msgid ""
+"Internally libguestfs is implemented by running a virtual machine using "
+"L<qemu(1)>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2098
+msgid ""
+"You should call this after configuring the handle (eg. adding drives) but "
+"before performing any actions."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3238
-msgid "guestfs_mkswap_L"
+#: ../src/guestfs-actions.pod:3068
+msgid "guestfs_lchown"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3240
+#: ../src/guestfs-actions.pod:3070
#, no-wrap
msgid ""
-" int guestfs_mkswap_L (guestfs_h *g,\n"
-"\t\tconst char *label,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_lchown (guestfs_h *g,\n"
+" int owner,\n"
+" int group,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2509
-msgid "Create a swap partition on C<device> with label C<label>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2511
+#: ../src/guestfs-actions.pod:3076
msgid ""
-"Note that you cannot attach a swap label to a block device "
-"(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
-"the kernel or swap tools."
+"Change the file owner to C<owner> and group to C<group>. This is like "
+"C<guestfs_chown> but if C<path> is a symlink then the link itself is "
+"changed, not the target."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3252
-msgid "guestfs_mkswap_U"
+#: ../src/guestfs-actions.pod:3088
+msgid "guestfs_lgetxattrs"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3254
+#: ../src/guestfs-actions.pod:3090
#, no-wrap
msgid ""
-" int guestfs_mkswap_U (guestfs_h *g,\n"
-"\t\tconst char *uuid,\n"
-"\t\tconst char *device);\n"
+" struct guestfs_xattr_list *\n"
+" guestfs_lgetxattrs (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3258 ../fish/guestfish-actions.pod:2519
-msgid "Create a swap partition on C<device> with UUID C<uuid>."
+#: ../src/guestfs-actions.pod:3094
+msgid ""
+"This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
+"then it returns the extended attributes of the link itself."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3262
-msgid "guestfs_mkswap_file"
+#: ../src/guestfs-actions.pod:3104
+msgid "guestfs_list_devices"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3264
+#: ../src/guestfs-actions.pod:3106
#, no-wrap
msgid ""
-" int guestfs_mkswap_file (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" char **\n"
+" guestfs_list_devices (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2525
-msgid "Create a swap file."
+#: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2125
+msgid "List all the block devices."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3269
-msgid ""
-"This command just writes a swap file signature to an existing file. To "
-"create the file itself, use something like C<guestfs_fallocate>."
+#: ../src/guestfs-actions.pod:3111 ../fish/guestfish-actions.pod:2127
+msgid "The full block device names are returned, eg. C</dev/sda>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3274
-msgid "guestfs_modprobe"
+#: ../src/guestfs-actions.pod:3121
+msgid "guestfs_list_filesystems"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3276
+#: ../src/guestfs-actions.pod:3123
#, no-wrap
msgid ""
-" int guestfs_modprobe (guestfs_h *g,\n"
-"\t\tconst char *modulename);\n"
+" char **\n"
+" guestfs_list_filesystems (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2534
-msgid "This loads a kernel module in the appliance."
+#: ../src/guestfs-actions.pod:3126 ../fish/guestfish-actions.pod:2135
+msgid ""
+"This inspection command looks for filesystems on partitions, block devices "
+"and logical volumes, returning a list of devices containing filesystems and "
+"their type."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3281 ../fish/guestfish-actions.pod:2536
+#: ../src/guestfs-actions.pod:3130 ../fish/guestfish-actions.pod:2139
msgid ""
-"The kernel module must have been whitelisted when libguestfs was built (see "
-"C<appliance/kmod.whitelist.in> in the source)."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:3286
-msgid "guestfs_mount"
+"The return value is a hash, where the keys are the devices containing "
+"filesystems, and the values are the filesystem types. For example:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3288
+#: ../src/guestfs-actions.pod:3134 ../fish/guestfish-actions.pod:2143
#, no-wrap
msgid ""
-" int guestfs_mount (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *mountpoint);\n"
+" \"/dev/sda1\" => \"ntfs\"\n"
+" \"/dev/sda2\" => \"ext2\"\n"
+" \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
+" \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3292 ../fish/guestfish-actions.pod:2543
+#: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2148
msgid ""
-"Mount a guest disk at a position in the filesystem. Block devices are named "
-"C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
-"those block devices contain partitions, they will have the usual names "
-"(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
+"The value can have the special value \"unknown\", meaning the content of the "
+"device is undetermined or empty. \"swap\" means a Linux swap partition."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3298 ../fish/guestfish-actions.pod:2549
+#: ../src/guestfs-actions.pod:3143
msgid ""
-"The rules are the same as for L<mount(2)>: A filesystem must first be "
-"mounted on C</> before others can be mounted. Other filesystems can only be "
-"mounted on directories which already exist."
+"This command runs other libguestfs commands, which might include "
+"C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
+"soon after launch and only when nothing is mounted."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2554
+#: ../src/guestfs-actions.pod:3147
msgid ""
-"The mounted filesystem is writable, if we have sufficient permissions on the "
-"underlying device."
+"Not all of the filesystems returned will be mountable. In particular, swap "
+"partitions are returned in the list. Also this command does not check that "
+"each filesystem found is valid and mountable, and some filesystems might be "
+"mountable but require special options. Filesystems may not all belong to a "
+"single logical operating system (use C<guestfs_inspect_os> to look for "
+"OSes)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3306
-msgid ""
-"B<Important note:> When you use this call, the filesystem options C<sync> "
-"and C<noatime> are set implicitly. This was originally done because we "
-"thought it would improve reliability, but it turns out that I<-o sync> has a "
-"very large negative performance impact and negligible effect on "
-"reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
-"in any code that needs performance, and instead use C<guestfs_mount_options> "
-"(use an empty string for the first parameter if you don't want any options)."
+#: ../src/guestfs-actions.pod:3161 ../src/guestfs-actions.pod:4684
+msgid "(Added in 1.5.15)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3318
-msgid "guestfs_mount_loop"
+#: ../src/guestfs-actions.pod:3163
+msgid "guestfs_list_partitions"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3320
+#: ../src/guestfs-actions.pod:3165
#, no-wrap
msgid ""
-" int guestfs_mount_loop (guestfs_h *g,\n"
-"\t\tconst char *file,\n"
-"\t\tconst char *mountpoint);\n"
+" char **\n"
+" guestfs_list_partitions (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3324 ../fish/guestfish-actions.pod:2571
+#: ../src/guestfs-actions.pod:3168 ../fish/guestfish-actions.pod:2168
+msgid "List all the partitions detected on all block devices."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2170
+msgid "The full partition device names are returned, eg. C</dev/sda1>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3172
msgid ""
-"This command lets you mount C<file> (a filesystem image in a file) on a "
-"mount point. It is entirely equivalent to the command C<mount -o loop file "
-"mountpoint>."
+"This does not return logical volumes. For that you will need to call "
+"C<guestfs_lvs>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3330
-msgid "guestfs_mount_options"
+#: ../src/guestfs-actions.pod:3183
+msgid "guestfs_ll"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3332
+#: ../src/guestfs-actions.pod:3185
#, no-wrap
msgid ""
-" int guestfs_mount_options (guestfs_h *g,\n"
-"\t\tconst char *options,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *mountpoint);\n"
+" char *\n"
+" guestfs_ll (guestfs_h *g,\n"
+" const char *directory);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3337
+#: ../src/guestfs-actions.pod:3189 ../fish/guestfish-actions.pod:2181
msgid ""
-"This is the same as the C<guestfs_mount> command, but it allows you to set "
-"the mount options as for the L<mount(8)> I<-o> flag."
+"List the files in C<directory> (relative to the root directory, there is no "
+"cwd) in the format of 'ls -la'."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3341 ../fish/guestfish-actions.pod:2583
+#: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2184
msgid ""
-"If the C<options> parameter is an empty string, then no options are passed "
-"(all options default to whatever the filesystem uses)."
+"This command is mostly useful for interactive sessions. It is I<not> "
+"intended that you try to parse the output string."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3347
-msgid "guestfs_mount_ro"
+#: ../src/guestfs-actions.pod:3200
+msgid "guestfs_ln"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3349
+#: ../src/guestfs-actions.pod:3202
#, no-wrap
msgid ""
-" int guestfs_mount_ro (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *mountpoint);\n"
+" int\n"
+" guestfs_ln (guestfs_h *g,\n"
+" const char *target,\n"
+" const char *linkname);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3353
-msgid ""
-"This is the same as the C<guestfs_mount> command, but it mounts the "
-"filesystem with the read-only (I<-o ro>) flag."
+#: ../src/guestfs-actions.pod:3207 ../fish/guestfish-actions.pod:2191
+msgid "This command creates a hard link using the C<ln> command."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3358
-msgid "guestfs_mount_vfs"
+#: ../src/guestfs-actions.pod:3213
+msgid "guestfs_ln_f"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3360
+#: ../src/guestfs-actions.pod:3215
#, no-wrap
msgid ""
-" int guestfs_mount_vfs (guestfs_h *g,\n"
-"\t\tconst char *options,\n"
-"\t\tconst char *vfstype,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *mountpoint);\n"
+" int\n"
+" guestfs_ln_f (guestfs_h *g,\n"
+" const char *target,\n"
+" const char *linkname);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3366
+#: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2197
msgid ""
-"This is the same as the C<guestfs_mount> command, but it allows you to set "
-"both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
-"I<-t> flags."
+"This command creates a hard link using the C<ln -f> command. The C<-f> "
+"option removes the link (C<linkname>) if it exists already."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3372
-msgid "guestfs_mountpoints"
+#: ../src/guestfs-actions.pod:3227
+msgid "guestfs_ln_s"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3374
+#: ../src/guestfs-actions.pod:3229
#, no-wrap
msgid ""
-" char **guestfs_mountpoints (guestfs_h *g);\n"
+" int\n"
+" guestfs_ln_s (guestfs_h *g,\n"
+" const char *target,\n"
+" const char *linkname);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3376
-msgid ""
-"This call is similar to C<guestfs_mounts>. That call returns a list of "
-"devices. This one returns a hash table (map) of device name to directory "
-"where the device is mounted."
+#: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2204
+msgid "This command creates a symbolic link using the C<ln -s> command."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3386
-msgid "guestfs_mounts"
+#: ../src/guestfs-actions.pod:3240
+msgid "guestfs_ln_sf"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3388
+#: ../src/guestfs-actions.pod:3242
#, no-wrap
msgid ""
-" char **guestfs_mounts (guestfs_h *g);\n"
+" int\n"
+" guestfs_ln_sf (guestfs_h *g,\n"
+" const char *target,\n"
+" const char *linkname);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3390 ../fish/guestfish-actions.pod:2614
+#: ../src/guestfs-actions.pod:3247 ../fish/guestfish-actions.pod:2210
msgid ""
-"This returns the list of currently mounted filesystems. It returns the list "
-"of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2617
-msgid "Some internal mounts are not shown."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3395
-msgid "See also: C<guestfs_mountpoints>"
+"This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
+"option removes the link (C<linkname>) if it exists already."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3401
-msgid "guestfs_mv"
+#: ../src/guestfs-actions.pod:3254
+msgid "guestfs_lremovexattr"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3403
+#: ../src/guestfs-actions.pod:3256
#, no-wrap
msgid ""
-" int guestfs_mv (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
+" int\n"
+" guestfs_lremovexattr (guestfs_h *g,\n"
+" const char *xattr,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3407 ../fish/guestfish-actions.pod:2625
+#: ../src/guestfs-actions.pod:3261
msgid ""
-"This moves a file from C<src> to C<dest> where C<dest> is either a "
-"destination filename or destination directory."
+"This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
+"link, then it removes an extended attribute of the link itself."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3412
-msgid "guestfs_ntfs_3g_probe"
+#: ../src/guestfs-actions.pod:3269
+msgid "guestfs_ls"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3414
+#: ../src/guestfs-actions.pod:3271
#, no-wrap
msgid ""
-" int guestfs_ntfs_3g_probe (guestfs_h *g,\n"
-"\t\tint rw,\n"
-"\t\tconst char *device);\n"
+" char **\n"
+" guestfs_ls (guestfs_h *g,\n"
+" const char *directory);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:2632
-msgid ""
-"This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
-"C<device> for mountability. (Not all NTFS volumes can be mounted "
-"read-write, and some cannot be mounted at all)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3422 ../fish/guestfish-actions.pod:2636
+#: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2225
msgid ""
-"C<rw> is a boolean flag. Set it to true if you want to test if the volume "
-"can be mounted read-write. Set it to false if you want to test if the "
-"volume can be mounted read-only."
+"List the files in C<directory> (relative to the root directory, there is no "
+"cwd). The '.' and '..' entries are not returned, but hidden files are "
+"shown."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3426 ../fish/guestfish-actions.pod:2640
+#: ../src/guestfs-actions.pod:3279
msgid ""
-"The return value is an integer which C<0> if the operation would succeed, or "
-"some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
+"This command is mostly useful for interactive sessions. Programs should "
+"probably use C<guestfs_readdir> instead."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3432
-msgid "guestfs_ntfsresize"
+#: ../src/guestfs-actions.pod:3288
+msgid "guestfs_lsetxattr"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3434
+#: ../src/guestfs-actions.pod:3290
#, no-wrap
msgid ""
-" int guestfs_ntfsresize (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_lsetxattr (guestfs_h *g,\n"
+" const char *xattr,\n"
+" const char *val,\n"
+" int vallen,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3437 ../fish/guestfish-actions.pod:2648
+#: ../src/guestfs-actions.pod:3297
msgid ""
-"This command resizes an NTFS filesystem, expanding or shrinking it to the "
-"size of the underlying device. See also L<ntfsresize(8)>."
+"This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
+"then it sets an extended attribute of the link itself."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3443
-msgid "guestfs_ntfsresize_size"
+#: ../src/guestfs-actions.pod:3305
+msgid "guestfs_lstat"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3445
+#: ../src/guestfs-actions.pod:3307
#, no-wrap
msgid ""
-" int guestfs_ntfsresize_size (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint64_t size);\n"
+" struct guestfs_stat *\n"
+" guestfs_lstat (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3449
-msgid ""
-"This command is the same as C<guestfs_ntfsresize> except that it allows you "
-"to specify the new size (in bytes) explicitly."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:3454
-msgid "guestfs_part_add"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:3456
-#, no-wrap
-msgid ""
-" int guestfs_part_add (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *prlogex,\n"
-"\t\tint64_t startsect,\n"
-"\t\tint64_t endsect);\n"
-"\n"
+#: ../src/guestfs-actions.pod:3311 ../src/guestfs-actions.pod:5738 ../fish/guestfish-actions.pod:2244 ../fish/guestfish-actions.pod:3826
+msgid "Returns file information for the given C<path>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3462
+#: ../src/guestfs-actions.pod:3313
msgid ""
-"This command adds a partition to C<device>. If there is no partition table "
-"on the device, call C<guestfs_part_init> first."
+"This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
+"link, then the link is stat-ed, not the file it refers to."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3465 ../fish/guestfish-actions.pod:2666
-msgid ""
-"The C<prlogex> parameter is the type of partition. Normally you should pass "
-"C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
-"C<logical>) and C<e> (or C<extended>) partition types."
+#: ../src/guestfs-actions.pod:3317 ../fish/guestfish-actions.pod:2250
+msgid "This is the same as the C<lstat(2)> system call."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3470 ../fish/guestfish-actions.pod:2671
+#: ../src/guestfs-actions.pod:3319 ../src/guestfs-actions.pod:5742
msgid ""
-"C<startsect> and C<endsect> are the start and end of the partition in "
-"I<sectors>. C<endsect> may be negative, which means it counts backwards "
-"from the end of the disk (C<-1> is the last sector)."
+"This function returns a C<struct guestfs_stat *>, or NULL if there was an "
+"error. I<The caller must call C<guestfs_free_stat> after use>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3474
-msgid ""
-"Creating a partition which covers the whole disk is not so easy. Use "
-"C<guestfs_part_disk> to do that."
+#: ../src/guestfs-actions.pod:3323 ../src/guestfs-actions.pod:5746 ../src/guestfs-actions.pod:5764 ../src/guestfs-actions.pod:6145
+msgid "(Added in 0.9.2)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3479
-msgid "guestfs_part_del"
+#: ../src/guestfs-actions.pod:3325
+msgid "guestfs_lstatlist"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3481
+#: ../src/guestfs-actions.pod:3327
#, no-wrap
msgid ""
-" int guestfs_part_del (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum);\n"
+" struct guestfs_stat_list *\n"
+" guestfs_lstatlist (guestfs_h *g,\n"
+" const char *path,\n"
+" char *const *names);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3485 ../fish/guestfish-actions.pod:2682
-msgid "This command deletes the partition numbered C<partnum> on C<device>."
+#: ../src/guestfs-actions.pod:3332
+msgid ""
+"This call allows you to perform the C<guestfs_lstat> operation on multiple "
+"files, where all files are in the directory C<path>. C<names> is the list "
+"of files from this directory."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3487 ../fish/guestfish-actions.pod:2684
+#: ../src/guestfs-actions.pod:3336 ../fish/guestfish-actions.pod:2260
msgid ""
-"Note that in the case of MBR partitioning, deleting an extended partition "
-"also deletes any logical partitions it contains."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:3493
-msgid "guestfs_part_disk"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:3495
-#, no-wrap
-msgid ""
-" int guestfs_part_disk (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *parttype);\n"
-"\n"
+"On return you get a list of stat structs, with a one-to-one correspondence "
+"to the C<names> list. If any name did not exist or could not be lstat'd, "
+"then the C<ino> field of that structure is set to C<-1>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3499
+#: ../src/guestfs-actions.pod:3341
msgid ""
-"This command is simply a combination of C<guestfs_part_init> followed by "
-"C<guestfs_part_add> to create a single primary partition covering the whole "
-"disk."
+"This call is intended for programs that want to efficiently list a directory "
+"contents without making many round-trips. See also C<guestfs_lxattrlist> "
+"for a similarly efficient call for getting extended attributes. Very long "
+"directory listings might cause the protocol message size to be exceeded, "
+"causing this call to fail. The caller must split up such requests into "
+"smaller groups of names."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3503
+#: ../src/guestfs-actions.pod:3349
msgid ""
-"C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
-"possible values are described in C<guestfs_part_init>."
+"This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
+"an error. I<The caller must call C<guestfs_free_stat_list> after use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3511
-msgid "guestfs_part_get_bootable"
+#: ../src/guestfs-actions.pod:3355
+msgid "guestfs_luks_add_key"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3513
+#: ../src/guestfs-actions.pod:3357
#, no-wrap
msgid ""
-" int guestfs_part_get_bootable (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum);\n"
+" int\n"
+" guestfs_luks_add_key (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *key,\n"
+" const char *newkey,\n"
+" int keyslot);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3517 ../fish/guestfish-actions.pod:2706
+#: ../src/guestfs-actions.pod:3364 ../fish/guestfish-actions.pod:2277
msgid ""
-"This command returns true if the partition C<partnum> on C<device> has the "
-"bootable flag set."
+"This command adds a new key on LUKS device C<device>. C<key> is any "
+"existing key, and is used to access the device. C<newkey> is the new key to "
+"add. C<keyslot> is the key slot that will be replaced."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3520
-msgid "See also C<guestfs_part_set_bootable>."
+#: ../src/guestfs-actions.pod:3369
+msgid ""
+"Note that if C<keyslot> already contains a key, then this command will "
+"fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:3509
+msgid ""
+"This function takes a key or passphrase parameter which could contain "
+"sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
+"information."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3379 ../src/guestfs-actions.pod:3419 ../src/guestfs-actions.pod:3442 ../src/guestfs-actions.pod:3462
+msgid "(Added in 1.5.2)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3524
-msgid "guestfs_part_get_mbr_id"
+#: ../src/guestfs-actions.pod:3381
+msgid "guestfs_luks_close"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3526
+#: ../src/guestfs-actions.pod:3383
#, no-wrap
msgid ""
-" int guestfs_part_get_mbr_id (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum);\n"
+" int\n"
+" guestfs_luks_close (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3530 ../fish/guestfish-actions.pod:2715
+#: ../src/guestfs-actions.pod:3387
msgid ""
-"Returns the MBR type byte (also known as the ID byte) from the numbered "
-"partition C<partnum>."
+"This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
+"or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
+"LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
+"underlying block device."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:3695
-msgid ""
-"Note that only MBR (old DOS-style) partitions have type bytes. You will get "
-"undefined results for other partition table types (see "
-"C<guestfs_part_get_parttype>)."
+#: ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3494 ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3563 ../src/guestfs-actions.pod:3611
+msgid "(Added in 1.5.1)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3539
-msgid "guestfs_part_get_parttype"
+#: ../src/guestfs-actions.pod:3397
+msgid "guestfs_luks_format"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3541
+#: ../src/guestfs-actions.pod:3399
#, no-wrap
msgid ""
-" char *guestfs_part_get_parttype (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_luks_format (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *key,\n"
+" int keyslot);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3544 ../fish/guestfish-actions.pod:2726
+#: ../src/guestfs-actions.pod:3405 ../fish/guestfish-actions.pod:2303
msgid ""
-"This command examines the partition table on C<device> and returns the "
-"partition table type (format) being used."
+"This command erases existing data on C<device> and formats the device as a "
+"LUKS encrypted device. C<key> is the initial key, which is added to key "
+"slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3547
+#: ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:3435 ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:5198 ../src/guestfs-actions.pod:5573 ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5622 ../src/guestfs-actions.pod:6772 ../fish/guestfish-actions.pod:2311 ../fish/guestfish-actions.pod:2324 ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2938 ../fish/guestfish-actions.pod:3445 ../fish/guestfish-actions.pod:3725 ../fish/guestfish-actions.pod:3741 ../fish/guestfish-actions.pod:3756 ../fish/guestfish-actions.pod:4471
msgid ""
-"Common return values include: C<msdos> (a DOS/Windows style MBR partition "
-"table), C<gpt> (a GPT/EFI-style partition table). Other values are "
-"possible, although unusual. See C<guestfs_part_init> for a full list."
+"B<This command is dangerous. Without careful use you can easily destroy all "
+"your data>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3555
-msgid "guestfs_part_init"
+#: ../src/guestfs-actions.pod:3421
+msgid "guestfs_luks_format_cipher"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3557
+#: ../src/guestfs-actions.pod:3423
#, no-wrap
msgid ""
-" int guestfs_part_init (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *parttype);\n"
+" int\n"
+" guestfs_luks_format_cipher (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *key,\n"
+" int keyslot,\n"
+" const char *cipher);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3561 ../fish/guestfish-actions.pod:2738
+#: ../src/guestfs-actions.pod:3430
msgid ""
-"This creates an empty partition table on C<device> of one of the partition "
-"types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
-"(for large disks)."
+"This command is the same as C<guestfs_luks_format> but it also allows you to "
+"set the C<cipher> used."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3565
+# type: =head2
+#: ../src/guestfs-actions.pod:3444
+msgid "guestfs_luks_kill_slot"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:3446
+#, no-wrap
msgid ""
-"Initially there are no partitions. Following this, you should call "
-"C<guestfs_part_add> for each partition required."
+" int\n"
+" guestfs_luks_kill_slot (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *key,\n"
+" int keyslot);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2745
-msgid "Possible values for C<parttype> are:"
+#: ../src/guestfs-actions.pod:3452 ../fish/guestfish-actions.pod:2331
+msgid ""
+"This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
+"device C<device>. C<key> must be one of the I<other> keys."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3572 ../fish/guestfish-actions.pod:2749
-msgid "B<efi> | B<gpt>"
+# type: =head2
+#: ../src/guestfs-actions.pod:3464
+msgid "guestfs_luks_open"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3574 ../fish/guestfish-actions.pod:2751
-msgid "Intel EFI / GPT partition table."
+# type: verbatim
+#: ../src/guestfs-actions.pod:3466
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_luks_open (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *key,\n"
+" const char *mapname);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2753
+#: ../src/guestfs-actions.pod:3472 ../fish/guestfish-actions.pod:2342
msgid ""
-"This is recommended for >= 2 TB partitions that will be accessed from Linux "
-"and Intel-based Mac OS X. It also has limited backwards compatibility with "
-"the C<mbr> format."
+"This command opens a block device which has been encrypted according to the "
+"Linux Unified Key Setup (LUKS) standard."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3580 ../fish/guestfish-actions.pod:2757
-msgid "B<mbr> | B<msdos>"
+# type: textblock
+#: ../src/guestfs-actions.pod:3475 ../fish/guestfish-actions.pod:2345
+msgid "C<device> is the encrypted block device or partition."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3582 ../fish/guestfish-actions.pod:2759
+#: ../src/guestfs-actions.pod:3477 ../fish/guestfish-actions.pod:2347
msgid ""
-"The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
-"Windows. This partition type will B<only> work for device sizes up to 2 "
-"TB. For large disks we recommend using C<gpt>."
+"The caller must supply one of the keys associated with the LUKS block "
+"device, in the C<key> parameter."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3589 ../fish/guestfish-actions.pod:2766
-msgid "Other partition table types that may work but are not supported include:"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:3594 ../fish/guestfish-actions.pod:2771
-msgid "B<aix>"
+#: ../src/guestfs-actions.pod:3480 ../fish/guestfish-actions.pod:2350
+msgid ""
+"This creates a new block device called C</dev/mapper/mapname>. Reads and "
+"writes to this block device are decrypted from and encrypted to the "
+"underlying C<device> respectively."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3596 ../fish/guestfish-actions.pod:2773
-msgid "AIX disk labels."
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:3598 ../fish/guestfish-actions.pod:2775
-msgid "B<amiga> | B<rdb>"
+#: ../src/guestfs-actions.pod:3484
+msgid ""
+"If this block device contains LVM volume groups, then calling "
+"C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
+"visible."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3600 ../fish/guestfish-actions.pod:2777
-msgid "Amiga \"Rigid Disk Block\" format."
+# type: =head2
+#: ../src/guestfs-actions.pod:3496
+msgid "guestfs_luks_open_ro"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3602 ../fish/guestfish-actions.pod:2779
-msgid "B<bsd>"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3498
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_luks_open_ro (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *key,\n"
+" const char *mapname);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3604 ../fish/guestfish-actions.pod:2781
-msgid "BSD disk labels."
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:3606 ../fish/guestfish-actions.pod:2783
-msgid "B<dasd>"
+#: ../src/guestfs-actions.pod:3504
+msgid ""
+"This is the same as C<guestfs_luks_open> except that a read-only mapping is "
+"created."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2785
-msgid "DASD, used on IBM mainframes."
+# type: =head2
+#: ../src/guestfs-actions.pod:3515
+msgid "guestfs_lvcreate"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2787
-msgid "B<dvh>"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3517
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvcreate (guestfs_h *g,\n"
+" const char *logvol,\n"
+" const char *volgroup,\n"
+" int mbytes);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2789
-msgid "MIPS/SGI volumes."
+#: ../src/guestfs-actions.pod:3523 ../fish/guestfish-actions.pod:2375
+msgid ""
+"This creates an LVM logical volume called C<logvol> on the volume group "
+"C<volgroup>, with C<size> megabytes."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3614 ../fish/guestfish-actions.pod:2791
-msgid "B<mac>"
+# type: =head2
+#: ../src/guestfs-actions.pod:3530
+msgid "guestfs_lvm_canonical_lv_name"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3616 ../fish/guestfish-actions.pod:2793
-msgid "Old Mac partition format. Modern Macs use C<gpt>."
+# type: verbatim
+#: ../src/guestfs-actions.pod:3532
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
+" const char *lvname);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3618 ../fish/guestfish-actions.pod:2795
-msgid "B<pc98>"
+# type: textblock
+#: ../src/guestfs-actions.pod:3536 ../fish/guestfish-actions.pod:2382
+msgid ""
+"This converts alternative naming schemes for LVs that you might find to the "
+"canonical name. For example, C</dev/mapper/VG-LV> is converted to "
+"C</dev/VG/LV>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2797
-msgid "NEC PC-98 format, common in Japan apparently."
+#: ../src/guestfs-actions.pod:3540 ../fish/guestfish-actions.pod:2386
+msgid ""
+"This command returns an error if the C<lvname> parameter does not refer to a "
+"logical volume."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3622 ../fish/guestfish-actions.pod:2799
-msgid "B<sun>"
+# type: textblock
+#: ../src/guestfs-actions.pod:3543
+msgid "See also C<guestfs_is_lv>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3624 ../fish/guestfish-actions.pod:2801
-msgid "Sun disk labels."
+#: ../src/guestfs-actions.pod:3548
+msgid "(Added in 1.5.24)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3630
-msgid "guestfs_part_list"
+#: ../src/guestfs-actions.pod:3550
+msgid "guestfs_lvm_clear_filter"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3632
+#: ../src/guestfs-actions.pod:3552
#, no-wrap
msgid ""
-" struct guestfs_partition_list *guestfs_part_list (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_lvm_clear_filter (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3635 ../fish/guestfish-actions.pod:2809
+#: ../src/guestfs-actions.pod:3555
msgid ""
-"This command parses the partition table on C<device> and returns the list of "
-"partitions found."
+"This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
+"see every block device."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3638 ../fish/guestfish-actions.pod:2812
-msgid "The fields in the returned structure are:"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:3642 ../fish/guestfish-actions.pod:2816
-msgid "B<part_num>"
+#: ../src/guestfs-actions.pod:3558 ../src/guestfs-actions.pod:3600 ../fish/guestfish-actions.pod:2398 ../fish/guestfish-actions.pod:2429
+msgid "This command also clears the LVM cache and performs a volume group scan."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:2818
-msgid "Partition number, counting from 1."
+# type: =head2
+#: ../src/guestfs-actions.pod:3565
+msgid "guestfs_lvm_remove_all"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3646 ../fish/guestfish-actions.pod:2820
-msgid "B<part_start>"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3567
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvm_remove_all (guestfs_h *g);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3648
+#: ../src/guestfs-actions.pod:3570 ../fish/guestfish-actions.pod:2405
msgid ""
-"Start of the partition I<in bytes>. To get sectors you have to divide by "
-"the device's sector size, see C<guestfs_blockdev_getss>."
+"This command removes all LVM logical volumes, volume groups and physical "
+"volumes."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3651 ../fish/guestfish-actions.pod:2825
-msgid "B<part_end>"
+# type: =head2
+#: ../src/guestfs-actions.pod:3580
+msgid "guestfs_lvm_set_filter"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:3582
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvm_set_filter (guestfs_h *g,\n"
+" char *const *devices);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2827
-msgid "End of the partition in bytes."
+#: ../src/guestfs-actions.pod:3586 ../fish/guestfish-actions.pod:2415
+msgid ""
+"This sets the LVM device filter so that LVM will only be able to \"see\" the "
+"block devices in the list C<devices>, and will ignore all other attached "
+"block devices."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3655 ../fish/guestfish-actions.pod:2829
-msgid "B<part_size>"
+# type: textblock
+#: ../src/guestfs-actions.pod:3590 ../fish/guestfish-actions.pod:2419
+msgid ""
+"Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
+"get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
+"there are two types of duplication possible: either cloned PVs/VGs which "
+"have identical UUIDs; or VGs that are not cloned but just happen to have the "
+"same name. In normal operation you cannot create this situation, but you "
+"can do it outside LVM, eg. by cloning disk images or by bit twiddling "
+"inside the LVM metadata."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2831
-msgid "Size of the partition in bytes."
+#: ../src/guestfs-actions.pod:3603 ../fish/guestfish-actions.pod:2432
+msgid "You can filter whole block devices or individual partitions."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3661
+#: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2434
msgid ""
-"This function returns a C<struct guestfs_partition_list *> (see "
-"E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
-"must call C<guestfs_free_partition_list> after use>."
+"You cannot use this if any VG is currently in use (eg. contains a mounted "
+"filesystem), even if you are not filtering out that VG."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3666
-msgid "guestfs_part_set_bootable"
+#: ../src/guestfs-actions.pod:3613
+msgid "guestfs_lvremove"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3668
+#: ../src/guestfs-actions.pod:3615
#, no-wrap
msgid ""
-" int guestfs_part_set_bootable (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum,\n"
-"\t\tint bootable);\n"
+" int\n"
+" guestfs_lvremove (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2839
+#: ../src/guestfs-actions.pod:3619 ../fish/guestfish-actions.pod:2442
msgid ""
-"This sets the bootable flag on partition numbered C<partnum> on device "
-"C<device>. Note that partitions are numbered from 1."
+"Remove an LVM logical volume C<device>, where C<device> is the path to the "
+"LV, such as C</dev/VG/LV>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2842
+#: ../src/guestfs-actions.pod:3622 ../fish/guestfish-actions.pod:2445
msgid ""
-"The bootable flag is used by some operating systems (notably Windows) to "
-"determine which partition to boot from. It is by no means universally "
-"recognized."
+"You can also remove all LVs in a volume group by specifying the VG name, "
+"C</dev/VG>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3627 ../src/guestfs-actions.pod:4781 ../src/guestfs-actions.pod:6511
+msgid "(Added in 1.0.13)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3682
-msgid "guestfs_part_set_mbr_id"
+#: ../src/guestfs-actions.pod:3629
+msgid "guestfs_lvrename"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3684
+#: ../src/guestfs-actions.pod:3631
#, no-wrap
msgid ""
-" int guestfs_part_set_mbr_id (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum,\n"
-"\t\tint idbyte);\n"
+" int\n"
+" guestfs_lvrename (guestfs_h *g,\n"
+" const char *logvol,\n"
+" const char *newlogvol);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2850
-msgid ""
-"Sets the MBR type byte (also known as the ID byte) of the numbered partition "
-"C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
-"documentation are in fact hexadecimal numbers, but usually documented "
-"without any leading \"0x\" which might be confusing."
+#: ../src/guestfs-actions.pod:3636 ../fish/guestfish-actions.pod:2452
+msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:6524
+msgid "(Added in 1.0.83)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3701
-msgid "guestfs_part_set_name"
+#: ../src/guestfs-actions.pod:3642
+msgid "guestfs_lvresize"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3703
+#: ../src/guestfs-actions.pod:3644
#, no-wrap
msgid ""
-" int guestfs_part_set_name (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum,\n"
-"\t\tconst char *name);\n"
+" int\n"
+" guestfs_lvresize (guestfs_h *g,\n"
+" const char *device,\n"
+" int mbytes);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3708 ../fish/guestfish-actions.pod:2864
-msgid ""
-"This sets the partition name on partition numbered C<partnum> on device "
-"C<device>. Note that partitions are numbered from 1."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3711 ../fish/guestfish-actions.pod:2867
+#: ../src/guestfs-actions.pod:3649 ../fish/guestfish-actions.pod:2458
msgid ""
-"The partition name can only be set on certain types of partition table. "
-"This works on C<gpt> but not on C<mbr> partitions."
+"This resizes (expands or shrinks) an existing LVM logical volume to "
+"C<mbytes>. When reducing, data in the reduced part is lost."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3716
-msgid "guestfs_ping_daemon"
+#: ../src/guestfs-actions.pod:3657
+msgid "guestfs_lvresize_free"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3718
+#: ../src/guestfs-actions.pod:3659
#, no-wrap
msgid ""
-" int guestfs_ping_daemon (guestfs_h *g);\n"
+" int\n"
+" guestfs_lvresize_free (guestfs_h *g,\n"
+" const char *lv,\n"
+" int percent);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3720 ../fish/guestfish-actions.pod:2874
+#: ../src/guestfs-actions.pod:3664 ../fish/guestfish-actions.pod:2466
msgid ""
-"This is a test probe into the guestfs daemon running inside the qemu "
-"subprocess. Calling this function checks that the daemon responds to the "
-"ping message, without affecting the daemon or attached block device(s) in "
-"any other way."
+"This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
+"remaining free space in the volume group. Commonly you would call this with "
+"pc = 100 which expands the logical volume as much as possible, using all "
+"remaining free space in the volume group."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3672
+msgid "(Added in 1.3.3)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3727
-msgid "guestfs_pread"
+#: ../src/guestfs-actions.pod:3674
+msgid "guestfs_lvs"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3729
+#: ../src/guestfs-actions.pod:3676
#, no-wrap
msgid ""
-" char *guestfs_pread (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint count,\n"
-"\t\tint64_t offset,\n"
-"\t\tsize_t *size_r);\n"
+" char **\n"
+" guestfs_lvs (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3735 ../fish/guestfish-actions.pod:2883
+#: ../src/guestfs-actions.pod:3679 ../fish/guestfish-actions.pod:2476
msgid ""
-"This command lets you read part of a file. It reads C<count> bytes of the "
-"file, starting at C<offset>, from file C<path>."
+"List all the logical volumes detected. This is the equivalent of the "
+"L<lvs(8)> command."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2886
+#: ../src/guestfs-actions.pod:3682 ../fish/guestfish-actions.pod:2479
msgid ""
-"This may read fewer bytes than requested. For further details see the "
-"L<pread(2)> system call."
+"This returns a list of the logical volume device names "
+"(eg. C</dev/VolGroup00/LogVol00>)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3741
-msgid "See also C<guestfs_pwrite>."
+#: ../src/guestfs-actions.pod:3685
+msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3750
-msgid "guestfs_pvcreate"
+#: ../src/guestfs-actions.pod:3693
+msgid "guestfs_lvs_full"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3752
+#: ../src/guestfs-actions.pod:3695
#, no-wrap
msgid ""
-" int guestfs_pvcreate (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" struct guestfs_lvm_lv_list *\n"
+" guestfs_lvs_full (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3755 ../fish/guestfish-actions.pod:2898
+#: ../src/guestfs-actions.pod:3698 ../fish/guestfish-actions.pod:2488
msgid ""
-"This creates an LVM physical volume on the named C<device>, where C<device> "
-"should usually be a partition name such as C</dev/sda1>."
+"List all the logical volumes detected. This is the equivalent of the "
+"L<lvs(8)> command. The \"full\" version includes all fields."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3701
+msgid ""
+"This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
+"was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
+"use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3761
-msgid "guestfs_pvremove"
+#: ../src/guestfs-actions.pod:3707
+msgid "guestfs_lvuuid"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3763
+#: ../src/guestfs-actions.pod:3709
#, no-wrap
msgid ""
-" int guestfs_pvremove (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" char *\n"
+" guestfs_lvuuid (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3766 ../fish/guestfish-actions.pod:2906
-msgid ""
-"This wipes a physical volume C<device> so that LVM will no longer recognise "
-"it."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2909
-msgid ""
-"The implementation uses the C<pvremove> command which refuses to wipe "
-"physical volumes that contain any volume groups, so you have to remove those "
-"first."
+#: ../src/guestfs-actions.pod:3713 ../fish/guestfish-actions.pod:2495
+msgid "This command returns the UUID of the LVM LV C<device>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3775
-msgid "guestfs_pvresize"
+#: ../src/guestfs-actions.pod:3720
+msgid "guestfs_lxattrlist"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3777
+#: ../src/guestfs-actions.pod:3722
#, no-wrap
msgid ""
-" int guestfs_pvresize (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" struct guestfs_xattr_list *\n"
+" guestfs_lxattrlist (guestfs_h *g,\n"
+" const char *path,\n"
+" char *const *names);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3780 ../fish/guestfish-actions.pod:2917
+#: ../src/guestfs-actions.pod:3727 ../fish/guestfish-actions.pod:2501
msgid ""
-"This resizes (expands or shrinks) an existing LVM physical volume to match "
-"the new size of the underlying device."
+"This call allows you to get the extended attributes of multiple files, where "
+"all files are in the directory C<path>. C<names> is the list of files from "
+"this directory."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3731 ../fish/guestfish-actions.pod:2505
+msgid ""
+"On return you get a flat list of xattr structs which must be interpreted "
+"sequentially. The first xattr struct always has a zero-length C<attrname>. "
+"C<attrval> in this struct is zero-length to indicate there was an error "
+"doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
+"number (the number of following attributes for this file, which could be "
+"C<\"0\">). Then after the first xattr struct are the zero or more "
+"attributes for the first named file. This repeats for the second and "
+"subsequent files."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3741
+msgid ""
+"This call is intended for programs that want to efficiently list a directory "
+"contents without making many round-trips. See also C<guestfs_lstatlist> for "
+"a similarly efficient call for getting standard stats. Very long directory "
+"listings might cause the protocol message size to be exceeded, causing this "
+"call to fail. The caller must split up such requests into smaller groups of "
+"names."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3785
-msgid "guestfs_pvresize_size"
+#: ../src/guestfs-actions.pod:3755
+msgid "guestfs_mkdir"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3787
+#: ../src/guestfs-actions.pod:3757
#, no-wrap
msgid ""
-" int guestfs_pvresize_size (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint64_t size);\n"
+" int\n"
+" guestfs_mkdir (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3791
-msgid ""
-"This command is the same as C<guestfs_pvresize> except that it allows you to "
-"specify the new size (in bytes) explicitly."
+#: ../src/guestfs-actions.pod:3761 ../fish/guestfish-actions.pod:2527
+msgid "Create a directory named C<path>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3796
-msgid "guestfs_pvs"
+#: ../src/guestfs-actions.pod:3767
+msgid "guestfs_mkdir_mode"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3798
+#: ../src/guestfs-actions.pod:3769
#, no-wrap
msgid ""
-" char **guestfs_pvs (guestfs_h *g);\n"
+" int\n"
+" guestfs_mkdir_mode (guestfs_h *g,\n"
+" const char *path,\n"
+" int mode);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3800 ../fish/guestfish-actions.pod:2931
+#: ../src/guestfs-actions.pod:3774 ../fish/guestfish-actions.pod:2533
msgid ""
-"List all the physical volumes detected. This is the equivalent of the "
-"L<pvs(8)> command."
+"This command creates a directory, setting the initial permissions of the "
+"directory to C<mode>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3803 ../fish/guestfish-actions.pod:2934
+#: ../src/guestfs-actions.pod:3777 ../fish/guestfish-actions.pod:2536
msgid ""
-"This returns a list of just the device names that contain PVs "
-"(eg. C</dev/sda2>)."
+"For common Linux filesystems, the actual mode which is set will be C<mode & "
+"~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
+"other ways."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3806
-msgid "See also C<guestfs_pvs_full>."
+#: ../src/guestfs-actions.pod:3781
+msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3812
-msgid "guestfs_pvs_full"
+#: ../src/guestfs-actions.pod:3787
+msgid "guestfs_mkdir_p"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3814
+#: ../src/guestfs-actions.pod:3789
#, no-wrap
msgid ""
-" struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *g);\n"
+" int\n"
+" guestfs_mkdir_p (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3816 ../fish/guestfish-actions.pod:2943
-msgid ""
-"List all the physical volumes detected. This is the equivalent of the "
-"L<pvs(8)> command. The \"full\" version includes all fields."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3819
+#: ../src/guestfs-actions.pod:3793 ../fish/guestfish-actions.pod:2546
msgid ""
-"This function returns a C<struct guestfs_lvm_pv_list *> (see "
-"E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
-"must call C<guestfs_free_lvm_pv_list> after use>."
+"Create a directory named C<path>, creating any parent directories as "
+"necessary. This is like the C<mkdir -p> shell command."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3824
-msgid "guestfs_pvuuid"
+#: ../src/guestfs-actions.pod:3800
+msgid "guestfs_mkdtemp"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3826
+#: ../src/guestfs-actions.pod:3802
#, no-wrap
msgid ""
-" char *guestfs_pvuuid (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" char *\n"
+" guestfs_mkdtemp (guestfs_h *g,\n"
+" const char *template);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3829 ../fish/guestfish-actions.pod:2950
-msgid "This command returns the UUID of the LVM PV C<device>."
+#: ../src/guestfs-actions.pod:3806 ../fish/guestfish-actions.pod:2553
+msgid ""
+"This command creates a temporary directory. The C<template> parameter "
+"should be a full pathname for the temporary directory name with the final "
+"six characters being \"XXXXXX\"."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3834
-msgid "guestfs_pwrite"
+# type: textblock
+#: ../src/guestfs-actions.pod:3811 ../fish/guestfish-actions.pod:2558
+msgid ""
+"For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
+"being suitable for Windows filesystems."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3836
-#, no-wrap
-msgid ""
-" int guestfs_pwrite (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tconst char *content,\n"
-"\t\tsize_t content_size,\n"
-"\t\tint64_t offset);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:3814 ../fish/guestfish-actions.pod:2561
+msgid "The name of the temporary directory that was created is returned."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2956
-msgid ""
-"This command writes to part of a file. It writes the data buffer C<content> "
-"to the file C<path> starting at offset C<offset>."
+#: ../src/guestfs-actions.pod:3817 ../fish/guestfish-actions.pod:2564
+msgid "The temporary directory is created with mode 0700 and is owned by root."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3845 ../fish/guestfish-actions.pod:2959
+#: ../src/guestfs-actions.pod:3820 ../fish/guestfish-actions.pod:2567
msgid ""
-"This command implements the L<pwrite(2)> system call, and like that system "
-"call it may not write the full data requested. The return value is the "
-"number of bytes that were actually written to the file. This could even be "
-"0, although short writes are unlikely for regular files in ordinary "
-"circumstances."
+"The caller is responsible for deleting the temporary directory and its "
+"contents after use."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3851
-msgid "See also C<guestfs_pread>."
+#: ../src/guestfs-actions.pod:3823 ../fish/guestfish-actions.pod:2570
+msgid "See also: L<mkdtemp(3)>"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3858
-msgid "guestfs_read_file"
+#: ../src/guestfs-actions.pod:3830
+msgid "guestfs_mke2fs_J"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3860
+#: ../src/guestfs-actions.pod:3832
#, no-wrap
msgid ""
-" char *guestfs_read_file (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tsize_t *size_r);\n"
+" int\n"
+" guestfs_mke2fs_J (guestfs_h *g,\n"
+" const char *fstype,\n"
+" int blocksize,\n"
+" const char *device,\n"
+" const char *journal);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3864 ../fish/guestfish-actions.pod:2974
-msgid "This calls returns the contents of the file C<path> as a buffer."
+#: ../src/guestfs-actions.pod:3839 ../fish/guestfish-actions.pod:2576
+msgid ""
+"This creates an ext2/3/4 filesystem on C<device> with an external journal on "
+"C<journal>. It is equivalent to the command:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3867
+# type: verbatim
+#: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2580
+#, no-wrap
msgid ""
-"Unlike C<guestfs_cat>, this function can correctly handle files that contain "
-"embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
-"function is limited in the total size of file that can be handled."
+" mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3845
+msgid "See also C<guestfs_mke2journal>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3867 ../src/guestfs-actions.pod:3885 ../src/guestfs-actions.pod:3901 ../src/guestfs-actions.pod:3915 ../src/guestfs-actions.pod:3929 ../src/guestfs-actions.pod:3981 ../src/guestfs-actions.pod:4171
+msgid "(Added in 1.0.68)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3879
-msgid "guestfs_read_lines"
+#: ../src/guestfs-actions.pod:3851
+msgid "guestfs_mke2fs_JL"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3881
+#: ../src/guestfs-actions.pod:3853
#, no-wrap
msgid ""
-" char **guestfs_read_lines (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_mke2fs_JL (guestfs_h *g,\n"
+" const char *fstype,\n"
+" int blocksize,\n"
+" const char *device,\n"
+" const char *label);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2991
+#: ../src/guestfs-actions.pod:3860 ../fish/guestfish-actions.pod:2588
msgid ""
-"The file contents are returned as a list of lines. Trailing C<LF> and "
-"C<CRLF> character sequences are I<not> returned."
+"This creates an ext2/3/4 filesystem on C<device> with an external journal on "
+"the journal labeled C<label>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3889
-msgid ""
-"Note that this function cannot correctly handle binary files (specifically, "
-"files containing C<\\0> character which is treated as end of line). For "
-"those you need to use the C<guestfs_read_file> function which has a more "
-"complex interface."
+#: ../src/guestfs-actions.pod:3863
+msgid "See also C<guestfs_mke2journal_L>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3898
-msgid "guestfs_readdir"
+#: ../src/guestfs-actions.pod:3869
+msgid "guestfs_mke2fs_JU"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3900
+#: ../src/guestfs-actions.pod:3871
#, no-wrap
msgid ""
-" struct guestfs_dirent_list *guestfs_readdir (guestfs_h *g,\n"
-"\t\tconst char *dir);\n"
+" int\n"
+" guestfs_mke2fs_JU (guestfs_h *g,\n"
+" const char *fstype,\n"
+" int blocksize,\n"
+" const char *device,\n"
+" const char *uuid);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3903 ../fish/guestfish-actions.pod:3003
-msgid "This returns the list of directory entries in directory C<dir>."
+#: ../src/guestfs-actions.pod:3878 ../fish/guestfish-actions.pod:2597
+msgid ""
+"This creates an ext2/3/4 filesystem on C<device> with an external journal on "
+"the journal with UUID C<uuid>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3905 ../fish/guestfish-actions.pod:3005
-msgid ""
-"All entries in the directory are returned, including C<.> and C<..>. The "
-"entries are I<not> sorted, but returned in the same order as the underlying "
-"filesystem."
+#: ../src/guestfs-actions.pod:3881
+msgid "See also C<guestfs_mke2journal_U>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3909 ../fish/guestfish-actions.pod:3009
-msgid ""
-"Also this call returns basic file type information about each file. The "
-"C<ftyp> field will contain one of the following characters:"
+# type: =head2
+#: ../src/guestfs-actions.pod:3887
+msgid "guestfs_mke2journal"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:3014
-msgid "'b'"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3889
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_mke2journal (guestfs_h *g,\n"
+" int blocksize,\n"
+" const char *device);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3916 ../fish/guestfish-actions.pod:3016
-msgid "Block special"
+#: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2606
+msgid ""
+"This creates an ext2 external journal on C<device>. It is equivalent to the "
+"command:"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3918 ../fish/guestfish-actions.pod:3018
-msgid "'c'"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3897 ../fish/guestfish-actions.pod:2609
+#, no-wrap
+msgid ""
+" mke2fs -O journal_dev -b blocksize device\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:3020
-msgid "Char special"
+# type: =head2
+#: ../src/guestfs-actions.pod:3903
+msgid "guestfs_mke2journal_L"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:3022
-msgid "'d'"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3905
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_mke2journal_L (guestfs_h *g,\n"
+" int blocksize,\n"
+" const char *label,\n"
+" const char *device);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3924 ../fish/guestfish-actions.pod:3024
-msgid "Directory"
+#: ../src/guestfs-actions.pod:3911 ../fish/guestfish-actions.pod:2615
+msgid "This creates an ext2 external journal on C<device> with label C<label>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:3026
-msgid "'f'"
+# type: =head2
+#: ../src/guestfs-actions.pod:3917
+msgid "guestfs_mke2journal_U"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3928 ../fish/guestfish-actions.pod:3028
-msgid "FIFO (named pipe)"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:3930 ../fish/guestfish-actions.pod:3030
-msgid "'l'"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3919
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_mke2journal_U (guestfs_h *g,\n"
+" int blocksize,\n"
+" const char *uuid,\n"
+" const char *device);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3932 ../fish/guestfish-actions.pod:3032
-msgid "Symbolic link"
+#: ../src/guestfs-actions.pod:3925 ../fish/guestfish-actions.pod:2621
+msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3934 ../fish/guestfish-actions.pod:3034
-msgid "'r'"
+# type: =head2
+#: ../src/guestfs-actions.pod:3931
+msgid "guestfs_mkfifo"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:3036
-msgid "Regular file"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3933
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_mkfifo (guestfs_h *g,\n"
+" int mode,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:3038
-msgid "'s'"
+# type: textblock
+#: ../src/guestfs-actions.pod:3938
+msgid ""
+"This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
+"is just a convenient wrapper around C<guestfs_mknod>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3940 ../fish/guestfish-actions.pod:3040
-msgid "Socket"
+# type: =head2
+#: ../src/guestfs-actions.pod:3948
+msgid "guestfs_mkfs"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3942 ../fish/guestfish-actions.pod:3042
-msgid "'u'"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3950
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_mkfs (guestfs_h *g,\n"
+" const char *fstype,\n"
+" const char *device);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:3044
-msgid "Unknown file type"
+#: ../src/guestfs-actions.pod:3955 ../fish/guestfish-actions.pod:2637
+msgid ""
+"This creates a filesystem on C<device> (usually a partition or LVM logical "
+"volume). The filesystem type is C<fstype>, for example C<ext3>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3946 ../fish/guestfish-actions.pod:3046
-msgid "'?'"
+# type: =head2
+#: ../src/guestfs-actions.pod:3963
+msgid "guestfs_mkfs_b"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3948 ../fish/guestfish-actions.pod:3048
-msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
+# type: verbatim
+#: ../src/guestfs-actions.pod:3965
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_mkfs_b (guestfs_h *g,\n"
+" const char *fstype,\n"
+" int blocksize,\n"
+" const char *device);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3953
+#: ../src/guestfs-actions.pod:3971
msgid ""
-"This function is primarily intended for use by programs. To get a simple "
-"list of names, use C<guestfs_ls>. To get a printable directory for human "
-"consumption, use C<guestfs_ll>."
+"This call is similar to C<guestfs_mkfs>, but it allows you to control the "
+"block size of the resulting filesystem. Supported block sizes depend on the "
+"filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3957
+#: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2650
msgid ""
-"This function returns a C<struct guestfs_dirent_list *> (see "
-"E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
-"must call C<guestfs_free_dirent_list> after use>."
+"For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
+"cluster size."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:3962
-msgid "guestfs_readlink"
+#: ../src/guestfs-actions.pod:3983
+msgid "guestfs_mkmountpoint"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3964
+#: ../src/guestfs-actions.pod:3985
#, no-wrap
msgid ""
-" char *guestfs_readlink (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_mkmountpoint (guestfs_h *g,\n"
+" const char *exemptpath);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3967 ../fish/guestfish-actions.pod:3061
-msgid "This command reads the target of a symbolic link."
+#: ../src/guestfs-actions.pod:3989
+msgid ""
+"C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
+"that can be used to create extra mountpoints before mounting the first "
+"filesystem."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3972
-msgid "guestfs_readlinklist"
+# type: textblock
+#: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2661
+msgid ""
+"These calls are I<only> necessary in some very limited circumstances, mainly "
+"the case where you want to mount a mix of unrelated and/or read-only "
+"filesystems together."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:3997 ../fish/guestfish-actions.pod:2665
+msgid ""
+"For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
+"an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
+"inside that. You can unpack this as follows in guestfish:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:3974
+#: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2670
#, no-wrap
msgid ""
-" char **guestfs_readlinklist (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tchar *const *names);\n"
+" add-ro Fedora-11-i686-Live.iso\n"
+" run\n"
+" mkmountpoint /cd\n"
+" mkmountpoint /sqsh\n"
+" mkmountpoint /ext3fs\n"
+" mount /dev/sda /cd\n"
+" mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
+" mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:3067
-msgid ""
-"This call allows you to do a C<readlink> operation on multiple files, where "
-"all files are in the directory C<path>. C<names> is the list of files from "
-"this directory."
+#: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2679
+msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3982 ../fish/guestfish-actions.pod:3071
+#: ../src/guestfs-actions.pod:4013
msgid ""
-"On return you get a list of strings, with a one-to-one correspondence to the "
-"C<names> list. Each string is the value of the symbolic link."
+"C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
+"may get unexpected errors if you try to mix these calls. It is safest to "
+"manually unmount filesystems and remove mountpoints after use."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3986 ../fish/guestfish-actions.pod:3075
+#: ../src/guestfs-actions.pod:4017
msgid ""
-"If the C<readlink(2)> operation fails on any name, then the corresponding "
-"result string is the empty string C<\"\">. However the whole operation is "
-"completed even if there were C<readlink(2)> errors, and so you can call this "
-"function with names where you don't know if they are symbolic links already "
-"(albeit slightly less efficient)."
+"C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
+"first, so for this to work for manual mountpoints, you must ensure that the "
+"innermost mountpoints have the longest pathnames, as in the example code "
+"above."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:3082
-msgid ""
-"This call is intended for programs that want to efficiently list a directory "
-"contents without making many round-trips. Very long directory listings "
-"might cause the protocol message size to be exceeded, causing this call to "
-"fail. The caller must split up such requests into smaller groups of names."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:4004
-msgid "guestfs_realpath"
+#: ../src/guestfs-actions.pod:4022 ../fish/guestfish-actions.pod:2690
+msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4006
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:4024
msgid ""
-" char *guestfs_realpath (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
+"means that C<guestfs_umount_all> is called when the handle is closed which "
+"can also trigger these issues."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4009 ../fish/guestfish-actions.pod:3093
-msgid ""
-"Return the canonicalized absolute pathname of C<path>. The returned path "
-"has no C<.>, C<..> or symbolic link path elements."
+#: ../src/guestfs-actions.pod:4030 ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:5182
+msgid "(Added in 1.0.62)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4015
-msgid "guestfs_removexattr"
+#: ../src/guestfs-actions.pod:4032
+msgid "guestfs_mknod"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4017
+#: ../src/guestfs-actions.pod:4034
#, no-wrap
msgid ""
-" int guestfs_removexattr (guestfs_h *g,\n"
-"\t\tconst char *xattr,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_mknod (guestfs_h *g,\n"
+" int mode,\n"
+" int devmajor,\n"
+" int devminor,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4021 ../fish/guestfish-actions.pod:3100
-msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
+#: ../src/guestfs-actions.pod:4041 ../fish/guestfish-actions.pod:2700
+msgid ""
+"This call creates block or character special devices, or named pipes "
+"(FIFOs)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4024
-msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
+#: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2703
+msgid ""
+"The C<mode> parameter should be the mode, using the standard constants. "
+"C<devmajor> and C<devminor> are the device major and minor numbers, only "
+"used when creating block and character special devices."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4049
+msgid ""
+"Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
+"S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
+"regular file). These constants are available in the standard Linux header "
+"files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
+"C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
+"the appropriate constant for you."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4028
-msgid "guestfs_resize2fs"
+#: ../src/guestfs-actions.pod:4063
+msgid "guestfs_mknod_b"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4030
+#: ../src/guestfs-actions.pod:4065
#, no-wrap
msgid ""
-" int guestfs_resize2fs (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_mknod_b (guestfs_h *g,\n"
+" int mode,\n"
+" int devmajor,\n"
+" int devminor,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4033 ../fish/guestfish-actions.pod:3109
+#: ../src/guestfs-actions.pod:4072
msgid ""
-"This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
-"underlying device."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4036
-msgid ""
-"I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
-"C<device> before calling this command. For unknown reasons C<resize2fs> "
-"sometimes gives an error about this and sometimes not. In any case, it is "
-"always safe to call C<guestfs_e2fsck_f> before calling this function."
+"This call creates a block device node called C<path> with mode C<mode> and "
+"device major/minor C<devmajor> and C<devminor>. It is just a convenient "
+"wrapper around C<guestfs_mknod>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4044
-msgid "guestfs_resize2fs_size"
+#: ../src/guestfs-actions.pod:4082
+msgid "guestfs_mknod_c"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4046
+#: ../src/guestfs-actions.pod:4084
#, no-wrap
msgid ""
-" int guestfs_resize2fs_size (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint64_t size);\n"
+" int\n"
+" guestfs_mknod_c (guestfs_h *g,\n"
+" int mode,\n"
+" int devmajor,\n"
+" int devminor,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4050
+#: ../src/guestfs-actions.pod:4091
msgid ""
-"This command is the same as C<guestfs_resize2fs> except that it allows you "
-"to specify the new size (in bytes) explicitly."
+"This call creates a char device node called C<path> with mode C<mode> and "
+"device major/minor C<devmajor> and C<devminor>. It is just a convenient "
+"wrapper around C<guestfs_mknod>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4055
-msgid "guestfs_rm"
+#: ../src/guestfs-actions.pod:4101
+msgid "guestfs_mkswap"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4057
+#: ../src/guestfs-actions.pod:4103
#, no-wrap
msgid ""
-" int guestfs_rm (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_mkswap (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4060 ../fish/guestfish-actions.pod:3129
-msgid "Remove the single file C<path>."
+#: ../src/guestfs-actions.pod:4107 ../fish/guestfish-actions.pod:2742
+msgid "Create a swap partition on C<device>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4064
-msgid "guestfs_rm_rf"
+#: ../src/guestfs-actions.pod:4113
+msgid "guestfs_mkswap_L"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4066
+#: ../src/guestfs-actions.pod:4115
#, no-wrap
msgid ""
-" int guestfs_rm_rf (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_mkswap_L (guestfs_h *g,\n"
+" const char *label,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:3135
+#: ../src/guestfs-actions.pod:4120 ../fish/guestfish-actions.pod:2748
+msgid "Create a swap partition on C<device> with label C<label>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4122 ../fish/guestfish-actions.pod:2750
msgid ""
-"Remove the file or directory C<path>, recursively removing the contents if "
-"its a directory. This is like the C<rm -rf> shell command."
+"Note that you cannot attach a swap label to a block device "
+"(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
+"the kernel or swap tools."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4075
-msgid "guestfs_rmdir"
+#: ../src/guestfs-actions.pod:4130
+msgid "guestfs_mkswap_U"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4077
+#: ../src/guestfs-actions.pod:4132
#, no-wrap
msgid ""
-" int guestfs_rmdir (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_mkswap_U (guestfs_h *g,\n"
+" const char *uuid,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4080 ../fish/guestfish-actions.pod:3143
-msgid "Remove the single directory C<path>."
+#: ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:2758
+msgid "Create a swap partition on C<device> with UUID C<uuid>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4084
-msgid "guestfs_rmmountpoint"
+#: ../src/guestfs-actions.pod:4143
+msgid "guestfs_mkswap_file"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4086
+#: ../src/guestfs-actions.pod:4145
#, no-wrap
msgid ""
-" int guestfs_rmmountpoint (guestfs_h *g,\n"
-"\t\tconst char *exemptpath);\n"
+" int\n"
+" guestfs_mkswap_file (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4089
+#: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2764
+msgid "Create a swap file."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4151
msgid ""
-"This calls removes a mountpoint that was previously created with "
-"C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
+"This command just writes a swap file signature to an existing file. To "
+"create the file itself, use something like C<guestfs_fallocate>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4095
-msgid "guestfs_scrub_device"
+#: ../src/guestfs-actions.pod:4158
+msgid "guestfs_modprobe"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4097
+#: ../src/guestfs-actions.pod:4160
#, no-wrap
msgid ""
-" int guestfs_scrub_device (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_modprobe (guestfs_h *g,\n"
+" const char *modulename);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:3157
-msgid ""
-"This command writes patterns over C<device> to make data retrieval more "
-"difficult."
+#: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2773
+msgid "This loads a kernel module in the appliance."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4137 ../fish/guestfish-actions.pod:3160 ../fish/guestfish-actions.pod:3175 ../fish/guestfish-actions.pod:3188
+#: ../src/guestfs-actions.pod:4166 ../fish/guestfish-actions.pod:2775
msgid ""
-"It is an interface to the L<scrub(1)> program. See that manual page for "
-"more details."
+"The kernel module must have been whitelisted when libguestfs was built (see "
+"C<appliance/kmod.whitelist.in> in the source)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4111
-msgid "guestfs_scrub_file"
+#: ../src/guestfs-actions.pod:4173
+msgid "guestfs_mount"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4113
+#: ../src/guestfs-actions.pod:4175
#, no-wrap
msgid ""
-" int guestfs_scrub_file (guestfs_h *g,\n"
-"\t\tconst char *file);\n"
+" int\n"
+" guestfs_mount (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *mountpoint);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:3170
+#: ../src/guestfs-actions.pod:4180 ../fish/guestfish-actions.pod:2782
msgid ""
-"This command writes patterns over a file to make data retrieval more "
-"difficult."
+"Mount a guest disk at a position in the filesystem. Block devices are named "
+"C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
+"those block devices contain partitions, they will have the usual names "
+"(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:3173
-msgid "The file is I<removed> after scrubbing."
+#: ../src/guestfs-actions.pod:4186 ../fish/guestfish-actions.pod:2788
+msgid ""
+"The rules are the same as for L<mount(2)>: A filesystem must first be "
+"mounted on C</> before others can be mounted. Other filesystems can only be "
+"mounted on directories which already exist."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4191 ../fish/guestfish-actions.pod:2793
+msgid ""
+"The mounted filesystem is writable, if we have sufficient permissions on the "
+"underlying device."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4194
+msgid ""
+"B<Important note:> When you use this call, the filesystem options C<sync> "
+"and C<noatime> are set implicitly. This was originally done because we "
+"thought it would improve reliability, but it turns out that I<-o sync> has a "
+"very large negative performance impact and negligible effect on "
+"reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
+"in any code that needs performance, and instead use C<guestfs_mount_options> "
+"(use an empty string for the first parameter if you don't want any options)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4126
-msgid "guestfs_scrub_freespace"
+#: ../src/guestfs-actions.pod:4208
+msgid "guestfs_mount_loop"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4128
+#: ../src/guestfs-actions.pod:4210
#, no-wrap
msgid ""
-" int guestfs_scrub_freespace (guestfs_h *g,\n"
-"\t\tconst char *dir);\n"
+" int\n"
+" guestfs_mount_loop (guestfs_h *g,\n"
+" const char *file,\n"
+" const char *mountpoint);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4131
+#: ../src/guestfs-actions.pod:4215 ../fish/guestfish-actions.pod:2810
msgid ""
-"This command creates the directory C<dir> and then fills it with files until "
-"the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
-"and deletes them. The intention is to scrub any free space on the partition "
-"containing C<dir>."
+"This command lets you mount C<file> (a filesystem image in a file) on a "
+"mount point. It is entirely equivalent to the command C<mount -o loop file "
+"mountpoint>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4142
-msgid "guestfs_set_append"
+#: ../src/guestfs-actions.pod:4223
+msgid "guestfs_mount_options"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4144
+#: ../src/guestfs-actions.pod:4225
#, no-wrap
msgid ""
-" int guestfs_set_append (guestfs_h *g,\n"
-"\t\tconst char *append);\n"
+" int\n"
+" guestfs_mount_options (guestfs_h *g,\n"
+" const char *options,\n"
+" const char *device,\n"
+" const char *mountpoint);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4147 ../fish/guestfish-actions.pod:3195
+#: ../src/guestfs-actions.pod:4231
msgid ""
-"This function is used to add additional options to the guest kernel command "
-"line."
+"This is the same as the C<guestfs_mount> command, but it allows you to set "
+"the mount options as for the L<mount(8)> I<-o> flag."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:3198
+#: ../src/guestfs-actions.pod:4235 ../fish/guestfish-actions.pod:2822
msgid ""
-"The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
-"environment variable."
+"If the C<options> parameter is an empty string, then no options are passed "
+"(all options default to whatever the filesystem uses)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4153 ../fish/guestfish-actions.pod:3201
-msgid ""
-"Setting C<append> to C<NULL> means I<no> additional options are passed "
-"(libguestfs always adds a few of its own)."
+#: ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4255 ../src/guestfs-actions.pod:4272
+msgid "(Added in 1.0.10)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4158
-msgid "guestfs_set_autosync"
+#: ../src/guestfs-actions.pod:4243
+msgid "guestfs_mount_ro"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4160
+#: ../src/guestfs-actions.pod:4245
#, no-wrap
msgid ""
-" int guestfs_set_autosync (guestfs_h *g,\n"
-"\t\tint autosync);\n"
+" int\n"
+" guestfs_mount_ro (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *mountpoint);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4163
-msgid ""
-"If C<autosync> is true, this enables autosync. Libguestfs will make a best "
-"effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
-"the handle is closed (also if the program exits without closing handles)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4168 ../fish/guestfish-actions.pod:3213
+#: ../src/guestfs-actions.pod:4250
msgid ""
-"This is disabled by default (except in guestfish where it is enabled by "
-"default)."
+"This is the same as the C<guestfs_mount> command, but it mounts the "
+"filesystem with the read-only (I<-o ro>) flag."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4173
-msgid "guestfs_set_direct"
+#: ../src/guestfs-actions.pod:4257
+msgid "guestfs_mount_vfs"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4175
+#: ../src/guestfs-actions.pod:4259
#, no-wrap
msgid ""
-" int guestfs_set_direct (guestfs_h *g,\n"
-"\t\tint direct);\n"
+" int\n"
+" guestfs_mount_vfs (guestfs_h *g,\n"
+" const char *options,\n"
+" const char *vfstype,\n"
+" const char *device,\n"
+" const char *mountpoint);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:3220
-msgid ""
-"If the direct appliance mode flag is enabled, then stdin and stdout are "
-"passed directly through to the appliance once it is launched."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4182
+#: ../src/guestfs-actions.pod:4266
msgid ""
-"One consequence of this is that log messages aren't caught by the library "
-"and handled by C<guestfs_set_log_message_callback>, but go straight to "
-"stdout."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4186 ../fish/guestfish-actions.pod:3228
-msgid "You probably don't want to use this unless you know what you are doing."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4189 ../fish/guestfish-actions.pod:3231
-msgid "The default is disabled."
+"This is the same as the C<guestfs_mount> command, but it allows you to set "
+"both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
+"I<-t> flags."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4193
-msgid "guestfs_set_e2label"
+#: ../src/guestfs-actions.pod:4274
+msgid "guestfs_mountpoints"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4195
+#: ../src/guestfs-actions.pod:4276
#, no-wrap
msgid ""
-" int guestfs_set_e2label (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *label);\n"
+" char **\n"
+" guestfs_mountpoints (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4199 ../fish/guestfish-actions.pod:3237
-msgid ""
-"This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
-"C<label>. Filesystem labels are limited to 16 characters."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4203
+#: ../src/guestfs-actions.pod:4279
msgid ""
-"You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
-"the existing label on a filesystem."
+"This call is similar to C<guestfs_mounts>. That call returns a list of "
+"devices. This one returns a hash table (map) of device name to directory "
+"where the device is mounted."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4208
-msgid "guestfs_set_e2uuid"
+#: ../src/guestfs-actions.pod:4291
+msgid "guestfs_mounts"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4210
+#: ../src/guestfs-actions.pod:4293
#, no-wrap
msgid ""
-" int guestfs_set_e2uuid (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *uuid);\n"
+" char **\n"
+" guestfs_mounts (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:3248
+#: ../src/guestfs-actions.pod:4296 ../fish/guestfish-actions.pod:2853
msgid ""
-"This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
-"C<uuid>. The format of the UUID and alternatives such as C<clear>, "
-"C<random> and C<time> are described in the L<tune2fs(8)> manpage."
+"This returns the list of currently mounted filesystems. It returns the list "
+"of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4219
-msgid ""
-"You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
-"the existing UUID of a filesystem."
+#: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2856
+msgid "Some internal mounts are not shown."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4301
+msgid "See also: C<guestfs_mountpoints>"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4224
-msgid "guestfs_set_memsize"
+#: ../src/guestfs-actions.pod:4309
+msgid "guestfs_mv"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4226
+#: ../src/guestfs-actions.pod:4311
#, no-wrap
msgid ""
-" int guestfs_set_memsize (guestfs_h *g,\n"
-"\t\tint memsize);\n"
+" int\n"
+" guestfs_mv (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4229
-msgid ""
-"This sets the memory size in megabytes allocated to the qemu subprocess. "
-"This only has any effect if called before C<guestfs_launch>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4233 ../fish/guestfish-actions.pod:3264
+#: ../src/guestfs-actions.pod:4316 ../fish/guestfish-actions.pod:2864
msgid ""
-"You can also change this by setting the environment variable "
-"C<LIBGUESTFS_MEMSIZE> before the handle is created."
+"This moves a file from C<src> to C<dest> where C<dest> is either a "
+"destination filename or destination directory."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4242
-msgid "guestfs_set_network"
+#: ../src/guestfs-actions.pod:4323
+msgid "guestfs_ntfs_3g_probe"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4244
+#: ../src/guestfs-actions.pod:4325
#, no-wrap
msgid ""
-" int guestfs_set_network (guestfs_h *g,\n"
-"\t\tint network);\n"
+" int\n"
+" guestfs_ntfs_3g_probe (guestfs_h *g,\n"
+" int rw,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4247 ../fish/guestfish-actions.pod:3275
+#: ../src/guestfs-actions.pod:4330 ../fish/guestfish-actions.pod:2871
msgid ""
-"If C<network> is true, then the network is enabled in the libguestfs "
-"appliance. The default is false."
+"This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
+"C<device> for mountability. (Not all NTFS volumes can be mounted "
+"read-write, and some cannot be mounted at all)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4250 ../fish/guestfish-actions.pod:3278
+#: ../src/guestfs-actions.pod:4334 ../fish/guestfish-actions.pod:2875
msgid ""
-"This affects whether commands are able to access the network (see "
-"L<guestfs(3)/RUNNING COMMANDS>)."
+"C<rw> is a boolean flag. Set it to true if you want to test if the volume "
+"can be mounted read-write. Set it to false if you want to test if the "
+"volume can be mounted read-only."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4253
+#: ../src/guestfs-actions.pod:4338 ../fish/guestfish-actions.pod:2879
msgid ""
-"You must call this before calling C<guestfs_launch>, otherwise it has no "
-"effect."
+"The return value is an integer which C<0> if the operation would succeed, or "
+"some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4344
+msgid "(Added in 1.0.43)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4258
-msgid "guestfs_set_path"
+#: ../src/guestfs-actions.pod:4346
+msgid "guestfs_ntfsresize"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4260
+#: ../src/guestfs-actions.pod:4348
#, no-wrap
msgid ""
-" int guestfs_set_path (guestfs_h *g,\n"
-"\t\tconst char *searchpath);\n"
+" int\n"
+" guestfs_ntfsresize (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4263 ../fish/guestfish-actions.pod:3288
-msgid "Set the path that libguestfs searches for kernel and initrd.img."
+#: ../src/guestfs-actions.pod:4352 ../fish/guestfish-actions.pod:2887
+msgid ""
+"This command resizes an NTFS filesystem, expanding or shrinking it to the "
+"size of the underlying device. See also L<ntfsresize(8)>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:4360
+msgid "guestfs_ntfsresize_size"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:4362
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_ntfsresize_size (guestfs_h *g,\n"
+" const char *device,\n"
+" int64_t size);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:3290
+#: ../src/guestfs-actions.pod:4367
msgid ""
-"The default is C<$libdir/guestfs> unless overridden by setting "
-"C<LIBGUESTFS_PATH> environment variable."
+"This command is the same as C<guestfs_ntfsresize> except that it allows you "
+"to specify the new size (in bytes) explicitly."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:3293
-msgid "Setting C<path> to C<NULL> restores the default path."
+#: ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4808 ../src/guestfs-actions.pod:4881 ../src/guestfs-actions.pod:5130
+msgid "(Added in 1.3.14)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4272
-msgid "guestfs_set_qemu"
+#: ../src/guestfs-actions.pod:4374
+msgid "guestfs_part_add"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4274
+#: ../src/guestfs-actions.pod:4376
#, no-wrap
msgid ""
-" int guestfs_set_qemu (guestfs_h *g,\n"
-"\t\tconst char *qemu);\n"
+" int\n"
+" guestfs_part_add (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *prlogex,\n"
+" int64_t startsect,\n"
+" int64_t endsect);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4277 ../fish/guestfish-actions.pod:3299
-msgid "Set the qemu binary that we will use."
+#: ../src/guestfs-actions.pod:4383
+msgid ""
+"This command adds a partition to C<device>. If there is no partition table "
+"on the device, call C<guestfs_part_init> first."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4279 ../fish/guestfish-actions.pod:3301
-msgid "The default is chosen when the library was compiled by the configure script."
+#: ../src/guestfs-actions.pod:4386 ../fish/guestfish-actions.pod:2905
+msgid ""
+"The C<prlogex> parameter is the type of partition. Normally you should pass "
+"C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
+"C<logical>) and C<e> (or C<extended>) partition types."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:3304
+#: ../src/guestfs-actions.pod:4391 ../fish/guestfish-actions.pod:2910
msgid ""
-"You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
-"variable."
+"C<startsect> and C<endsect> are the start and end of the partition in "
+"I<sectors>. C<endsect> may be negative, which means it counts backwards "
+"from the end of the disk (C<-1> is the last sector)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4285 ../fish/guestfish-actions.pod:3307
-msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
+#: ../src/guestfs-actions.pod:4395
+msgid ""
+"Creating a partition which covers the whole disk is not so easy. Use "
+"C<guestfs_part_disk> to do that."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4287 ../fish/guestfish-actions.pod:3309
-msgid ""
-"Note that you should call this function as early as possible after creating "
-"the handle. This is because some pre-launch operations depend on testing "
-"qemu features (by running C<qemu -help>). If the qemu binary changes, we "
-"don't retest features, and so you might see inconsistent results. Using the "
-"environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
-"the qemu binary at the same time as the handle is created."
+#: ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4569 ../src/guestfs-actions.pod:4607 ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4666
+msgid "(Added in 1.0.78)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4297
-msgid "guestfs_set_recovery_proc"
+#: ../src/guestfs-actions.pod:4402
+msgid "guestfs_part_del"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4299
+#: ../src/guestfs-actions.pod:4404
#, no-wrap
msgid ""
-" int guestfs_set_recovery_proc (guestfs_h *g,\n"
-"\t\tint recoveryproc);\n"
+" int\n"
+" guestfs_part_del (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4302
-msgid ""
-"If this is called with the parameter C<false> then C<guestfs_launch> does "
-"not create a recovery process. The purpose of the recovery process is to "
-"stop runaway qemu processes in the case where the main program aborts "
-"abruptly."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4307
-msgid ""
-"This only has any effect if called before C<guestfs_launch>, and the default "
-"is true."
+#: ../src/guestfs-actions.pod:4409 ../fish/guestfish-actions.pod:2921
+msgid "This command deletes the partition numbered C<partnum> on C<device>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4310 ../fish/guestfish-actions.pod:3329
+#: ../src/guestfs-actions.pod:4411 ../fish/guestfish-actions.pod:2923
msgid ""
-"About the only time when you would want to disable this is if the main "
-"process will fork itself into the background (\"daemonize\" itself). In "
-"this case the recovery process thinks that the main program has disappeared "
-"and so kills qemu, which is not very helpful."
+"Note that in the case of MBR partitioning, deleting an extended partition "
+"also deletes any logical partitions it contains."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4318
-msgid "guestfs_set_selinux"
+#: ../src/guestfs-actions.pod:4419
+msgid "guestfs_part_disk"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4320
+#: ../src/guestfs-actions.pod:4421
#, no-wrap
msgid ""
-" int guestfs_set_selinux (guestfs_h *g,\n"
-"\t\tint selinux);\n"
+" int\n"
+" guestfs_part_disk (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *parttype);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:3339
+#: ../src/guestfs-actions.pod:4426
msgid ""
-"This sets the selinux flag that is passed to the appliance at boot time. "
-"The default is C<selinux=0> (disabled)."
+"This command is simply a combination of C<guestfs_part_init> followed by "
+"C<guestfs_part_add> to create a single primary partition covering the whole "
+"disk."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4326 ../fish/guestfish-actions.pod:3342
+#: ../src/guestfs-actions.pod:4430
msgid ""
-"Note that if SELinux is enabled, it is always in Permissive mode "
-"(C<enforcing=0>)."
+"C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
+"possible values are described in C<guestfs_part_init>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4334
-msgid "guestfs_set_trace"
+#: ../src/guestfs-actions.pod:4440
+msgid "guestfs_part_get_bootable"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4336
+#: ../src/guestfs-actions.pod:4442
#, no-wrap
msgid ""
-" int guestfs_set_trace (guestfs_h *g,\n"
-"\t\tint trace);\n"
+" int\n"
+" guestfs_part_get_bootable (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:3352
-msgid ""
-"If the command trace flag is set to 1, then commands are printed on stderr "
-"before they are executed in a format which is very similar to the one used "
-"by guestfish. In other words, you can run a program with this enabled, and "
-"you will get out a script which you can feed to guestfish to perform the "
-"same set of actions."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4346 ../fish/guestfish-actions.pod:3359
+#: ../src/guestfs-actions.pod:4447 ../fish/guestfish-actions.pod:2945
msgid ""
-"If you want to trace C API calls into libguestfs (and other libraries) then "
-"possibly a better way is to use the external ltrace(1) command."
+"This command returns true if the partition C<partnum> on C<device> has the "
+"bootable flag set."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4350 ../fish/guestfish-actions.pod:3363
-msgid ""
-"Command traces are disabled unless the environment variable "
-"C<LIBGUESTFS_TRACE> is defined and set to C<1>."
+#: ../src/guestfs-actions.pod:4450
+msgid "See also C<guestfs_part_set_bootable>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4355
-msgid "guestfs_set_verbose"
+#: ../src/guestfs-actions.pod:4456
+msgid "guestfs_part_get_mbr_id"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4357
+#: ../src/guestfs-actions.pod:4458
#, no-wrap
msgid ""
-" int guestfs_set_verbose (guestfs_h *g,\n"
-"\t\tint verbose);\n"
+" int\n"
+" guestfs_part_get_mbr_id (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4360 ../fish/guestfish-actions.pod:3370
-msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
+#: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2954
+msgid ""
+"Returns the MBR type byte (also known as the ID byte) from the numbered "
+"partition C<partnum>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:3372
+#: ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4642
msgid ""
-"Verbose messages are disabled unless the environment variable "
-"C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
+"Note that only MBR (old DOS-style) partitions have type bytes. You will get "
+"undefined results for other partition table types (see "
+"C<guestfs_part_get_parttype>)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4367
-msgid "guestfs_setcon"
+#: ../src/guestfs-actions.pod:4474
+msgid "guestfs_part_get_parttype"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4369
+#: ../src/guestfs-actions.pod:4476
#, no-wrap
msgid ""
-" int guestfs_setcon (guestfs_h *g,\n"
-"\t\tconst char *context);\n"
+" char *\n"
+" guestfs_part_get_parttype (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:3379
+#: ../src/guestfs-actions.pod:4480 ../fish/guestfish-actions.pod:2965
msgid ""
-"This sets the SELinux security context of the daemon to the string "
-"C<context>."
+"This command examines the partition table on C<device> and returns the "
+"partition table type (format) being used."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4375 ../fish/guestfish-actions.pod:3382
-msgid "See the documentation about SELINUX in L<guestfs(3)>."
+#: ../src/guestfs-actions.pod:4483
+msgid ""
+"Common return values include: C<msdos> (a DOS/Windows style MBR partition "
+"table), C<gpt> (a GPT/EFI-style partition table). Other values are "
+"possible, although unusual. See C<guestfs_part_init> for a full list."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4379
-msgid "guestfs_setxattr"
+#: ../src/guestfs-actions.pod:4493
+msgid "guestfs_part_init"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4381
+#: ../src/guestfs-actions.pod:4495
#, no-wrap
msgid ""
-" int guestfs_setxattr (guestfs_h *g,\n"
-"\t\tconst char *xattr,\n"
-"\t\tconst char *val,\n"
-"\t\tint vallen,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_part_init (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *parttype);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4387 ../fish/guestfish-actions.pod:3388
+#: ../src/guestfs-actions.pod:4500 ../fish/guestfish-actions.pod:2977
msgid ""
-"This call sets the extended attribute named C<xattr> of the file C<path> to "
-"the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
+"This creates an empty partition table on C<device> of one of the partition "
+"types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
+"(for large disks)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4391
-msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:4395
-msgid "guestfs_sfdisk"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:4397
-#, no-wrap
+#: ../src/guestfs-actions.pod:4504
msgid ""
-" int guestfs_sfdisk (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint cyls,\n"
-"\t\tint heads,\n"
-"\t\tint sectors,\n"
-"\t\tchar *const *lines);\n"
-"\n"
+"Initially there are no partitions. Following this, you should call "
+"C<guestfs_part_add> for each partition required."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4404 ../fish/guestfish-actions.pod:3398
-msgid ""
-"This is a direct interface to the L<sfdisk(8)> program for creating "
-"partitions on block devices."
+#: ../src/guestfs-actions.pod:4507 ../fish/guestfish-actions.pod:2984
+msgid "Possible values for C<parttype> are:"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4511 ../fish/guestfish-actions.pod:2988
+msgid "B<efi> | B<gpt>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4407 ../fish/guestfish-actions.pod:3401
-msgid "C<device> should be a block device, for example C</dev/sda>."
+#: ../src/guestfs-actions.pod:4513 ../fish/guestfish-actions.pod:2990
+msgid "Intel EFI / GPT partition table."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4409 ../fish/guestfish-actions.pod:3403
+#: ../src/guestfs-actions.pod:4515 ../fish/guestfish-actions.pod:2992
msgid ""
-"C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
-"sectors on the device, which are passed directly to sfdisk as the I<-C>, "
-"I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
-"corresponding parameter is omitted. Usually for 'large' disks, you can just "
-"pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
-"the kernel) cannot work out the right geometry and you will need to tell it."
+"This is recommended for >= 2 TB partitions that will be accessed from Linux "
+"and Intel-based Mac OS X. It also has limited backwards compatibility with "
+"the C<mbr> format."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:2996
+msgid "B<mbr> | B<msdos>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4417 ../fish/guestfish-actions.pod:3411
+#: ../src/guestfs-actions.pod:4521 ../fish/guestfish-actions.pod:2998
msgid ""
-"C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
-"refer to the L<sfdisk(8)> manpage."
+"The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
+"Windows. This partition type will B<only> work for device sizes up to 2 "
+"TB. For large disks we recommend using C<gpt>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4420 ../fish/guestfish-actions.pod:3414
-msgid ""
-"To create a single partition occupying the whole disk, you would pass "
-"C<lines> as a single element list, when the single element being the string "
-"C<,> (comma)."
+#: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3005
+msgid "Other partition table types that may work but are not supported include:"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4533 ../fish/guestfish-actions.pod:3010
+msgid "B<aix>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4424
-msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
+#: ../src/guestfs-actions.pod:4535 ../fish/guestfish-actions.pod:3012
+msgid "AIX disk labels."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4432
-msgid "guestfs_sfdiskM"
+# type: =item
+#: ../src/guestfs-actions.pod:4537 ../fish/guestfish-actions.pod:3014
+msgid "B<amiga> | B<rdb>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4434
-#, no-wrap
-msgid ""
-" int guestfs_sfdiskM (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tchar *const *lines);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:4539 ../fish/guestfish-actions.pod:3016
+msgid "Amiga \"Rigid Disk Block\" format."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3018
+msgid "B<bsd>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4438
-msgid ""
-"This is a simplified interface to the C<guestfs_sfdisk> command, where "
-"partition sizes are specified in megabytes only (rounded to the nearest "
-"cylinder) and you don't need to specify the cyls, heads and sectors "
-"parameters which were rarely if ever used anyway."
+#: ../src/guestfs-actions.pod:4543 ../fish/guestfish-actions.pod:3020
+msgid "BSD disk labels."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4545 ../fish/guestfish-actions.pod:3022
+msgid "B<dasd>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4444
-msgid ""
-"See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
-"C<guestfs_part_disk>"
+#: ../src/guestfs-actions.pod:4547 ../fish/guestfish-actions.pod:3024
+msgid "DASD, used on IBM mainframes."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4452
-msgid "guestfs_sfdisk_N"
+# type: =item
+#: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3026
+msgid "B<dvh>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4454
-#, no-wrap
-msgid ""
-" int guestfs_sfdisk_N (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum,\n"
-"\t\tint cyls,\n"
-"\t\tint heads,\n"
-"\t\tint sectors,\n"
-"\t\tconst char *line);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3028
+msgid "MIPS/SGI volumes."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3030
+msgid "B<mac>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:3444
-msgid ""
-"This runs L<sfdisk(8)> option to modify just the single partition C<n> "
-"(note: C<n> counts from 1)."
+#: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3032
+msgid "Old Mac partition format. Modern Macs use C<gpt>."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4557 ../fish/guestfish-actions.pod:3034
+msgid "B<pc98>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4465
-msgid ""
-"For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
-"for the cyls/heads/sectors parameters."
+#: ../src/guestfs-actions.pod:4559 ../fish/guestfish-actions.pod:3036
+msgid "NEC PC-98 format, common in Japan apparently."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4561 ../fish/guestfish-actions.pod:3038
+msgid "B<sun>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4468
-msgid "See also: C<guestfs_part_add>"
+#: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3040
+msgid "Sun disk labels."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4475
-msgid "guestfs_sfdisk_disk_geometry"
+#: ../src/guestfs-actions.pod:4571
+msgid "guestfs_part_list"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4477
+#: ../src/guestfs-actions.pod:4573
#, no-wrap
msgid ""
-" char *guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" struct guestfs_partition_list *\n"
+" guestfs_part_list (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4480
+#: ../src/guestfs-actions.pod:4577 ../fish/guestfish-actions.pod:3048
msgid ""
-"This displays the disk geometry of C<device> read from the partition table. "
-"Especially in the case where the underlying block device has been resized, "
-"this can be different from the kernel's idea of the geometry (see "
-"C<guestfs_sfdisk_kernel_geometry>)."
+"This command parses the partition table on C<device> and returns the list of "
+"partitions found."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4485 ../src/guestfs-actions.pod:4498 ../fish/guestfish-actions.pod:3464 ../fish/guestfish-actions.pod:3473
-msgid "The result is in human-readable format, and not designed to be parsed."
+#: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3051
+msgid "The fields in the returned structure are:"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4491
-msgid "guestfs_sfdisk_kernel_geometry"
+# type: =item
+#: ../src/guestfs-actions.pod:4584 ../fish/guestfish-actions.pod:3055
+msgid "B<part_num>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4493
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:4586 ../fish/guestfish-actions.pod:3057
+msgid "Partition number, counting from 1."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4588 ../fish/guestfish-actions.pod:3059
+msgid "B<part_start>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4590
msgid ""
-" char *guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+"Start of the partition I<in bytes>. To get sectors you have to divide by "
+"the device's sector size, see C<guestfs_blockdev_getss>."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4593 ../fish/guestfish-actions.pod:3064
+msgid "B<part_end>"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4496 ../fish/guestfish-actions.pod:3471
-msgid "This displays the kernel's idea of the geometry of C<device>."
+#: ../src/guestfs-actions.pod:4595 ../fish/guestfish-actions.pod:3066
+msgid "End of the partition in bytes."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3068
+msgid "B<part_size>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4599 ../fish/guestfish-actions.pod:3070
+msgid "Size of the partition in bytes."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4603
+msgid ""
+"This function returns a C<struct guestfs_partition_list *>, or NULL if there "
+"was an error. I<The caller must call C<guestfs_free_partition_list> after "
+"use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4504
-msgid "guestfs_sfdisk_l"
+#: ../src/guestfs-actions.pod:4609
+msgid "guestfs_part_set_bootable"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4506
+#: ../src/guestfs-actions.pod:4611
#, no-wrap
msgid ""
-" char *guestfs_sfdisk_l (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_part_set_bootable (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum,\n"
+" int bootable);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:3480
+#: ../src/guestfs-actions.pod:4617 ../fish/guestfish-actions.pod:3078
msgid ""
-"This displays the partition table on C<device>, in the human-readable output "
-"of the L<sfdisk(8)> command. It is not intended to be parsed."
+"This sets the bootable flag on partition numbered C<partnum> on device "
+"C<device>. Note that partitions are numbered from 1."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4513
-msgid "See also: C<guestfs_part_list>"
+#: ../src/guestfs-actions.pod:4620 ../fish/guestfish-actions.pod:3081
+msgid ""
+"The bootable flag is used by some operating systems (notably Windows) to "
+"determine which partition to boot from. It is by no means universally "
+"recognized."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4518
-msgid "guestfs_sh"
+#: ../src/guestfs-actions.pod:4628
+msgid "guestfs_part_set_mbr_id"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4520
+#: ../src/guestfs-actions.pod:4630
#, no-wrap
msgid ""
-" char *guestfs_sh (guestfs_h *g,\n"
-"\t\tconst char *command);\n"
+" int\n"
+" guestfs_part_set_mbr_id (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum,\n"
+" int idbyte);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4523 ../fish/guestfish-actions.pod:3490
+#: ../src/guestfs-actions.pod:4636 ../fish/guestfish-actions.pod:3089
msgid ""
-"This call runs a command from the guest filesystem via the guest's "
-"C</bin/sh>."
+"Sets the MBR type byte (also known as the ID byte) of the numbered partition "
+"C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
+"documentation are in fact hexadecimal numbers, but usually documented "
+"without any leading \"0x\" which might be confusing."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4526
-msgid "This is like C<guestfs_command>, but passes the command to:"
+# type: =head2
+#: ../src/guestfs-actions.pod:4650
+msgid "guestfs_part_set_name"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3495
+#: ../src/guestfs-actions.pod:4652
#, no-wrap
msgid ""
-" /bin/sh -c \"command\"\n"
+" int\n"
+" guestfs_part_set_name (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum,\n"
+" const char *name);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3497
+#: ../src/guestfs-actions.pod:4658 ../fish/guestfish-actions.pod:3103
msgid ""
-"Depending on the guest's shell, this usually results in wildcards being "
-"expanded, shell expressions being interpolated and so on."
+"This sets the partition name on partition numbered C<partnum> on device "
+"C<device>. Note that partitions are numbered from 1."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4534
-msgid "All the provisos about C<guestfs_command> apply to this call."
+#: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3106
+msgid ""
+"The partition name can only be set on certain types of partition table. "
+"This works on C<gpt> but not on C<mbr> partitions."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4539
-msgid "guestfs_sh_lines"
+#: ../src/guestfs-actions.pod:4668
+msgid "guestfs_part_to_dev"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4541
+#: ../src/guestfs-actions.pod:4670
#, no-wrap
msgid ""
-" char **guestfs_sh_lines (guestfs_h *g,\n"
-"\t\tconst char *command);\n"
+" char *\n"
+" guestfs_part_to_dev (guestfs_h *g,\n"
+" const char *partition);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4544
+#: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3113
msgid ""
-"This is the same as C<guestfs_sh>, but splits the result into a list of "
-"lines."
+"This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
+"partition number, returning the device name (eg. \"/dev/sdb\")."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4547
-msgid "See also: C<guestfs_command_lines>"
+#: ../src/guestfs-actions.pod:4678
+msgid ""
+"The named partition must exist, for example as a string returned from "
+"C<guestfs_list_partitions>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4553
-msgid "guestfs_sleep"
+#: ../src/guestfs-actions.pod:4686
+msgid "guestfs_ping_daemon"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4555
+#: ../src/guestfs-actions.pod:4688
#, no-wrap
msgid ""
-" int guestfs_sleep (guestfs_h *g,\n"
-"\t\tint secs);\n"
+" int\n"
+" guestfs_ping_daemon (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4558 ../fish/guestfish-actions.pod:3516
-msgid "Sleep for C<secs> seconds."
+#: ../src/guestfs-actions.pod:4691 ../fish/guestfish-actions.pod:3124
+msgid ""
+"This is a test probe into the guestfs daemon running inside the qemu "
+"subprocess. Calling this function checks that the daemon responds to the "
+"ping message, without affecting the daemon or attached block device(s) in "
+"any other way."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4562 ../src/guestfs-structs.pod:109
-msgid "guestfs_stat"
+#: ../src/guestfs-actions.pod:4700
+msgid "guestfs_pread"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4564
+#: ../src/guestfs-actions.pod:4702
#, no-wrap
msgid ""
-" struct guestfs_stat *guestfs_stat (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_pread (guestfs_h *g,\n"
+" const char *path,\n"
+" int count,\n"
+" int64_t offset,\n"
+" size_t *size_r);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4569 ../fish/guestfish-actions.pod:3524
-msgid "This is the same as the C<stat(2)> system call."
+#: ../src/guestfs-actions.pod:4709 ../fish/guestfish-actions.pod:3133
+msgid ""
+"This command lets you read part of a file. It reads C<count> bytes of the "
+"file, starting at C<offset>, from file C<path>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4712 ../src/guestfs-actions.pod:4738 ../fish/guestfish-actions.pod:3136 ../fish/guestfish-actions.pod:3151
+msgid ""
+"This may read fewer bytes than requested. For further details see the "
+"L<pread(2)> system call."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4715
+msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4575 ../src/guestfs-structs.pod:135
-msgid "guestfs_statvfs"
+#: ../src/guestfs-actions.pod:4726
+msgid "guestfs_pread_device"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4577
+#: ../src/guestfs-actions.pod:4728
#, no-wrap
msgid ""
-" struct guestfs_statvfs *guestfs_statvfs (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_pread_device (guestfs_h *g,\n"
+" const char *device,\n"
+" int count,\n"
+" int64_t offset,\n"
+" size_t *size_r);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3530
+#: ../src/guestfs-actions.pod:4735 ../fish/guestfish-actions.pod:3148
msgid ""
-"Returns file system statistics for any mounted file system. C<path> should "
-"be a file or directory in the mounted file system (typically it is the mount "
-"point itself, but it doesn't need to be)."
+"This command lets you read part of a file. It reads C<count> bytes of "
+"C<device>, starting at C<offset>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4584 ../fish/guestfish-actions.pod:3534
-msgid "This is the same as the C<statvfs(2)> system call."
+#: ../src/guestfs-actions.pod:4741
+msgid "See also C<guestfs_pread>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4586
-msgid ""
-"This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
-"error. I<The caller must call C<guestfs_free_statvfs> after use>."
+#: ../src/guestfs-actions.pod:4750
+msgid "(Added in 1.5.21)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4590
-msgid "guestfs_strings"
+#: ../src/guestfs-actions.pod:4752
+msgid "guestfs_pvcreate"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4592
+#: ../src/guestfs-actions.pod:4754
#, no-wrap
msgid ""
-" char **guestfs_strings (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_pvcreate (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4595 ../fish/guestfish-actions.pod:3540
+#: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3163
msgid ""
-"This runs the L<strings(1)> command on a file and returns the list of "
-"printable strings found."
+"This creates an LVM physical volume on the named C<device>, where C<device> "
+"should usually be a partition name such as C</dev/sda1>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4605
-msgid "guestfs_strings_e"
+#: ../src/guestfs-actions.pod:4766
+msgid "guestfs_pvremove"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4607
+#: ../src/guestfs-actions.pod:4768
#, no-wrap
msgid ""
-" char **guestfs_strings_e (guestfs_h *g,\n"
-"\t\tconst char *encoding,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_pvremove (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4611
+#: ../src/guestfs-actions.pod:4772 ../fish/guestfish-actions.pod:3171
msgid ""
-"This is like the C<guestfs_strings> command, but allows you to specify the "
-"encoding of strings that are looked for in the source file C<path>."
+"This wipes a physical volume C<device> so that LVM will no longer recognise "
+"it."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4615 ../fish/guestfish-actions.pod:3554
-msgid "Allowed encodings are:"
+#: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3174
+msgid ""
+"The implementation uses the C<pvremove> command which refuses to wipe "
+"physical volumes that contain any volume groups, so you have to remove those "
+"first."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:4619 ../fish/guestfish-actions.pod:3558
-msgid "s"
+# type: =head2
+#: ../src/guestfs-actions.pod:4783
+msgid "guestfs_pvresize"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4621
+# type: verbatim
+#: ../src/guestfs-actions.pod:4785
+#, no-wrap
msgid ""
-"Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
-"ISO-8859-X (this is what C<guestfs_strings> uses)."
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:4624 ../fish/guestfish-actions.pod:3563
-msgid "S"
+" int\n"
+" guestfs_pvresize (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3565
-msgid "Single 8-bit-byte characters."
+#: ../src/guestfs-actions.pod:4789 ../fish/guestfish-actions.pod:3182
+msgid ""
+"This resizes (expands or shrinks) an existing LVM physical volume to match "
+"the new size of the underlying device."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:4628 ../fish/guestfish-actions.pod:3567
-msgid "b"
+# type: =head2
+#: ../src/guestfs-actions.pod:4796
+msgid "guestfs_pvresize_size"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4630 ../fish/guestfish-actions.pod:3569
-msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:4633 ../fish/guestfish-actions.pod:3572
-msgid "l (lower case letter L)"
+# type: verbatim
+#: ../src/guestfs-actions.pod:4798
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_pvresize_size (guestfs_h *g,\n"
+" const char *device,\n"
+" int64_t size);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4635 ../fish/guestfish-actions.pod:3574
+#: ../src/guestfs-actions.pod:4803
msgid ""
-"16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
-"examining binaries in Windows guests."
+"This command is the same as C<guestfs_pvresize> except that it allows you to "
+"specify the new size (in bytes) explicitly."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:4638 ../fish/guestfish-actions.pod:3577
-msgid "B"
+# type: =head2
+#: ../src/guestfs-actions.pod:4810
+msgid "guestfs_pvs"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3579
-msgid "32-bit big endian such as UCS-4BE."
+# type: verbatim
+#: ../src/guestfs-actions.pod:4812
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_pvs (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:4642 ../fish/guestfish-actions.pod:3581
-msgid "L"
+# type: textblock
+#: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3196
+msgid ""
+"List all the physical volumes detected. This is the equivalent of the "
+"L<pvs(8)> command."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3583
-msgid "32-bit little endian such as UCS-4LE."
+#: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3199
+msgid ""
+"This returns a list of just the device names that contain PVs "
+"(eg. C</dev/sda2>)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3587
-msgid "The returned strings are transcoded to UTF-8."
+#: ../src/guestfs-actions.pod:4821
+msgid "See also C<guestfs_pvs_full>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4657
-msgid "guestfs_swapoff_device"
+#: ../src/guestfs-actions.pod:4829
+msgid "guestfs_pvs_full"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4659
+#: ../src/guestfs-actions.pod:4831
#, no-wrap
msgid ""
-" int guestfs_swapoff_device (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" struct guestfs_lvm_pv_list *\n"
+" guestfs_pvs_full (guestfs_h *g);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4662
+#: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3208
msgid ""
-"This command disables the libguestfs appliance swap device or partition "
-"named C<device>. See C<guestfs_swapon_device>."
+"List all the physical volumes detected. This is the equivalent of the "
+"L<pvs(8)> command. The \"full\" version includes all fields."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:4837
+msgid ""
+"This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
+"was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
+"use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4668
-msgid "guestfs_swapoff_file"
+#: ../src/guestfs-actions.pod:4843
+msgid "guestfs_pvuuid"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4670
+#: ../src/guestfs-actions.pod:4845
#, no-wrap
msgid ""
-" int guestfs_swapoff_file (guestfs_h *g,\n"
-"\t\tconst char *file);\n"
+" char *\n"
+" guestfs_pvuuid (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3604
-msgid "This command disables the libguestfs appliance swap on file."
+#: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3215
+msgid "This command returns the UUID of the LVM PV C<device>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4677
-msgid "guestfs_swapoff_label"
+#: ../src/guestfs-actions.pod:4856
+msgid "guestfs_pwrite"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4679
+#: ../src/guestfs-actions.pod:4858
#, no-wrap
msgid ""
-" int guestfs_swapoff_label (guestfs_h *g,\n"
-"\t\tconst char *label);\n"
+" int\n"
+" guestfs_pwrite (guestfs_h *g,\n"
+" const char *path,\n"
+" const char *content,\n"
+" size_t content_size,\n"
+" int64_t offset);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3610
+#: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3221
msgid ""
-"This command disables the libguestfs appliance swap on labeled swap "
-"partition."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:4687
-msgid "guestfs_swapoff_uuid"
+"This command writes to part of a file. It writes the data buffer C<content> "
+"to the file C<path> starting at offset C<offset>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4689
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3224
msgid ""
-" int guestfs_swapoff_uuid (guestfs_h *g,\n"
-"\t\tconst char *uuid);\n"
-"\n"
+"This command implements the L<pwrite(2)> system call, and like that system "
+"call it may not write the full data requested. The return value is the "
+"number of bytes that were actually written to the file. This could even be "
+"0, although short writes are unlikely for regular files in ordinary "
+"circumstances."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3617
-msgid ""
-"This command disables the libguestfs appliance swap partition with the given "
-"UUID."
+#: ../src/guestfs-actions.pod:4874
+msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4697
-msgid "guestfs_swapon_device"
+#: ../src/guestfs-actions.pod:4883
+msgid "guestfs_pwrite_device"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4699
+#: ../src/guestfs-actions.pod:4885
#, no-wrap
msgid ""
-" int guestfs_swapon_device (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_pwrite_device (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *content,\n"
+" size_t content_size,\n"
+" int64_t offset);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4702
+#: ../src/guestfs-actions.pod:4892 ../fish/guestfish-actions.pod:3239
msgid ""
-"This command enables the libguestfs appliance to use the swap device or "
-"partition named C<device>. The increased memory is made available for all "
-"commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
+"This command writes to part of a device. It writes the data buffer "
+"C<content> to C<device> starting at offset C<offset>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3629
+#: ../src/guestfs-actions.pod:4895 ../fish/guestfish-actions.pod:3242
msgid ""
-"Note that you should not swap to existing guest swap partitions unless you "
-"know what you are doing. They may contain hibernation information, or other "
-"information that the guest doesn't want you to trash. You also risk leaking "
-"information about the host to the guest this way. Instead, attach a new "
-"host device to the guest and swap on that."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:4716
-msgid "guestfs_swapon_file"
+"This command implements the L<pwrite(2)> system call, and like that system "
+"call it may not write the full data requested (although short writes to disk "
+"devices and partitions are probably impossible with standard Linux kernels)."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4718
-#, no-wrap
-msgid ""
-" int guestfs_swapon_file (guestfs_h *g,\n"
-"\t\tconst char *file);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:4900
+msgid "See also C<guestfs_pwrite>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4721
-msgid ""
-"This command enables swap to a file. See C<guestfs_swapon_device> for other "
-"notes."
+#: ../src/guestfs-actions.pod:4907
+msgid "(Added in 1.5.20)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4726
-msgid "guestfs_swapon_label"
+#: ../src/guestfs-actions.pod:4909
+msgid "guestfs_read_file"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4728
+#: ../src/guestfs-actions.pod:4911
#, no-wrap
msgid ""
-" int guestfs_swapon_label (guestfs_h *g,\n"
-"\t\tconst char *label);\n"
+" char *\n"
+" guestfs_read_file (guestfs_h *g,\n"
+" const char *path,\n"
+" size_t *size_r);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4731
-msgid ""
-"This command enables swap to a labeled swap partition. See "
-"C<guestfs_swapon_device> for other notes."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:4736
-msgid "guestfs_swapon_uuid"
+#: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3256
+msgid "This calls returns the contents of the file C<path> as a buffer."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4738
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:4919
msgid ""
-" int guestfs_swapon_uuid (guestfs_h *g,\n"
-"\t\tconst char *uuid);\n"
-"\n"
+"Unlike C<guestfs_cat>, this function can correctly handle files that contain "
+"embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
+"function is limited in the total size of file that can be handled."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4741
-msgid ""
-"This command enables swap to a swap partition with the given UUID. See "
-"C<guestfs_swapon_device> for other notes."
+#: ../src/guestfs-actions.pod:4931
+msgid "(Added in 1.0.63)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4746
-msgid "guestfs_sync"
+#: ../src/guestfs-actions.pod:4933
+msgid "guestfs_read_lines"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4748
+#: ../src/guestfs-actions.pod:4935
#, no-wrap
msgid ""
-" int guestfs_sync (guestfs_h *g);\n"
+" char **\n"
+" guestfs_read_lines (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3661
+#: ../src/guestfs-actions.pod:4941 ../fish/guestfish-actions.pod:3273
msgid ""
-"This syncs the disk, so that any writes are flushed through to the "
-"underlying disk image."
+"The file contents are returned as a list of lines. Trailing C<LF> and "
+"C<CRLF> character sequences are I<not> returned."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3664
+#: ../src/guestfs-actions.pod:4944
msgid ""
-"You should always call this if you have modified a disk image, before "
-"closing the handle."
+"Note that this function cannot correctly handle binary files (specifically, "
+"files containing C<\\0> character which is treated as end of line). For "
+"those you need to use the C<guestfs_read_file> function which has a more "
+"complex interface."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4758
-msgid "guestfs_tail"
+#: ../src/guestfs-actions.pod:4955
+msgid "guestfs_readdir"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4760
+#: ../src/guestfs-actions.pod:4957
#, no-wrap
msgid ""
-" char **guestfs_tail (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" struct guestfs_dirent_list *\n"
+" guestfs_readdir (guestfs_h *g,\n"
+" const char *dir);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4763 ../fish/guestfish-actions.pod:3671
-msgid "This command returns up to the last 10 lines of a file as a list of strings."
+#: ../src/guestfs-actions.pod:4961 ../fish/guestfish-actions.pod:3285
+msgid "This returns the list of directory entries in directory C<dir>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4773
-msgid "guestfs_tail_n"
+# type: textblock
+#: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3287
+msgid ""
+"All entries in the directory are returned, including C<.> and C<..>. The "
+"entries are I<not> sorted, but returned in the same order as the underlying "
+"filesystem."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4775
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3291
msgid ""
-" char **guestfs_tail_n (guestfs_h *g,\n"
-"\t\tint nrlines,\n"
-"\t\tconst char *path);\n"
-"\n"
+"Also this call returns basic file type information about each file. The "
+"C<ftyp> field will contain one of the following characters:"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4972 ../fish/guestfish-actions.pod:3296
+msgid "'b'"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4779 ../fish/guestfish-actions.pod:3681
-msgid ""
-"If the parameter C<nrlines> is a positive number, this returns the last "
-"C<nrlines> lines of the file C<path>."
+#: ../src/guestfs-actions.pod:4974 ../fish/guestfish-actions.pod:3298
+msgid "Block special"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4976 ../fish/guestfish-actions.pod:3300
+msgid "'c'"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3684
-msgid ""
-"If the parameter C<nrlines> is a negative number, this returns lines from "
-"the file C<path>, starting with the C<-nrlines>th line."
+#: ../src/guestfs-actions.pod:4978 ../fish/guestfish-actions.pod:3302
+msgid "Char special"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4794
-msgid "guestfs_tar_in"
+# type: =item
+#: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3304
+msgid "'d'"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4796
-#, no-wrap
-msgid ""
-" int guestfs_tar_in (guestfs_h *g,\n"
-"\t\tconst char *tarfile,\n"
-"\t\tconst char *directory);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3306
+msgid "Directory"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4984 ../fish/guestfish-actions.pod:3308
+msgid "'f'"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4800 ../fish/guestfish-actions.pod:3696
-msgid ""
-"This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
-"tar file) into C<directory>."
+#: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3310
+msgid "FIFO (named pipe)"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4988 ../fish/guestfish-actions.pod:3312
+msgid "'l'"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4803
-msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
+#: ../src/guestfs-actions.pod:4990 ../fish/guestfish-actions.pod:3314
+msgid "Symbolic link"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4808
-msgid "guestfs_tar_out"
+# type: =item
+#: ../src/guestfs-actions.pod:4992 ../fish/guestfish-actions.pod:3316
+msgid "'r'"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4810
-#, no-wrap
-msgid ""
-" int guestfs_tar_out (guestfs_h *g,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *tarfile);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3318
+msgid "Regular file"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:4996 ../fish/guestfish-actions.pod:3320
+msgid "'s'"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3708
-msgid ""
-"This command packs the contents of C<directory> and downloads it to local "
-"file C<tarfile>."
+#: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3322
+msgid "Socket"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-actions.pod:5000 ../fish/guestfish-actions.pod:3324
+msgid "'u'"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4817
-msgid ""
-"To download a compressed tarball, use C<guestfs_tgz_out> or "
-"C<guestfs_txz_out>."
+#: ../src/guestfs-actions.pod:5002 ../fish/guestfish-actions.pod:3326
+msgid "Unknown file type"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4822
-msgid "guestfs_tgz_in"
+# type: =item
+#: ../src/guestfs-actions.pod:5004 ../fish/guestfish-actions.pod:3328
+msgid "'?'"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4824
-#, no-wrap
-msgid ""
-" int guestfs_tgz_in (guestfs_h *g,\n"
-"\t\tconst char *tarball,\n"
-"\t\tconst char *directory);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:5006 ../fish/guestfish-actions.pod:3330
+msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3720
+#: ../src/guestfs-actions.pod:5011
msgid ""
-"This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
-"tar file) into C<directory>."
+"This function is primarily intended for use by programs. To get a simple "
+"list of names, use C<guestfs_ls>. To get a printable directory for human "
+"consumption, use C<guestfs_ll>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4831
-msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
+#: ../src/guestfs-actions.pod:5015
+msgid ""
+"This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
+"was an error. I<The caller must call C<guestfs_free_dirent_list> after "
+"use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4835
-msgid "guestfs_tgz_out"
+#: ../src/guestfs-actions.pod:5021
+msgid "guestfs_readlink"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4837
+#: ../src/guestfs-actions.pod:5023
#, no-wrap
msgid ""
-" int guestfs_tgz_out (guestfs_h *g,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *tarball);\n"
+" char *\n"
+" guestfs_readlink (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4841 ../fish/guestfish-actions.pod:3731
-msgid ""
-"This command packs the contents of C<directory> and downloads it to local "
-"file C<tarball>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4844
-msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
+#: ../src/guestfs-actions.pod:5027 ../fish/guestfish-actions.pod:3343
+msgid "This command reads the target of a symbolic link."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4848
-msgid "guestfs_touch"
+#: ../src/guestfs-actions.pod:5034
+msgid "guestfs_readlinklist"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4850
+#: ../src/guestfs-actions.pod:5036
#, no-wrap
msgid ""
-" int guestfs_touch (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" char **\n"
+" guestfs_readlinklist (guestfs_h *g,\n"
+" const char *path,\n"
+" char *const *names);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3742
+#: ../src/guestfs-actions.pod:5041 ../fish/guestfish-actions.pod:3349
msgid ""
-"Touch acts like the L<touch(1)> command. It can be used to update the "
-"timestamps on a file, or, if the file does not exist, to create a new "
-"zero-length file."
+"This call allows you to do a C<readlink> operation on multiple files, where "
+"all files are in the directory C<path>. C<names> is the list of files from "
+"this directory."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3746
+#: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3353
msgid ""
-"This command only works on regular files, and will fail on other file types "
-"such as directories, symbolic links, block special etc."
+"On return you get a list of strings, with a one-to-one correspondence to the "
+"C<names> list. Each string is the value of the symbolic link."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3357
+msgid ""
+"If the C<readlink(2)> operation fails on any name, then the corresponding "
+"result string is the empty string C<\"\">. However the whole operation is "
+"completed even if there were C<readlink(2)> errors, and so you can call this "
+"function with names where you don't know if they are symbolic links already "
+"(albeit slightly less efficient)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5056 ../fish/guestfish-actions.pod:3364
+msgid ""
+"This call is intended for programs that want to efficiently list a directory "
+"contents without making many round-trips. Very long directory listings "
+"might cause the protocol message size to be exceeded, causing this call to "
+"fail. The caller must split up such requests into smaller groups of names."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4862
-msgid "guestfs_truncate"
+#: ../src/guestfs-actions.pod:5069
+msgid "guestfs_realpath"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4864
+#: ../src/guestfs-actions.pod:5071
#, no-wrap
msgid ""
-" int guestfs_truncate (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_realpath (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3753
+#: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3375
msgid ""
-"This command truncates C<path> to a zero-length file. The file must exist "
-"already."
+"Return the canonicalized absolute pathname of C<path>. The returned path "
+"has no C<.>, C<..> or symbolic link path elements."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4872
-msgid "guestfs_truncate_size"
+#: ../src/guestfs-actions.pod:5083
+msgid "guestfs_removexattr"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4874
+#: ../src/guestfs-actions.pod:5085
#, no-wrap
msgid ""
-" int guestfs_truncate_size (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint64_t size);\n"
+" int\n"
+" guestfs_removexattr (guestfs_h *g,\n"
+" const char *xattr,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4878 ../fish/guestfish-actions.pod:3760
-msgid ""
-"This command truncates C<path> to size C<size> bytes. The file must exist "
-"already."
+#: ../src/guestfs-actions.pod:5090 ../fish/guestfish-actions.pod:3382
+msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4881
-msgid ""
-"If the current file size is less than C<size> then the file is extended to "
-"the required size with zero bytes. This creates a sparse file (ie. disk "
-"blocks are not allocated for the file until you write to it). To create a "
-"non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
+#: ../src/guestfs-actions.pod:5093
+msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4889
-msgid "guestfs_tune2fs_l"
+#: ../src/guestfs-actions.pod:5099
+msgid "guestfs_resize2fs"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4891
+#: ../src/guestfs-actions.pod:5101
#, no-wrap
msgid ""
-" char **guestfs_tune2fs_l (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_resize2fs (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3773
+#: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3391
msgid ""
-"This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
-"C<device>."
+"This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
+"underlying device."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4897 ../fish/guestfish-actions.pod:3776
+#: ../src/guestfs-actions.pod:5108
msgid ""
-"It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
-"for more details. The list of fields returned isn't clearly defined, and "
-"depends on both the version of C<tune2fs> that libguestfs was built against, "
-"and the filesystem itself."
+"I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
+"C<device> before calling this command. For unknown reasons C<resize2fs> "
+"sometimes gives an error about this and sometimes not. In any case, it is "
+"always safe to call C<guestfs_e2fsck_f> before calling this function."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4908
-msgid "guestfs_txz_in"
+#: ../src/guestfs-actions.pod:5118
+msgid "guestfs_resize2fs_size"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4910
+#: ../src/guestfs-actions.pod:5120
#, no-wrap
msgid ""
-" int guestfs_txz_in (guestfs_h *g,\n"
-"\t\tconst char *tarball,\n"
-"\t\tconst char *directory);\n"
+" int\n"
+" guestfs_resize2fs_size (guestfs_h *g,\n"
+" const char *device,\n"
+" int64_t size);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4914 ../fish/guestfish-actions.pod:3785
+#: ../src/guestfs-actions.pod:5125
msgid ""
-"This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
-"tar file) into C<directory>."
+"This command is the same as C<guestfs_resize2fs> except that it allows you "
+"to specify the new size (in bytes) explicitly."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4919
-msgid "guestfs_txz_out"
+#: ../src/guestfs-actions.pod:5132
+msgid "guestfs_rm"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4921
+#: ../src/guestfs-actions.pod:5134
#, no-wrap
msgid ""
-" int guestfs_txz_out (guestfs_h *g,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *tarball);\n"
+" int\n"
+" guestfs_rm (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4925 ../fish/guestfish-actions.pod:3794
-msgid ""
-"This command packs the contents of C<directory> and downloads it to local "
-"file C<tarball> (as an xz compressed tar archive)."
+#: ../src/guestfs-actions.pod:5138 ../fish/guestfish-actions.pod:3411
+msgid "Remove the single file C<path>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4930
-msgid "guestfs_umask"
+#: ../src/guestfs-actions.pod:5144
+msgid "guestfs_rm_rf"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4932
+#: ../src/guestfs-actions.pod:5146
#, no-wrap
msgid ""
-" int guestfs_umask (guestfs_h *g,\n"
-"\t\tint mask);\n"
+" int\n"
+" guestfs_rm_rf (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4935 ../fish/guestfish-actions.pod:3803
-msgid ""
-"This function sets the mask used for creating new files and device nodes to "
-"C<mask & 0777>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3806
+#: ../src/guestfs-actions.pod:5150 ../fish/guestfish-actions.pod:3417
msgid ""
-"Typical umask values would be C<022> which creates new files with "
-"permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
-"new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
+"Remove the file or directory C<path>, recursively removing the contents if "
+"its a directory. This is like the C<rm -rf> shell command."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4943 ../fish/guestfish-actions.pod:3811
-msgid ""
-"The default umask is C<022>. This is important because it means that "
-"directories and device nodes will be created with C<0644> or C<0755> mode "
-"even if you specify C<0777>."
+# type: =head2
+#: ../src/guestfs-actions.pod:5158
+msgid "guestfs_rmdir"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4947
+# type: verbatim
+#: ../src/guestfs-actions.pod:5160
+#, no-wrap
msgid ""
-"See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
-"C<guestfs_mkdir>."
+" int\n"
+" guestfs_rmdir (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4950 ../fish/guestfish-actions.pod:3818
-msgid "This call returns the previous umask."
+#: ../src/guestfs-actions.pod:5164 ../fish/guestfish-actions.pod:3425
+msgid "Remove the single directory C<path>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4954
-msgid "guestfs_umount"
+#: ../src/guestfs-actions.pod:5170
+msgid "guestfs_rmmountpoint"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4956
+#: ../src/guestfs-actions.pod:5172
#, no-wrap
msgid ""
-" int guestfs_umount (guestfs_h *g,\n"
-"\t\tconst char *pathordevice);\n"
+" int\n"
+" guestfs_rmmountpoint (guestfs_h *g,\n"
+" const char *exemptpath);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4959 ../fish/guestfish-actions.pod:3824
+#: ../src/guestfs-actions.pod:5176
msgid ""
-"This unmounts the given filesystem. The filesystem may be specified either "
-"by its mountpoint (path) or the device which contains the filesystem."
+"This calls removes a mountpoint that was previously created with "
+"C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4965
-msgid "guestfs_umount_all"
+#: ../src/guestfs-actions.pod:5184
+msgid "guestfs_scrub_device"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4967
+#: ../src/guestfs-actions.pod:5186
#, no-wrap
msgid ""
-" int guestfs_umount_all (guestfs_h *g);\n"
+" int\n"
+" guestfs_scrub_device (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3832
-msgid "This unmounts all mounted filesystems."
+#: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:3439
+msgid ""
+"This command writes patterns over C<device> to make data retrieval more "
+"difficult."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4971 ../fish/guestfish-actions.pod:3834
-msgid "Some internal mounts are not unmounted by this call."
+#: ../src/guestfs-actions.pod:5193 ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5233 ../fish/guestfish-actions.pod:3442 ../fish/guestfish-actions.pod:3457 ../fish/guestfish-actions.pod:3470
+msgid ""
+"It is an interface to the L<scrub(1)> program. See that manual page for "
+"more details."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5201 ../src/guestfs-actions.pod:5219 ../src/guestfs-actions.pod:5238
+msgid "(Added in 1.0.52)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4975
-msgid "guestfs_upload"
+#: ../src/guestfs-actions.pod:5203
+msgid "guestfs_scrub_file"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4977
+#: ../src/guestfs-actions.pod:5205
#, no-wrap
msgid ""
-" int guestfs_upload (guestfs_h *g,\n"
-"\t\tconst char *filename,\n"
-"\t\tconst char *remotefilename);\n"
+" int\n"
+" guestfs_scrub_file (guestfs_h *g,\n"
+" const char *file);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4981 ../fish/guestfish-actions.pod:3840
-msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
+#: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3452
+msgid ""
+"This command writes patterns over a file to make data retrieval more "
+"difficult."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4986
-msgid "See also C<guestfs_download>."
+#: ../src/guestfs-actions.pod:5212 ../fish/guestfish-actions.pod:3455
+msgid "The file is I<removed> after scrubbing."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:4990
-msgid "guestfs_utimens"
+#: ../src/guestfs-actions.pod:5221
+msgid "guestfs_scrub_freespace"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:4992
+#: ../src/guestfs-actions.pod:5223
#, no-wrap
msgid ""
-" int guestfs_utimens (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint64_t atsecs,\n"
-"\t\tint64_t atnsecs,\n"
-"\t\tint64_t mtsecs,\n"
-"\t\tint64_t mtnsecs);\n"
+" int\n"
+" guestfs_scrub_freespace (guestfs_h *g,\n"
+" const char *dir);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:4999 ../fish/guestfish-actions.pod:3853
-msgid "This command sets the timestamps of a file with nanosecond precision."
+#: ../src/guestfs-actions.pod:5227
+msgid ""
+"This command creates the directory C<dir> and then fills it with files until "
+"the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
+"and deletes them. The intention is to scrub any free space on the partition "
+"containing C<dir>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5002 ../fish/guestfish-actions.pod:3856
+# type: =head2
+#: ../src/guestfs-actions.pod:5240
+msgid "guestfs_set_append"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:5242
+#, no-wrap
msgid ""
-"C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
-"from the epoch."
+" int\n"
+" guestfs_set_append (guestfs_h *g,\n"
+" const char *append);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5005 ../fish/guestfish-actions.pod:3859
+#: ../src/guestfs-actions.pod:5246 ../fish/guestfish-actions.pod:3479
msgid ""
-"C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
-"nanoseconds from the epoch."
+"This function is used to add additional options to the guest kernel command "
+"line."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5008 ../fish/guestfish-actions.pod:3862
+#: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3482
msgid ""
-"If the C<*nsecs> field contains the special value C<-1> then the "
-"corresponding timestamp is set to the current time. (The C<*secs> field is "
-"ignored in this case)."
+"The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
+"environment variable."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5012 ../fish/guestfish-actions.pod:3866
+#: ../src/guestfs-actions.pod:5252 ../fish/guestfish-actions.pod:3485
msgid ""
-"If the C<*nsecs> field contains the special value C<-2> then the "
-"corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
-"in this case)."
+"Setting C<append> to C<NULL> means I<no> additional options are passed "
+"(libguestfs always adds a few of its own)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5018 ../src/guestfs-structs.pod:175
-msgid "guestfs_version"
+#: ../src/guestfs-actions.pod:5259
+msgid "guestfs_set_autosync"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5020
+#: ../src/guestfs-actions.pod:5261
#, no-wrap
msgid ""
-" struct guestfs_version *guestfs_version (guestfs_h *g);\n"
+" int\n"
+" guestfs_set_autosync (guestfs_h *g,\n"
+" int autosync);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5022 ../fish/guestfish-actions.pod:3874
-msgid "Return the libguestfs version number that the program is linked against."
+#: ../src/guestfs-actions.pod:5265
+msgid ""
+"If C<autosync> is true, this enables autosync. Libguestfs will make a best "
+"effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
+"the handle is closed (also if the program exits without closing handles)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3877
+#: ../src/guestfs-actions.pod:5270 ../fish/guestfish-actions.pod:3499
msgid ""
-"Note that because of dynamic linking this is not necessarily the version of "
-"libguestfs that you compiled against. You can compile the program, and then "
-"at runtime dynamically link against a completely different C<libguestfs.so> "
-"library."
+"This is enabled by default (since libguestfs 1.5.24, previously it was "
+"disabled by default)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3882
-msgid ""
-"This call was added in version C<1.0.58>. In previous versions of "
-"libguestfs there was no way to get the version number. From C code you can "
-"use dynamic linker functions to find out if this symbol exists (if it "
-"doesn't, then it's an earlier version)."
+# type: =head2
+#: ../src/guestfs-actions.pod:5277
+msgid "guestfs_set_direct"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5036 ../fish/guestfish-actions.pod:3888
+# type: verbatim
+#: ../src/guestfs-actions.pod:5279
+#, no-wrap
msgid ""
-"The call returns a structure with four elements. The first three (C<major>, "
-"C<minor> and C<release>) are numbers and correspond to the usual version "
-"triplet. The fourth element (C<extra>) is a string and is normally empty, "
-"but may be used for distro-specific information."
+" int\n"
+" guestfs_set_direct (guestfs_h *g,\n"
+" int direct);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3894
-msgid "To construct the original version string: C<$major.$minor.$release$extra>"
+#: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3508
+msgid ""
+"If the direct appliance mode flag is enabled, then stdin and stdout are "
+"passed directly through to the appliance once it is launched."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3897
-msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
+#: ../src/guestfs-actions.pod:5287
+msgid ""
+"One consequence of this is that log messages aren't caught by the library "
+"and handled by C<guestfs_set_log_message_callback>, but go straight to "
+"stdout."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5047
-msgid ""
-"I<Note:> Don't use this call to test for availability of features. In "
-"enterprise distributions we backport features from later versions into "
-"earlier versions, making this an unreliable way to test for features. Use "
-"C<guestfs_available> instead."
+#: ../src/guestfs-actions.pod:5291 ../fish/guestfish-actions.pod:3516
+msgid "You probably don't want to use this unless you know what you are doing."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5053
-msgid ""
-"This function returns a C<struct guestfs_version *>, or NULL if there was an "
-"error. I<The caller must call C<guestfs_free_version> after use>."
+#: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3519
+msgid "The default is disabled."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5057
-msgid "guestfs_vfs_label"
+#: ../src/guestfs-actions.pod:5300
+msgid "guestfs_set_e2label"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5059
+#: ../src/guestfs-actions.pod:5302
#, no-wrap
msgid ""
-" char *guestfs_vfs_label (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_set_e2label (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *label);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5062 ../fish/guestfish-actions.pod:3909
-msgid "This returns the filesystem label of the filesystem on C<device>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:5065 ../fish/guestfish-actions.pod:3912
-msgid "If the filesystem is unlabeled, this returns the empty string."
+#: ../src/guestfs-actions.pod:5307 ../fish/guestfish-actions.pod:3525
+msgid ""
+"This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
+"C<label>. Filesystem labels are limited to 16 characters."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5067
-msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
+#: ../src/guestfs-actions.pod:5311
+msgid ""
+"You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
+"the existing label on a filesystem."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5072
-msgid "guestfs_vfs_type"
+#: ../src/guestfs-actions.pod:5318
+msgid "guestfs_set_e2uuid"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5074
+#: ../src/guestfs-actions.pod:5320
#, no-wrap
msgid ""
-" char *guestfs_vfs_type (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_set_e2uuid (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *uuid);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3920
+#: ../src/guestfs-actions.pod:5325 ../fish/guestfish-actions.pod:3536
msgid ""
-"This command gets the filesystem type corresponding to the filesystem on "
-"C<device>."
+"This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
+"C<uuid>. The format of the UUID and alternatives such as C<clear>, "
+"C<random> and C<time> are described in the L<tune2fs(8)> manpage."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3923
+#: ../src/guestfs-actions.pod:5330
msgid ""
-"For most filesystems, the result is the name of the Linux VFS module which "
-"would be used to mount this filesystem if you mounted it without specifying "
-"the filesystem type. For example a string such as C<ext3> or C<ntfs>."
+"You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
+"the existing UUID of a filesystem."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5088
-msgid "guestfs_vfs_uuid"
+#: ../src/guestfs-actions.pod:5337
+msgid "guestfs_set_memsize"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5090
+#: ../src/guestfs-actions.pod:5339
#, no-wrap
msgid ""
-" char *guestfs_vfs_uuid (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" int\n"
+" guestfs_set_memsize (guestfs_h *g,\n"
+" int memsize);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5093 ../fish/guestfish-actions.pod:3932
-msgid "This returns the filesystem UUID of the filesystem on C<device>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3935
-msgid "If the filesystem does not have a UUID, this returns the empty string."
+#: ../src/guestfs-actions.pod:5343
+msgid ""
+"This sets the memory size in megabytes allocated to the qemu subprocess. "
+"This only has any effect if called before C<guestfs_launch>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5098
-msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
+#: ../src/guestfs-actions.pod:5347 ../fish/guestfish-actions.pod:3554
+msgid ""
+"You can also change this by setting the environment variable "
+"C<LIBGUESTFS_MEMSIZE> before the handle is created."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5103
-msgid "guestfs_vg_activate"
+#: ../src/guestfs-actions.pod:5358
+msgid "guestfs_set_network"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5105
+#: ../src/guestfs-actions.pod:5360
#, no-wrap
msgid ""
-" int guestfs_vg_activate (guestfs_h *g,\n"
-"\t\tint activate,\n"
-"\t\tchar *const *volgroups);\n"
+" int\n"
+" guestfs_set_network (guestfs_h *g,\n"
+" int network);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3943
+#: ../src/guestfs-actions.pod:5364 ../fish/guestfish-actions.pod:3567
msgid ""
-"This command activates or (if C<activate> is false) deactivates all logical "
-"volumes in the listed volume groups C<volgroups>. If activated, then they "
-"are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
-"deactivated, then those devices disappear."
+"If C<network> is true, then the network is enabled in the libguestfs "
+"appliance. The default is false."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3949
-msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
+#: ../src/guestfs-actions.pod:5367 ../fish/guestfish-actions.pod:3570
+msgid ""
+"This affects whether commands are able to access the network (see "
+"L<guestfs(3)/RUNNING COMMANDS>)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3951
+#: ../src/guestfs-actions.pod:5370
msgid ""
-"Note that if C<volgroups> is an empty list then B<all> volume groups are "
-"activated or deactivated."
+"You must call this before calling C<guestfs_launch>, otherwise it has no "
+"effect."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5122
-msgid "guestfs_vg_activate_all"
+#: ../src/guestfs-actions.pod:5377
+msgid "guestfs_set_path"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5124
+#: ../src/guestfs-actions.pod:5379
#, no-wrap
msgid ""
-" int guestfs_vg_activate_all (guestfs_h *g,\n"
-"\t\tint activate);\n"
+" int\n"
+" guestfs_set_path (guestfs_h *g,\n"
+" const char *searchpath);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3958
+#: ../src/guestfs-actions.pod:5383 ../fish/guestfish-actions.pod:3582
+msgid "Set the path that libguestfs searches for kernel and initrd.img."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3584
msgid ""
-"This command activates or (if C<activate> is false) deactivates all logical "
-"volumes in all volume groups. If activated, then they are made known to the "
-"kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
-"those devices disappear."
+"The default is C<$libdir/guestfs> unless overridden by setting "
+"C<LIBGUESTFS_PATH> environment variable."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3964
-msgid "This command is the same as running C<vgchange -a y|n>"
+#: ../src/guestfs-actions.pod:5388 ../fish/guestfish-actions.pod:3587
+msgid "Setting C<path> to C<NULL> restores the default path."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5137
-msgid "guestfs_vgcreate"
+#: ../src/guestfs-actions.pod:5394
+msgid "guestfs_set_qemu"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5139
+#: ../src/guestfs-actions.pod:5396
#, no-wrap
msgid ""
-" int guestfs_vgcreate (guestfs_h *g,\n"
-"\t\tconst char *volgroup,\n"
-"\t\tchar *const *physvols);\n"
+" int\n"
+" guestfs_set_qemu (guestfs_h *g,\n"
+" const char *qemu);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5143 ../fish/guestfish-actions.pod:3970
-msgid ""
-"This creates an LVM volume group called C<volgroup> from the non-empty list "
-"of physical volumes C<physvols>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:5148
-msgid "guestfs_vglvuuids"
+#: ../src/guestfs-actions.pod:5400 ../fish/guestfish-actions.pod:3595
+msgid "Set the qemu binary that we will use."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5150
-#, no-wrap
-msgid ""
-" char **guestfs_vglvuuids (guestfs_h *g,\n"
-"\t\tconst char *vgname);\n"
-"\n"
+# type: textblock
+#: ../src/guestfs-actions.pod:5402 ../fish/guestfish-actions.pod:3597
+msgid "The default is chosen when the library was compiled by the configure script."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3977
+#: ../src/guestfs-actions.pod:5405 ../fish/guestfish-actions.pod:3600
msgid ""
-"Given a VG called C<vgname>, this returns the UUIDs of all the logical "
-"volumes created in this volume group."
+"You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
+"variable."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5156
-msgid ""
-"You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
-"associate logical volumes and volume groups."
+#: ../src/guestfs-actions.pod:5408 ../fish/guestfish-actions.pod:3603
+msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5159
-msgid "See also C<guestfs_vgpvuuids>."
+#: ../src/guestfs-actions.pod:5410 ../fish/guestfish-actions.pod:3605
+msgid ""
+"Note that you should call this function as early as possible after creating "
+"the handle. This is because some pre-launch operations depend on testing "
+"qemu features (by running C<qemu -help>). If the qemu binary changes, we "
+"don't retest features, and so you might see inconsistent results. Using the "
+"environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
+"the qemu binary at the same time as the handle is created."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5165
-msgid "guestfs_vgpvuuids"
+#: ../src/guestfs-actions.pod:5422
+msgid "guestfs_set_recovery_proc"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5167
+#: ../src/guestfs-actions.pod:5424
#, no-wrap
msgid ""
-" char **guestfs_vgpvuuids (guestfs_h *g,\n"
-"\t\tconst char *vgname);\n"
+" int\n"
+" guestfs_set_recovery_proc (guestfs_h *g,\n"
+" int recoveryproc);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5170 ../fish/guestfish-actions.pod:3989
+#: ../src/guestfs-actions.pod:5428
msgid ""
-"Given a VG called C<vgname>, this returns the UUIDs of all the physical "
-"volumes that this volume group resides on."
+"If this is called with the parameter C<false> then C<guestfs_launch> does "
+"not create a recovery process. The purpose of the recovery process is to "
+"stop runaway qemu processes in the case where the main program aborts "
+"abruptly."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5173
+#: ../src/guestfs-actions.pod:5433
msgid ""
-"You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
-"associate physical volumes and volume groups."
+"This only has any effect if called before C<guestfs_launch>, and the default "
+"is true."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5176
-msgid "See also C<guestfs_vglvuuids>."
+#: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3627
+msgid ""
+"About the only time when you would want to disable this is if the main "
+"process will fork itself into the background (\"daemonize\" itself). In "
+"this case the recovery process thinks that the main program has disappeared "
+"and so kills qemu, which is not very helpful."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5182
-msgid "guestfs_vgremove"
+#: ../src/guestfs-actions.pod:5446
+msgid "guestfs_set_selinux"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5184
+#: ../src/guestfs-actions.pod:5448
#, no-wrap
msgid ""
-" int guestfs_vgremove (guestfs_h *g,\n"
-"\t\tconst char *vgname);\n"
+" int\n"
+" guestfs_set_selinux (guestfs_h *g,\n"
+" int selinux);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5187 ../fish/guestfish-actions.pod:4001
-msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:4003
-msgid "This also forcibly removes all logical volumes in the volume group (if any)."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:5194
-msgid "guestfs_vgrename"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:5196
-#, no-wrap
+#: ../src/guestfs-actions.pod:5452 ../fish/guestfish-actions.pod:3639
msgid ""
-" int guestfs_vgrename (guestfs_h *g,\n"
-"\t\tconst char *volgroup,\n"
-"\t\tconst char *newvolgroup);\n"
-"\n"
+"This sets the selinux flag that is passed to the appliance at boot time. "
+"The default is C<selinux=0> (disabled)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5200 ../fish/guestfish-actions.pod:4010
-msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
+#: ../src/guestfs-actions.pod:5455 ../fish/guestfish-actions.pod:3642
+msgid ""
+"Note that if SELinux is enabled, it is always in Permissive mode "
+"(C<enforcing=0>)."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5204
-msgid "guestfs_vgs"
+#: ../src/guestfs-actions.pod:5465
+msgid "guestfs_set_trace"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5206
+#: ../src/guestfs-actions.pod:5467
#, no-wrap
msgid ""
-" char **guestfs_vgs (guestfs_h *g);\n"
+" int\n"
+" guestfs_set_trace (guestfs_h *g,\n"
+" int trace);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:4016
+#: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3654
msgid ""
-"List all the volumes groups detected. This is the equivalent of the "
-"L<vgs(8)> command."
+"If the command trace flag is set to 1, then commands are printed on stderr "
+"before they are executed in a format which is very similar to the one used "
+"by guestfish. In other words, you can run a program with this enabled, and "
+"you will get out a script which you can feed to guestfish to perform the "
+"same set of actions."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:4019
+#: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3661
msgid ""
-"This returns a list of just the volume group names that were detected "
-"(eg. C<VolGroup00>)."
+"If you want to trace C API calls into libguestfs (and other libraries) then "
+"possibly a better way is to use the external ltrace(1) command."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5214
-msgid "See also C<guestfs_vgs_full>."
+#: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3665
+msgid ""
+"Command traces are disabled unless the environment variable "
+"C<LIBGUESTFS_TRACE> is defined and set to C<1>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5220
-msgid "guestfs_vgs_full"
+#: ../src/guestfs-actions.pod:5489
+msgid "guestfs_set_verbose"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5222
+#: ../src/guestfs-actions.pod:5491
#, no-wrap
msgid ""
-" struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *g);\n"
+" int\n"
+" guestfs_set_verbose (guestfs_h *g,\n"
+" int verbose);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5224 ../fish/guestfish-actions.pod:4028
-msgid ""
-"List all the volumes groups detected. This is the equivalent of the "
-"L<vgs(8)> command. The \"full\" version includes all fields."
+#: ../src/guestfs-actions.pod:5495 ../fish/guestfish-actions.pod:3674
+msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5227
+#: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3676
msgid ""
-"This function returns a C<struct guestfs_lvm_vg_list *> (see "
-"E<lt>guestfs-structs.hE<gt>), or NULL if there was an error. I<The caller "
-"must call C<guestfs_free_lvm_vg_list> after use>."
+"Verbose messages are disabled unless the environment variable "
+"C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5232
-msgid "guestfs_vgscan"
+#: ../src/guestfs-actions.pod:5504
+msgid "guestfs_setcon"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5234
+#: ../src/guestfs-actions.pod:5506
#, no-wrap
msgid ""
-" int guestfs_vgscan (guestfs_h *g);\n"
+" int\n"
+" guestfs_setcon (guestfs_h *g,\n"
+" const char *context);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5236 ../fish/guestfish-actions.pod:4035
-msgid ""
-"This rescans all block devices and rebuilds the list of LVM physical "
-"volumes, volume groups and logical volumes."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:5241
-msgid "guestfs_vguuid"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:5243
-#, no-wrap
+#: ../src/guestfs-actions.pod:5510 ../fish/guestfish-actions.pod:3683
msgid ""
-" char *guestfs_vguuid (guestfs_h *g,\n"
-"\t\tconst char *vgname);\n"
-"\n"
+"This sets the SELinux security context of the daemon to the string "
+"C<context>."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5246 ../fish/guestfish-actions.pod:4042
-msgid "This command returns the UUID of the LVM VG named C<vgname>."
+#: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3686
+msgid "See the documentation about SELINUX in L<guestfs(3)>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5251
-msgid "guestfs_wait_ready"
+#: ../src/guestfs-actions.pod:5519
+msgid "guestfs_setxattr"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5253
+#: ../src/guestfs-actions.pod:5521
#, no-wrap
msgid ""
-" int guestfs_wait_ready (guestfs_h *g);\n"
+" int\n"
+" guestfs_setxattr (guestfs_h *g,\n"
+" const char *xattr,\n"
+" const char *val,\n"
+" int vallen,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5255
-msgid "This function is a no op."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:5257
+#: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3692
msgid ""
-"In versions of the API E<lt> 1.0.71 you had to call this function just after "
-"calling C<guestfs_launch> to wait for the launch to complete. However this "
-"is no longer necessary because C<guestfs_launch> now does the waiting."
+"This call sets the extended attribute named C<xattr> of the file C<path> to "
+"the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5262
-msgid ""
-"If you see any calls to this function in code then you can just remove them, "
-"unless you want to retain compatibility with older versions of the API."
+#: ../src/guestfs-actions.pod:5532
+msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5268
-msgid "guestfs_wc_c"
+#: ../src/guestfs-actions.pod:5538
+msgid "guestfs_sfdisk"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5270
+#: ../src/guestfs-actions.pod:5540
#, no-wrap
msgid ""
-" int guestfs_wc_c (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_sfdisk (guestfs_h *g,\n"
+" const char *device,\n"
+" int cyls,\n"
+" int heads,\n"
+" int sectors,\n"
+" char *const *lines);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:4048
+#: ../src/guestfs-actions.pod:5548 ../fish/guestfish-actions.pod:3702
msgid ""
-"This command counts the characters in a file, using the C<wc -c> external "
-"command."
+"This is a direct interface to the L<sfdisk(8)> program for creating "
+"partitions on block devices."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5278
-msgid "guestfs_wc_l"
+# type: textblock
+#: ../src/guestfs-actions.pod:5551 ../fish/guestfish-actions.pod:3705
+msgid "C<device> should be a block device, for example C</dev/sda>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5280
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:3707
msgid ""
-" int guestfs_wc_l (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
+"sectors on the device, which are passed directly to sfdisk as the I<-C>, "
+"I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
+"corresponding parameter is omitted. Usually for 'large' disks, you can just "
+"pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
+"the kernel) cannot work out the right geometry and you will need to tell it."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:4055
+#: ../src/guestfs-actions.pod:5561 ../fish/guestfish-actions.pod:3715
msgid ""
-"This command counts the lines in a file, using the C<wc -l> external "
-"command."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:5288
-msgid "guestfs_wc_w"
+"C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
+"refer to the L<sfdisk(8)> manpage."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5290
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:5564 ../fish/guestfish-actions.pod:3718
msgid ""
-" int guestfs_wc_w (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"To create a single partition occupying the whole disk, you would pass "
+"C<lines> as a single element list, when the single element being the string "
+"C<,> (comma)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5293 ../fish/guestfish-actions.pod:4062
-msgid ""
-"This command counts the words in a file, using the C<wc -w> external "
-"command."
+#: ../src/guestfs-actions.pod:5568
+msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5298
-msgid "guestfs_write"
+#: ../src/guestfs-actions.pod:5578
+msgid "guestfs_sfdiskM"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5300
+#: ../src/guestfs-actions.pod:5580
#, no-wrap
msgid ""
-" int guestfs_write (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tconst char *content,\n"
-"\t\tsize_t content_size);\n"
+" int\n"
+" guestfs_sfdiskM (guestfs_h *g,\n"
+" const char *device,\n"
+" char *const *lines);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5305 ../fish/guestfish-actions.pod:4069
+#: ../src/guestfs-actions.pod:5585
msgid ""
-"This call creates a file called C<path>. The content of the file is the "
-"string C<content> (which can contain any 8 bit data)."
+"This is a simplified interface to the C<guestfs_sfdisk> command, where "
+"partition sizes are specified in megabytes only (rounded to the nearest "
+"cylinder) and you don't need to specify the cyls, heads and sectors "
+"parameters which were rarely if ever used anyway."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5591
+msgid ""
+"See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
+"C<guestfs_part_disk>"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5313
-msgid "guestfs_write_file"
+#: ../src/guestfs-actions.pod:5601
+msgid "guestfs_sfdisk_N"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5315
+#: ../src/guestfs-actions.pod:5603
#, no-wrap
msgid ""
-" int guestfs_write_file (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tconst char *content,\n"
-"\t\tint size);\n"
+" int\n"
+" guestfs_sfdisk_N (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum,\n"
+" int cyls,\n"
+" int heads,\n"
+" int sectors,\n"
+" const char *line);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:4079
-msgid ""
-"This call creates a file called C<path>. The contents of the file is the "
-"string C<content> (which can contain any 8 bit data), with length C<size>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:5324 ../fish/guestfish-actions.pod:4083
+#: ../src/guestfs-actions.pod:5612 ../fish/guestfish-actions.pod:3748
msgid ""
-"As a special case, if C<size> is C<0> then the length is calculated using "
-"C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
+"This runs L<sfdisk(8)> option to modify just the single partition C<n> "
+"(note: C<n> counts from 1)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5328 ../fish/guestfish-actions.pod:4087
+#: ../src/guestfs-actions.pod:5615
msgid ""
-"I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
-"I<not> work, even if the length is specified."
+"For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
+"for the cyls/heads/sectors parameters."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5336 ../fish/guestfish-actions.pod:4093
-msgid "This function is deprecated. In new code, use the C<write> call instead."
+#: ../src/guestfs-actions.pod:5618
+msgid "See also: C<guestfs_part_add>"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5343
-msgid "guestfs_zegrep"
+#: ../src/guestfs-actions.pod:5627
+msgid "guestfs_sfdisk_disk_geometry"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5345
+#: ../src/guestfs-actions.pod:5629
#, no-wrap
msgid ""
-" char **guestfs_zegrep (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5349 ../fish/guestfish-actions.pod:4104
-msgid "This calls the external C<zegrep> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:5633
+msgid ""
+"This displays the disk geometry of C<device> read from the partition table. "
+"Especially in the case where the underlying block device has been resized, "
+"this can be different from the kernel's idea of the geometry (see "
+"C<guestfs_sfdisk_kernel_geometry>)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5638 ../src/guestfs-actions.pod:5654 ../fish/guestfish-actions.pod:3768 ../fish/guestfish-actions.pod:3777
+msgid "The result is in human-readable format, and not designed to be parsed."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5359
-msgid "guestfs_zegrepi"
+#: ../src/guestfs-actions.pod:5646
+msgid "guestfs_sfdisk_kernel_geometry"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5361
+#: ../src/guestfs-actions.pod:5648
#, no-wrap
msgid ""
-" char **guestfs_zegrepi (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" char *\n"
+" guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:4114
-msgid "This calls the external C<zegrep -i> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:5652 ../fish/guestfish-actions.pod:3775
+msgid "This displays the kernel's idea of the geometry of C<device>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5375
-msgid "guestfs_zero"
+#: ../src/guestfs-actions.pod:5662
+msgid "guestfs_sfdisk_l"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5377
+#: ../src/guestfs-actions.pod:5664
#, no-wrap
msgid ""
-" int guestfs_zero (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" char *\n"
+" guestfs_sfdisk_l (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5380 ../fish/guestfish-actions.pod:4124
-msgid "This command writes zeroes over the first few blocks of C<device>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:4126
+#: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3784
msgid ""
-"How many blocks are zeroed isn't specified (but it's I<not> enough to "
-"securely wipe the device). It should be sufficient to remove any partition "
-"tables, filesystem superblocks and so on."
+"This displays the partition table on C<device>, in the human-readable output "
+"of the L<sfdisk(8)> command. It is not intended to be parsed."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5386
-msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
+#: ../src/guestfs-actions.pod:5672
+msgid "See also: C<guestfs_part_list>"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5395
-msgid "guestfs_zero_device"
+#: ../src/guestfs-actions.pod:5679
+msgid "guestfs_sh"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5397
+#: ../src/guestfs-actions.pod:5681
#, no-wrap
msgid ""
-" int guestfs_zero_device (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" char *\n"
+" guestfs_sh (guestfs_h *g,\n"
+" const char *command);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5400
+#: ../src/guestfs-actions.pod:5685 ../fish/guestfish-actions.pod:3794
msgid ""
-"This command writes zeroes over the entire C<device>. Compare with "
-"C<guestfs_zero> which just zeroes the first few blocks of a device."
+"This call runs a command from the guest filesystem via the guest's "
+"C</bin/sh>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5414
-msgid "guestfs_zerofree"
+# type: textblock
+#: ../src/guestfs-actions.pod:5688
+msgid "This is like C<guestfs_command>, but passes the command to:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5416
+#: ../src/guestfs-actions.pod:5690 ../fish/guestfish-actions.pod:3799
#, no-wrap
msgid ""
-" int guestfs_zerofree (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" /bin/sh -c \"command\"\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:4147
+#: ../src/guestfs-actions.pod:5692 ../fish/guestfish-actions.pod:3801
msgid ""
-"This runs the I<zerofree> program on C<device>. This program claims to zero "
-"unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
-"possible to compress the filesystem more effectively."
+"Depending on the guest's shell, this usually results in wildcards being "
+"expanded, shell expressions being interpolated and so on."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:4152
-msgid "You should B<not> run this program if the filesystem is mounted."
+#: ../src/guestfs-actions.pod:5696
+msgid "All the provisos about C<guestfs_command> apply to this call."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:5703
+msgid "guestfs_sh_lines"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:5705
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_sh_lines (guestfs_h *g,\n"
+" const char *command);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:4155
+#: ../src/guestfs-actions.pod:5709
msgid ""
-"It is possible that using this program can damage the filesystem or data on "
-"the filesystem."
+"This is the same as C<guestfs_sh>, but splits the result into a list of "
+"lines."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5712
+msgid "See also: C<guestfs_command_lines>"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5432
-msgid "guestfs_zfgrep"
+#: ../src/guestfs-actions.pod:5720
+msgid "guestfs_sleep"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5434
+#: ../src/guestfs-actions.pod:5722
#, no-wrap
msgid ""
-" char **guestfs_zfgrep (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tconst char *path);\n"
+" int\n"
+" guestfs_sleep (guestfs_h *g,\n"
+" int secs);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:4162
-msgid "This calls the external C<zfgrep> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3820
+msgid "Sleep for C<secs> seconds."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5730
+msgid "(Added in 1.0.41)"
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5448
-msgid "guestfs_zfgrepi"
+#: ../src/guestfs-actions.pod:5732 ../src/guestfs-structs.pod:109
+msgid "guestfs_stat"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5450
+#: ../src/guestfs-actions.pod:5734
#, no-wrap
msgid ""
-" char **guestfs_zfgrepi (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tconst char *path);\n"
+" struct guestfs_stat *\n"
+" guestfs_stat (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5454 ../fish/guestfish-actions.pod:4172
-msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3828
+msgid "This is the same as the C<stat(2)> system call."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5464
-msgid "guestfs_zfile"
+#: ../src/guestfs-actions.pod:5748 ../src/guestfs-structs.pod:135
+msgid "guestfs_statvfs"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5466
+#: ../src/guestfs-actions.pod:5750
#, no-wrap
msgid ""
-" char *guestfs_zfile (guestfs_h *g,\n"
-"\t\tconst char *meth,\n"
-"\t\tconst char *path);\n"
+" struct guestfs_statvfs *\n"
+" guestfs_statvfs (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5470 ../fish/guestfish-actions.pod:4182
-msgid "This command runs C<file> after first decompressing C<path> using C<method>."
+#: ../src/guestfs-actions.pod:5754 ../fish/guestfish-actions.pod:3834
+msgid ""
+"Returns file system statistics for any mounted file system. C<path> should "
+"be a file or directory in the mounted file system (typically it is the mount "
+"point itself, but it doesn't need to be)."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:4185
-msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
+#: ../src/guestfs-actions.pod:5758 ../fish/guestfish-actions.pod:3838
+msgid "This is the same as the C<statvfs(2)> system call."
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5475
+#: ../src/guestfs-actions.pod:5760
msgid ""
-"Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
-"files."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:4190
-msgid "This function is deprecated. In new code, use the C<file> call instead."
+"This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
+"error. I<The caller must call C<guestfs_free_statvfs> after use>."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5488
-msgid "guestfs_zgrep"
+#: ../src/guestfs-actions.pod:5766
+msgid "guestfs_strings"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5490
+#: ../src/guestfs-actions.pod:5768
#, no-wrap
msgid ""
-" char **guestfs_zgrep (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" char **\n"
+" guestfs_strings (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:4201
-msgid "This calls the external C<zgrep> program and returns the matching lines."
+#: ../src/guestfs-actions.pod:5772 ../fish/guestfish-actions.pod:3844
+msgid ""
+"This runs the L<strings(1)> command on a file and returns the list of "
+"printable strings found."
msgstr ""
# type: =head2
-#: ../src/guestfs-actions.pod:5504
-msgid "guestfs_zgrepi"
+#: ../src/guestfs-actions.pod:5784
+msgid "guestfs_strings_e"
msgstr ""
# type: verbatim
-#: ../src/guestfs-actions.pod:5506
+#: ../src/guestfs-actions.pod:5786
#, no-wrap
msgid ""
-" char **guestfs_zgrepi (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" char **\n"
+" guestfs_strings_e (guestfs_h *g,\n"
+" const char *encoding,\n"
+" const char *path);\n"
"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-actions.pod:5510 ../fish/guestfish-actions.pod:4211
-msgid "This calls the external C<zgrep -i> program and returns the matching lines."
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-availability.pod:3
-msgid "B<augeas>"
+#: ../src/guestfs-actions.pod:5791
+msgid ""
+"This is like the C<guestfs_strings> command, but allows you to specify the "
+"encoding of strings that are looked for in the source file C<path>."
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:5
-msgid ""
-"The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
-"L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
-"L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
-"L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
-"L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
+#: ../src/guestfs-actions.pod:5795 ../fish/guestfish-actions.pod:3858
+msgid "Allowed encodings are:"
msgstr ""
# type: =item
-#: ../src/guestfs-availability.pod:21
-msgid "B<inotify>"
+#: ../src/guestfs-actions.pod:5799 ../fish/guestfish-actions.pod:3862
+msgid "s"
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:23
+#: ../src/guestfs-actions.pod:5801
msgid ""
-"The following functions: L</guestfs_inotify_add_watch> "
-"L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
-"L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
+"Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
+"ISO-8859-X (this is what C<guestfs_strings> uses)."
msgstr ""
# type: =item
-#: ../src/guestfs-availability.pod:31
-msgid "B<linuxfsuuid>"
+#: ../src/guestfs-actions.pod:5804 ../fish/guestfish-actions.pod:3867
+msgid "S"
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:33
-msgid ""
-"The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
-"L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
+#: ../src/guestfs-actions.pod:5806 ../fish/guestfish-actions.pod:3869
+msgid "Single 8-bit-byte characters."
msgstr ""
# type: =item
-#: ../src/guestfs-availability.pod:40
-msgid "B<linuxmodules>"
+#: ../src/guestfs-actions.pod:5808 ../fish/guestfish-actions.pod:3871
+msgid "b"
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:42
-msgid "The following functions: L</guestfs_modprobe>"
+#: ../src/guestfs-actions.pod:5810 ../fish/guestfish-actions.pod:3873
+msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
msgstr ""
# type: =item
-#: ../src/guestfs-availability.pod:45
-msgid "B<linuxxattrs>"
+#: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3876
+msgid "l (lower case letter L)"
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:47
+#: ../src/guestfs-actions.pod:5815 ../fish/guestfish-actions.pod:3878
msgid ""
-"The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
-"L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
-"L</guestfs_removexattr> L</guestfs_setxattr>"
+"16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
+"examining binaries in Windows guests."
msgstr ""
# type: =item
-#: ../src/guestfs-availability.pod:56
-msgid "B<luks>"
+#: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3881
+msgid "B"
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:58
-msgid ""
-"The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
-"L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
-"L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
+#: ../src/guestfs-actions.pod:5820 ../fish/guestfish-actions.pod:3883
+msgid "32-bit big endian such as UCS-4BE."
msgstr ""
# type: =item
-#: ../src/guestfs-availability.pod:67
-msgid "B<lvm2>"
+#: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3885
+msgid "L"
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:69
-msgid ""
-"The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
-"L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
-"L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
-"L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
-"L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
-"L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
-"L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
-"L</guestfs_vgs_full>"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-availability.pod:92
-msgid "B<mknod>"
+#: ../src/guestfs-actions.pod:5824 ../fish/guestfish-actions.pod:3887
+msgid "32-bit little endian such as UCS-4LE."
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:94
-msgid ""
-"The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
-"L</guestfs_mknod_b> L</guestfs_mknod_c>"
+#: ../src/guestfs-actions.pod:5828 ../fish/guestfish-actions.pod:3891
+msgid "The returned strings are transcoded to UTF-8."
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:100
-msgid "B<ntfs3g>"
+# type: =head2
+#: ../src/guestfs-actions.pod:5839
+msgid "guestfs_swapoff_device"
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:102
-msgid "The following functions: L</guestfs_ntfs_3g_probe>"
+# type: verbatim
+#: ../src/guestfs-actions.pod:5841
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_swapoff_device (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:105
-msgid "B<ntfsprogs>"
+# type: textblock
+#: ../src/guestfs-actions.pod:5845
+msgid ""
+"This command disables the libguestfs appliance swap device or partition "
+"named C<device>. See C<guestfs_swapon_device>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:107
-msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
+# type: =head2
+#: ../src/guestfs-actions.pod:5853
+msgid "guestfs_swapoff_file"
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:111
-msgid "B<realpath>"
+# type: verbatim
+#: ../src/guestfs-actions.pod:5855
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_swapoff_file (guestfs_h *g,\n"
+" const char *file);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:113
-msgid "The following functions: L</guestfs_realpath>"
+#: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3908
+msgid "This command disables the libguestfs appliance swap on file."
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:116
-msgid "B<scrub>"
+# type: =head2
+#: ../src/guestfs-actions.pod:5865
+msgid "guestfs_swapoff_label"
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:118
+# type: verbatim
+#: ../src/guestfs-actions.pod:5867
+#, no-wrap
msgid ""
-"The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
-"L</guestfs_scrub_freespace>"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-availability.pod:123
-msgid "B<selinux>"
+" int\n"
+" guestfs_swapoff_label (guestfs_h *g,\n"
+" const char *label);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:125
-msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-availability.pod:129
-msgid "B<xz>"
+#: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3914
+msgid ""
+"This command disables the libguestfs appliance swap on labeled swap "
+"partition."
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:131
-msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
+# type: =head2
+#: ../src/guestfs-actions.pod:5878
+msgid "guestfs_swapoff_uuid"
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:135
-msgid "B<zerofree>"
+# type: verbatim
+#: ../src/guestfs-actions.pod:5880
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_swapoff_uuid (guestfs_h *g,\n"
+" const char *uuid);\n"
+"\n"
msgstr ""
# type: textblock
-#: ../src/guestfs-availability.pod:137
-msgid "The following functions: L</guestfs_zerofree>"
+#: ../src/guestfs-actions.pod:5884 ../fish/guestfish-actions.pod:3921
+msgid ""
+"This command disables the libguestfs appliance swap partition with the given "
+"UUID."
msgstr ""
# type: =head2
-#: ../src/guestfs-structs.pod:1
-msgid "guestfs_int_bool"
+#: ../src/guestfs-actions.pod:5891
+msgid "guestfs_swapon_device"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:3
+#: ../src/guestfs-actions.pod:5893
#, no-wrap
msgid ""
-" struct guestfs_int_bool {\n"
-" int32_t i;\n"
-" int32_t b;\n"
-" };\n"
-" \n"
+" int\n"
+" guestfs_swapon_device (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:8
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:5897
msgid ""
-" struct guestfs_int_bool_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_int_bool *val; /* Elements. */\n"
-" };\n"
-" \n"
+"This command enables the libguestfs appliance to use the swap device or "
+"partition named C<device>. The increased memory is made available for all "
+"commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5902 ../fish/guestfish-actions.pod:3933
+msgid ""
+"Note that you should not swap to existing guest swap partitions unless you "
+"know what you are doing. They may contain hibernation information, or other "
+"information that the guest doesn't want you to trash. You also risk leaking "
+"information about the host to the guest this way. Instead, attach a new "
+"host device to the guest and swap on that."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:5913
+msgid "guestfs_swapon_file"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:13
+#: ../src/guestfs-actions.pod:5915
#, no-wrap
msgid ""
-" void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
-" void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
+" int\n"
+" guestfs_swapon_file (guestfs_h *g,\n"
+" const char *file);\n"
"\n"
msgstr ""
+# type: textblock
+#: ../src/guestfs-actions.pod:5919
+msgid ""
+"This command enables swap to a file. See C<guestfs_swapon_device> for other "
+"notes."
+msgstr ""
+
# type: =head2
-#: ../src/guestfs-structs.pod:16
-msgid "guestfs_lvm_pv"
+#: ../src/guestfs-actions.pod:5926
+msgid "guestfs_swapon_label"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:18
+#: ../src/guestfs-actions.pod:5928
#, no-wrap
msgid ""
-" struct guestfs_lvm_pv {\n"
-" char *pv_name;\n"
-" /* The next field is NOT nul-terminated, be careful when printing it: "
-"*/\n"
-" char pv_uuid[32];\n"
-" char *pv_fmt;\n"
-" uint64_t pv_size;\n"
-" uint64_t dev_size;\n"
-" uint64_t pv_free;\n"
-" uint64_t pv_used;\n"
-" char *pv_attr;\n"
-" int64_t pv_pe_count;\n"
-" int64_t pv_pe_alloc_count;\n"
-" char *pv_tags;\n"
-" uint64_t pe_start;\n"
-" int64_t pv_mda_count;\n"
-" uint64_t pv_mda_free;\n"
-" };\n"
-" \n"
+" int\n"
+" guestfs_swapon_label (guestfs_h *g,\n"
+" const char *label);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:36
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:5932
msgid ""
-" struct guestfs_lvm_pv_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_lvm_pv *val; /* Elements. */\n"
-" };\n"
-" \n"
+"This command enables swap to a labeled swap partition. See "
+"C<guestfs_swapon_device> for other notes."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:5939
+msgid "guestfs_swapon_uuid"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:41
+#: ../src/guestfs-actions.pod:5941
#, no-wrap
msgid ""
-" void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
-" void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
+" int\n"
+" guestfs_swapon_uuid (guestfs_h *g,\n"
+" const char *uuid);\n"
"\n"
msgstr ""
+# type: textblock
+#: ../src/guestfs-actions.pod:5945
+msgid ""
+"This command enables swap to a swap partition with the given UUID. See "
+"C<guestfs_swapon_device> for other notes."
+msgstr ""
+
# type: =head2
-#: ../src/guestfs-structs.pod:44
-msgid "guestfs_lvm_vg"
+#: ../src/guestfs-actions.pod:5952
+msgid "guestfs_sync"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:46
+#: ../src/guestfs-actions.pod:5954
#, no-wrap
msgid ""
-" struct guestfs_lvm_vg {\n"
-" char *vg_name;\n"
-" /* The next field is NOT nul-terminated, be careful when printing it: "
-"*/\n"
-" char vg_uuid[32];\n"
-" char *vg_fmt;\n"
-" char *vg_attr;\n"
-" uint64_t vg_size;\n"
-" uint64_t vg_free;\n"
-" char *vg_sysid;\n"
-" uint64_t vg_extent_size;\n"
-" int64_t vg_extent_count;\n"
-" int64_t vg_free_count;\n"
-" int64_t max_lv;\n"
-" int64_t max_pv;\n"
-" int64_t pv_count;\n"
-" int64_t lv_count;\n"
-" int64_t snap_count;\n"
-" int64_t vg_seqno;\n"
-" char *vg_tags;\n"
-" int64_t vg_mda_count;\n"
-" uint64_t vg_mda_free;\n"
-" };\n"
-" \n"
+" int\n"
+" guestfs_sync (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:69
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:3965
msgid ""
-" struct guestfs_lvm_vg_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_lvm_vg *val; /* Elements. */\n"
-" };\n"
-" \n"
+"This syncs the disk, so that any writes are flushed through to the "
+"underlying disk image."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:3968
+msgid ""
+"You should always call this if you have modified a disk image, before "
+"closing the handle."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:5967
+msgid "guestfs_tail"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:74
+#: ../src/guestfs-actions.pod:5969
#, no-wrap
msgid ""
-" void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
-" void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
+" char **\n"
+" guestfs_tail (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
+# type: textblock
+#: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:3975
+msgid "This command returns up to the last 10 lines of a file as a list of strings."
+msgstr ""
+
# type: =head2
-#: ../src/guestfs-structs.pod:77
-msgid "guestfs_lvm_lv"
+#: ../src/guestfs-actions.pod:5985
+msgid "guestfs_tail_n"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:79
+#: ../src/guestfs-actions.pod:5987
#, no-wrap
msgid ""
-" struct guestfs_lvm_lv {\n"
-" char *lv_name;\n"
-" /* The next field is NOT nul-terminated, be careful when printing it: "
-"*/\n"
-" char lv_uuid[32];\n"
-" char *lv_attr;\n"
-" int64_t lv_major;\n"
-" int64_t lv_minor;\n"
-" int64_t lv_kernel_major;\n"
-" int64_t lv_kernel_minor;\n"
-" uint64_t lv_size;\n"
-" int64_t seg_count;\n"
-" char *origin;\n"
-" /* The next field is [0..100] or -1 meaning 'not present': */\n"
-" float snap_percent;\n"
-" /* The next field is [0..100] or -1 meaning 'not present': */\n"
-" float copy_percent;\n"
-" char *move_pv;\n"
-" char *lv_tags;\n"
-" char *mirror_log;\n"
-" char *modules;\n"
-" };\n"
-" \n"
+" char **\n"
+" guestfs_tail_n (guestfs_h *g,\n"
+" int nrlines,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:101
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:3985
msgid ""
-" struct guestfs_lvm_lv_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_lvm_lv *val; /* Elements. */\n"
-" };\n"
-" \n"
+"If the parameter C<nrlines> is a positive number, this returns the last "
+"C<nrlines> lines of the file C<path>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:5995 ../fish/guestfish-actions.pod:3988
+msgid ""
+"If the parameter C<nrlines> is a negative number, this returns lines from "
+"the file C<path>, starting with the C<-nrlines>th line."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6009
+msgid "guestfs_tar_in"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:106
+#: ../src/guestfs-actions.pod:6011
#, no-wrap
msgid ""
-" void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
-" void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
+" int\n"
+" guestfs_tar_in (guestfs_h *g,\n"
+" const char *tarfile,\n"
+" const char *directory);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:111
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4000
msgid ""
-" struct guestfs_stat {\n"
-" int64_t dev;\n"
-" int64_t ino;\n"
-" int64_t mode;\n"
-" int64_t nlink;\n"
-" int64_t uid;\n"
-" int64_t gid;\n"
-" int64_t rdev;\n"
-" int64_t size;\n"
-" int64_t blksize;\n"
-" int64_t blocks;\n"
-" int64_t atime;\n"
-" int64_t mtime;\n"
-" int64_t ctime;\n"
-" };\n"
-" \n"
+"This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
+"tar file) into C<directory>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6019
+msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6024 ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6073
+msgid "(Added in 1.0.3)"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6026
+msgid "guestfs_tar_out"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:127
+#: ../src/guestfs-actions.pod:6028
#, no-wrap
msgid ""
-" struct guestfs_stat_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_stat *val; /* Elements. */\n"
-" };\n"
-" \n"
+" int\n"
+" guestfs_tar_out (guestfs_h *g,\n"
+" const char *directory,\n"
+" const char *tarfile);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4012
+msgid ""
+"This command packs the contents of C<directory> and downloads it to local "
+"file C<tarfile>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6036
+msgid ""
+"To download a compressed tarball, use C<guestfs_tgz_out> or "
+"C<guestfs_txz_out>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6043
+msgid "guestfs_tgz_in"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:132
+#: ../src/guestfs-actions.pod:6045
#, no-wrap
msgid ""
-" void guestfs_free_stat (struct guestfs_free_stat *);\n"
-" void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
+" int\n"
+" guestfs_tgz_in (guestfs_h *g,\n"
+" const char *tarball,\n"
+" const char *directory);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:137
-#, no-wrap
+# type: textblock
+#: ../src/guestfs-actions.pod:6050 ../fish/guestfish-actions.pod:4024
msgid ""
-" struct guestfs_statvfs {\n"
-" int64_t bsize;\n"
-" int64_t frsize;\n"
-" int64_t blocks;\n"
+"This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
+"tar file) into C<directory>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6053
+msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6059
+msgid "guestfs_tgz_out"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6061
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_tgz_out (guestfs_h *g,\n"
+" const char *directory,\n"
+" const char *tarball);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6066 ../fish/guestfish-actions.pod:4035
+msgid ""
+"This command packs the contents of C<directory> and downloads it to local "
+"file C<tarball>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6069
+msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6075
+msgid "guestfs_touch"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6077
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_touch (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4046
+msgid ""
+"Touch acts like the L<touch(1)> command. It can be used to update the "
+"timestamps on a file, or, if the file does not exist, to create a new "
+"zero-length file."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6085 ../fish/guestfish-actions.pod:4050
+msgid ""
+"This command only works on regular files, and will fail on other file types "
+"such as directories, symbolic links, block special etc."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6092
+msgid "guestfs_truncate"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6094
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_truncate (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6098 ../fish/guestfish-actions.pod:4057
+msgid ""
+"This command truncates C<path> to a zero-length file. The file must exist "
+"already."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6105
+msgid "guestfs_truncate_size"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6107
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_truncate_size (guestfs_h *g,\n"
+" const char *path,\n"
+" int64_t size);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6112 ../fish/guestfish-actions.pod:4064
+msgid ""
+"This command truncates C<path> to size C<size> bytes. The file must exist "
+"already."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6115
+msgid ""
+"If the current file size is less than C<size> then the file is extended to "
+"the required size with zero bytes. This creates a sparse file (ie. disk "
+"blocks are not allocated for the file until you write to it). To create a "
+"non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6125
+msgid "guestfs_tune2fs_l"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6127
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_tune2fs_l (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6131 ../fish/guestfish-actions.pod:4077
+msgid ""
+"This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
+"C<device>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6134 ../fish/guestfish-actions.pod:4080
+msgid ""
+"It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
+"for more details. The list of fields returned isn't clearly defined, and "
+"depends on both the version of C<tune2fs> that libguestfs was built against, "
+"and the filesystem itself."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6147
+msgid "guestfs_txz_in"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6149
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_txz_in (guestfs_h *g,\n"
+" const char *tarball,\n"
+" const char *directory);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6154 ../fish/guestfish-actions.pod:4089
+msgid ""
+"This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
+"tar file) into C<directory>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6161
+msgid "guestfs_txz_out"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6163
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_txz_out (guestfs_h *g,\n"
+" const char *directory,\n"
+" const char *tarball);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6168 ../fish/guestfish-actions.pod:4098
+msgid ""
+"This command packs the contents of C<directory> and downloads it to local "
+"file C<tarball> (as an xz compressed tar archive)."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6175
+msgid "guestfs_umask"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6177
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_umask (guestfs_h *g,\n"
+" int mask);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6181 ../fish/guestfish-actions.pod:4107
+msgid ""
+"This function sets the mask used for creating new files and device nodes to "
+"C<mask & 0777>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6184 ../fish/guestfish-actions.pod:4110
+msgid ""
+"Typical umask values would be C<022> which creates new files with "
+"permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
+"new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6189 ../fish/guestfish-actions.pod:4115
+msgid ""
+"The default umask is C<022>. This is important because it means that "
+"directories and device nodes will be created with C<0644> or C<0755> mode "
+"even if you specify C<0777>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6193
+msgid ""
+"See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
+"C<guestfs_mkdir>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6196 ../fish/guestfish-actions.pod:4122
+msgid "This call returns the previous umask."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6202
+msgid "guestfs_umount"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6204
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_umount (guestfs_h *g,\n"
+" const char *pathordevice);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6208 ../fish/guestfish-actions.pod:4130
+msgid ""
+"This unmounts the given filesystem. The filesystem may be specified either "
+"by its mountpoint (path) or the device which contains the filesystem."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6216
+msgid "guestfs_umount_all"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6218
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_umount_all (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6221 ../fish/guestfish-actions.pod:4140
+msgid "This unmounts all mounted filesystems."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6223 ../fish/guestfish-actions.pod:4142
+msgid "Some internal mounts are not unmounted by this call."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6229
+msgid "guestfs_upload"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6231
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_upload (guestfs_h *g,\n"
+" const char *filename,\n"
+" const char *remotefilename);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6255 ../fish/guestfish-actions.pod:4148 ../fish/guestfish-actions.pod:4161
+msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6241
+msgid "See also C<guestfs_download>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6247
+msgid "guestfs_upload_offset"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6249
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_upload_offset (guestfs_h *g,\n"
+" const char *filename,\n"
+" const char *remotefilename,\n"
+" int64_t offset);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6258 ../fish/guestfish-actions.pod:4164
+msgid ""
+"C<remotefilename> is overwritten starting at the byte C<offset> specified. "
+"The intention is to overwrite parts of existing files or devices, although "
+"if a non-existant file is specified then it is created with a \"hole\" "
+"before C<offset>. The size of the data written is implicit in the size of "
+"the source C<filename>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6265
+msgid ""
+"Note that there is no limit on the amount of data that can be uploaded with "
+"this call, unlike with C<guestfs_pwrite>, and this call always writes the "
+"full amount unless an error occurs."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6270
+msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6276
+msgid "guestfs_utimens"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6278
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_utimens (guestfs_h *g,\n"
+" const char *path,\n"
+" int64_t atsecs,\n"
+" int64_t atnsecs,\n"
+" int64_t mtsecs,\n"
+" int64_t mtnsecs);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6286 ../fish/guestfish-actions.pod:4184
+msgid "This command sets the timestamps of a file with nanosecond precision."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6289 ../fish/guestfish-actions.pod:4187
+msgid ""
+"C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
+"from the epoch."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6292 ../fish/guestfish-actions.pod:4190
+msgid ""
+"C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
+"nanoseconds from the epoch."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6295 ../fish/guestfish-actions.pod:4193
+msgid ""
+"If the C<*nsecs> field contains the special value C<-1> then the "
+"corresponding timestamp is set to the current time. (The C<*secs> field is "
+"ignored in this case)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6299 ../fish/guestfish-actions.pod:4197
+msgid ""
+"If the C<*nsecs> field contains the special value C<-2> then the "
+"corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
+"in this case)."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6307 ../src/guestfs-structs.pod:175
+msgid "guestfs_version"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6309
+#, no-wrap
+msgid ""
+" struct guestfs_version *\n"
+" guestfs_version (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6312 ../fish/guestfish-actions.pod:4205
+msgid "Return the libguestfs version number that the program is linked against."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6315 ../fish/guestfish-actions.pod:4208
+msgid ""
+"Note that because of dynamic linking this is not necessarily the version of "
+"libguestfs that you compiled against. You can compile the program, and then "
+"at runtime dynamically link against a completely different C<libguestfs.so> "
+"library."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6320 ../fish/guestfish-actions.pod:4213
+msgid ""
+"This call was added in version C<1.0.58>. In previous versions of "
+"libguestfs there was no way to get the version number. From C code you can "
+"use dynamic linker functions to find out if this symbol exists (if it "
+"doesn't, then it's an earlier version)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4219
+msgid ""
+"The call returns a structure with four elements. The first three (C<major>, "
+"C<minor> and C<release>) are numbers and correspond to the usual version "
+"triplet. The fourth element (C<extra>) is a string and is normally empty, "
+"but may be used for distro-specific information."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6332 ../fish/guestfish-actions.pod:4225
+msgid "To construct the original version string: C<$major.$minor.$release$extra>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6335 ../fish/guestfish-actions.pod:4228
+msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6337
+msgid ""
+"I<Note:> Don't use this call to test for availability of features. In "
+"enterprise distributions we backport features from later versions into "
+"earlier versions, making this an unreliable way to test for features. Use "
+"C<guestfs_available> instead."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6343
+msgid ""
+"This function returns a C<struct guestfs_version *>, or NULL if there was an "
+"error. I<The caller must call C<guestfs_free_version> after use>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6347
+msgid "(Added in 1.0.58)"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6349
+msgid "guestfs_vfs_label"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6351
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_vfs_label (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6355 ../fish/guestfish-actions.pod:4240
+msgid "This returns the filesystem label of the filesystem on C<device>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6358 ../fish/guestfish-actions.pod:4243
+msgid "If the filesystem is unlabeled, this returns the empty string."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6360
+msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6365 ../src/guestfs-actions.pod:6402
+msgid "(Added in 1.3.18)"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6367
+msgid "guestfs_vfs_type"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6369
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_vfs_type (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6373 ../fish/guestfish-actions.pod:4251
+msgid ""
+"This command gets the filesystem type corresponding to the filesystem on "
+"C<device>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6376 ../fish/guestfish-actions.pod:4254
+msgid ""
+"For most filesystems, the result is the name of the Linux VFS module which "
+"would be used to mount this filesystem if you mounted it without specifying "
+"the filesystem type. For example a string such as C<ext3> or C<ntfs>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6386
+msgid "guestfs_vfs_uuid"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6388
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_vfs_uuid (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4263
+msgid "This returns the filesystem UUID of the filesystem on C<device>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4266
+msgid "If the filesystem does not have a UUID, this returns the empty string."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6397
+msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6404
+msgid "guestfs_vg_activate"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6406
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_vg_activate (guestfs_h *g,\n"
+" int activate,\n"
+" char *const *volgroups);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6411 ../fish/guestfish-actions.pod:4274
+msgid ""
+"This command activates or (if C<activate> is false) deactivates all logical "
+"volumes in the listed volume groups C<volgroups>. If activated, then they "
+"are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
+"deactivated, then those devices disappear."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6417 ../fish/guestfish-actions.pod:4280
+msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4282
+msgid ""
+"Note that if C<volgroups> is an empty list then B<all> volume groups are "
+"activated or deactivated."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6426
+msgid "guestfs_vg_activate_all"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6428
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_vg_activate_all (guestfs_h *g,\n"
+" int activate);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4289
+msgid ""
+"This command activates or (if C<activate> is false) deactivates all logical "
+"volumes in all volume groups. If activated, then they are made known to the "
+"kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
+"those devices disappear."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6438 ../fish/guestfish-actions.pod:4295
+msgid "This command is the same as running C<vgchange -a y|n>"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6444
+msgid "guestfs_vgcreate"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6446
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_vgcreate (guestfs_h *g,\n"
+" const char *volgroup,\n"
+" char *const *physvols);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6451 ../fish/guestfish-actions.pod:4301
+msgid ""
+"This creates an LVM volume group called C<volgroup> from the non-empty list "
+"of physical volumes C<physvols>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6458
+msgid "guestfs_vglvuuids"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6460
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_vglvuuids (guestfs_h *g,\n"
+" const char *vgname);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6464 ../fish/guestfish-actions.pod:4308
+msgid ""
+"Given a VG called C<vgname>, this returns the UUIDs of all the logical "
+"volumes created in this volume group."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6467
+msgid ""
+"You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
+"associate logical volumes and volume groups."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6470
+msgid "See also C<guestfs_vgpvuuids>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6478
+msgid "guestfs_vgpvuuids"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6480
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_vgpvuuids (guestfs_h *g,\n"
+" const char *vgname);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6484 ../fish/guestfish-actions.pod:4320
+msgid ""
+"Given a VG called C<vgname>, this returns the UUIDs of all the physical "
+"volumes that this volume group resides on."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6487
+msgid ""
+"You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
+"associate physical volumes and volume groups."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6490
+msgid "See also C<guestfs_vglvuuids>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6498
+msgid "guestfs_vgremove"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6500
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_vgremove (guestfs_h *g,\n"
+" const char *vgname);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6504 ../fish/guestfish-actions.pod:4332
+msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4334
+msgid "This also forcibly removes all logical volumes in the volume group (if any)."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6513
+msgid "guestfs_vgrename"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6515
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_vgrename (guestfs_h *g,\n"
+" const char *volgroup,\n"
+" const char *newvolgroup);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6520 ../fish/guestfish-actions.pod:4341
+msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6526
+msgid "guestfs_vgs"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6528
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_vgs (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6531 ../fish/guestfish-actions.pod:4347
+msgid ""
+"List all the volumes groups detected. This is the equivalent of the "
+"L<vgs(8)> command."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6534 ../fish/guestfish-actions.pod:4350
+msgid ""
+"This returns a list of just the volume group names that were detected "
+"(eg. C<VolGroup00>)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6537
+msgid "See also C<guestfs_vgs_full>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6545
+msgid "guestfs_vgs_full"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6547
+#, no-wrap
+msgid ""
+" struct guestfs_lvm_vg_list *\n"
+" guestfs_vgs_full (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4359
+msgid ""
+"List all the volumes groups detected. This is the equivalent of the "
+"L<vgs(8)> command. The \"full\" version includes all fields."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6553
+msgid ""
+"This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
+"was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
+"use>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6559
+msgid "guestfs_vgscan"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6561
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_vgscan (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6564 ../fish/guestfish-actions.pod:4366
+msgid ""
+"This rescans all block devices and rebuilds the list of LVM physical "
+"volumes, volume groups and logical volumes."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6571
+msgid "guestfs_vguuid"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6573
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_vguuid (guestfs_h *g,\n"
+" const char *vgname);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4373
+msgid "This command returns the UUID of the LVM VG named C<vgname>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6584
+msgid "guestfs_wait_ready"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6586
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_wait_ready (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6589
+msgid "This function is a no op."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6591
+msgid ""
+"In versions of the API E<lt> 1.0.71 you had to call this function just after "
+"calling C<guestfs_launch> to wait for the launch to complete. However this "
+"is no longer necessary because C<guestfs_launch> now does the waiting."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6596
+msgid ""
+"If you see any calls to this function in code then you can just remove them, "
+"unless you want to retain compatibility with older versions of the API."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6604
+msgid "guestfs_wc_c"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6606
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_wc_c (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6610 ../fish/guestfish-actions.pod:4379
+msgid ""
+"This command counts the characters in a file, using the C<wc -c> external "
+"command."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6617
+msgid "guestfs_wc_l"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6619
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_wc_l (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6623 ../fish/guestfish-actions.pod:4386
+msgid ""
+"This command counts the lines in a file, using the C<wc -l> external "
+"command."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6630
+msgid "guestfs_wc_w"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6632
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_wc_w (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6636 ../fish/guestfish-actions.pod:4393
+msgid ""
+"This command counts the words in a file, using the C<wc -w> external "
+"command."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6643
+msgid "guestfs_write"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6645
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_write (guestfs_h *g,\n"
+" const char *path,\n"
+" const char *content,\n"
+" size_t content_size);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6651 ../fish/guestfish-actions.pod:4400
+msgid ""
+"This call creates a file called C<path>. The content of the file is the "
+"string C<content> (which can contain any 8 bit data)."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6661
+msgid "guestfs_write_file"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6663
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_write_file (guestfs_h *g,\n"
+" const char *path,\n"
+" const char *content,\n"
+" int size);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6669 ../fish/guestfish-actions.pod:4410
+msgid ""
+"This call creates a file called C<path>. The contents of the file is the "
+"string C<content> (which can contain any 8 bit data), with length C<size>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4414
+msgid ""
+"As a special case, if C<size> is C<0> then the length is calculated using "
+"C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6677 ../fish/guestfish-actions.pod:4418
+msgid ""
+"I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
+"I<not> work, even if the length is specified."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6685 ../fish/guestfish-actions.pod:4424
+msgid "This function is deprecated. In new code, use the C<write> call instead."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6694
+msgid "guestfs_zegrep"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6696
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_zegrep (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6701 ../fish/guestfish-actions.pod:4435
+msgid "This calls the external C<zegrep> program and returns the matching lines."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6713
+msgid "guestfs_zegrepi"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6715
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_zegrepi (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6720 ../fish/guestfish-actions.pod:4445
+msgid "This calls the external C<zegrep -i> program and returns the matching lines."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6732
+msgid "guestfs_zero"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6734
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_zero (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6738 ../fish/guestfish-actions.pod:4455
+msgid "This command writes zeroes over the first few blocks of C<device>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6740 ../fish/guestfish-actions.pod:4457
+msgid ""
+"How many blocks are zeroed isn't specified (but it's I<not> enough to "
+"securely wipe the device). It should be sufficient to remove any partition "
+"tables, filesystem superblocks and so on."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6744
+msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6755
+msgid "guestfs_zero_device"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6757
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_zero_device (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6761
+msgid ""
+"This command writes zeroes over the entire C<device>. Compare with "
+"C<guestfs_zero> which just zeroes the first few blocks of a device."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6775
+msgid "(Added in 1.3.1)"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6777
+msgid "guestfs_zerofree"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6779
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_zerofree (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6783 ../fish/guestfish-actions.pod:4478
+msgid ""
+"This runs the I<zerofree> program on C<device>. This program claims to zero "
+"unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
+"possible to compress the filesystem more effectively."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6788 ../fish/guestfish-actions.pod:4483
+msgid "You should B<not> run this program if the filesystem is mounted."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4486
+msgid ""
+"It is possible that using this program can damage the filesystem or data on "
+"the filesystem."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6798
+msgid "guestfs_zfgrep"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6800
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_zfgrep (guestfs_h *g,\n"
+" const char *pattern,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4493
+msgid "This calls the external C<zfgrep> program and returns the matching lines."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6817
+msgid "guestfs_zfgrepi"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6819
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_zfgrepi (guestfs_h *g,\n"
+" const char *pattern,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6824 ../fish/guestfish-actions.pod:4503
+msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6836
+msgid "guestfs_zfile"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6838
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_zfile (guestfs_h *g,\n"
+" const char *meth,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6843 ../fish/guestfish-actions.pod:4513
+msgid "This command runs C<file> after first decompressing C<path> using C<method>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6846 ../fish/guestfish-actions.pod:4516
+msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6848
+msgid ""
+"Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
+"files."
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6854 ../fish/guestfish-actions.pod:4521
+msgid "This function is deprecated. In new code, use the C<file> call instead."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6863
+msgid "guestfs_zgrep"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6865
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_zgrep (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6870 ../fish/guestfish-actions.pod:4532
+msgid "This calls the external C<zgrep> program and returns the matching lines."
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-actions.pod:6882
+msgid "guestfs_zgrepi"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-actions.pod:6884
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_zgrepi (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-actions.pod:6889 ../fish/guestfish-actions.pod:4542
+msgid "This calls the external C<zgrep -i> program and returns the matching lines."
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:3
+msgid "B<augeas>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:5
+msgid ""
+"The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
+"L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
+"L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
+"L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
+"L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:21
+msgid "B<inotify>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:23
+msgid ""
+"The following functions: L</guestfs_inotify_add_watch> "
+"L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
+"L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:31
+msgid "B<linuxfsuuid>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:33
+msgid ""
+"The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
+"L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:40
+msgid "B<linuxmodules>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:42
+msgid "The following functions: L</guestfs_modprobe>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:45
+msgid "B<linuxxattrs>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:47
+msgid ""
+"The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
+"L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
+"L</guestfs_removexattr> L</guestfs_setxattr>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:56
+msgid "B<luks>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:58
+msgid ""
+"The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
+"L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
+"L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:67
+msgid "B<lvm2>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:69
+msgid ""
+"The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
+"L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
+"L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
+"L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
+"L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
+"L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
+"L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
+"L</guestfs_vgs_full>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:92
+msgid "B<mknod>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:94
+msgid ""
+"The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
+"L</guestfs_mknod_b> L</guestfs_mknod_c>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:100
+msgid "B<ntfs3g>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:102
+msgid "The following functions: L</guestfs_ntfs_3g_probe>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:105
+msgid "B<ntfsprogs>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:107
+msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:111
+msgid "B<realpath>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:113
+msgid "The following functions: L</guestfs_realpath>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:116
+msgid "B<scrub>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:118
+msgid ""
+"The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
+"L</guestfs_scrub_freespace>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:123
+msgid "B<selinux>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:125
+msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:129
+msgid "B<xz>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:131
+msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
+msgstr ""
+
+# type: =item
+#: ../src/guestfs-availability.pod:135
+msgid "B<zerofree>"
+msgstr ""
+
+# type: textblock
+#: ../src/guestfs-availability.pod:137
+msgid "The following functions: L</guestfs_zerofree>"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-structs.pod:1
+msgid "guestfs_int_bool"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:3
+#, no-wrap
+msgid ""
+" struct guestfs_int_bool {\n"
+" int32_t i;\n"
+" int32_t b;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:8
+#, no-wrap
+msgid ""
+" struct guestfs_int_bool_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_int_bool *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:13
+#, no-wrap
+msgid ""
+" void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
+" void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-structs.pod:16
+msgid "guestfs_lvm_pv"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:18
+#, no-wrap
+msgid ""
+" struct guestfs_lvm_pv {\n"
+" char *pv_name;\n"
+" /* The next field is NOT nul-terminated, be careful when printing it: "
+"*/\n"
+" char pv_uuid[32];\n"
+" char *pv_fmt;\n"
+" uint64_t pv_size;\n"
+" uint64_t dev_size;\n"
+" uint64_t pv_free;\n"
+" uint64_t pv_used;\n"
+" char *pv_attr;\n"
+" int64_t pv_pe_count;\n"
+" int64_t pv_pe_alloc_count;\n"
+" char *pv_tags;\n"
+" uint64_t pe_start;\n"
+" int64_t pv_mda_count;\n"
+" uint64_t pv_mda_free;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:36
+#, no-wrap
+msgid ""
+" struct guestfs_lvm_pv_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_lvm_pv *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:41
+#, no-wrap
+msgid ""
+" void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
+" void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-structs.pod:44
+msgid "guestfs_lvm_vg"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:46
+#, no-wrap
+msgid ""
+" struct guestfs_lvm_vg {\n"
+" char *vg_name;\n"
+" /* The next field is NOT nul-terminated, be careful when printing it: "
+"*/\n"
+" char vg_uuid[32];\n"
+" char *vg_fmt;\n"
+" char *vg_attr;\n"
+" uint64_t vg_size;\n"
+" uint64_t vg_free;\n"
+" char *vg_sysid;\n"
+" uint64_t vg_extent_size;\n"
+" int64_t vg_extent_count;\n"
+" int64_t vg_free_count;\n"
+" int64_t max_lv;\n"
+" int64_t max_pv;\n"
+" int64_t pv_count;\n"
+" int64_t lv_count;\n"
+" int64_t snap_count;\n"
+" int64_t vg_seqno;\n"
+" char *vg_tags;\n"
+" int64_t vg_mda_count;\n"
+" uint64_t vg_mda_free;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:69
+#, no-wrap
+msgid ""
+" struct guestfs_lvm_vg_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_lvm_vg *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:74
+#, no-wrap
+msgid ""
+" void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
+" void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-structs.pod:77
+msgid "guestfs_lvm_lv"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:79
+#, no-wrap
+msgid ""
+" struct guestfs_lvm_lv {\n"
+" char *lv_name;\n"
+" /* The next field is NOT nul-terminated, be careful when printing it: "
+"*/\n"
+" char lv_uuid[32];\n"
+" char *lv_attr;\n"
+" int64_t lv_major;\n"
+" int64_t lv_minor;\n"
+" int64_t lv_kernel_major;\n"
+" int64_t lv_kernel_minor;\n"
+" uint64_t lv_size;\n"
+" int64_t seg_count;\n"
+" char *origin;\n"
+" /* The next field is [0..100] or -1 meaning 'not present': */\n"
+" float snap_percent;\n"
+" /* The next field is [0..100] or -1 meaning 'not present': */\n"
+" float copy_percent;\n"
+" char *move_pv;\n"
+" char *lv_tags;\n"
+" char *mirror_log;\n"
+" char *modules;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:101
+#, no-wrap
+msgid ""
+" struct guestfs_lvm_lv_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_lvm_lv *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:106
+#, no-wrap
+msgid ""
+" void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
+" void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:111
+#, no-wrap
+msgid ""
+" struct guestfs_stat {\n"
+" int64_t dev;\n"
+" int64_t ino;\n"
+" int64_t mode;\n"
+" int64_t nlink;\n"
+" int64_t uid;\n"
+" int64_t gid;\n"
+" int64_t rdev;\n"
+" int64_t size;\n"
+" int64_t blksize;\n"
+" int64_t blocks;\n"
+" int64_t atime;\n"
+" int64_t mtime;\n"
+" int64_t ctime;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:127
+#, no-wrap
+msgid ""
+" struct guestfs_stat_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_stat *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:132
+#, no-wrap
+msgid ""
+" void guestfs_free_stat (struct guestfs_free_stat *);\n"
+" void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:137
+#, no-wrap
+msgid ""
+" struct guestfs_statvfs {\n"
+" int64_t bsize;\n"
+" int64_t frsize;\n"
+" int64_t blocks;\n"
" int64_t bfree;\n"
" int64_t bavail;\n"
" int64_t files;\n"
" \n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:151
-#, no-wrap
+# type: verbatim
+#: ../src/guestfs-structs.pod:151
+#, no-wrap
+msgid ""
+" struct guestfs_statvfs_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_statvfs *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:156
+#, no-wrap
+msgid ""
+" void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
+" void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-structs.pod:159
+msgid "guestfs_dirent"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:161
+#, no-wrap
+msgid ""
+" struct guestfs_dirent {\n"
+" int64_t ino;\n"
+" char ftyp;\n"
+" char *name;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:167
+#, no-wrap
+msgid ""
+" struct guestfs_dirent_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_dirent *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:172
+#, no-wrap
+msgid ""
+" void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
+" void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:177
+#, no-wrap
+msgid ""
+" struct guestfs_version {\n"
+" int64_t major;\n"
+" int64_t minor;\n"
+" int64_t release;\n"
+" char *extra;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:184
+#, no-wrap
+msgid ""
+" struct guestfs_version_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_version *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:189
+#, no-wrap
+msgid ""
+" void guestfs_free_version (struct guestfs_free_version *);\n"
+" void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-structs.pod:192
+msgid "guestfs_xattr"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:194
+#, no-wrap
+msgid ""
+" struct guestfs_xattr {\n"
+" char *attrname;\n"
+" /* The next two fields describe a byte array. */\n"
+" uint32_t attrval_len;\n"
+" char *attrval;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:201
+#, no-wrap
+msgid ""
+" struct guestfs_xattr_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_xattr *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:206
+#, no-wrap
+msgid ""
+" void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
+" void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-structs.pod:209
+msgid "guestfs_inotify_event"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:211
+#, no-wrap
+msgid ""
+" struct guestfs_inotify_event {\n"
+" int64_t in_wd;\n"
+" uint32_t in_mask;\n"
+" uint32_t in_cookie;\n"
+" char *in_name;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:218
+#, no-wrap
+msgid ""
+" struct guestfs_inotify_event_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_inotify_event *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:223
+#, no-wrap
+msgid ""
+" void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
+" void guestfs_free_inotify_event_list (struct "
+"guestfs_free_inotify_event_list *);\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../src/guestfs-structs.pod:226
+msgid "guestfs_partition"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:228
+#, no-wrap
+msgid ""
+" struct guestfs_partition {\n"
+" int32_t part_num;\n"
+" uint64_t part_start;\n"
+" uint64_t part_end;\n"
+" uint64_t part_size;\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:235
+#, no-wrap
+msgid ""
+" struct guestfs_partition_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_partition *val; /* Elements. */\n"
+" };\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../src/guestfs-structs.pod:240
+#, no-wrap
+msgid ""
+" void guestfs_free_partition (struct guestfs_free_partition *);\n"
+" void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:5
+msgid "guestfish - the libguestfs Filesystem Interactive SHell"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:9
+#, no-wrap
+msgid ""
+" guestfish [--options] [commands]\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:11
+#, no-wrap
+msgid ""
+" guestfish\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:13
+#, no-wrap
+msgid ""
+" guestfish [--ro|--rw] -a disk.img\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:15
+#, no-wrap
+msgid ""
+" guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:17
+#, no-wrap
+msgid ""
+" guestfish -d libvirt-domain\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:19
+#, no-wrap
+msgid ""
+" guestfish [--ro|--rw] -a disk.img -i\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:21
+#, no-wrap
+msgid ""
+" guestfish -d libvirt-domain -i\n"
+"\n"
+msgstr ""
+
+# type: =head1
+#: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59 ../tools/virt-rescue.pl:41
+msgid "WARNING"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:25
+msgid ""
+"Using guestfish in read/write mode on live virtual machines can be "
+"dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
+"option to use guestfish safely if the disk image or virtual machine might be "
+"live."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:32
+msgid ""
+"Guestfish is a shell and command-line tool for examining and modifying "
+"virtual machine filesystems. It uses libguestfs and exposes all of the "
+"functionality of the guestfs API, see L<guestfs(3)>."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:36
+msgid ""
+"Guestfish gives you structured access to the libguestfs API, from shell "
+"scripts or the command line or interactively. If you want to rescue a "
+"broken virtual machine image, you should look at the L<virt-rescue(1)> "
+"command."
+msgstr ""
+
+# type: =head1
+#: ../fish/guestfish.pod:41 ../fish/guestfish.pod:846 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:66 ../tools/virt-tar.pl:45
+msgid "EXAMPLES"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish.pod:43
+msgid "As an interactive shell"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:45
+#, no-wrap
+msgid ""
+" $ guestfish\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:47
+#, no-wrap
+msgid ""
+" Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
+" editing virtual machine filesystems.\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:50
+#, no-wrap
+msgid ""
+" Type: 'help' for a list of commands\n"
+" 'man' to read the manual\n"
+" 'quit' to quit the shell\n"
+" \n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:54
+#, no-wrap
+msgid ""
+" ><fs> add-ro disk.img\n"
+" ><fs> run\n"
+" ><fs> list-filesystems\n"
+" /dev/sda1: ext4\n"
+" /dev/vg_guest/lv_root: ext4\n"
+" /dev/vg_guest/lv_swap: swap\n"
+" ><fs> mount /dev/vg_guest/lv_root /\n"
+" ><fs> cat /etc/fstab\n"
+" # /etc/fstab\n"
+" # Created by anaconda\n"
+" [...]\n"
+" ><fs> exit\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish.pod:67
+msgid "From shell scripts"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:69
+msgid "Create a new C</etc/motd> file in a guest or disk image:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:71
+#, no-wrap
+msgid ""
+" guestfish <<_EOF_\n"
+" add disk.img\n"
+" run\n"
+" mount /dev/vg_guest/lv_root /\n"
+" write /etc/motd \"Welcome, new users\"\n"
+" _EOF_\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:78
+msgid "List the LVM logical volumes in a disk image:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:80
+#, no-wrap
+msgid ""
+" guestfish -a disk.img --ro <<_EOF_\n"
+" run\n"
+" lvs\n"
+" _EOF_\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:85
+msgid "List all the filesystems in a disk image:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:87
+#, no-wrap
+msgid ""
+" guestfish -a disk.img --ro <<_EOF_\n"
+" run\n"
+" list-filesystems\n"
+" _EOF_\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish.pod:92
+msgid "On one command line"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:94
+msgid "Update C</etc/resolv.conf> in a guest:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:96
+#, no-wrap
+msgid ""
+" guestfish \\\n"
+" add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
+" write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:100
+msgid "Edit C</boot/grub/grub.conf> interactively:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:102
+#, no-wrap
+msgid ""
+" guestfish --rw --add disk.img \\\n"
+" --mount /dev/vg_guest/lv_root \\\n"
+" --mount /dev/sda1:/boot \\\n"
+" edit /boot/grub/grub.conf\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish.pod:107
+msgid "Mount disks automatically"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:109
+msgid ""
+"Use the I<-i> option to automatically mount the disks from a virtual "
+"machine:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:112
+#, no-wrap
+msgid ""
+" guestfish --ro -a disk.img -i cat /etc/group\n"
+"\n"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:114
+#, no-wrap
+msgid ""
+" guestfish --ro -d libvirt-domain -i cat /etc/group\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:116
+msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:118
+#, no-wrap
+msgid ""
+" guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish.pod:120
+msgid "As a script interpreter"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:122
+msgid "Create a 100MB disk containing an ext2-formatted partition:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:124
+#, no-wrap
+msgid ""
+" #!/usr/bin/guestfish -f\n"
+" sparse test1.img 100M\n"
+" run\n"
+" part-disk /dev/sda mbr\n"
+" mkfs ext2 /dev/sda1\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish.pod:130
+msgid "Start with a prepared disk"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:132
+msgid ""
+"An alternate way to create a 100MB disk called C<test1.img> containing a "
+"single ext2-formatted partition:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:135
+#, no-wrap
+msgid ""
+" guestfish -N fs\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:137
+msgid "To list what is available do:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:139 ../fish/guestfish.pod:837
+#, no-wrap
+msgid ""
+" guestfish -N help | less\n"
+"\n"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish.pod:141
+msgid "Remote control"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:143
+#, no-wrap
+msgid ""
+" eval \"`guestfish --listen`\"\n"
+" guestfish --remote add-ro disk.img\n"
+" guestfish --remote run\n"
+" guestfish --remote lvs\n"
+"\n"
+msgstr ""
+
+# type: =head1
+#: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../inspector/virt-inspector.pl:68 ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171 ../tools/virt-df.pl:71 ../tools/virt-ls.pl:78 ../tools/virt-resize.pl:257 ../tools/virt-list-filesystems.pl:50 ../tools/virt-tar.pl:98 ../tools/virt-rescue.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:51
+msgid "OPTIONS"
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../inspector/virt-inspector.pl:76 ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:86 ../tools/virt-resize.pl:265 ../tools/virt-list-filesystems.pl:58 ../tools/virt-tar.pl:106 ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:59
+msgid "B<--help>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:154
+msgid "Displays general help on options."
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:156
+msgid "B<-h> | B<--cmd-help>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:158
+msgid "Lists all available guestfish commands."
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:160
+msgid "B<-h cmd> | B<--cmd-help cmd>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:162
+msgid "Displays detailed help on a single command C<cmd>."
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
+msgid "B<-a image> | B<--add image>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:166
+msgid "Add a block device or virtual machine image to the shell."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
+msgid ""
+"The format of the disk image is auto-detected. To override this and force a "
+"particular format use the I<--format=..> option."
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
+msgid "B<-c URI> | B<--connect URI>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
+msgid ""
+"When used in conjunction with the I<-d> option, this specifies the libvirt "
+"URI to use. The default is to use the default libvirt connection."
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:177
+msgid "B<--csh>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:179
msgid ""
-" struct guestfs_statvfs_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_statvfs *val; /* Elements. */\n"
-" };\n"
-" \n"
+"If using the I<--listen> option and a csh-like shell, use this option. See "
+"section L</REMOTE CONTROL AND CSH> below."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:156
-#, no-wrap
+# type: =item
+#: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
+msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
msgid ""
-" void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
-" void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
-"\n"
+"Add disks from the named libvirt domain. If the I<--ro> option is also "
+"used, then any libvirt domain can be used. However in write mode, only "
+"libvirt domains which are shut down can be named here."
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:159
-msgid "guestfs_dirent"
+# type: =item
+#: ../fish/guestfish.pod:188
+msgid "B<-D> | B<--no-dest-paths>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:161
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:190
msgid ""
-" struct guestfs_dirent {\n"
-" int64_t ino;\n"
-" char ftyp;\n"
-" char *name;\n"
-" };\n"
-" \n"
+"Don't tab-complete paths on the guest filesystem. It is useful to be able "
+"to hit the tab key to complete paths on the guest filesystem, but this "
+"causes extra \"hidden\" guestfs calls to be made, so this option is here to "
+"allow this feature to be disabled."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:167
-#, no-wrap
-msgid ""
-" struct guestfs_dirent_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_dirent *val; /* Elements. */\n"
-" };\n"
-" \n"
+# type: =item
+#: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
+msgid "B<--echo-keys>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:172
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
msgid ""
-" void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
-" void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
-"\n"
+"When prompting for keys and passphrases, guestfish normally turns echoing "
+"off so you cannot see what you are typing. If you are not worried about "
+"Tempest attacks and there is no one else in the room you can specify this "
+"flag to see what you are typing."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:177
-#, no-wrap
-msgid ""
-" struct guestfs_version {\n"
-" int64_t major;\n"
-" int64_t minor;\n"
-" int64_t release;\n"
-" char *extra;\n"
-" };\n"
-" \n"
+# type: =item
+#: ../fish/guestfish.pod:202
+msgid "B<-f file> | B<--file file>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:184
-#, no-wrap
-msgid ""
-" struct guestfs_version_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_version *val; /* Elements. */\n"
-" };\n"
-" \n"
+# type: textblock
+#: ../fish/guestfish.pod:204
+msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:189
+#: ../fish/guestfish.pod:207
#, no-wrap
msgid ""
-" void guestfs_free_version (struct guestfs_free_version *);\n"
-" void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
+" #!/usr/bin/guestfish -f\n"
"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:192
-msgid "guestfs_xattr"
+# type: =item
+#: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
+msgid "B<--format=raw|qcow2|..> | B<--format>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:194
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
msgid ""
-" struct guestfs_xattr {\n"
-" char *attrname;\n"
-" /* The next two fields describe a byte array. */\n"
-" uint32_t attrval_len;\n"
-" char *attrval;\n"
-" };\n"
-" \n"
+"The default for the I<-a> option is to auto-detect the format of the disk "
+"image. Using this forces the disk format for I<-a> options which follow on "
+"the command line. Using I<--format> with no argument switches back to "
+"auto-detection for subsequent I<-a> options."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:201
-#, no-wrap
-msgid ""
-" struct guestfs_xattr_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_xattr *val; /* Elements. */\n"
-" };\n"
-" \n"
+# type: textblock
+#: ../fish/guestfish.pod:216 ../fish/guestfish.pod:543 ../inspector/virt-inspector.pl:515
+msgid "For example:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:206
+#: ../fish/guestfish.pod:218
#, no-wrap
msgid ""
-" void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
-" void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
+" guestfish --format=raw -a disk.img\n"
"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:209
-msgid "guestfs_inotify_event"
+# type: textblock
+#: ../fish/guestfish.pod:220
+msgid "forces raw format (no auto-detection) for C<disk.img>."
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:211
+#: ../fish/guestfish.pod:222
#, no-wrap
msgid ""
-" struct guestfs_inotify_event {\n"
-" int64_t in_wd;\n"
-" uint32_t in_mask;\n"
-" uint32_t in_cookie;\n"
-" char *in_name;\n"
-" };\n"
-" \n"
+" guestfish --format=raw -a disk.img --format -a another.img\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:218
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:224
msgid ""
-" struct guestfs_inotify_event_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_inotify_event *val; /* Elements. */\n"
-" };\n"
-" \n"
+"forces raw format (no auto-detection) for C<disk.img> and reverts to "
+"auto-detection for C<another.img>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:223
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:227
msgid ""
-" void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
-" void guestfs_free_inotify_event_list (struct "
-"guestfs_free_inotify_event_list *);\n"
-"\n"
+"If you have untrusted raw-format guest disk images, you should use this "
+"option to specify the disk format. This avoids a possible security problem "
+"with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:226
-msgid "guestfs_partition"
+# type: =item
+#: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
+msgid "B<-i> | B<--inspector>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:228
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
msgid ""
-" struct guestfs_partition {\n"
-" int32_t part_num;\n"
-" uint64_t part_start;\n"
-" uint64_t part_end;\n"
-" uint64_t part_size;\n"
-" };\n"
-" \n"
+"Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
+"system and mount filesystems as they would be mounted on the real virtual "
+"machine."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:235
-#, no-wrap
-msgid ""
-" struct guestfs_partition_list {\n"
-" uint32_t len; /* Number of elements in list. */\n"
-" struct guestfs_partition *val; /* Elements. */\n"
-" };\n"
-" \n"
+# type: textblock
+#: ../fish/guestfish.pod:238
+msgid "Typical usage is either:"
msgstr ""
# type: verbatim
-#: ../src/guestfs-structs.pod:240
+#: ../fish/guestfish.pod:240
#, no-wrap
msgid ""
-" void guestfs_free_partition (struct guestfs_free_partition *);\n"
-" void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
+" guestfish -d myguest -i\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:5
-msgid "guestfish - the libguestfs Filesystem Interactive SHell"
+#: ../fish/guestfish.pod:242
+msgid "(for an inactive libvirt domain called I<myguest>), or:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:9
+#: ../fish/guestfish.pod:244
#, no-wrap
msgid ""
-" guestfish [--options] [commands]\n"
+" guestfish --ro -d myguest -i\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish.pod:246
+msgid "(for active domains, readonly), or specify the block device directly:"
+msgstr ""
+
# type: verbatim
-#: ../fish/guestfish.pod:11
+#: ../fish/guestfish.pod:248
#, no-wrap
msgid ""
-" guestfish\n"
+" guestfish --rw -a /dev/Guests/MyGuest -i\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:13
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:250
msgid ""
-" guestfish -a disk.img\n"
-"\n"
+"Note that the command line syntax changed slightly over older versions of "
+"guestfish. You can still use the old syntax:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:15
+#: ../fish/guestfish.pod:253
#, no-wrap
msgid ""
-" guestfish -a disk.img -m dev[:mountpoint]\n"
+" guestfish [--ro] -i disk.img\n"
"\n"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:17
+#: ../fish/guestfish.pod:255
#, no-wrap
msgid ""
-" guestfish -d libvirt-domain\n"
+" guestfish [--ro] -i libvirt-domain\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:19
-#, no-wrap
+# type: =item
+#: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
+msgid "B<--keys-from-stdin>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
msgid ""
-" guestfish -a disk.img -i\n"
-"\n"
+"Read key or passphrase parameters from stdin. The default is to try to read "
+"passphrases from the user by opening C</dev/tty>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:21
-#, no-wrap
+# type: =item
+#: ../fish/guestfish.pod:262
+msgid "B<--listen>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:264
msgid ""
-" guestfish -d libvirt-domain -i\n"
-"\n"
+"Fork into the background and listen for remote commands. See section "
+"L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:11 ../tools/virt-edit.pl:45 ../tools/virt-rescue.pl:41 ../tools/virt-tar.pl:60 ../tools/virt-win-reg.pl:52
-msgid "WARNING"
+# type: =item
+#: ../fish/guestfish.pod:267
+msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:269
+msgid "Mount the named partition or logical volume on the given mountpoint."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:271
+msgid "If the mountpoint is omitted, it defaults to C</>."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:273
+msgid "You have to mount something on C</> before most commands will work."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:25
+#: ../fish/guestfish.pod:275
msgid ""
-"Using guestfish in read/write mode on live virtual machines can be "
-"dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
-"option to use guestfish safely if the disk image or virtual machine might be "
-"live."
+"If any I<-m> or I<--mount> options are given, the guest is automatically "
+"launched."
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:30 ../fish/guestfish.pod:729 ../fuse/guestmount.pod:35 ../tools/virt-cat.pl:51 ../tools/virt-edit.pl:59 ../tools/virt-resize.pl:66 ../tools/virt-tar.pl:46
-msgid "EXAMPLES"
+# type: textblock
+#: ../fish/guestfish.pod:278
+msgid ""
+"If you don't know what filesystems a disk image contains, you can either run "
+"guestfish without this option, then list the partitions and LVs available "
+"(see L</list-partitions> and L</lvs> commands), or you can use the "
+"L<virt-list-filesystems(1)> program."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:32
-msgid "As an interactive shell"
+# type: =item
+#: ../fish/guestfish.pod:283 ../fuse/guestmount.pod:154
+msgid "B<-n> | B<--no-sync>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:34
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:285
msgid ""
-" $ guestfish\n"
-" \n"
+"Disable autosync. This is enabled by default. See the discussion of "
+"autosync in the L<guestfs(3)> manpage."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:36
-#, no-wrap
-msgid ""
-" Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
-" editing virtual machine filesystems.\n"
-" \n"
+# type: =item
+#: ../fish/guestfish.pod:288
+msgid "B<-N type> | B<--new type> | B<-N help>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:39
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:290
msgid ""
-" Type: 'help' for a list of commands\n"
-" 'man' to read the manual\n"
-" 'quit' to quit the shell\n"
-" \n"
+"Prepare a fresh disk image formatted as \"type\". This is an alternative to "
+"the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
+"preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
+"IMAGES> below."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:43
-#, no-wrap
-msgid ""
-" ><fs> man\n"
-"\n"
+# type: =item
+#: ../fish/guestfish.pod:295
+msgid "B<--progress-bars>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:45
-msgid "From shell scripts"
+# type: textblock
+#: ../fish/guestfish.pod:297
+msgid "Enable progress bars, even when guestfish is used non-interactively."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:47
-msgid "Create a new C</etc/motd> file in a guest:"
+#: ../fish/guestfish.pod:299
+msgid ""
+"Progress bars are enabled by default when guestfish is used as an "
+"interactive shell."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:49
-#, no-wrap
-msgid ""
-" guestfish <<_EOF_\n"
-" add disk.img\n"
-" run\n"
-" mount /dev/vg_guest/lv_root /\n"
-" write /etc/motd \"Welcome, new users\"\n"
-" _EOF_\n"
-"\n"
+# type: =item
+#: ../fish/guestfish.pod:302
+msgid "B<--no-progress-bars>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:56
-msgid "List the LVM logical volumes in a guest:"
+#: ../fish/guestfish.pod:304
+msgid "Disable progress bars."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:58
-#, no-wrap
+# type: =item
+#: ../fish/guestfish.pod:306
+msgid "B<--remote[=pid]>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:308
msgid ""
-" guestfish -a disk.img --ro <<_EOF_\n"
-" run\n"
-" lvs\n"
-" _EOF_\n"
-"\n"
+"Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
+"CONTROL GUESTFISH OVER A SOCKET> below."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:63
-msgid "On one command line"
+# type: =item
+#: ../fish/guestfish.pod:311 ../fuse/guestmount.pod:196
+msgid "B<-r> | B<--ro>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:65
-msgid "Update C</etc/resolv.conf> in a guest:"
+#: ../fish/guestfish.pod:313
+msgid ""
+"This changes the I<-a> and I<-m> options so that disks are added and mounts "
+"are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:67
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:316 ../tools/virt-rescue.pl:187
msgid ""
-" guestfish \\\n"
-" add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
-" write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
-"\n"
+"The option must always be used if the disk image or virtual machine might be "
+"running, and is generally recommended in cases where you don't need write "
+"access to the disk."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:71
-msgid "Edit C</boot/grub/grub.conf> interactively:"
+#: ../fish/guestfish.pod:320
+msgid ""
+"Note that prepared disk images created with I<-N> are not affected by the "
+"I<--ro> option."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:73
-#, no-wrap
-msgid ""
-" guestfish --add disk.img \\\n"
-" --mount /dev/vg_guest/lv_root \\\n"
-" --mount /dev/sda1:/boot \\\n"
-" edit /boot/grub/grub.conf\n"
-"\n"
+# type: textblock
+#: ../fish/guestfish.pod:323
+msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:78
-msgid "Mount disks automatically"
+# type: =item
+#: ../fish/guestfish.pod:325 ../fuse/guestmount.pod:208 ../tools/virt-rescue.pl:195
+msgid "B<--selinux>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:80
-msgid ""
-"Use the I<-i> option to automatically mount the disks from a virtual "
-"machine:"
+#: ../fish/guestfish.pod:327
+msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:83
-#, no-wrap
-msgid ""
-" guestfish --ro -a disk.img -i cat /etc/group\n"
-"\n"
+# type: =item
+#: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:212
+msgid "B<-v> | B<--verbose>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:85
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:331
msgid ""
-" guestfish --ro -d libvirt-domain -i cat /etc/group\n"
-"\n"
+"Enable very verbose messages. This is particularly useful if you find a "
+"bug."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:87
-msgid "As a script interpreter"
+# type: =item
+#: ../fish/guestfish.pod:334 ../fuse/guestmount.pod:216
+msgid "B<-V> | B<--version>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:89
-msgid "Create a 100MB disk containing an ext2-formatted partition:"
+#: ../fish/guestfish.pod:336
+msgid "Display the guestfish / libguestfs version number and exit."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:91
-#, no-wrap
+# type: =item
+#: ../fish/guestfish.pod:338 ../fuse/guestmount.pod:220
+msgid "B<-w> | B<--rw>"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:340
msgid ""
-" #!/usr/bin/guestfish -f\n"
-" sparse test1.img 100M\n"
-" run\n"
-" part-disk /dev/sda mbr\n"
-" mkfs ext2 /dev/sda1\n"
-"\n"
+"This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
+"WRITE> below."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:97
-msgid "Start with a prepared disk"
+# type: =item
+#: ../fish/guestfish.pod:343
+msgid "B<-x>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:99
-msgid ""
-"An alternate way to create a 100MB disk called C<test1.img> containing a "
-"single ext2-formatted partition:"
+#: ../fish/guestfish.pod:345
+msgid "Echo each command before executing it."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:102
-#, no-wrap
-msgid ""
-" guestfish -N fs\n"
-"\n"
+# type: =head1
+#: ../fish/guestfish.pod:349
+msgid "COMMANDS ON COMMAND LINE"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:104
-msgid "To list what is available do:"
+#: ../fish/guestfish.pod:351
+msgid "Any additional (non-option) arguments are treated as commands to execute."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:106 ../fish/guestfish.pod:720
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:354
msgid ""
-" guestfish -N help | less\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish.pod:108
-msgid "Remote control"
+"Commands to execute should be separated by a colon (C<:>), where the colon "
+"is a separate parameter. Thus:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:110
+#: ../fish/guestfish.pod:357
#, no-wrap
msgid ""
-" eval `guestfish --listen --ro`\n"
-" guestfish --remote add disk.img\n"
-" guestfish --remote run\n"
-" guestfish --remote lvs\n"
+" guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:117
+#: ../fish/guestfish.pod:359
msgid ""
-"Guestfish is a shell and command-line tool for examining and modifying "
-"virtual machine filesystems. It uses libguestfs and exposes all of the "
-"functionality of the guestfs API, see L<guestfs(3)>."
+"If there are no additional arguments, then we enter a shell, either an "
+"interactive shell with a prompt (if the input is a terminal) or a "
+"non-interactive shell."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:121
+#: ../fish/guestfish.pod:363
msgid ""
-"Guestfish gives you structured access to the libguestfs API, from shell "
-"scripts or the command line or interactively. If you want to rescue a "
-"broken virtual machine image, you should look at the L<virt-rescue(1)> "
-"command."
+"In either command line mode or non-interactive shell, the first command that "
+"gives an error causes the whole shell to exit. In interactive mode (with a "
+"prompt) if a command fails, you can continue to enter commands."
msgstr ""
# type: =head1
-#: ../fish/guestfish.pod:126 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:70 ../inspector/virt-inspector.pl:75 ../tools/virt-cat.pl:80 ../tools/virt-df.pl:71 ../tools/virt-edit.pl:73 ../tools/virt-list-filesystems.pl:50 ../tools/virt-list-partitions.pl:51 ../tools/virt-ls.pl:79 ../tools/virt-make-fs.pl:153 ../tools/virt-rescue.pl:103 ../tools/virt-resize.pl:233 ../tools/virt-tar.pl:99 ../tools/virt-win-reg.pl:172
-msgid "OPTIONS"
-msgstr ""
-
-# type: =item
-#: ../fish/guestfish.pod:130 ../fuse/guestmount.pod:94 ../inspector/virt-inspector.pl:83 ../tools/virt-cat.pl:88 ../tools/virt-df.pl:79 ../tools/virt-edit.pl:81 ../tools/virt-list-filesystems.pl:58 ../tools/virt-list-partitions.pl:59 ../tools/virt-ls.pl:87 ../tools/virt-make-fs.pl:161 ../tools/virt-rescue.pl:111 ../tools/virt-resize.pl:241 ../tools/virt-tar.pl:107 ../tools/virt-win-reg.pl:180
-msgid "B<--help>"
+#: ../fish/guestfish.pod:368
+msgid "USING launch (OR run)"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:132
-msgid "Displays general help on options."
-msgstr ""
-
-# type: =item
-#: ../fish/guestfish.pod:134
-msgid "B<-h> | B<--cmd-help>"
+#: ../fish/guestfish.pod:370
+msgid ""
+"As with L<guestfs(3)>, you must first configure your guest by adding disks, "
+"then launch it, then mount any disks you need, and finally issue "
+"actions/commands. So the general order of the day is:"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:136
-msgid "Lists all available guestfish commands."
-msgstr ""
-
-# type: =item
-#: ../fish/guestfish.pod:138
-msgid "B<-h cmd> | B<--cmd-help cmd>"
+#: ../fish/guestfish.pod:378
+msgid "add or -a/--add"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:140
-msgid "Displays detailed help on a single command C<cmd>."
+#: ../fish/guestfish.pod:382
+msgid "launch (aka run)"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:142 ../fuse/guestmount.pod:74
-msgid "B<-a image> | B<--add image>"
+# type: textblock
+#: ../fish/guestfish.pod:386
+msgid "mount or -m/--mount"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:144
-msgid "Add a block device or virtual machine image to the shell."
+#: ../fish/guestfish.pod:390
+msgid "any other commands"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:146
-msgid "B<-c URI> | B<--connect URI>"
+# type: textblock
+#: ../fish/guestfish.pod:394
+msgid ""
+"C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
+"guest before mounting or performing any other commands."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:148
+#: ../fish/guestfish.pod:397
msgid ""
-"When used in conjunction with the I<-d> option, this specifies the libvirt "
-"URI to use. The default is to use the default libvirt connection."
+"The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
+"I<--new> options were given then C<run> is done automatically, simply "
+"because guestfish can't perform the action you asked for without doing this."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:152
-msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
+# type: =head1
+#: ../fish/guestfish.pod:402
+msgid "OPENING DISKS FOR READ AND WRITE"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:154
+#: ../fish/guestfish.pod:404
msgid ""
-"Add disks from the named libvirt domain. If the I<--ro> option is also "
-"used, then any libvirt domain can be used. However in write mode, only "
-"libvirt domains which are shut down can be named here."
+"The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
+"whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
+"open disk images read-only or for writing."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:158
-msgid "B<-D> | B<--no-dest-paths>"
+# type: textblock
+#: ../fish/guestfish.pod:408
+msgid ""
+"In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
+"disk images supplied on the command line for write. To open a disk image "
+"read-only you have to do I<-a image --ro>."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:160
+#: ../fish/guestfish.pod:412
msgid ""
-"Don't tab-complete paths on the guest filesystem. It is useful to be able "
-"to hit the tab key to complete paths on the guest filesystem, but this "
-"causes extra \"hidden\" guestfs calls to be made, so this option is here to "
-"allow this feature to be disabled."
+"This matters: If you accidentally open a live VM disk image writable then "
+"you will cause irreversible disk corruption."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:165
-msgid "B<-f file> | B<--file file>"
+# type: textblock
+#: ../fish/guestfish.pod:415
+msgid ""
+"By libguestfs 1.8 we intend to change the default the other way. Disk "
+"images will be opened read-only. You will have to either specify "
+"I<guestfish --rw> or change a configuration file in order to get write "
+"access for disk images specified by those other command line options."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:167
-msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
+#: ../fish/guestfish.pod:420
+msgid ""
+"This version of guestfish has a I<--rw> option which does nothing (it is "
+"already the default). However it is highly recommended that you use this "
+"option to indicate that guestfish needs write access, and to prepare your "
+"scripts for the day when this option will be required for write access."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:170
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:426
msgid ""
-" #!/usr/bin/guestfish -f\n"
-"\n"
+"B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
+"other libguestfs program apart from guestfish and guestmount."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:172
-msgid "B<-i> | B<--inspector>"
+# type: =head1
+#: ../fish/guestfish.pod:429
+msgid "QUOTING"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:174
+#: ../fish/guestfish.pod:431
msgid ""
-"Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
-"system and mount filesystems as they would be mounted on the real virtual "
-"machine."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:178
-msgid "Typical usage is either:"
+"You can quote ordinary parameters using either single or double quotes. For "
+"example:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:180
+#: ../fish/guestfish.pod:434
#, no-wrap
msgid ""
-" guestfish -d myguest -i\n"
+" add \"file with a space.img\"\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:182
-msgid "(for an inactive libvirt domain called I<myguest>), or:"
+# type: verbatim
+#: ../fish/guestfish.pod:436
+#, no-wrap
+msgid ""
+" rm '/file name'\n"
+"\n"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:184
+#: ../fish/guestfish.pod:438
#, no-wrap
msgid ""
-" guestfish --ro -d myguest -i\n"
+" rm '/\"'\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:186
-msgid "(for active domains, readonly), or specify the block device directly:"
+#: ../fish/guestfish.pod:440
+msgid ""
+"A few commands require a list of strings to be passed. For these, use a "
+"whitespace-separated list, enclosed in quotes. Strings containing "
+"whitespace to be passed through must be enclosed in single quotes. A "
+"literal single quote must be escaped with a backslash."
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:188
+#: ../fish/guestfish.pod:445
#, no-wrap
msgid ""
-" guestfish -a /dev/Guests/MyGuest -i\n"
+" vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
+" command \"/bin/echo 'foo bar'\"\n"
+" command \"/bin/echo \\'foo\\'\"\n"
"\n"
msgstr ""
+# type: =head1
+#: ../fish/guestfish.pod:449
+msgid "OPTIONAL ARGUMENTS"
+msgstr ""
+
# type: textblock
-#: ../fish/guestfish.pod:190
+#: ../fish/guestfish.pod:451
msgid ""
-"Note that the command line syntax changed slightly over older versions of "
-"guestfish. You can still use the old syntax:"
+"Some commands take optional arguments. These arguments appear in this "
+"documentation as C<[argname:..]>. You can use them as in these examples:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:193
+#: ../fish/guestfish.pod:455
#, no-wrap
msgid ""
-" guestfish [--ro] -i disk.img\n"
+" add-drive-opts filename\n"
"\n"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:195
+#: ../fish/guestfish.pod:457
#, no-wrap
msgid ""
-" guestfish [--ro] -i libvirt-domain\n"
+" add-drive-opts filename readonly:true\n"
"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:197
-msgid "B<--keys-from-stdin>"
+# type: verbatim
+#: ../fish/guestfish.pod:459
+#, no-wrap
+msgid ""
+" add-drive-opts filename format:qcow2 readonly:false\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:199
+#: ../fish/guestfish.pod:461
msgid ""
-"Read key or passphrase parameters from stdin. The default is to try to read "
-"passphrases from the user by opening C</dev/tty>."
+"Each optional argument can appear at most once. All optional arguments must "
+"appear after the required ones."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:202
-msgid "B<--listen>"
+# type: =head1
+#: ../fish/guestfish.pod:464
+msgid "NUMBERS"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:204
-msgid ""
-"Fork into the background and listen for remote commands. See section "
-"L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
+#: ../fish/guestfish.pod:466
+msgid "This section applies to all commands which can take integers as parameters."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:207
-msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
+# type: =head2
+#: ../fish/guestfish.pod:469
+msgid "SIZE SUFFIX"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:209
-msgid "Mount the named partition or logical volume on the given mountpoint."
+#: ../fish/guestfish.pod:471
+msgid ""
+"When the command takes a parameter measured in bytes, you can use one of the "
+"following suffixes to specify kilobytes, megabytes and larger sizes:"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:211
-msgid "If the mountpoint is omitted, it defaults to C</>."
+# type: =item
+#: ../fish/guestfish.pod:477
+msgid "B<k> or B<K> or B<KiB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:213
-msgid "You have to mount something on C</> before most commands will work."
+#: ../fish/guestfish.pod:479
+msgid "The size in kilobytes (multiplied by 1024)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:215
-msgid ""
-"If any I<-m> or I<--mount> options are given, the guest is automatically "
-"launched."
+# type: =item
+#: ../fish/guestfish.pod:481
+msgid "B<KB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:218
-msgid ""
-"If you don't know what filesystems a disk image contains, you can either run "
-"guestfish without this option, then list the partitions and LVs available "
-"(see L</list-partitions> and L</lvs> commands), or you can use the "
-"L<virt-list-filesystems(1)> program."
+#: ../fish/guestfish.pod:483
+msgid "The size in SI 1000 byte units."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:223 ../fuse/guestmount.pod:106
-msgid "B<-n> | B<--no-sync>"
+#: ../fish/guestfish.pod:485
+msgid "B<M> or B<MiB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:225
-msgid ""
-"Disable autosync. This is enabled by default. See the discussion of "
-"autosync in the L<guestfs(3)> manpage."
+#: ../fish/guestfish.pod:487
+msgid "The size in megabytes (multiplied by 1048576)."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:228
-msgid "B<-N type> | B<--new type> | B<-N help>"
+#: ../fish/guestfish.pod:489
+msgid "B<MB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:230
-msgid ""
-"Prepare a fresh disk image formatted as \"type\". This is an alternative to "
-"the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
-"preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
-"IMAGES> below."
+#: ../fish/guestfish.pod:491
+msgid "The size in SI 1000000 byte units."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:235
-msgid "B<--progress-bars>"
+#: ../fish/guestfish.pod:493
+msgid "B<G> or B<GiB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:237
-msgid "Enable progress bars, even when guestfish is used non-interactively."
+#: ../fish/guestfish.pod:495
+msgid "The size in gigabytes (multiplied by 2**30)."
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:497
+msgid "B<GB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:239
-msgid ""
-"Progress bars are enabled by default when guestfish is used as an "
-"interactive shell."
+#: ../fish/guestfish.pod:499
+msgid "The size in SI 10**9 byte units."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:242
-msgid "B<--no-progress-bars>"
+#: ../fish/guestfish.pod:501
+msgid "B<T> or B<TiB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:244
-msgid "Disable progress bars."
+#: ../fish/guestfish.pod:503
+msgid "The size in terabytes (multiplied by 2**40)."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:246
-msgid "B<--remote[=pid]>"
+#: ../fish/guestfish.pod:505
+msgid "B<TB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:248
-msgid ""
-"Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
-"CONTROL GUESTFISH OVER A SOCKET> below."
+#: ../fish/guestfish.pod:507
+msgid "The size in SI 10**12 byte units."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:251 ../fuse/guestmount.pod:148
-msgid "B<-r> | B<--ro>"
+#: ../fish/guestfish.pod:509
+msgid "B<P> or B<PiB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:253
-msgid ""
-"This changes the I<-a> and I<-m> options so that disks are added and mounts "
-"are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
+#: ../fish/guestfish.pod:511
+msgid "The size in petabytes (multiplied by 2**50)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:256 ../tools/virt-rescue.pl:162
-msgid ""
-"The option must always be used if the disk image or virtual machine might be "
-"running, and is generally recommended in cases where you don't need write "
-"access to the disk."
+# type: =item
+#: ../fish/guestfish.pod:513
+msgid "B<PB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:260
-msgid ""
-"Note that prepared disk images created with I<-N> are not affected by the "
-"I<--ro> option."
+#: ../fish/guestfish.pod:515
+msgid "The size in SI 10**15 byte units."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:263 ../fuse/guestmount.pod:158 ../tools/virt-rescue.pl:170
-msgid "B<--selinux>"
+#: ../fish/guestfish.pod:517
+msgid "B<E> or B<EiB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:265
-msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
+#: ../fish/guestfish.pod:519
+msgid "The size in exabytes (multiplied by 2**60)."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:267 ../fuse/guestmount.pod:168
-msgid "B<-v> | B<--verbose>"
+#: ../fish/guestfish.pod:521
+msgid "B<EB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:269
-msgid ""
-"Enable very verbose messages. This is particularly useful if you find a "
-"bug."
+#: ../fish/guestfish.pod:523
+msgid "The size in SI 10**18 byte units."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:272 ../fuse/guestmount.pod:172
-msgid "B<-V> | B<--version>"
+#: ../fish/guestfish.pod:525
+msgid "B<Z> or B<ZiB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:274
-msgid "Display the guestfish / libguestfs version number and exit."
+#: ../fish/guestfish.pod:527
+msgid "The size in zettabytes (multiplied by 2**70)."
msgstr ""
# type: =item
-#: ../fish/guestfish.pod:276
-msgid "B<-x>"
+#: ../fish/guestfish.pod:529
+msgid "B<ZB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:278
-msgid "Echo each command before executing it."
+#: ../fish/guestfish.pod:531
+msgid "The size in SI 10**21 byte units."
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:282
-msgid "COMMANDS ON COMMAND LINE"
+# type: =item
+#: ../fish/guestfish.pod:533
+msgid "B<Y> or B<YiB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:284
-msgid "Any additional (non-option) arguments are treated as commands to execute."
+#: ../fish/guestfish.pod:535
+msgid "The size in yottabytes (multiplied by 2**80)."
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:537
+msgid "B<YB>"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:287
-msgid ""
-"Commands to execute should be separated by a colon (C<:>), where the colon "
-"is a separate parameter. Thus:"
+#: ../fish/guestfish.pod:539
+msgid "The size in SI 10**24 byte units."
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:290
+#: ../fish/guestfish.pod:545
#, no-wrap
msgid ""
-" guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
+" truncate-size /file 1G\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:292
-msgid ""
-"If there are no additional arguments, then we enter a shell, either an "
-"interactive shell with a prompt (if the input is a terminal) or a "
-"non-interactive shell."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:296
-msgid ""
-"In either command line mode or non-interactive shell, the first command that "
-"gives an error causes the whole shell to exit. In interactive mode (with a "
-"prompt) if a command fails, you can continue to enter commands."
-msgstr ""
-
-# type: =head1
-#: ../fish/guestfish.pod:301
-msgid "USING launch (OR run)"
+#: ../fish/guestfish.pod:547
+msgid "would truncate the file to 1 gigabyte."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:303
+#: ../fish/guestfish.pod:549
msgid ""
-"As with L<guestfs(3)>, you must first configure your guest by adding disks, "
-"then launch it, then mount any disks you need, and finally issue "
-"actions/commands. So the general order of the day is:"
+"Be careful because a few commands take sizes in kilobytes or megabytes "
+"(eg. the parameter to L</memsize> is specified in megabytes already). "
+"Adding a suffix will probably not do what you expect."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:311
-msgid "add or -a/--add"
+# type: =head2
+#: ../fish/guestfish.pod:553
+msgid "OCTAL AND HEXADECIMAL NUMBERS"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:315
-msgid "launch (aka run)"
+#: ../fish/guestfish.pod:555
+msgid ""
+"For specifying the radix (base) use the C convention: C<0> to prefix an "
+"octal number or C<0x> to prefix a hexadecimal number. For example:"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:319
-msgid "mount or -m/--mount"
+# type: verbatim
+#: ../fish/guestfish.pod:558
+#, no-wrap
+msgid ""
+" 1234 decimal number 1234\n"
+" 02322 octal number, equivalent to decimal 1234\n"
+" 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:323
-msgid "any other commands"
+#: ../fish/guestfish.pod:562
+msgid ""
+"When using the C<chmod> command, you almost always want to specify an octal "
+"number for the mode, and you must prefix it with C<0> (unlike the Unix "
+"L<chmod(1)> program):"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:327
+# type: verbatim
+#: ../fish/guestfish.pod:566
+#, no-wrap
msgid ""
-"C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
-"guest before mounting or performing any other commands."
+" chmod 0777 /public # OK\n"
+" chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:330
+#: ../fish/guestfish.pod:569
msgid ""
-"The only exception is that if the I<-m> or I<--mount> option was given, the "
-"guest is automatically run for you (simply because guestfish can't mount the "
-"disks you asked for without doing this)."
+"Commands that return numbers usually print them in decimal, but some "
+"commands print numbers in other radices (eg. C<umask> prints the mode in "
+"octal, preceeded by C<0>)."
msgstr ""
# type: =head1
-#: ../fish/guestfish.pod:334
-msgid "QUOTING"
+#: ../fish/guestfish.pod:573
+msgid "WILDCARDS AND GLOBBING"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:336
+#: ../fish/guestfish.pod:575
msgid ""
-"You can quote ordinary parameters using either single or double quotes. For "
-"example:"
+"Neither guestfish nor the underlying guestfs API performs wildcard expansion "
+"(globbing) by default. So for example the following will not do what you "
+"expect:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:339
+#: ../fish/guestfish.pod:579
#, no-wrap
msgid ""
-" add \"file with a space.img\"\n"
+" rm-rf /home/*\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:341
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:581
msgid ""
-" rm '/file name'\n"
-"\n"
+"Assuming you don't have a directory called literally C</home/*> then the "
+"above command will return an error."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:584
+msgid "To perform wildcard expansion, use the C<glob> command."
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:343
+#: ../fish/guestfish.pod:586
#, no-wrap
msgid ""
-" rm '/\"'\n"
+" glob rm-rf /home/*\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:345
+#: ../fish/guestfish.pod:588
msgid ""
-"A few commands require a list of strings to be passed. For these, use a "
-"whitespace-separated list, enclosed in quotes. Strings containing "
-"whitespace to be passed through must be enclosed in single quotes. A "
-"literal single quote must be escaped with a backslash."
+"runs C<rm-rf> on each path that matches (ie. potentially running the command "
+"many times), equivalent to:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:350
+#: ../fish/guestfish.pod:591
#, no-wrap
msgid ""
-" vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
-" command \"/bin/echo 'foo bar'\"\n"
-" command \"/bin/echo \\'foo\\'\"\n"
+" rm-rf /home/jim\n"
+" rm-rf /home/joe\n"
+" rm-rf /home/mary\n"
"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:354
-msgid "NUMBERS"
+# type: textblock
+#: ../fish/guestfish.pod:595
+msgid "C<glob> only works on simple guest paths and not on device names."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:356
-msgid "This section applies to all commands which can take integers as parameters."
+#: ../fish/guestfish.pod:597
+msgid ""
+"If you have several parameters, each containing a wildcard, then glob will "
+"perform a Cartesian product."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:359
-msgid "SIZE SUFFIX"
+# type: =head1
+#: ../fish/guestfish.pod:600
+msgid "COMMENTS"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:361
+#: ../fish/guestfish.pod:602
msgid ""
-"When the command takes a parameter measured in bytes, you can use one of the "
-"following suffixes to specify kilobytes, megabytes and larger sizes:"
+"Any line which starts with a I<#> character is treated as a comment and "
+"ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
+"a command. For example:"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:367
-msgid "B<k> or B<K> or B<KiB>"
+# type: verbatim
+#: ../fish/guestfish.pod:606
+#, no-wrap
+msgid ""
+" # this is a comment\n"
+" # this is a comment\n"
+" foo # NOT a comment\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:369
-msgid "The size in kilobytes (multiplied by 1024)."
+#: ../fish/guestfish.pod:610
+msgid "Blank lines are also ignored."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:371
-msgid "B<KB>"
+# type: =head1
+#: ../fish/guestfish.pod:612
+msgid "RUNNING COMMANDS LOCALLY"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:373
-msgid "The size in SI 1000 byte units."
+#: ../fish/guestfish.pod:614
+msgid ""
+"Any line which starts with a I<!> character is treated as a command sent to "
+"the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:375
-msgid "B<M> or B<MiB>"
+# type: verbatim
+#: ../fish/guestfish.pod:618
+#, no-wrap
+msgid ""
+" !mkdir local\n"
+" tgz-out /remote local/remote-data.tar.gz\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:377
-msgid "The size in megabytes (multiplied by 1048576)."
-msgstr ""
-
-# type: =item
-#: ../fish/guestfish.pod:379
-msgid "B<MB>"
+#: ../fish/guestfish.pod:621
+msgid ""
+"will create a directory C<local> on the host, and then export the contents "
+"of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
+"(See C<tgz-out>)."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:381
-msgid "The size in SI 1000000 byte units."
+#: ../fish/guestfish.pod:625
+msgid ""
+"To change the local directory, use the C<lcd> command. C<!cd> will have no "
+"effect, due to the way that subprocesses work in Unix."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:383
-msgid "B<G> or B<GiB>"
+# type: =head1
+#: ../fish/guestfish.pod:628
+msgid "PIPES"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:385
-msgid "The size in gigabytes (multiplied by 2**30)."
+#: ../fish/guestfish.pod:630
+msgid ""
+"Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
+"command (a guestfish command) to the second command (any host command). For "
+"example:"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:387
-msgid "B<GB>"
+# type: verbatim
+#: ../fish/guestfish.pod:634
+#, no-wrap
+msgid ""
+" cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:389
-msgid "The size in SI 10**9 byte units."
+#: ../fish/guestfish.pod:636
+msgid ""
+"(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
+"program). The above command would list all accounts in the guest filesystem "
+"which have UID 0, ie. root accounts including backdoors. Other examples:"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:391
-msgid "B<T> or B<TiB>"
+# type: verbatim
+#: ../fish/guestfish.pod:641
+#, no-wrap
+msgid ""
+" hexdump /bin/ls | head\n"
+" list-devices | tail -1\n"
+" tgz-out / - | tar ztf -\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:393
-msgid "The size in terabytes (multiplied by 2**40)."
+#: ../fish/guestfish.pod:645
+msgid ""
+"The space before the pipe symbol is required, any space after the pipe "
+"symbol is optional. Everything after the pipe symbol is just passed "
+"straight to the host shell, so it can contain redirections, globs and "
+"anything else that makes sense on the host side."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:395
-msgid "B<TB>"
+# type: textblock
+#: ../fish/guestfish.pod:650
+msgid ""
+"To use a literal argument which begins with a pipe symbol, you have to quote "
+"it, eg:"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:397
-msgid "The size in SI 10**12 byte units."
+# type: verbatim
+#: ../fish/guestfish.pod:653
+#, no-wrap
+msgid ""
+" echo \"|\"\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:399
-msgid "B<P> or B<PiB>"
+# type: =head1
+#: ../fish/guestfish.pod:655
+msgid "HOME DIRECTORIES"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:401
-msgid "The size in petabytes (multiplied by 2**50)."
+#: ../fish/guestfish.pod:657
+msgid ""
+"If a parameter starts with the character C<~> then the tilde may be expanded "
+"as a home directory path (either C<~> for the current user's home directory, "
+"or C<~user> for another user)."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:403
-msgid "B<PB>"
+# type: textblock
+#: ../fish/guestfish.pod:661
+msgid ""
+"Note that home directory expansion happens for users known I<on the host>, "
+"not in the guest filesystem."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:405
-msgid "The size in SI 10**15 byte units."
+#: ../fish/guestfish.pod:664
+msgid ""
+"To use a literal argument which begins with a tilde, you have to quote it, "
+"eg:"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:407
-msgid "B<E> or B<EiB>"
+# type: verbatim
+#: ../fish/guestfish.pod:667
+#, no-wrap
+msgid ""
+" echo \"~\"\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:409
-msgid "The size in exabytes (multiplied by 2**60)."
+#: ../fish/guestfish.pod:671
+msgid ""
+"Libguestfs has some support for Linux guests encrypted according to the "
+"Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
+"disk encryption systems used by modern Linux guests. Currently only "
+"LVM-on-LUKS is supported."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:411
-msgid "B<EB>"
+# type: textblock
+#: ../fish/guestfish.pod:676
+msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:678
+#, no-wrap
+msgid ""
+" ><fs> vfs-type /dev/sda2\n"
+" crypto_LUKS\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:413
-msgid "The size in SI 10**18 byte units."
+#: ../fish/guestfish.pod:681
+msgid ""
+"Then open those devices using L</luks-open>. This creates a device-mapper "
+"device called C</dev/mapper/luksdev>."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:415
-msgid "B<Z> or B<ZiB>"
+# type: verbatim
+#: ../fish/guestfish.pod:684
+#, no-wrap
+msgid ""
+" ><fs> luks-open /dev/sda2 luksdev\n"
+" Enter key or passphrase (\"key\"): <enter the passphrase>\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:417
-msgid "The size in zettabytes (multiplied by 2**70)."
+#: ../fish/guestfish.pod:687
+msgid ""
+"Finally you have to tell LVM to scan for volume groups on the newly created "
+"mapper device:"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:419
-msgid "B<ZB>"
+# type: verbatim
+#: ../fish/guestfish.pod:690
+#, no-wrap
+msgid ""
+" vgscan\n"
+" vg-activate-all true\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:693
+msgid "The logical volume(s) can now be mounted in the usual way."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:421
-msgid "The size in SI 10**21 byte units."
+#: ../fish/guestfish.pod:695
+msgid ""
+"Before closing a LUKS device you must unmount any logical volumes on it and "
+"deactivate the volume groups by calling C<vg-activate false VG> on each "
+"one. Then you can close the mapper device:"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:423
-msgid "B<Y> or B<YiB>"
+# type: verbatim
+#: ../fish/guestfish.pod:699
+#, no-wrap
+msgid ""
+" vg-activate false /dev/VG\n"
+" luks-close /dev/mapper/luksdev\n"
+"\n"
+msgstr ""
+
+# type: =head1
+#: ../fish/guestfish.pod:702
+msgid "WINDOWS PATHS"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:425
-msgid "The size in yottabytes (multiplied by 2**80)."
+#: ../fish/guestfish.pod:704
+msgid ""
+"If a path is prefixed with C<win:> then you can use Windows-style paths "
+"(with some limitations). The following commands are equivalent:"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:427
-msgid "B<YB>"
+# type: verbatim
+#: ../fish/guestfish.pod:707
+#, no-wrap
+msgid ""
+" file /WINDOWS/system32/config/system.LOG\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:429
-msgid "The size in SI 10**24 byte units."
+# type: verbatim
+#: ../fish/guestfish.pod:709
+#, no-wrap
+msgid ""
+" file win:/windows/system32/config/system.log\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:433
-msgid "For example:"
+# type: verbatim
+#: ../fish/guestfish.pod:711
+#, no-wrap
+msgid ""
+" file win:\\windows\\system32\\config\\system.log\n"
+"\n"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:435
+#: ../fish/guestfish.pod:713
#, no-wrap
msgid ""
-" truncate-size /file 1G\n"
+" file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:437
-msgid "would truncate the file to 1 gigabyte."
+#: ../fish/guestfish.pod:715
+msgid ""
+"This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
+"handles case insensitivity like Windows would. This only works in argument "
+"positions that expect a path."
+msgstr ""
+
+# type: =head1
+#: ../fish/guestfish.pod:719
+msgid "UPLOADING AND DOWNLOADING FILES"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:439
+#: ../fish/guestfish.pod:721
msgid ""
-"Be careful because a few commands take sizes in kilobytes or megabytes "
-"(eg. the parameter to L</memsize> is specified in megabytes already). "
-"Adding a suffix will probably not do what you expect."
+"For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
+"others which upload from or download to a local file, you can use the "
+"special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:443
-msgid "OCTAL AND HEXADECIMAL NUMBERS"
+# type: verbatim
+#: ../fish/guestfish.pod:725
+#, no-wrap
+msgid ""
+" upload - /foo\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:445
-msgid ""
-"For specifying the radix (base) use the C convention: C<0> to prefix an "
-"octal number or C<0x> to prefix a hexadecimal number. For example:"
+#: ../fish/guestfish.pod:727
+msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:448
+#: ../fish/guestfish.pod:730
#, no-wrap
msgid ""
-" 1234 decimal number 1234\n"
-" 02322 octal number, equivalent to decimal 1234\n"
-" 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
+" tar-out /etc - | tar tf -\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:452
+#: ../fish/guestfish.pod:732
msgid ""
-"When using the C<chmod> command, you almost always want to specify an octal "
-"number for the mode, and you must prefix it with C<0> (unlike the Unix "
-"L<chmod(1)> program):"
+"writes the tarball to stdout and then pipes that into the external \"tar\" "
+"command (see L</PIPES>)."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:735
+msgid ""
+"When using C<-> to read from stdin, the input is read up to the end of "
+"stdin. You can also use a special \"heredoc\"-like syntax to read up to "
+"some arbitrary end marker:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:456
+#: ../fish/guestfish.pod:739
#, no-wrap
msgid ""
-" chmod 0777 /public # OK\n"
-" chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
+" upload -<<END /foo\n"
+" input line 1\n"
+" input line 2\n"
+" input line 3\n"
+" END\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:459
+#: ../fish/guestfish.pod:745
msgid ""
-"Commands that return numbers usually print them in decimal, but some "
-"commands print numbers in other radices (eg. C<umask> prints the mode in "
-"octal, preceeded by C<0>)."
+"Any string of characters can be used instead of C<END>. The end marker must "
+"appear on a line of its own, without any preceeding or following characters "
+"(not even spaces)."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:749
+msgid ""
+"Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
+"upload local files (so-called \"FileIn\" parameters in the generator)."
msgstr ""
# type: =head1
-#: ../fish/guestfish.pod:463
-msgid "WILDCARDS AND GLOBBING"
+#: ../fish/guestfish.pod:752
+msgid "EXIT ON ERROR BEHAVIOUR"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:465
+#: ../fish/guestfish.pod:754
msgid ""
-"Neither guestfish nor the underlying guestfs API performs wildcard expansion "
-"(globbing) by default. So for example the following will not do what you "
-"expect:"
+"By default, guestfish will ignore any errors when in interactive mode "
+"(ie. taking commands from a human over a tty), and will exit on the first "
+"error in non-interactive mode (scripts, commands given on the command line)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:469
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:759
msgid ""
-" rm-rf /home/*\n"
-"\n"
+"If you prefix a command with a I<-> character, then that command will not "
+"cause guestfish to exit, even if that (one) command returns an error."
+msgstr ""
+
+# type: =head1
+#: ../fish/guestfish.pod:763
+msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:471
+#: ../fish/guestfish.pod:765
msgid ""
-"Assuming you don't have a directory literally called C</home/*> then the "
-"above command will return an error."
+"Guestfish can be remote-controlled over a socket. This is useful "
+"particularly in shell scripts where you want to make several different "
+"changes to a filesystem, but you don't want the overhead of starting up a "
+"guestfish process each time."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:474
-msgid "To perform wildcard expansion, use the C<glob> command."
+#: ../fish/guestfish.pod:770
+msgid "Start a guestfish server process using:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:476
+#: ../fish/guestfish.pod:772
#, no-wrap
msgid ""
-" glob rm-rf /home/*\n"
+" eval \"`guestfish --listen`\"\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:478
-msgid ""
-"runs C<rm-rf> on each path that matches (ie. potentially running the command "
-"many times), equivalent to:"
+#: ../fish/guestfish.pod:774
+msgid "and then send it commands by doing:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:481
+#: ../fish/guestfish.pod:776
#, no-wrap
msgid ""
-" rm-rf /home/jim\n"
-" rm-rf /home/joe\n"
-" rm-rf /home/mary\n"
+" guestfish --remote cmd [...]\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:485
-msgid "C<glob> only works on simple guest paths and not on device names."
+#: ../fish/guestfish.pod:778
+msgid "To cause the server to exit, send it the exit command:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:780
+#, no-wrap
+msgid ""
+" guestfish --remote exit\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:487
+#: ../fish/guestfish.pod:782
msgid ""
-"If you have several parameters, each containing a wildcard, then glob will "
-"perform a cartesian product."
+"Note that the server will normally exit if there is an error in a command. "
+"You can change this in the usual way. See section L</EXIT ON ERROR "
+"BEHAVIOUR>."
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:490
-msgid "COMMENTS"
+# type: =head2
+#: ../fish/guestfish.pod:786
+msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:492
+#: ../fish/guestfish.pod:788
msgid ""
-"Any line which starts with a I<#> character is treated as a comment and "
-"ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
-"a command. For example:"
+"The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
+"is how the I<--remote> option knows where to send the commands. You can "
+"have several guestfish listener processes running using:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:496
+#: ../fish/guestfish.pod:792
#, no-wrap
msgid ""
-" # this is a comment\n"
-" # this is a comment\n"
-" foo # NOT a comment\n"
+" eval \"`guestfish --listen`\"\n"
+" pid1=$GUESTFISH_PID\n"
+" eval \"`guestfish --listen`\"\n"
+" pid2=$GUESTFISH_PID\n"
+" ...\n"
+" guestfish --remote=$pid1 cmd\n"
+" guestfish --remote=$pid2 cmd\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:500
-msgid "Blank lines are also ignored."
-msgstr ""
-
-# type: =head1
-#: ../fish/guestfish.pod:502
-msgid "RUNNING COMMANDS LOCALLY"
+# type: =head2
+#: ../fish/guestfish.pod:800
+msgid "REMOTE CONTROL AND CSH"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:504
+#: ../fish/guestfish.pod:802
msgid ""
-"Any line which starts with a I<!> character is treated as a command sent to "
-"the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
+"When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
+"option:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:508
+#: ../fish/guestfish.pod:805
#, no-wrap
msgid ""
-" !mkdir local\n"
-" tgz-out /remote local/remote-data.tar.gz\n"
+" eval \"`guestfish --listen --csh`\"\n"
"\n"
msgstr ""
+# type: =head2
+#: ../fish/guestfish.pod:807
+msgid "REMOTE CONTROL DETAILS"
+msgstr ""
+
# type: textblock
-#: ../fish/guestfish.pod:511
+#: ../fish/guestfish.pod:809
msgid ""
-"will create a directory C<local> on the host, and then export the contents "
-"of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
-"(See C<tgz-out>)."
+"Remote control happens over a Unix domain socket called "
+"C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
+"of the process, and C<$PID> is the process ID of the server."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:515
-msgid ""
-"To change the local directory, use the C<lcd> command. C<!cd> will have no "
-"effect, due to the way that subprocesses work in Unix."
+#: ../fish/guestfish.pod:813
+msgid "Guestfish client and server versions must match exactly."
msgstr ""
# type: =head1
-#: ../fish/guestfish.pod:518
-msgid "PIPES"
+#: ../fish/guestfish.pod:815
+msgid "PREPARED DISK IMAGES"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:520
+#: ../fish/guestfish.pod:817
msgid ""
-"Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
-"command (a guestfish command) to the second command (any host command). For "
-"example:"
+"Use the I<-N type> or I<--new type> parameter to select one of a set of "
+"preformatted disk images that guestfish can make for you to save typing. "
+"This is particularly useful for testing purposes. This option is used "
+"instead of the I<-a> option, and like I<-a> can appear multiple times (and "
+"can be mixed with I<-a>)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:524
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:823
msgid ""
-" cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
-"\n"
+"The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
+"the second and so on. Existing files in the current directory are "
+"I<overwritten>."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:526
+#: ../fish/guestfish.pod:827
msgid ""
-"(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
-"program). The above command would list all accounts in the guest filesystem "
-"which have UID 0, ie. root accounts including backdoors. Other examples:"
+"The type briefly describes how the disk should be sized, partitioned, how "
+"filesystem(s) should be created, and how content should be added. "
+"Optionally the type can be followed by extra parameters, separated by C<:> "
+"(colon) characters. For example, I<-N fs> creates a default 100MB, "
+"sparsely-allocated disk, containing a single partition, with the partition "
+"formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
+"on a 1GB disk instead."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:531
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:835
+msgid "To list the available types and any extra parameters they take, run:"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish.pod:839
msgid ""
-" hexdump /bin/ls | head\n"
-" list-devices | tail -1\n"
-" tgz-out / - | tar ztf -\n"
-"\n"
+"Note that the prepared filesystem is not mounted. You would usually have to "
+"use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:535
+#: ../fish/guestfish.pod:843
msgid ""
-"The space before the pipe symbol is required, any space after the pipe "
-"symbol is optional. Everything after the pipe symbol is just passed "
-"straight to the host shell, so it can contain redirections, globs and "
-"anything else that makes sense on the host side."
+"If any I<-N> or I<--new> options are given, the guest is automatically "
+"launched."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:540
-msgid ""
-"To use a literal argument which begins with a pipe symbol, you have to quote "
-"it, eg:"
+#: ../fish/guestfish.pod:848
+msgid "Create a 100MB disk with an ext4-formatted partition:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:543
+#: ../fish/guestfish.pod:850
#, no-wrap
msgid ""
-" echo \"|\"\n"
+" guestfish -N fs:ext4\n"
"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:545
-msgid "HOME DIRECTORIES"
-msgstr ""
-
# type: textblock
-#: ../fish/guestfish.pod:547
-msgid ""
-"If a parameter starts with the character C<~> then the tilde may be expanded "
-"as a home directory path (either C<~> for the current user's home directory, "
-"or C<~user> for another user)."
+#: ../fish/guestfish.pod:852
+msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:551
+# type: verbatim
+#: ../fish/guestfish.pod:854
+#, no-wrap
msgid ""
-"Note that home directory expansion happens for users known I<on the host>, "
-"not in the guest filesystem."
+" guestfish -N fs:vfat:32M -m /dev/sda1\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:554
-msgid ""
-"To use a literal argument which begins with a tilde, you have to quote it, "
-"eg:"
+#: ../fish/guestfish.pod:856
+msgid "Create a blank 200MB disk:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:557
+#: ../fish/guestfish.pod:858
#, no-wrap
msgid ""
-" echo \"~\"\n"
+" guestfish -N disk:200M\n"
"\n"
msgstr ""
+# type: =head1
+#: ../fish/guestfish.pod:860
+msgid "PROGRESS BARS"
+msgstr ""
+
# type: textblock
-#: ../fish/guestfish.pod:561
+#: ../fish/guestfish.pod:862
msgid ""
-"Libguestfs has some support for Linux guests encrypted according to the "
-"Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
-"disk encryption systems used by modern Linux guests. Currently only "
-"LVM-on-LUKS is supported."
+"Some (not all) long-running commands send progress notification messages as "
+"they are running. Guestfish turns these messages into progress bars."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:566
-msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
+#: ../fish/guestfish.pod:866
+msgid ""
+"When a command that supports progress bars takes longer than two seconds to "
+"run, and if progress bars are enabled, then you will see one appearing below "
+"the command:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:568
+#: ../fish/guestfish.pod:870
#, no-wrap
msgid ""
-" ><fs> vfs-type /dev/sda2\n"
-" crypto_LUKS\n"
+" ><fs> copy-size /large-file /another-file 2048M\n"
+" / 10% [#####-----------------------------------------] 00:30\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:571
+#: ../fish/guestfish.pod:873
msgid ""
-"Then open those devices using L</luks-open>. This creates a device-mapper "
-"device called C</dev/mapper/luksdev>."
+"The spinner on the left hand side moves round once for every progress "
+"notification received from the backend. This is a (reasonably) golden "
+"assurance that the command is \"doing something\" even if the progress bar "
+"is not moving, because the command is able to send the progress "
+"notifications. When the bar reaches 100% and the command finishes, the "
+"spinner disappears."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:574
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:880
msgid ""
-" ><fs> luks-open /dev/sda2 luksdev\n"
-" Enter key or passphrase (\"key\"): <enter the passphrase>\n"
-"\n"
+"Progress bars are enabled by default when guestfish is used interactively. "
+"You can enable them even for non-interactive modes using I<--progress-bars>, "
+"and you can disable them completely using I<--no-progress-bars>."
+msgstr ""
+
+# type: =head1
+#: ../fish/guestfish.pod:885
+msgid "GUESTFISH COMMANDS"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:577
+#: ../fish/guestfish.pod:887
msgid ""
-"Finally you have to tell LVM to scan for volume groups on the newly created "
-"mapper device:"
+"The commands in this section are guestfish convenience commands, in other "
+"words, they are not part of the L<guestfs(3)> API."
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish.pod:890
+msgid "help"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:580
+#: ../fish/guestfish.pod:892
#, no-wrap
msgid ""
-" ><fs> vgscan\n"
-" ><fs> vg-activate-all true\n"
+" help\n"
+" help cmd\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:583
-msgid "The logical volume(s) can now be mounted in the usual way."
+#: ../fish/guestfish.pod:895
+msgid "Without any parameter, this provides general help."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:585
-msgid ""
-"Before closing a LUKS device you must unmount any logical volumes on it and "
-"deactivate the volume groups by calling C<vg-activate false VG> on each "
-"one. Then you can close the mapper device:"
+#: ../fish/guestfish.pod:897
+msgid "With a C<cmd> parameter, this displays detailed help for that command."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:589
-#, no-wrap
-msgid ""
-" ><fs> vg-activate false /dev/VG\n"
-" ><fs> luks-close /dev/mapper/luksdev\n"
-"\n"
+# type: =head2
+#: ../fish/guestfish.pod:899
+msgid "quit | exit"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:592
-msgid "WINDOWS PATHS"
+# type: textblock
+#: ../fish/guestfish.pod:901
+msgid "This exits guestfish. You can also use C<^D> key."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:594
-msgid ""
-"If a path is prefixed with C<win:> then you can use Windows-style paths "
-"(with some limitations). The following commands are equivalent:"
+#: ../fish/guestfish.pod:903
+msgid "@FISH_COMMANDS@"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:597
-#, no-wrap
-msgid ""
-" file /WINDOWS/system32/config/system.LOG\n"
-"\n"
+# type: =head1
+#: ../fish/guestfish.pod:905
+msgid "COMMANDS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:599
-#, no-wrap
-msgid ""
-" file win:/windows/system32/config/system.log\n"
-"\n"
+# type: =head1
+#: ../fish/guestfish.pod:909 ../test-tool/libguestfs-test-tool.pod:83
+msgid "EXIT CODE"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:601
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:911
msgid ""
-" file win:\\windows\\system32\\config\\system.log\n"
-"\n"
+"guestfish returns 0 if the commands completed without error, or 1 if there "
+"was an error."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:603
-#, no-wrap
-msgid ""
-" file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
-"\n"
+# type: =item
+#: ../fish/guestfish.pod:918
+msgid "EDITOR"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:605
+#: ../fish/guestfish.pod:920
msgid ""
-"This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
-"handles case insensitivity like Windows would. This only works in argument "
-"positions that expect a path."
+"The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
+"C<vi>."
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:609
-msgid "UPLOADING AND DOWNLOADING FILES"
+# type: =item
+#: ../fish/guestfish.pod:923
+msgid "GUESTFISH_PID"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:611
+#: ../fish/guestfish.pod:925
msgid ""
-"For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
-"others which upload from or download to a local file, you can use the "
-"special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
+"Used with the I<--remote> option to specify the remote guestfish process to "
+"control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:615
-#, no-wrap
-msgid ""
-" upload - /foo\n"
-"\n"
+# type: =item
+#: ../fish/guestfish.pod:929
+msgid "HEXEDITOR"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:617
-msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
+#: ../fish/guestfish.pod:931
+msgid ""
+"The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
+"not specified, the external L<hexedit(1)> program is used."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:620
-#, no-wrap
-msgid ""
-" tar-out /etc - | tar tf -\n"
-"\n"
+# type: =item
+#: ../fish/guestfish.pod:935
+msgid "HOME"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:622
+#: ../fish/guestfish.pod:937
msgid ""
-"writes the tarball to stdout and then pipes that into the external \"tar\" "
-"command (see L</PIPES>)."
+"If compiled with GNU readline support, various files in the home directory "
+"can be used. See L</FILES>."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:625
+#: ../fish/guestfish.pod:946
msgid ""
-"When using C<-> to read from stdin, the input is read up to the end of "
-"stdin. You can also use a special \"heredoc\"-like syntax to read up to "
-"some arbitrary end marker:"
+"Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
+"effect as using the B<-v> option."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:629
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:958
msgid ""
-" upload -<<END /foo\n"
-" input line 1\n"
-" input line 2\n"
-" input line 3\n"
-" END\n"
-"\n"
+"Set the path that guestfish uses to search for kernel and initrd.img. See "
+"the discussion of paths in L<guestfs(3)>."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:635
-msgid ""
-"Any string of characters can be used instead of C<END>. The end marker must "
-"appear on a line of its own, without any preceeding or following characters "
-"(not even spaces)."
+#: ../fish/guestfish.pod:969
+msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:971
+msgid "PAGER"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:639
+#: ../fish/guestfish.pod:973
msgid ""
-"Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
-"upload local files (so-called \"FileIn\" parameters in the generator)."
+"The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
+"C<more>."
msgstr ""
# type: =head1
-#: ../fish/guestfish.pod:642
-msgid "EXIT ON ERROR BEHAVIOUR"
+#: ../fish/guestfish.pod:988 ../test-tool/libguestfs-test-tool.pod:88
+msgid "FILES"
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:992
+msgid "$HOME/.guestfish"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:644
+#: ../fish/guestfish.pod:994
msgid ""
-"By default, guestfish will ignore any errors when in interactive mode "
-"(ie. taking commands from a human over a tty), and will exit on the first "
-"error in non-interactive mode (scripts, commands given on the command line)."
+"If compiled with GNU readline support, then the command history is saved in "
+"this file."
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:997
+msgid "$HOME/.inputrc"
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:999
+msgid "/etc/inputrc"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:649
+#: ../fish/guestfish.pod:1001
msgid ""
-"If you prefix a command with a I<-> character, then that command will not "
-"cause guestfish to exit, even if that (one) command returns an error."
+"If compiled with GNU readline support, then these files can be used to "
+"configure readline. For further information, please see "
+"L<readline(3)/INITIALIZATION FILE>."
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:653
-msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
+# type: textblock
+#: ../fish/guestfish.pod:1005
+msgid "To write rules which only apply to guestfish, use:"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish.pod:1007
+#, no-wrap
+msgid ""
+" $if guestfish\n"
+" ...\n"
+" $endif\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:655
+#: ../fish/guestfish.pod:1011
msgid ""
-"Guestfish can be remote-controlled over a socket. This is useful "
-"particularly in shell scripts where you want to make several different "
-"changes to a filesystem, but you don't want the overhead of starting up a "
-"guestfish process each time."
+"Variables that you can set in inputrc that change the behaviour of guestfish "
+"in useful ways include:"
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:1016
+msgid "completion-ignore-case (default: on)"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:660
-msgid "Start a guestfish server process using:"
+#: ../fish/guestfish.pod:1018
+msgid ""
+"By default, guestfish will ignore case when tab-completing paths on the "
+"disk. Use:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:662
+#: ../fish/guestfish.pod:1021
#, no-wrap
msgid ""
-" eval `guestfish --listen`\n"
+" set completion-ignore-case off\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:664
-msgid "and then send it commands by doing:"
+#: ../fish/guestfish.pod:1023
+msgid "to make guestfish case sensitive."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:666
-#, no-wrap
-msgid ""
-" guestfish --remote cmd [...]\n"
-"\n"
+# type: =item
+#: ../fish/guestfish.pod:1027
+msgid "test1.img"
+msgstr ""
+
+# type: =item
+#: ../fish/guestfish.pod:1029
+msgid "test2.img (etc)"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:668
-msgid "To cause the server to exit, send it the exit command:"
+#: ../fish/guestfish.pod:1031
+msgid ""
+"When using the C<-N> or C<--new> option, the prepared disk or filesystem "
+"will be created in the file C<test1.img> in the current directory. The "
+"second use of C<-N> will use C<test2.img> and so on. Any existing file with "
+"the same name will be overwritten."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:670
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish.pod:1040
msgid ""
-" guestfish --remote exit\n"
-"\n"
+"L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
+"L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
+"L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
+"L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:672
+#: ../fish/guestfish.pod:1064 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../inspector/virt-inspector.pl:564 ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518 ../tools/virt-df.pl:657 ../tools/virt-ls.pl:251 ../tools/virt-resize.pl:1516 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:300 ../tools/virt-rescue.pl:285 ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:273
msgid ""
-"Note that the server will normally exit if there is an error in a command. "
-"You can change this in the usual way. See section L</EXIT ON ERROR "
-"BEHAVIOUR>."
+"This program is free software; you can redistribute it and/or modify it "
+"under the terms of the GNU General Public License as published by the Free "
+"Software Foundation; either version 2 of the License, or (at your option) "
+"any later version."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:676
-msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
+# type: textblock
+#: ../fish/guestfish.pod:1069 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../inspector/virt-inspector.pl:569 ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523 ../tools/virt-df.pl:662 ../tools/virt-ls.pl:256 ../tools/virt-resize.pl:1521 ../tools/virt-list-filesystems.pl:211 ../tools/virt-tar.pl:305 ../tools/virt-rescue.pl:290 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:278
+msgid ""
+"This program is distributed in the hope that it will be useful, but WITHOUT "
+"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
+"FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
+"more details."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:678
+#: ../fish/guestfish.pod:1074 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pl:574 ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528 ../tools/virt-df.pl:667 ../tools/virt-ls.pl:261 ../tools/virt-resize.pl:1526 ../tools/virt-list-filesystems.pl:216 ../tools/virt-tar.pl:310 ../tools/virt-rescue.pl:295 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:283
msgid ""
-"The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
-"is how the I<--remote> option knows where to send the commands. You can "
-"have several guestfish listener processes running using:"
+"You should have received a copy of the GNU General Public License along with "
+"this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
+"Ave, Cambridge, MA 02139, USA."
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:1
+msgid "add-cdrom"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:682
+#: ../fish/guestfish-actions.pod:3
#, no-wrap
msgid ""
-" eval `guestfish --listen`\n"
-" pid1=$GUESTFISH_PID\n"
-" eval `guestfish --listen`\n"
-" pid2=$GUESTFISH_PID\n"
-" ...\n"
-" guestfish --remote=$pid1 cmd\n"
-" guestfish --remote=$pid2 cmd\n"
+" add-cdrom filename\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:690
-msgid "REMOTE CONTROL DETAILS"
-msgstr ""
-
# type: textblock
-#: ../fish/guestfish.pod:692
+#: ../fish/guestfish-actions.pod:15
msgid ""
-"Remote control happens over a Unix domain socket called "
-"C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
-"of the process, and C<$PID> is the process ID of the server."
+"This call checks for the existence of C<filename>. This stops you from "
+"specifying other types of drive which are supported by qemu such as C<nbd:> "
+"and C<http:> URLs. To specify those, use the general L</config> call "
+"instead."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:696
-msgid "Guestfish client and server versions must match exactly."
+#: ../fish/guestfish-actions.pod:22
+msgid ""
+"If you just want to add an ISO file (often you use this as an efficient way "
+"to transfer large files into the guest), then you should probably use "
+"L</add-drive-ro> instead."
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:698
-msgid "PREPARED DISK IMAGES"
+# type: =head2
+#: ../fish/guestfish-actions.pod:35
+msgid "add-domain"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:700
-msgid ""
-"Use the I<-N type> or I<--new type> parameter to select one of a set of "
-"preformatted disk images that guestfish can make for you to save typing. "
-"This is particularly useful for testing purposes. This option is used "
-"instead of the I<-a> option, and like I<-a> can appear multiple times (and "
-"can be mixed with I<-a>)."
+# type: =head2
+#: ../fish/guestfish-actions.pod:37
+msgid "domain"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:706
+# type: verbatim
+#: ../fish/guestfish-actions.pod:39
+#, no-wrap
msgid ""
-"The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
-"the second and so on. Existing files in the current directory are "
-"I<overwritten>."
+" add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:710
+#: ../fish/guestfish-actions.pod:41
msgid ""
-"The type briefly describes how the disk should be sized, partitioned, how "
-"filesystem(s) should be created, and how content should be added. "
-"Optionally the type can be followed by extra parameters, separated by C<:> "
-"(colon) characters. For example, I<-N fs> creates a default 100MB, "
-"sparsely-allocated disk, containing a single partition, with the partition "
-"formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
-"on a 1GB disk instead."
+"This function adds the disk(s) attached to the named libvirt domain C<dom>. "
+"It works by connecting to libvirt, requesting the domain and domain XML from "
+"libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:718
-msgid "To list the available types and any extra parameters they take, run:"
+#: ../fish/guestfish-actions.pod:58
+msgid ""
+"The optional C<libvirturi> parameter sets the libvirt URI (see "
+"L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
+"default libvirt URI (or one set through an environment variable, see the "
+"libvirt documentation for full details). If you are using the C API "
+"directly then it is more flexible to create the libvirt connection object "
+"yourself, get the domain object, and call L</add-libvirt-dom>."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:722
+#: ../fish/guestfish-actions.pod:66
msgid ""
-"Note that the prepared filesystem is not mounted. You would usually have to "
-"use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
+"The other optional parameters are passed directly through to "
+"L</add-drive-opts>."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:726
+#: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
msgid ""
-"If any I<-N> or I<--new> options are given, the guest is automatically "
-"launched."
+"This command has one or more optional arguments. See L</OPTIONAL "
+"ARGUMENTS>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:731
-msgid "Create a 100MB disk with an ext4-formatted partition:"
+# type: =head2
+#: ../fish/guestfish-actions.pod:71
+msgid "add-drive"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:733
+#: ../fish/guestfish-actions.pod:73
#, no-wrap
msgid ""
-" guestfish -N fs:ext4\n"
+" add-drive filename\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:735
-msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
+#: ../fish/guestfish-actions.pod:75
+msgid ""
+"This function is the equivalent of calling L</add-drive-opts> with no "
+"optional parameters, so the disk is added writable, with the format being "
+"detected automatically."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:737
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:79
msgid ""
-" guestfish -N fs:vfat:32M -m /dev/sda1\n"
-"\n"
+"Automatic detection of the format opens you up to a potential security hole "
+"when dealing with untrusted raw-format images. See CVE-2010-3851 and "
+"RHBZ#642934. Specifying the format closes this security hole. Therefore "
+"you should think about replacing calls to this function with calls to "
+"L</add-drive-opts>, and specifying the format."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:739
-msgid "Create a blank 200MB disk:"
+# type: =head2
+#: ../fish/guestfish-actions.pod:86
+msgid "add-drive-opts"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:88
+msgid "add"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:741
+#: ../fish/guestfish-actions.pod:90
#, no-wrap
msgid ""
-" guestfish -N disk:200M\n"
+" add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:743
-msgid "PROGRESS BARS"
-msgstr ""
-
# type: textblock
-#: ../fish/guestfish.pod:745
+#: ../fish/guestfish-actions.pod:117
msgid ""
-"Some (not all) long-running commands send progress notification messages as "
-"they are running. Guestfish turns these messages into progress bars."
+"This forces the image format. If you omit this (or use L</add-drive> or "
+"L</add-drive-ro>) then the format is automatically detected. Possible "
+"formats include C<raw> and C<qcow2>."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:749
+#: ../fish/guestfish-actions.pod:128
msgid ""
-"When a command that supports progress bars takes longer than two seconds to "
-"run, and if progress bars are enabled, then you will see one appearing below "
-"the command:"
+"This rarely-used option lets you emulate the behaviour of the deprecated "
+"L</add-drive-with-if> call (q.v.)"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:135
+msgid "add-drive-ro"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:137
+msgid "add-ro"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:753
+#: ../fish/guestfish-actions.pod:139
#, no-wrap
msgid ""
-" ><fs> copy-size /large-file /another-file 2048M\n"
-" / 10% [#####-----------------------------------------] 00:30\n"
+" add-drive-ro filename\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:756
+#: ../fish/guestfish-actions.pod:141
msgid ""
-"The spinner on the left hand side moves round once for every progress "
-"notification received from the backend. This is a (reasonably) golden "
-"assurance that the command is \"doing something\" even if the progress bar "
-"is not moving, because the command is able to send the progress "
-"notifications. When the bar reaches 100% and the command finishes, the "
-"spinner disappears."
+"This function is the equivalent of calling L</add-drive-opts> with the "
+"optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
+"is added read-only, with the format being detected automatically."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:763
-msgid ""
-"Progress bars are enabled by default when guestfish is used interactively. "
-"You can enable them even for non-interactive modes using I<--progress-bars>, "
-"and you can disable them completely using I<--no-progress-bars>."
+# type: =head2
+#: ../fish/guestfish-actions.pod:146
+msgid "add-drive-ro-with-if"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:768
-msgid "GUESTFISH COMMANDS"
+# type: verbatim
+#: ../fish/guestfish-actions.pod:148
+#, no-wrap
+msgid ""
+" add-drive-ro-with-if filename iface\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:770
+#: ../fish/guestfish-actions.pod:150
msgid ""
-"The commands in this section are guestfish convenience commands, in other "
-"words, they are not part of the L<guestfs(3)> API."
+"This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
+"interface emulation to use at run time."
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:773
-msgid "alloc | allocate"
+#: ../fish/guestfish-actions.pod:160
+msgid "add-drive-with-if"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:775
+#: ../fish/guestfish-actions.pod:162
#, no-wrap
msgid ""
-" alloc filename size\n"
+" add-drive-with-if filename iface\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:777
+#: ../fish/guestfish-actions.pod:164
msgid ""
-"This creates an empty (zeroed) file of the given size, and then adds so it "
-"can be further examined."
+"This is the same as L</add-drive> but it allows you to specify the QEMU "
+"interface emulation to use at run time."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:780 ../fish/guestfish.pod:903
-msgid "For more advanced image creation, see L<qemu-img(1)> utility."
+# type: =head2
+#: ../fish/guestfish-actions.pod:174
+msgid "aug-clear"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:782 ../fish/guestfish.pod:905
-msgid "Size can be specified using standard suffixes, eg. C<1M>."
+# type: verbatim
+#: ../fish/guestfish-actions.pod:176
+#, no-wrap
+msgid ""
+" aug-clear augpath\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:784
-msgid "copy-in"
+#: ../fish/guestfish-actions.pod:181
+msgid "aug-close"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:786
+#: ../fish/guestfish-actions.pod:183
#, no-wrap
msgid ""
-" copy-in local [local ...] /remotedir\n"
+" aug-close\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:788
-msgid ""
-"C<copy-in> copies local files or directories recursively into the disk "
-"image, placing them in the directory called C</remotedir> (which must "
-"exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
-"other commands as necessary."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:793
+#: ../fish/guestfish-actions.pod:185
msgid ""
-"Multiple local files and directories can be specified, but the last "
-"parameter must always be a remote directory. Wildcards cannot be used."
+"Close the current Augeas handle and free up any resources used by it. After "
+"calling this, you have to call L</aug-init> again before you can use any "
+"other Augeas functions."
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:797
-msgid "copy-out"
+#: ../fish/guestfish-actions.pod:190
+msgid "aug-defnode"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:799
+#: ../fish/guestfish-actions.pod:192
#, no-wrap
msgid ""
-" copy-out remote [remote ...] localdir\n"
+" aug-defnode name expr val\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:801
+#: ../fish/guestfish-actions.pod:197
msgid ""
-"C<copy-out> copies remote files or directories recursively out of the disk "
-"image, placing them on the host disk in a local directory called C<localdir> "
-"(which must exist). This guestfish meta-command turns into a sequence of "
-"L</download>, L</tar-out> and other commands as necessary."
+"If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
+"calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
+"containing that single node."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:807
-msgid ""
-"Multiple remote files and directories can be specified, but the last "
-"parameter must always be a local directory. To download to the current "
-"directory, use C<.> as in:"
+# type: =head2
+#: ../fish/guestfish-actions.pod:205
+msgid "aug-defvar"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:811
+#: ../fish/guestfish-actions.pod:207
#, no-wrap
msgid ""
-" copy-out /home .\n"
+" aug-defvar name expr\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:813
-msgid ""
-"Wildcards cannot be used in the ordinary command, but you can use them with "
-"the help of L</glob> like this:"
+# type: =head2
+#: ../fish/guestfish-actions.pod:216
+msgid "aug-get"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:816
+#: ../fish/guestfish-actions.pod:218
#, no-wrap
msgid ""
-" glob copy-out /home/* .\n"
+" aug-get augpath\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:818
-msgid "echo"
+#: ../fish/guestfish-actions.pod:223
+msgid "aug-init"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:820
+#: ../fish/guestfish-actions.pod:225
#, no-wrap
msgid ""
-" echo [params ...]\n"
+" aug-init root flags\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:822
-msgid "This echos the parameters to the terminal."
+#: ../fish/guestfish-actions.pod:231
+msgid "You must call this before using any other L</aug-*> commands."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:266
+msgid "Do not load the tree in L</aug-init>."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:270
+msgid "To close the handle, you can call L</aug-close>."
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:824
-msgid "edit | vi | emacs"
+#: ../fish/guestfish-actions.pod:274
+msgid "aug-insert"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:826
+#: ../fish/guestfish-actions.pod:276
#, no-wrap
msgid ""
-" edit filename\n"
+" aug-insert augpath label true|false\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:828
-msgid ""
-"This is used to edit a file. It downloads the file, edits it locally using "
-"your editor, then uploads the result."
+# type: =head2
+#: ../fish/guestfish-actions.pod:286
+msgid "aug-load"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:831
+# type: verbatim
+#: ../fish/guestfish-actions.pod:288
+#, no-wrap
msgid ""
-"The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
-"or C<emacs> you will get those corresponding editors."
+" aug-load\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:835
-msgid "glob"
+#: ../fish/guestfish-actions.pod:295
+msgid "aug-ls"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:837
+#: ../fish/guestfish-actions.pod:297
#, no-wrap
msgid ""
-" glob command args...\n"
+" aug-ls augpath\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:839
+#: ../fish/guestfish-actions.pod:299
msgid ""
-"Expand wildcards in any paths in the args list, and run C<command> "
-"repeatedly on each matching path."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:842
-msgid "See section WILDCARDS AND GLOBBING."
+"This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
+"resulting nodes into alphabetical order."
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:844
-msgid "help"
+#: ../fish/guestfish-actions.pod:302
+msgid "aug-match"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:846
+#: ../fish/guestfish-actions.pod:304
#, no-wrap
msgid ""
-" help\n"
-" help cmd\n"
+" aug-match augpath\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:849
+# type: =head2
+#: ../fish/guestfish-actions.pod:310
+msgid "aug-mv"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:312
+#, no-wrap
msgid ""
-"Without any parameter, this lists all commands. With a C<cmd> parameter, "
-"this displays detailed help for a command."
+" aug-mv src dest\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:852
-msgid "lcd"
+#: ../fish/guestfish-actions.pod:317
+msgid "aug-rm"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:854
+#: ../fish/guestfish-actions.pod:319
#, no-wrap
msgid ""
-" lcd directory\n"
+" aug-rm augpath\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:856
-msgid "Change the local directory, ie. the current directory of guestfish itself."
+# type: =head2
+#: ../fish/guestfish-actions.pod:325
+msgid "aug-save"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:327
+#, no-wrap
+msgid ""
+" aug-save\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:859
-msgid "Note that C<!cd> won't do what you might expect."
+#: ../fish/guestfish-actions.pod:331
+msgid ""
+"The flags which were passed to L</aug-init> affect exactly how files are "
+"saved."
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:861
-msgid "man | manual"
+#: ../fish/guestfish-actions.pod:334
+msgid "aug-set"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:863
+#: ../fish/guestfish-actions.pod:336
#, no-wrap
msgid ""
-" man\n"
+" aug-set augpath val\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:865
-msgid "Opens the manual page for guestfish."
+#: ../fish/guestfish-actions.pod:340
+msgid ""
+"In the Augeas API, it is possible to clear a node by setting the value to "
+"NULL. Due to an oversight in the libguestfs API you cannot do that with "
+"this call. Instead you must use the L</aug-clear> call."
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:867
-msgid "more | less"
+#: ../fish/guestfish-actions.pod:345
+msgid "available"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:869
+#: ../fish/guestfish-actions.pod:347
#, no-wrap
msgid ""
-" more filename\n"
+" available 'groups ...'\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:871
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:353
msgid ""
-" less filename\n"
-"\n"
+"The libguestfs groups, and the functions that those groups correspond to, "
+"are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
+"runtime by calling L</available-all-groups>."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:873
-msgid "This is used to view a file."
+#: ../fish/guestfish-actions.pod:377
+msgid "You must call L</launch> before calling this function."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:875
+#: ../fish/guestfish-actions.pod:399
msgid ""
-"The default viewer is C<$PAGER>. However if you use the alternate command "
-"C<less> you will get the C<less> command specifically."
+"This call was added in version C<1.0.80>. In previous versions of "
+"libguestfs all you could do would be to speculatively execute a command to "
+"find out if the daemon implemented it. See also L</version>."
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:878
-msgid "quit | exit"
+#: ../fish/guestfish-actions.pod:406
+msgid "available-all-groups"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:408
+#, no-wrap
+msgid ""
+" available-all-groups\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:880
-msgid "This exits guestfish. You can also use C<^D> key."
+#: ../fish/guestfish-actions.pod:410
+msgid ""
+"This command returns a list of all optional groups that this daemon knows "
+"about. Note this returns both supported and unsupported groups. To find "
+"out which ones the daemon can actually support you have to call "
+"L</available> on each member of the returned list."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:416
+msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:882
-msgid "reopen"
+#: ../fish/guestfish-actions.pod:418
+msgid "base64-in"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:884
+#: ../fish/guestfish-actions.pod:420
#, no-wrap
msgid ""
-" reopen\n"
+" base64-in (base64file|-) filename\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:886
-msgid ""
-"Close and reopen the libguestfs handle. It is not necessary to use this "
-"normally, because the handle is closed properly when guestfish exits. "
-"However this is occasionally useful for testing."
+#: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434 ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827 ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223 ../fish/guestfish-actions.pod:4006 ../fish/guestfish-actions.pod:4018 ../fish/guestfish-actions.pod:4029 ../fish/guestfish-actions.pod:4040 ../fish/guestfish-actions.pod:4092 ../fish/guestfish-actions.pod:4101 ../fish/guestfish-actions.pod:4155 ../fish/guestfish-actions.pod:4178
+msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:890
-msgid "sparse"
+#: ../fish/guestfish-actions.pod:427
+msgid "base64-out"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:892
+#: ../fish/guestfish-actions.pod:429
#, no-wrap
msgid ""
-" sparse filename size\n"
+" base64-out filename (base64file|-)\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:894
-msgid ""
-"This creates an empty sparse file of the given size, and then adds so it can "
-"be further examined."
+# type: =head2
+#: ../fish/guestfish-actions.pod:436
+msgid "blockdev-flushbufs"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:897
+# type: verbatim
+#: ../fish/guestfish-actions.pod:438
+#, no-wrap
msgid ""
-"In all respects it works the same as the C<alloc> command, except that the "
-"image file is allocated sparsely, which means that disk blocks are not "
-"assigned to the file until they are needed. Sparse disk files only use "
-"space when written to, but they are slower and there is a danger you could "
-"run out of real disk space during a write operation."
+" blockdev-flushbufs device\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:907
-msgid "supported"
+#: ../fish/guestfish-actions.pod:445
+msgid "blockdev-getbsz"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:909
+#: ../fish/guestfish-actions.pod:447
#, no-wrap
msgid ""
-" supported\n"
+" blockdev-getbsz device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:911
-msgid ""
-"This command returns a list of the optional groups known to the daemon, and "
-"indicates which ones are supported by this build of the libguestfs "
-"appliance."
+# type: =head2
+#: ../fish/guestfish-actions.pod:456
+msgid "blockdev-getro"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:915
-msgid "See also L<guestfs(3)/AVAILABILITY>."
+# type: verbatim
+#: ../fish/guestfish-actions.pod:458
+#, no-wrap
+msgid ""
+" blockdev-getro device\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish.pod:917
-msgid "time"
+#: ../fish/guestfish-actions.pod:465
+msgid "blockdev-getsize64"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:919
+#: ../fish/guestfish-actions.pod:467
#, no-wrap
msgid ""
-" time command args...\n"
+" blockdev-getsize64 device\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:921
-msgid ""
-"Run the command as usual, but print the elapsed time afterwards. This can "
-"be useful for benchmarking operations."
-msgstr ""
-
-# type: =head1
-#: ../fish/guestfish.pod:924
-msgid "COMMANDS"
+#: ../fish/guestfish-actions.pod:471
+msgid "See also L</blockdev-getsz>."
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:928 ../test-tool/libguestfs-test-tool.pod:83
-msgid "EXIT CODE"
+# type: =head2
+#: ../fish/guestfish-actions.pod:475
+msgid "blockdev-getss"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:930
+# type: verbatim
+#: ../fish/guestfish-actions.pod:477
+#, no-wrap
msgid ""
-"guestfish returns 0 if the commands completed without error, or 1 if there "
-"was an error."
-msgstr ""
-
-# type: =item
-#: ../fish/guestfish.pod:937
-msgid "EDITOR"
+" blockdev-getss device\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:939
-msgid ""
-"The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
-"C<vi>."
+#: ../fish/guestfish-actions.pod:482
+msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:942
-msgid "GUESTFISH_PID"
+# type: =head2
+#: ../fish/guestfish-actions.pod:487
+msgid "blockdev-getsz"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:944
+# type: verbatim
+#: ../fish/guestfish-actions.pod:489
+#, no-wrap
msgid ""
-"Used with the I<--remote> option to specify the remote guestfish process to "
-"control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
-msgstr ""
-
-# type: =item
-#: ../fish/guestfish.pod:948
-msgid "HOME"
+" blockdev-getsz device\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:950
+#: ../fish/guestfish-actions.pod:494
msgid ""
-"If compiled with GNU readline support, various files in the home directory "
-"can be used. See L</FILES>."
+"See also L</blockdev-getss> for the real sector size of the device, and "
+"L</blockdev-getsize64> for the more useful I<size in bytes>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:959
-msgid ""
-"Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
-"effect as using the B<-v> option."
+# type: =head2
+#: ../fish/guestfish-actions.pod:500
+msgid "blockdev-rereadpt"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:971
+# type: verbatim
+#: ../fish/guestfish-actions.pod:502
+#, no-wrap
msgid ""
-"Set the path that guestfish uses to search for kernel and initrd.img. See "
-"the discussion of paths in L<guestfs(3)>."
+" blockdev-rereadpt device\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:982
-msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
+# type: =head2
+#: ../fish/guestfish-actions.pod:508
+msgid "blockdev-setbsz"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:984
-msgid "PAGER"
+# type: verbatim
+#: ../fish/guestfish-actions.pod:510
+#, no-wrap
+msgid ""
+" blockdev-setbsz device blocksize\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:986
-msgid ""
-"The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
-"C<more>."
+# type: =head2
+#: ../fish/guestfish-actions.pod:519
+msgid "blockdev-setro"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:1001 ../test-tool/libguestfs-test-tool.pod:88
-msgid "FILES"
+# type: verbatim
+#: ../fish/guestfish-actions.pod:521
+#, no-wrap
+msgid ""
+" blockdev-setro device\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1005
-msgid "$HOME/.guestfish"
+# type: =head2
+#: ../fish/guestfish-actions.pod:527
+msgid "blockdev-setrw"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1007
+# type: verbatim
+#: ../fish/guestfish-actions.pod:529
+#, no-wrap
msgid ""
-"If compiled with GNU readline support, then the command history is saved in "
-"this file."
+" blockdev-setrw device\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1010
-msgid "$HOME/.inputrc"
+# type: =head2
+#: ../fish/guestfish-actions.pod:535
+msgid "case-sensitive-path"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1012
-msgid "/etc/inputrc"
+# type: verbatim
+#: ../fish/guestfish-actions.pod:537
+#, no-wrap
+msgid ""
+" case-sensitive-path path\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:1014
+#: ../fish/guestfish-actions.pod:561
msgid ""
-"If compiled with GNU readline support, then these files can be used to "
-"configure readline. For further information, please see "
-"L<readline(3)/INITIALIZATION FILE>."
+"Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
+"C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
+"how the directories were originally created under Windows)."
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:1018
-msgid "To write rules which only apply to guestfish, use:"
+#: ../fish/guestfish-actions.pod:569
+msgid "See also L</realpath>."
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:571
+msgid "cat"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:1020
+#: ../fish/guestfish-actions.pod:573
#, no-wrap
msgid ""
-" $if guestfish\n"
-" ...\n"
-" $endif\n"
+" cat path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:1024
+#: ../fish/guestfish-actions.pod:577
msgid ""
-"Variables that you can set in inputrc that change the behaviour of guestfish "
-"in useful ways include:"
-msgstr ""
-
-# type: =item
-#: ../fish/guestfish.pod:1029
-msgid "completion-ignore-case (default: on)"
+"Note that this function cannot correctly handle binary files (specifically, "
+"files containing C<\\0> character which is treated as end of string). For "
+"those you need to use the L</read-file> or L</download> functions which have "
+"a more complex interface."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1031
-msgid ""
-"By default, guestfish will ignore case when tab-completing paths on the "
-"disk. Use:"
+# type: =head2
+#: ../fish/guestfish-actions.pod:585
+msgid "checksum"
msgstr ""
# type: verbatim
-#: ../fish/guestfish.pod:1034
+#: ../fish/guestfish-actions.pod:587
#, no-wrap
msgid ""
-" set completion-ignore-case off\n"
+" checksum csumtype path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:1036
-msgid "to make guestfish case sensitive."
+#: ../fish/guestfish-actions.pod:630
+msgid "To get the checksum for a device, use L</checksum-device>."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1040
-msgid "test1.img"
+# type: textblock
+#: ../fish/guestfish-actions.pod:632
+msgid "To get the checksums for many files, use L</checksums-out>."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1042
-msgid "test2.img (etc)"
+# type: =head2
+#: ../fish/guestfish-actions.pod:634
+msgid "checksum-device"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1044
+# type: verbatim
+#: ../fish/guestfish-actions.pod:636
+#, no-wrap
msgid ""
-"When using the C<-N> or C<--new> option, the prepared disk or filesystem "
-"will be created in the file C<test1.img> in the current directory. The "
-"second use of C<-N> will use C<test2.img> and so on. Any existing file with "
-"the same name will be overwritten."
+" checksum-device csumtype device\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish.pod:1053
+#: ../fish/guestfish-actions.pod:638
msgid ""
-"L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
-"L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
-"L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
-"L<virt-tar(1)>, L<virt-win-reg(1)>."
+"This call computes the MD5, SHAx or CRC checksum of the contents of the "
+"device named C<device>. For the types of checksums supported see the "
+"L</checksum> command."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1076 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:198 ../inspector/virt-inspector.pl:865 ../tools/virt-cat.pl:181 ../tools/virt-df.pl:499 ../tools/virt-edit.pl:345 ../tools/virt-list-filesystems.pl:211 ../tools/virt-list-partitions.pl:248 ../tools/virt-ls.pl:229 ../tools/virt-make-fs.pl:560 ../tools/virt-rescue.pl:249 ../tools/virt-resize.pl:1415 ../tools/virt-tar.pl:276 ../tools/virt-win-reg.pl:495
-msgid ""
-"This program is free software; you can redistribute it and/or modify it "
-"under the terms of the GNU General Public License as published by the Free "
-"Software Foundation; either version 2 of the License, or (at your option) "
-"any later version."
+# type: =head2
+#: ../fish/guestfish-actions.pod:642
+msgid "checksums-out"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1081 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:203 ../inspector/virt-inspector.pl:870 ../tools/virt-cat.pl:186 ../tools/virt-df.pl:504 ../tools/virt-edit.pl:350 ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:253 ../tools/virt-ls.pl:234 ../tools/virt-make-fs.pl:565 ../tools/virt-rescue.pl:254 ../tools/virt-resize.pl:1420 ../tools/virt-tar.pl:281 ../tools/virt-win-reg.pl:500
+# type: verbatim
+#: ../fish/guestfish-actions.pod:644
+#, no-wrap
msgid ""
-"This program is distributed in the hope that it will be useful, but WITHOUT "
-"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
-"FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
-"more details."
+" checksums-out csumtype directory (sumsfile|-)\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1086 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:208 ../inspector/virt-inspector.pl:875 ../tools/virt-cat.pl:191 ../tools/virt-df.pl:509 ../tools/virt-edit.pl:355 ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:258 ../tools/virt-ls.pl:239 ../tools/virt-make-fs.pl:570 ../tools/virt-rescue.pl:259 ../tools/virt-resize.pl:1425 ../tools/virt-tar.pl:286 ../tools/virt-win-reg.pl:505
+# type: =head2
+#: ../fish/guestfish-actions.pod:660
+msgid "chmod"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:662
+#, no-wrap
msgid ""
-"You should have received a copy of the GNU General Public License along with "
-"this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
-"Ave, Cambridge, MA 02139, USA."
+" chmod mode path\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1
-msgid "add-cdrom | cdrom"
+#: ../fish/guestfish-actions.pod:673
+msgid "chown"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3
+#: ../fish/guestfish-actions.pod:675
#, no-wrap
msgid ""
-" add-cdrom filename\n"
+" chown owner group path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:15
+# type: =head2
+#: ../fish/guestfish-actions.pod:683
+msgid "command"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:685
+#, no-wrap
msgid ""
-"This call checks for the existence of C<filename>. This stops you from "
-"specifying other types of drive which are supported by qemu such as C<nbd:> "
-"and C<http:> URLs. To specify those, use the general C<config> call "
-"instead."
+" command 'arguments ...'\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:22
+#: ../fish/guestfish-actions.pod:692
msgid ""
-"If you just want to add an ISO file (often you use this as an efficient way "
-"to transfer large files into the guest), then you should probably use "
-"C<add-drive-ro> instead."
+"The single parameter is an argv-style list of arguments. The first element "
+"is the name of the program to run. Subsequent elements are parameters. The "
+"list must be non-empty (ie. must contain a program name). Note that the "
+"command runs directly, and is I<not> invoked via the shell (see L</sh>)."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:28
-msgid "add-drive | add"
+#: ../fish/guestfish-actions.pod:720
+msgid "command-lines"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:30
+#: ../fish/guestfish-actions.pod:722
#, no-wrap
msgid ""
-" add-drive filename\n"
+" command-lines 'arguments ...'\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:49 ../fish/guestfish-actions.pod:75
-msgid ""
-"C<if=...> is set at compile time by the configuration option C<./configure "
-"--with-drive-if=...>. In the rare case where you might need to change this "
-"at run time, use C<add-drive-with-if> or C<add-drive-ro-with-if>."
+#: ../fish/guestfish-actions.pod:724
+msgid "This is the same as L</command>, but splits the result into a list of lines."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:54 ../fish/guestfish-actions.pod:80
-msgid ""
-"Note that this call checks for the existence of C<filename>. This stops you "
-"from specifying other types of drive which are supported by qemu such as "
-"C<nbd:> and C<http:> URLs. To specify those, use the general C<config> call "
-"instead."
+#: ../fish/guestfish-actions.pod:727
+msgid "See also: L</sh-lines>"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:59
-msgid "add-drive-ro | add-ro"
+#: ../fish/guestfish-actions.pod:732
+msgid "config"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:61
+#: ../fish/guestfish-actions.pod:734
#, no-wrap
msgid ""
-" add-drive-ro filename\n"
+" config qemuparam qemuvalue\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:85
-msgid "add-drive-ro-with-if"
+#: ../fish/guestfish-actions.pod:745
+msgid "copy-size"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:87
+#: ../fish/guestfish-actions.pod:747
#, no-wrap
msgid ""
-" add-drive-ro-with-if filename iface\n"
+" copy-size src dest size\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:89
-msgid ""
-"This is the same as C<add-drive-ro> but it allows you to specify the QEMU "
-"interface emulation to use at run time."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:92
-msgid "add-drive-with-if"
+#: ../fish/guestfish-actions.pod:755
+msgid "cp"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:94
+#: ../fish/guestfish-actions.pod:757
#, no-wrap
msgid ""
-" add-drive-with-if filename iface\n"
+" cp src dest\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:96
-msgid ""
-"This is the same as C<add-drive> but it allows you to specify the QEMU "
-"interface emulation to use at run time."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:99
-msgid "aug-clear"
+#: ../fish/guestfish-actions.pod:762
+msgid "cp-a"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:101
+#: ../fish/guestfish-actions.pod:764
#, no-wrap
msgid ""
-" aug-clear augpath\n"
+" cp-a src dest\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:106
-msgid "aug-close"
+#: ../fish/guestfish-actions.pod:769
+msgid "dd"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:108
+#: ../fish/guestfish-actions.pod:771
#, no-wrap
msgid ""
-" aug-close\n"
+" dd src dest\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:110
+#: ../fish/guestfish-actions.pod:778
msgid ""
-"Close the current Augeas handle and free up any resources used by it. After "
-"calling this, you have to call C<aug-init> again before you can use any "
-"other Augeas functions."
+"If the destination is a device, it must be as large or larger than the "
+"source file or device, otherwise the copy will fail. This command cannot do "
+"partial copies (see L</copy-size>)."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:115
-msgid "aug-defnode"
+#: ../fish/guestfish-actions.pod:782
+msgid "df"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:117
+#: ../fish/guestfish-actions.pod:784
#, no-wrap
msgid ""
-" aug-defnode name expr val\n"
+" df\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:122
+# type: =head2
+#: ../fish/guestfish-actions.pod:792
+msgid "df-h"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:794
+#, no-wrap
msgid ""
-"If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
-"calling C<aug-set> C<expr>, C<value>. C<name> will be the nodeset "
-"containing that single node."
+" df-h\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:130
-msgid "aug-defvar"
+#: ../fish/guestfish-actions.pod:803
+msgid "dmesg"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:132
+#: ../fish/guestfish-actions.pod:805
#, no-wrap
msgid ""
-" aug-defvar name expr\n"
+" dmesg\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:811
+msgid ""
+"Another way to get the same information is to enable verbose messages with "
+"L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
+"before running the program."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:141
-msgid "aug-get"
+#: ../fish/guestfish-actions.pod:816
+msgid "download"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:143
+#: ../fish/guestfish-actions.pod:818
#, no-wrap
msgid ""
-" aug-get augpath\n"
+" download remotefilename (filename|-)\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:825
+msgid "See also L</upload>, L</cat>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:148
-msgid "aug-init"
+#: ../fish/guestfish-actions.pod:829
+msgid "download-offset"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:150
+#: ../fish/guestfish-actions.pod:831
#, no-wrap
msgid ""
-" aug-init root flags\n"
+" download-offset remotefilename (filename|-) offset size\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:156
-msgid "You must call this before using any other C<aug-*> commands."
+#: ../fish/guestfish-actions.pod:839
+msgid ""
+"Note that there is no limit on the amount of data that can be downloaded "
+"with this call, unlike with L</pread>, and this call always reads the full "
+"amount unless an error occurs."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:191
-msgid "Do not load the tree in C<aug-init>."
+#: ../fish/guestfish-actions.pod:844
+msgid "See also L</download>, L</pread>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:195
-msgid "To close the handle, you can call C<aug-close>."
+# type: =head2
+#: ../fish/guestfish-actions.pod:848
+msgid "drop-caches"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:850
+#, no-wrap
+msgid ""
+" drop-caches whattodrop\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:199
-msgid "aug-insert"
+#: ../fish/guestfish-actions.pod:862
+msgid "du"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:201
+#: ../fish/guestfish-actions.pod:864
#, no-wrap
msgid ""
-" aug-insert augpath label true|false\n"
+" du path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:211
-msgid "aug-load"
+#: ../fish/guestfish-actions.pod:876
+msgid "e2fsck-f"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:213
+#: ../fish/guestfish-actions.pod:878
#, no-wrap
msgid ""
-" aug-load\n"
+" e2fsck-f device\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:884
+msgid ""
+"This command is only needed because of L</resize2fs> (q.v.). Normally you "
+"should use L</fsck>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:220
-msgid "aug-ls"
+#: ../fish/guestfish-actions.pod:887
+msgid "echo-daemon"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:222
+#: ../fish/guestfish-actions.pod:889
#, no-wrap
msgid ""
-" aug-ls augpath\n"
+" echo-daemon 'words ...'\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:224
-msgid ""
-"This is just a shortcut for listing C<aug-match> C<path/*> and sorting the "
-"resulting nodes into alphabetical order."
+#: ../fish/guestfish-actions.pod:896
+msgid "See also L</ping-daemon>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:227
-msgid "aug-match"
+#: ../fish/guestfish-actions.pod:898
+msgid "egrep"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:229
+#: ../fish/guestfish-actions.pod:900
#, no-wrap
msgid ""
-" aug-match augpath\n"
+" egrep regex path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:235
-msgid "aug-mv"
+#: ../fish/guestfish-actions.pod:908
+msgid "egrepi"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:237
+#: ../fish/guestfish-actions.pod:910
#, no-wrap
msgid ""
-" aug-mv src dest\n"
+" egrepi regex path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:242
-msgid "aug-rm"
+#: ../fish/guestfish-actions.pod:918
+msgid "equal"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:244
+#: ../fish/guestfish-actions.pod:920
#, no-wrap
msgid ""
-" aug-rm augpath\n"
+" equal file1 file2\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:250
-msgid "aug-save"
+#: ../fish/guestfish-actions.pod:927
+msgid "exists"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:252
+#: ../fish/guestfish-actions.pod:929
#, no-wrap
msgid ""
-" aug-save\n"
+" exists path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:256
-msgid ""
-"The flags which were passed to C<aug-init> affect exactly how files are "
-"saved."
+#: ../fish/guestfish-actions.pod:934
+msgid "See also L</is-file>, L</is-dir>, L</stat>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:259
-msgid "aug-set"
+#: ../fish/guestfish-actions.pod:936
+msgid "fallocate"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:261
+#: ../fish/guestfish-actions.pod:938
#, no-wrap
msgid ""
-" aug-set augpath val\n"
+" fallocate path len\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:265
-msgid ""
-"In the Augeas API, it is possible to clear a node by setting the value to "
-"NULL. Due to an oversight in the libguestfs API you cannot do that with "
-"this call. Instead you must use the C<aug-clear> call."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:270
-msgid "available"
+#: ../fish/guestfish-actions.pod:955
+msgid "fallocate64"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:272
+#: ../fish/guestfish-actions.pod:957
#, no-wrap
msgid ""
-" available 'groups ...'\n"
+" fallocate64 path len\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:278
+#: ../fish/guestfish-actions.pod:963
msgid ""
-"The libguestfs groups, and the functions that those groups correspond to, "
-"are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
-"runtime by calling C<available-all-groups>."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:302
-msgid "You must call C<launch> before calling this function."
+"Note that this call allocates disk blocks for the file. To create a sparse "
+"file use L</truncate-size> instead."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:324
+#: ../fish/guestfish-actions.pod:966
msgid ""
-"This call was added in version C<1.0.80>. In previous versions of "
-"libguestfs all you could do would be to speculatively execute a command to "
-"find out if the daemon implemented it. See also C<version>."
+"The deprecated call L</fallocate> does the same, but owing to an oversight "
+"it only allowed 30 bit lengths to be specified, effectively limiting the "
+"maximum size of files created through that call to 1GB."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:331
-msgid "available-all-groups"
+#: ../fish/guestfish-actions.pod:975
+msgid "fgrep"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:333
+#: ../fish/guestfish-actions.pod:977
#, no-wrap
msgid ""
-" available-all-groups\n"
+" fgrep pattern path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:335
-msgid ""
-"This command returns a list of all optional groups that this daemon knows "
-"about. Note this returns both supported and unsupported groups. To find "
-"out which ones the daemon can actually support you have to call C<available> "
-"on each member of the returned list."
+# type: =head2
+#: ../fish/guestfish-actions.pod:985
+msgid "fgrepi"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:341
-msgid "See also C<available> and L<guestfs(3)/AVAILABILITY>."
+# type: verbatim
+#: ../fish/guestfish-actions.pod:987
+#, no-wrap
+msgid ""
+" fgrepi pattern path\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:343
-msgid "base64-in"
+#: ../fish/guestfish-actions.pod:995
+msgid "file"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:345
+#: ../fish/guestfish-actions.pod:997
#, no-wrap
msgid ""
-" base64-in (base64file|-) filename\n"
+" file path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:350 ../fish/guestfish-actions.pod:359 ../fish/guestfish-actions.pod:583 ../fish/guestfish-actions.pod:730 ../fish/guestfish-actions.pod:777 ../fish/guestfish-actions.pod:1154 ../fish/guestfish-actions.pod:3702 ../fish/guestfish-actions.pod:3714 ../fish/guestfish-actions.pod:3725 ../fish/guestfish-actions.pod:3736 ../fish/guestfish-actions.pod:3788 ../fish/guestfish-actions.pod:3797 ../fish/guestfish-actions.pod:3847
-msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
+#: ../fish/guestfish-actions.pod:1009
+msgid ""
+"This command can also be used on C</dev/> devices (and partitions, LV "
+"names). You can for example use this to determine if a device contains a "
+"filesystem, although it's usually better to use L</vfs-type>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:352
-msgid "base64-out"
+#: ../fish/guestfish-actions.pod:1019
+msgid "file-architecture"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:354
+#: ../fish/guestfish-actions.pod:1021
#, no-wrap
msgid ""
-" base64-out filename (base64file|-)\n"
+" file-architecture filename\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:361
-msgid "blockdev-flushbufs"
+#: ../fish/guestfish-actions.pod:1124
+msgid "filesize"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:363
+#: ../fish/guestfish-actions.pod:1126
#, no-wrap
msgid ""
-" blockdev-flushbufs device\n"
+" filesize file\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:1130
+msgid ""
+"To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
+"L</is-file> etc. To get the size of block devices, use "
+"L</blockdev-getsize64>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:370
-msgid "blockdev-getbsz"
+#: ../fish/guestfish-actions.pod:1134
+msgid "fill"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:372
+#: ../fish/guestfish-actions.pod:1136
#, no-wrap
msgid ""
-" blockdev-getbsz device\n"
+" fill c len path\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:1142
+msgid ""
+"To fill a file with zero bytes (sparsely), it is much more efficient to use "
+"L</truncate-size>. To create a file with a pattern of repeating bytes use "
+"L</fill-pattern>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:381
-msgid "blockdev-getro"
+#: ../fish/guestfish-actions.pod:1147
+msgid "fill-pattern"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:383
+#: ../fish/guestfish-actions.pod:1149
#, no-wrap
msgid ""
-" blockdev-getro device\n"
+" fill-pattern pattern len path\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:1151
+msgid ""
+"This function is like L</fill> except that it creates a new file of length "
+"C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
+"is truncated if necessary to ensure the length of the file is exactly C<len> "
+"bytes."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:390
-msgid "blockdev-getsize64"
+#: ../fish/guestfish-actions.pod:1156
+msgid "find"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:392
+#: ../fish/guestfish-actions.pod:1158
#, no-wrap
msgid ""
-" blockdev-getsize64 device\n"
+" find directory\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:396
-msgid "See also C<blockdev-getsz>."
+#: ../fish/guestfish-actions.pod:1172
+msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:1185
+msgid "See also L</find0>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:400
-msgid "blockdev-getss"
+#: ../fish/guestfish-actions.pod:1190
+msgid "find0"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:402
+#: ../fish/guestfish-actions.pod:1192
#, no-wrap
msgid ""
-" blockdev-getss device\n"
+" find0 directory (files|-)\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:407
-msgid "(Note, this is not the size in sectors, use C<blockdev-getsz> for that)."
+#: ../fish/guestfish-actions.pod:1198
+msgid "This command works the same way as L</find> with the following exceptions:"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:412
-msgid "blockdev-getsz"
+#: ../fish/guestfish-actions.pod:1225
+msgid "findfs-label"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:414
+#: ../fish/guestfish-actions.pod:1227
#, no-wrap
msgid ""
-" blockdev-getsz device\n"
+" findfs-label label\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:419
-msgid ""
-"See also C<blockdev-getss> for the real sector size of the device, and "
-"C<blockdev-getsize64> for the more useful I<size in bytes>."
+#: ../fish/guestfish-actions.pod:1233
+msgid "To find the label of a filesystem, use L</vfs-label>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:425
-msgid "blockdev-rereadpt"
+#: ../fish/guestfish-actions.pod:1235
+msgid "findfs-uuid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:427
+#: ../fish/guestfish-actions.pod:1237
#, no-wrap
msgid ""
-" blockdev-rereadpt device\n"
+" findfs-uuid uuid\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:1243
+msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:433
-msgid "blockdev-setbsz"
+#: ../fish/guestfish-actions.pod:1245
+msgid "fsck"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:435
+#: ../fish/guestfish-actions.pod:1247
#, no-wrap
msgid ""
-" blockdev-setbsz device blocksize\n"
+" fsck fstype device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:444
-msgid "blockdev-setro"
+#: ../fish/guestfish-actions.pod:1277
+msgid "get-append"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:446
+#: ../fish/guestfish-actions.pod:1279
#, no-wrap
msgid ""
-" blockdev-setro device\n"
+" get-append\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:452
-msgid "blockdev-setrw"
+#: ../fish/guestfish-actions.pod:1286
+msgid "get-autosync"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:454
+#: ../fish/guestfish-actions.pod:1288
#, no-wrap
msgid ""
-" blockdev-setrw device\n"
+" get-autosync\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:460
-msgid "case-sensitive-path"
+#: ../fish/guestfish-actions.pod:1292
+msgid "get-direct"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:462
+#: ../fish/guestfish-actions.pod:1294
#, no-wrap
msgid ""
-" case-sensitive-path path\n"
+" get-direct\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:486
-msgid ""
-"Thus C<case-sensitive-path> (\"/Windows/System32\") might return "
-"C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
-"how the directories were originally created under Windows)."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:494
-msgid "See also C<realpath>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:496
-msgid "cat"
+#: ../fish/guestfish-actions.pod:1298
+msgid "get-e2label"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:498
+#: ../fish/guestfish-actions.pod:1300
#, no-wrap
msgid ""
-" cat path\n"
+" get-e2label device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:502
-msgid ""
-"Note that this function cannot correctly handle binary files (specifically, "
-"files containing C<\\0> character which is treated as end of string). For "
-"those you need to use the C<read-file> or C<download> functions which have a "
-"more complex interface."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:510
-msgid "checksum"
+#: ../fish/guestfish-actions.pod:1312
+msgid "get-e2uuid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:512
+#: ../fish/guestfish-actions.pod:1314
#, no-wrap
msgid ""
-" checksum csumtype path\n"
+" get-e2uuid device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:555
-msgid "To get the checksum for a device, use C<checksum-device>."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:557
-msgid "To get the checksums for many files, use C<checksums-out>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:559
-msgid "checksum-device"
+#: ../fish/guestfish-actions.pod:1326
+msgid "get-memsize"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:561
+#: ../fish/guestfish-actions.pod:1328
#, no-wrap
msgid ""
-" checksum-device csumtype device\n"
+" get-memsize\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:563
+#: ../fish/guestfish-actions.pod:1333
msgid ""
-"This call computes the MD5, SHAx or CRC checksum of the contents of the "
-"device named C<device>. For the types of checksums supported see the "
-"C<checksum> command."
+"If L</set-memsize> was not called on this handle, and if "
+"C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
+"value for memsize."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:567
-msgid "checksums-out"
+#: ../fish/guestfish-actions.pod:1340
+msgid "get-network"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:569
+#: ../fish/guestfish-actions.pod:1342
#, no-wrap
msgid ""
-" checksums-out csumtype directory (sumsfile|-)\n"
+" get-network\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:585
-msgid "chmod"
+#: ../fish/guestfish-actions.pod:1346
+msgid "get-path"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:587
+#: ../fish/guestfish-actions.pod:1348
#, no-wrap
msgid ""
-" chmod mode path\n"
+" get-path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:598
-msgid "chown"
+#: ../fish/guestfish-actions.pod:1355
+msgid "get-pid"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:1357
+msgid "pid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:600
+#: ../fish/guestfish-actions.pod:1359
#, no-wrap
msgid ""
-" chown owner group path\n"
+" get-pid\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:608
-msgid "command"
+#: ../fish/guestfish-actions.pod:1366
+msgid "get-qemu"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:610
+#: ../fish/guestfish-actions.pod:1368
#, no-wrap
msgid ""
-" command 'arguments ...'\n"
+" get-qemu\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:617
-msgid ""
-"The single parameter is an argv-style list of arguments. The first element "
-"is the name of the program to run. Subsequent elements are parameters. The "
-"list must be non-empty (ie. must contain a program name). Note that the "
-"command runs directly, and is I<not> invoked via the shell (see C<sh>)."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:645
-msgid "command-lines"
+#: ../fish/guestfish-actions.pod:1375
+msgid "get-recovery-proc"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:647
+#: ../fish/guestfish-actions.pod:1377
#, no-wrap
msgid ""
-" command-lines 'arguments ...'\n"
+" get-recovery-proc\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:649
-msgid "This is the same as C<command>, but splits the result into a list of lines."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:652
-msgid "See also: C<sh-lines>"
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:657
-msgid "config"
+#: ../fish/guestfish-actions.pod:1381
+msgid "get-selinux"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:659
+#: ../fish/guestfish-actions.pod:1383
#, no-wrap
msgid ""
-" config qemuparam qemuvalue\n"
+" get-selinux\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:1385
+msgid ""
+"This returns the current setting of the selinux flag which is passed to the "
+"appliance at boot time. See L</set-selinux>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:670
-msgid "copy-size"
+#: ../fish/guestfish-actions.pod:1391
+msgid "get-state"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:672
+#: ../fish/guestfish-actions.pod:1393
#, no-wrap
msgid ""
-" copy-size src dest size\n"
+" get-state\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:680
-msgid "cp"
+#: ../fish/guestfish-actions.pod:1400
+msgid "get-trace"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:682
+#: ../fish/guestfish-actions.pod:1402
#, no-wrap
msgid ""
-" cp src dest\n"
+" get-trace\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:687
-msgid "cp-a"
+#: ../fish/guestfish-actions.pod:1406
+msgid "get-umask"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:689
+#: ../fish/guestfish-actions.pod:1408
#, no-wrap
msgid ""
-" cp-a src dest\n"
+" get-umask\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:1410
+msgid ""
+"Return the current umask. By default the umask is C<022> unless it has been "
+"set by calling L</umask>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:694
-msgid "dd"
+#: ../fish/guestfish-actions.pod:1413
+msgid "get-verbose"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:696
+#: ../fish/guestfish-actions.pod:1415
#, no-wrap
msgid ""
-" dd src dest\n"
+" get-verbose\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:703
-msgid ""
-"If the destination is a device, it must be as large or larger than the "
-"source file or device, otherwise the copy will fail. This command cannot do "
-"partial copies (see C<copy-size>)."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:707
-msgid "debug"
+#: ../fish/guestfish-actions.pod:1419
+msgid "getcon"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:709
+#: ../fish/guestfish-actions.pod:1421
#, no-wrap
msgid ""
-" debug subcmd 'extraargs ...'\n"
+" getcon\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:711
-msgid ""
-"The C<debug> command exposes some internals of C<guestfsd> (the guestfs "
-"daemon) that runs inside the qemu subprocess."
+#: ../fish/guestfish-actions.pod:1425
+msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:719
-msgid "debug-upload"
+#: ../fish/guestfish-actions.pod:1428
+msgid "getxattrs"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:721
+#: ../fish/guestfish-actions.pod:1430
#, no-wrap
msgid ""
-" debug-upload (filename|-) tmpname mode\n"
+" getxattrs path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:723
-msgid "The C<debug-upload> command uploads a file to the libguestfs appliance."
+#: ../fish/guestfish-actions.pod:1438
+msgid "See also: L</lgetxattrs>, L<attr(5)>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:732
-msgid "df"
+#: ../fish/guestfish-actions.pod:1440
+msgid "glob-expand"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:734
+#: ../fish/guestfish-actions.pod:1442
#, no-wrap
msgid ""
-" df\n"
+" glob-expand pattern\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:742
-msgid "df-h"
+#: ../fish/guestfish-actions.pod:1455
+msgid "grep"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:744
+#: ../fish/guestfish-actions.pod:1457
#, no-wrap
msgid ""
-" df-h\n"
+" grep regex path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:753
-msgid "dmesg"
+#: ../fish/guestfish-actions.pod:1465
+msgid "grepi"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:755
+#: ../fish/guestfish-actions.pod:1467
#, no-wrap
msgid ""
-" dmesg\n"
+" grepi regex path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:761
-msgid ""
-"Another way to get the same information is to enable verbose messages with "
-"C<set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
-"before running the program."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:766
-msgid "download"
+#: ../fish/guestfish-actions.pod:1475
+msgid "grub-install"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:768
+#: ../fish/guestfish-actions.pod:1477
#, no-wrap
msgid ""
-" download remotefilename (filename|-)\n"
+" grub-install root device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:775
-msgid "See also C<upload>, C<cat>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:779
-msgid "drop-caches"
+#: ../fish/guestfish-actions.pod:1493
+msgid "head"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:781
+#: ../fish/guestfish-actions.pod:1495
#, no-wrap
msgid ""
-" drop-caches whattodrop\n"
+" head path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:793
-msgid "du"
+#: ../fish/guestfish-actions.pod:1503
+msgid "head-n"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:795
+#: ../fish/guestfish-actions.pod:1505
#, no-wrap
msgid ""
-" du path\n"
+" head-n nrlines path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:807
-msgid "e2fsck-f"
+#: ../fish/guestfish-actions.pod:1518
+msgid "hexdump"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:809
+#: ../fish/guestfish-actions.pod:1520
#, no-wrap
msgid ""
-" e2fsck-f device\n"
+" hexdump path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:815
-msgid ""
-"This command is only needed because of C<resize2fs> (q.v.). Normally you "
-"should use C<fsck>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:818
-msgid "echo-daemon"
+#: ../fish/guestfish-actions.pod:1528
+msgid "initrd-cat"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:820
+#: ../fish/guestfish-actions.pod:1530
#, no-wrap
msgid ""
-" echo-daemon 'words ...'\n"
+" initrd-cat initrdpath filename\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:827
-msgid "See also C<ping-daemon>."
+#: ../fish/guestfish-actions.pod:1542
+msgid "See also L</initrd-list>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:829
-msgid "egrep"
+#: ../fish/guestfish-actions.pod:1547
+msgid "initrd-list"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:831
+#: ../fish/guestfish-actions.pod:1549
#, no-wrap
msgid ""
-" egrep regex path\n"
+" initrd-list path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:839
-msgid "egrepi"
+#: ../fish/guestfish-actions.pod:1561
+msgid "inotify-add-watch"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:841
+#: ../fish/guestfish-actions.pod:1563
#, no-wrap
msgid ""
-" egrepi regex path\n"
+" inotify-add-watch path mask\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:849
-msgid "equal"
+#: ../fish/guestfish-actions.pod:1575
+msgid "inotify-close"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:851
+#: ../fish/guestfish-actions.pod:1577
#, no-wrap
msgid ""
-" equal file1 file2\n"
+" inotify-close\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:858
-msgid "exists"
+#: ../fish/guestfish-actions.pod:1583
+msgid "inotify-files"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:860
+#: ../fish/guestfish-actions.pod:1585
#, no-wrap
msgid ""
-" exists path\n"
+" inotify-files\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:865
-msgid "See also C<is-file>, C<is-dir>, C<stat>."
+#: ../fish/guestfish-actions.pod:1587
+msgid ""
+"This function is a helpful wrapper around L</inotify-read> which just "
+"returns a list of pathnames of objects that were touched. The returned "
+"pathnames are sorted and deduplicated."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:867
-msgid "fallocate"
+#: ../fish/guestfish-actions.pod:1591
+msgid "inotify-init"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:869
+#: ../fish/guestfish-actions.pod:1593
#, no-wrap
msgid ""
-" fallocate path len\n"
+" inotify-init maxevents\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:886
-msgid "fallocate64"
+# type: textblock
+#: ../fish/guestfish-actions.pod:1599
+msgid ""
+"C<maxevents> is the maximum number of events which will be queued up between "
+"calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
+"then the kernel (or previously set) default is used. For Linux 2.6.29 the "
+"default was 16384 events. Beyond this limit, the kernel throws away events, "
+"but records the fact that it threw them away by setting a flag "
+"C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:888
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:1609
msgid ""
-" fallocate64 path len\n"
-"\n"
+"Before any events are generated, you have to add some watches to the "
+"internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
+"L</inotify-watch-all>."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:894
+#: ../fish/guestfish-actions.pod:1615
msgid ""
-"Note that this call allocates disk blocks for the file. To create a sparse "
-"file use C<truncate-size> instead."
+"Queued up events should be read periodically by calling L</inotify-read> (or "
+"L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
+"If you don't read the events out often enough then you risk the internal "
+"queue overflowing."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:897
+#: ../fish/guestfish-actions.pod:1622
msgid ""
-"The deprecated call C<fallocate> does the same, but owing to an oversight it "
-"only allowed 30 bit lengths to be specified, effectively limiting the "
-"maximum size of files created through that call to 1GB."
+"The handle should be closed after use by calling L</inotify-close>. This "
+"also removes any watches automatically."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:906
-msgid "fgrep"
+#: ../fish/guestfish-actions.pod:1631
+msgid "inotify-read"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:908
+#: ../fish/guestfish-actions.pod:1633
#, no-wrap
msgid ""
-" fgrep pattern path\n"
+" inotify-read\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:916
-msgid "fgrepi"
+#: ../fish/guestfish-actions.pod:1646
+msgid "inotify-rm-watch"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:918
+#: ../fish/guestfish-actions.pod:1648
#, no-wrap
msgid ""
-" fgrepi pattern path\n"
+" inotify-rm-watch wd\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:1650
+msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:926
-msgid "file"
+#: ../fish/guestfish-actions.pod:1653
+msgid "inspect-get-arch"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:928
+#: ../fish/guestfish-actions.pod:1655
#, no-wrap
msgid ""
-" file path\n"
+" inspect-get-arch root\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:940
+#: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673 ../fish/guestfish-actions.pod:1739 ../fish/guestfish-actions.pod:1757 ../fish/guestfish-actions.pod:1778 ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1838 ../fish/guestfish-actions.pod:1862 ../fish/guestfish-actions.pod:1892 ../fish/guestfish-actions.pod:1927
msgid ""
-"This command can also be used on C</dev/> devices (and partitions, LV "
-"names). You can for example use this to determine if a device contains a "
-"filesystem, although it's usually better to use C<vfs-type>."
+"This function should only be called with a root device string as returned by "
+"L</inspect-os>."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:1660
+msgid ""
+"This returns the architecture of the inspected operating system. The "
+"possible return values are listed under L</file-architecture>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:950
-msgid "file-architecture"
+#: ../fish/guestfish-actions.pod:1669
+msgid "inspect-get-distro"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:952
+#: ../fish/guestfish-actions.pod:1671
#, no-wrap
msgid ""
-" file-architecture filename\n"
+" inspect-get-distro root\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1055
-msgid "filesize"
+#: ../fish/guestfish-actions.pod:1735
+msgid "inspect-get-filesystems"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1057
+#: ../fish/guestfish-actions.pod:1737
#, no-wrap
msgid ""
-" filesize file\n"
+" inspect-get-filesystems root\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1061
+#: ../fish/guestfish-actions.pod:1750
msgid ""
-"To get other stats about a file, use C<stat>, C<lstat>, C<is-dir>, "
-"C<is-file> etc. To get the size of block devices, use "
-"C<blockdev-getsize64>."
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"L</inspect-get-mountpoints>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1065
-msgid "fill"
+#: ../fish/guestfish-actions.pod:1753
+msgid "inspect-get-major-version"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1067
+#: ../fish/guestfish-actions.pod:1755
#, no-wrap
msgid ""
-" fill c len path\n"
+" inspect-get-major-version root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1073
-msgid ""
-"To fill a file with zero bytes (sparsely), it is much more efficient to use "
-"C<truncate-size>. To create a file with a pattern of repeating bytes use "
-"C<fill-pattern>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:1078
-msgid "fill-pattern"
+#: ../fish/guestfish-actions.pod:1774
+msgid "inspect-get-minor-version"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1080
+#: ../fish/guestfish-actions.pod:1776
#, no-wrap
msgid ""
-" fill-pattern pattern len path\n"
+" inspect-get-minor-version root\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1082
+#: ../fish/guestfish-actions.pod:1786
msgid ""
-"This function is like C<fill> except that it creates a new file of length "
-"C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
-"is truncated if necessary to ensure the length of the file is exactly C<len> "
-"bytes."
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"L</inspect-get-major-version>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1087
-msgid "find"
+#: ../fish/guestfish-actions.pod:1789
+msgid "inspect-get-mountpoints"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1089
+#: ../fish/guestfish-actions.pod:1791
#, no-wrap
msgid ""
-" find directory\n"
+" inspect-get-mountpoints root\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1103
-msgid "then the returned list from C<find> C</tmp> would be 4 elements:"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:1116
-msgid "See also C<find0>."
+#: ../fish/guestfish-actions.pod:1809
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"L</inspect-get-filesystems>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1121
-msgid "find0"
+#: ../fish/guestfish-actions.pod:1812
+msgid "inspect-get-package-format"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1123
+#: ../fish/guestfish-actions.pod:1814
#, no-wrap
msgid ""
-" find0 directory (files|-)\n"
+" inspect-get-package-format root\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1129
-msgid "This command works the same way as C<find> with the following exceptions:"
+#: ../fish/guestfish-actions.pod:1819
+msgid ""
+"This function and L</inspect-get-package-management> return the package "
+"format and package management tool used by the inspected operating system. "
+"For example for Fedora these functions would return C<rpm> (package format) "
+"and C<yum> (package management)."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1156
-msgid "findfs-label"
+#: ../fish/guestfish-actions.pod:1834
+msgid "inspect-get-package-management"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1158
+#: ../fish/guestfish-actions.pod:1836
#, no-wrap
msgid ""
-" findfs-label label\n"
+" inspect-get-package-management root\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1164
-msgid "To find the label of a filesystem, use C<vfs-label>."
+#: ../fish/guestfish-actions.pod:1841
+msgid ""
+"L</inspect-get-package-format> and this function return the package format "
+"and package management tool used by the inspected operating system. For "
+"example for Fedora these functions would return C<rpm> (package format) and "
+"C<yum> (package management)."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1166
-msgid "findfs-uuid"
+#: ../fish/guestfish-actions.pod:1858
+msgid "inspect-get-product-name"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1168
+#: ../fish/guestfish-actions.pod:1860
#, no-wrap
msgid ""
-" findfs-uuid uuid\n"
+" inspect-get-product-name root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1174
-msgid "To find the UUID of a filesystem, use C<vfs-uuid>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:1176
-msgid "fsck"
+#: ../fish/guestfish-actions.pod:1875
+msgid "inspect-get-roots"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1178
+#: ../fish/guestfish-actions.pod:1877
#, no-wrap
msgid ""
-" fsck fstype device\n"
+" inspect-get-roots\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1208
-msgid "get-append"
+# type: textblock
+#: ../fish/guestfish-actions.pod:1879
+msgid ""
+"This function is a convenient way to get the list of root devices, as "
+"returned from a previous call to L</inspect-os>, but without redoing the "
+"whole inspection process."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1210
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:1883
msgid ""
-" get-append\n"
-"\n"
+"This returns an empty list if either no root devices were found or the "
+"caller has not called L</inspect-os>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1217
-msgid "get-autosync"
+#: ../fish/guestfish-actions.pod:1888
+msgid "inspect-get-type"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1219
+#: ../fish/guestfish-actions.pod:1890
#, no-wrap
msgid ""
-" get-autosync\n"
+" inspect-get-type root\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1223
-msgid "get-direct"
+#: ../fish/guestfish-actions.pod:1923
+msgid "inspect-get-windows-systemroot"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1225
+#: ../fish/guestfish-actions.pod:1925
#, no-wrap
msgid ""
-" get-direct\n"
+" inspect-get-windows-systemroot root\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1229
-msgid "get-e2label"
+#: ../fish/guestfish-actions.pod:1939
+msgid "inspect-os"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1231
+#: ../fish/guestfish-actions.pod:1941
#, no-wrap
msgid ""
-" get-e2label device\n"
+" inspect-os\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1243
-msgid "get-e2uuid"
+# type: textblock
+#: ../fish/guestfish-actions.pod:1956
+msgid ""
+"You can pass the root string(s) returned to other L</inspect-get-*> "
+"functions in order to query further information about each operating system, "
+"such as the name and version."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1245
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:1961
msgid ""
-" get-e2uuid device\n"
-"\n"
+"This function uses other libguestfs features such as L</mount-ro> and "
+"L</umount-all> in order to mount and unmount filesystems and look at the "
+"contents. This should be called with no disks currently mounted. The "
+"function may also use Augeas, so any existing Augeas handle will be closed."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:1973 ../fish/guestfish-actions.pod:2129 ../fish/guestfish-actions.pod:2175
+msgid "See also L</list-filesystems>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1257
-msgid "get-memsize"
+#: ../fish/guestfish-actions.pod:1975
+msgid "is-blockdev"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1259
+#: ../fish/guestfish-actions.pod:1977
#, no-wrap
msgid ""
-" get-memsize\n"
+" is-blockdev path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1264
-msgid ""
-"If C<set-memsize> was not called on this handle, and if "
-"C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
-"value for memsize."
+#: ../fish/guestfish-actions.pod:1982 ../fish/guestfish-actions.pod:2000 ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2028 ../fish/guestfish-actions.pod:2038 ../fish/guestfish-actions.pod:2072 ../fish/guestfish-actions.pod:2081
+msgid "See also L</stat>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1271
-msgid "get-network"
+#: ../fish/guestfish-actions.pod:1984
+msgid "is-busy"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1273
+#: ../fish/guestfish-actions.pod:1986
#, no-wrap
msgid ""
-" get-network\n"
+" is-busy\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1277
-msgid "get-path"
+#: ../fish/guestfish-actions.pod:1993
+msgid "is-chardev"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1279
+#: ../fish/guestfish-actions.pod:1995
#, no-wrap
msgid ""
-" get-path\n"
+" is-chardev path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1286
-msgid "get-pid | pid"
+#: ../fish/guestfish-actions.pod:2002
+msgid "is-config"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1288
+#: ../fish/guestfish-actions.pod:2004
#, no-wrap
msgid ""
-" get-pid\n"
+" is-config\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1295
-msgid "get-qemu"
+#: ../fish/guestfish-actions.pod:2011
+msgid "is-dir"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1297
+#: ../fish/guestfish-actions.pod:2013
#, no-wrap
msgid ""
-" get-qemu\n"
+" is-dir path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1304
-msgid "get-recovery-proc"
+#: ../fish/guestfish-actions.pod:2021
+msgid "is-fifo"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1306
+#: ../fish/guestfish-actions.pod:2023
#, no-wrap
msgid ""
-" get-recovery-proc\n"
+" is-fifo path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1310
-msgid "get-selinux"
+#: ../fish/guestfish-actions.pod:2030
+msgid "is-file"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1312
+#: ../fish/guestfish-actions.pod:2032
#, no-wrap
msgid ""
-" get-selinux\n"
+" is-file path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1314
-msgid ""
-"This returns the current setting of the selinux flag which is passed to the "
-"appliance at boot time. See C<set-selinux>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:1320
-msgid "get-state"
+#: ../fish/guestfish-actions.pod:2040
+msgid "is-launching"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1322
+#: ../fish/guestfish-actions.pod:2042
#, no-wrap
msgid ""
-" get-state\n"
+" is-launching\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1329
-msgid "get-trace"
+#: ../fish/guestfish-actions.pod:2049
+msgid "is-lv"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1331
+#: ../fish/guestfish-actions.pod:2051
#, no-wrap
msgid ""
-" get-trace\n"
+" is-lv device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1335
-msgid "get-umask"
+#: ../fish/guestfish-actions.pod:2056
+msgid "is-ready"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1337
+#: ../fish/guestfish-actions.pod:2058
#, no-wrap
msgid ""
-" get-umask\n"
+" is-ready\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1339
-msgid ""
-"Return the current umask. By default the umask is C<022> unless it has been "
-"set by calling C<umask>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:1342
-msgid "get-verbose"
+#: ../fish/guestfish-actions.pod:2065
+msgid "is-socket"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1344
+#: ../fish/guestfish-actions.pod:2067
#, no-wrap
msgid ""
-" get-verbose\n"
+" is-socket path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1348
-msgid "getcon"
+#: ../fish/guestfish-actions.pod:2074
+msgid "is-symlink"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1350
+#: ../fish/guestfish-actions.pod:2076
#, no-wrap
msgid ""
-" getcon\n"
+" is-symlink path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1354
-msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<setcon>"
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:1357
-msgid "getxattrs"
+#: ../fish/guestfish-actions.pod:2083
+msgid "kill-subprocess"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1359
+#: ../fish/guestfish-actions.pod:2085
#, no-wrap
msgid ""
-" getxattrs path\n"
+" kill-subprocess\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1367
-msgid "See also: C<lgetxattrs>, L<attr(5)>."
+# type: =head2
+#: ../fish/guestfish-actions.pod:2089
+msgid "launch"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1369
-msgid "glob-expand"
+#: ../fish/guestfish-actions.pod:2091
+msgid "run"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1371
+#: ../fish/guestfish-actions.pod:2093
#, no-wrap
msgid ""
-" glob-expand pattern\n"
+" launch\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1384
-msgid "grep"
+#: ../fish/guestfish-actions.pod:2101
+msgid "lchown"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1386
+#: ../fish/guestfish-actions.pod:2103
#, no-wrap
msgid ""
-" grep regex path\n"
+" lchown owner group path\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1394
-msgid "grepi"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1396
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:2105
msgid ""
-" grepi regex path\n"
-"\n"
+"Change the file owner to C<owner> and group to C<group>. This is like "
+"L</chown> but if C<path> is a symlink then the link itself is changed, not "
+"the target."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1404
-msgid "grub-install"
+#: ../fish/guestfish-actions.pod:2113
+msgid "lgetxattrs"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1406
+#: ../fish/guestfish-actions.pod:2115
#, no-wrap
msgid ""
-" grub-install root device\n"
+" lgetxattrs path\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2117
+msgid ""
+"This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
+"it returns the extended attributes of the link itself."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:1422
-msgid "head"
+#: ../fish/guestfish-actions.pod:2121
+msgid "list-devices"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1424
+#: ../fish/guestfish-actions.pod:2123
#, no-wrap
msgid ""
-" head path\n"
+" list-devices\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1432
-msgid "head-n"
+#: ../fish/guestfish-actions.pod:2131
+msgid "list-filesystems"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1434
+#: ../fish/guestfish-actions.pod:2133
#, no-wrap
msgid ""
-" head-n nrlines path\n"
+" list-filesystems\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1447
-msgid "hexdump"
+# type: textblock
+#: ../fish/guestfish-actions.pod:2152
+msgid ""
+"This command runs other libguestfs commands, which might include L</mount> "
+"and L</umount>, and therefore you should use this soon after launch and only "
+"when nothing is mounted."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1449
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:2156
msgid ""
-" hexdump path\n"
-"\n"
+"Not all of the filesystems returned will be mountable. In particular, swap "
+"partitions are returned in the list. Also this command does not check that "
+"each filesystem found is valid and mountable, and some filesystems might be "
+"mountable but require special options. Filesystems may not all belong to a "
+"single logical operating system (use L</inspect-os> to look for OSes)."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1457
-msgid "initrd-cat"
+#: ../fish/guestfish-actions.pod:2164
+msgid "list-partitions"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1459
+#: ../fish/guestfish-actions.pod:2166
#, no-wrap
msgid ""
-" initrd-cat initrdpath filename\n"
+" list-partitions\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1471
-msgid "See also C<initrd-list>."
+#: ../fish/guestfish-actions.pod:2172
+msgid ""
+"This does not return logical volumes. For that you will need to call "
+"L</lvs>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1476
-msgid "initrd-list"
+#: ../fish/guestfish-actions.pod:2177
+msgid "ll"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1478
+#: ../fish/guestfish-actions.pod:2179
#, no-wrap
msgid ""
-" initrd-list path\n"
+" ll directory\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1490
-msgid "inotify-add-watch"
+#: ../fish/guestfish-actions.pod:2187
+msgid "ln"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1492
+#: ../fish/guestfish-actions.pod:2189
#, no-wrap
msgid ""
-" inotify-add-watch path mask\n"
+" ln target linkname\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1504
-msgid "inotify-close"
+#: ../fish/guestfish-actions.pod:2193
+msgid "ln-f"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1506
+#: ../fish/guestfish-actions.pod:2195
#, no-wrap
msgid ""
-" inotify-close\n"
+" ln-f target linkname\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1512
-msgid "inotify-files"
+#: ../fish/guestfish-actions.pod:2200
+msgid "ln-s"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1514
+#: ../fish/guestfish-actions.pod:2202
#, no-wrap
msgid ""
-" inotify-files\n"
+" ln-s target linkname\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1516
+# type: =head2
+#: ../fish/guestfish-actions.pod:2206
+msgid "ln-sf"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:2208
+#, no-wrap
msgid ""
-"This function is a helpful wrapper around C<inotify-read> which just returns "
-"a list of pathnames of objects that were touched. The returned pathnames "
-"are sorted and deduplicated."
+" ln-sf target linkname\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1520
-msgid "inotify-init"
+#: ../fish/guestfish-actions.pod:2213
+msgid "lremovexattr"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1522
+#: ../fish/guestfish-actions.pod:2215
#, no-wrap
msgid ""
-" inotify-init maxevents\n"
+" lremovexattr xattr path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1528
+#: ../fish/guestfish-actions.pod:2217
msgid ""
-"C<maxevents> is the maximum number of events which will be queued up between "
-"calls to C<inotify-read> or C<inotify-files>. If this is passed as C<0>, "
-"then the kernel (or previously set) default is used. For Linux 2.6.29 the "
-"default was 16384 events. Beyond this limit, the kernel throws away events, "
-"but records the fact that it threw them away by setting a flag "
-"C<IN_Q_OVERFLOW> in the returned structure list (see C<inotify-read>)."
+"This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
+"it removes an extended attribute of the link itself."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1538
-msgid ""
-"Before any events are generated, you have to add some watches to the "
-"internal watch list. See: C<inotify-add-watch>, C<inotify-rm-watch> and "
-"C<inotify-watch-all>."
+# type: =head2
+#: ../fish/guestfish-actions.pod:2221
+msgid "ls"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1544
+# type: verbatim
+#: ../fish/guestfish-actions.pod:2223
+#, no-wrap
msgid ""
-"Queued up events should be read periodically by calling C<inotify-read> (or "
-"C<inotify-files> which is just a helpful wrapper around C<inotify-read>). "
-"If you don't read the events out often enough then you risk the internal "
-"queue overflowing."
+" ls directory\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1551
+#: ../fish/guestfish-actions.pod:2229
msgid ""
-"The handle should be closed after use by calling C<inotify-close>. This "
-"also removes any watches automatically."
+"This command is mostly useful for interactive sessions. Programs should "
+"probably use L</readdir> instead."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1560
-msgid "inotify-read"
+#: ../fish/guestfish-actions.pod:2232
+msgid "lsetxattr"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1562
+#: ../fish/guestfish-actions.pod:2234
#, no-wrap
msgid ""
-" inotify-read\n"
+" lsetxattr xattr val vallen path\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2236
+msgid ""
+"This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
+"sets an extended attribute of the link itself."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:1575
-msgid "inotify-rm-watch"
+#: ../fish/guestfish-actions.pod:2240
+msgid "lstat"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1577
+#: ../fish/guestfish-actions.pod:2242
#, no-wrap
msgid ""
-" inotify-rm-watch wd\n"
+" lstat path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1579
-msgid "Remove a previously defined inotify watch. See C<inotify-add-watch>."
+#: ../fish/guestfish-actions.pod:2246
+msgid ""
+"This is the same as L</stat> except that if C<path> is a symbolic link, then "
+"the link is stat-ed, not the file it refers to."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1582
-msgid "inspect-get-arch"
+#: ../fish/guestfish-actions.pod:2252
+msgid "lstatlist"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1584
+#: ../fish/guestfish-actions.pod:2254
#, no-wrap
msgid ""
-" inspect-get-arch root\n"
+" lstatlist path 'names ...'\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1586 ../fish/guestfish-actions.pod:1602 ../fish/guestfish-actions.pod:1648 ../fish/guestfish-actions.pod:1666 ../fish/guestfish-actions.pod:1687 ../fish/guestfish-actions.pod:1702 ../fish/guestfish-actions.pod:1725 ../fish/guestfish-actions.pod:1742
+#: ../fish/guestfish-actions.pod:2256
msgid ""
-"This function should only be called with a root device string as returned by "
-"C<inspect-os>."
+"This call allows you to perform the L</lstat> operation on multiple files, "
+"where all files are in the directory C<path>. C<names> is the list of files "
+"from this directory."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1589
+#: ../fish/guestfish-actions.pod:2265
msgid ""
-"This returns the architecture of the inspected operating system. The "
-"possible return values are listed under C<file-architecture>."
+"This call is intended for programs that want to efficiently list a directory "
+"contents without making many round-trips. See also L</lxattrlist> for a "
+"similarly efficient call for getting extended attributes. Very long "
+"directory listings might cause the protocol message size to be exceeded, "
+"causing this call to fail. The caller must split up such requests into "
+"smaller groups of names."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1598
-msgid "inspect-get-distro"
+#: ../fish/guestfish-actions.pod:2273
+msgid "luks-add-key"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1600
+#: ../fish/guestfish-actions.pod:2275
#, no-wrap
msgid ""
-" inspect-get-distro root\n"
+" luks-add-key device keyslot\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1644
-msgid "inspect-get-filesystems"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1646
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:2282
msgid ""
-" inspect-get-filesystems root\n"
-"\n"
+"Note that if C<keyslot> already contains a key, then this command will "
+"fail. You have to use L</luks-kill-slot> first to remove that key."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1659
+#: ../fish/guestfish-actions.pod:2286 ../fish/guestfish-actions.pod:2308 ../fish/guestfish-actions.pod:2321 ../fish/guestfish-actions.pod:2335 ../fish/guestfish-actions.pod:2358 ../fish/guestfish-actions.pod:2368
msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also "
-"C<inspect-get-mountpoints>."
+"This command has one or more key or passphrase parameters. Guestfish will "
+"prompt for these separately."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1662
-msgid "inspect-get-major-version"
+#: ../fish/guestfish-actions.pod:2289
+msgid "luks-close"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1664
+#: ../fish/guestfish-actions.pod:2291
#, no-wrap
msgid ""
-" inspect-get-major-version root\n"
+" luks-close device\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2293
+msgid ""
+"This closes a LUKS device that was created earlier by L</luks-open> or "
+"L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
+"mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
+"underlying block device."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:1683
-msgid "inspect-get-minor-version"
+#: ../fish/guestfish-actions.pod:2299
+msgid "luks-format"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1685
+#: ../fish/guestfish-actions.pod:2301
#, no-wrap
msgid ""
-" inspect-get-minor-version root\n"
+" luks-format device keyslot\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1695
-msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also "
-"C<inspect-get-major-version>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:1698
-msgid "inspect-get-mountpoints"
+#: ../fish/guestfish-actions.pod:2314
+msgid "luks-format-cipher"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1700
+#: ../fish/guestfish-actions.pod:2316
#, no-wrap
msgid ""
-" inspect-get-mountpoints root\n"
+" luks-format-cipher device keyslot cipher\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1718
+#: ../fish/guestfish-actions.pod:2318
msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also "
-"C<inspect-get-filesystems>."
+"This command is the same as L</luks-format> but it also allows you to set "
+"the C<cipher> used."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1721
-msgid "inspect-get-product-name"
+#: ../fish/guestfish-actions.pod:2327
+msgid "luks-kill-slot"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1723
+#: ../fish/guestfish-actions.pod:2329
#, no-wrap
msgid ""
-" inspect-get-product-name root\n"
+" luks-kill-slot device keyslot\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1738
-msgid "inspect-get-type"
+#: ../fish/guestfish-actions.pod:2338
+msgid "luks-open"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1740
+#: ../fish/guestfish-actions.pod:2340
#, no-wrap
msgid ""
-" inspect-get-type root\n"
+" luks-open device mapname\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2354
+msgid ""
+"If this block device contains LVM volume groups, then calling L</vgscan> "
+"followed by L</vg-activate-all> will make them visible."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:1769
-msgid "inspect-os"
+#: ../fish/guestfish-actions.pod:2361
+msgid "luks-open-ro"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1771
+#: ../fish/guestfish-actions.pod:2363
#, no-wrap
msgid ""
-" inspect-os\n"
+" luks-open-ro device mapname\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1786
-msgid ""
-"You can pass the root string(s) returned to other C<inspect-get-*> functions "
-"in order to query further information about each operating system, such as "
-"the name and version."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:1791
+#: ../fish/guestfish-actions.pod:2365
msgid ""
-"This function uses other libguestfs features such as C<mount-ro> and "
-"C<umount-all> in order to mount and unmount filesystems and look at the "
-"contents. This should be called with no disks currently mounted. The "
-"function may also use Augeas, so any existing Augeas handle will be closed."
+"This is the same as L</luks-open> except that a read-only mapping is "
+"created."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1803
-msgid "is-blockdev"
+#: ../fish/guestfish-actions.pod:2371
+msgid "lvcreate"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1805
+#: ../fish/guestfish-actions.pod:2373
#, no-wrap
msgid ""
-" is-blockdev path\n"
+" lvcreate logvol volgroup mbytes\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1810 ../fish/guestfish-actions.pod:1828 ../fish/guestfish-actions.pod:1847 ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:1866 ../fish/guestfish-actions.pod:1900 ../fish/guestfish-actions.pod:1909
-msgid "See also C<stat>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:1812
-msgid "is-busy"
+#: ../fish/guestfish-actions.pod:2378
+msgid "lvm-canonical-lv-name"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1814
+#: ../fish/guestfish-actions.pod:2380
#, no-wrap
msgid ""
-" is-busy\n"
+" lvm-canonical-lv-name lvname\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2389
+msgid "See also L</is-lv>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:1821
-msgid "is-chardev"
+#: ../fish/guestfish-actions.pod:2391
+msgid "lvm-clear-filter"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1823
+#: ../fish/guestfish-actions.pod:2393
#, no-wrap
msgid ""
-" is-chardev path\n"
+" lvm-clear-filter\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2395
+msgid ""
+"This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
+"block device."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:1830
-msgid "is-config"
+#: ../fish/guestfish-actions.pod:2401
+msgid "lvm-remove-all"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1832
+#: ../fish/guestfish-actions.pod:2403
#, no-wrap
msgid ""
-" is-config\n"
+" lvm-remove-all\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1839
-msgid "is-dir"
+#: ../fish/guestfish-actions.pod:2411
+msgid "lvm-set-filter"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1841
+#: ../fish/guestfish-actions.pod:2413
#, no-wrap
msgid ""
-" is-dir path\n"
+" lvm-set-filter 'devices ...'\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1849
-msgid "is-fifo"
+#: ../fish/guestfish-actions.pod:2438
+msgid "lvremove"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1851
+#: ../fish/guestfish-actions.pod:2440
#, no-wrap
msgid ""
-" is-fifo path\n"
+" lvremove device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1858
-msgid "is-file"
+#: ../fish/guestfish-actions.pod:2448
+msgid "lvrename"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1860
+#: ../fish/guestfish-actions.pod:2450
#, no-wrap
msgid ""
-" is-file path\n"
+" lvrename logvol newlogvol\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1868
-msgid "is-launching"
+#: ../fish/guestfish-actions.pod:2454
+msgid "lvresize"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1870
+#: ../fish/guestfish-actions.pod:2456
#, no-wrap
msgid ""
-" is-launching\n"
+" lvresize device mbytes\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1877
-msgid "is-lv"
+#: ../fish/guestfish-actions.pod:2462
+msgid "lvresize-free"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1879
+#: ../fish/guestfish-actions.pod:2464
#, no-wrap
msgid ""
-" is-lv device\n"
+" lvresize-free lv percent\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1884
-msgid "is-ready"
+#: ../fish/guestfish-actions.pod:2472
+msgid "lvs"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1886
+#: ../fish/guestfish-actions.pod:2474
#, no-wrap
msgid ""
-" is-ready\n"
+" lvs\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2482
+msgid "See also L</lvs-full>, L</list-filesystems>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:1893
-msgid "is-socket"
+#: ../fish/guestfish-actions.pod:2484
+msgid "lvs-full"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1895
+#: ../fish/guestfish-actions.pod:2486
#, no-wrap
msgid ""
-" is-socket path\n"
+" lvs-full\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1902
-msgid "is-symlink"
+#: ../fish/guestfish-actions.pod:2491
+msgid "lvuuid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1904
+#: ../fish/guestfish-actions.pod:2493
#, no-wrap
msgid ""
-" is-symlink path\n"
+" lvuuid device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1911
-msgid "kill-subprocess"
+#: ../fish/guestfish-actions.pod:2497
+msgid "lxattrlist"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1913
+#: ../fish/guestfish-actions.pod:2499
#, no-wrap
msgid ""
-" kill-subprocess\n"
+" lxattrlist path 'names ...'\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2515
+msgid ""
+"This call is intended for programs that want to efficiently list a directory "
+"contents without making many round-trips. See also L</lstatlist> for a "
+"similarly efficient call for getting standard stats. Very long directory "
+"listings might cause the protocol message size to be exceeded, causing this "
+"call to fail. The caller must split up such requests into smaller groups of "
+"names."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:1917
-msgid "launch | run"
+#: ../fish/guestfish-actions.pod:2523
+msgid "mkdir"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1919
+#: ../fish/guestfish-actions.pod:2525
#, no-wrap
msgid ""
-" launch\n"
+" mkdir path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1927
-msgid "lchown"
+#: ../fish/guestfish-actions.pod:2529
+msgid "mkdir-mode"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1929
+#: ../fish/guestfish-actions.pod:2531
#, no-wrap
msgid ""
-" lchown owner group path\n"
+" mkdir-mode path mode\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1931
-msgid ""
-"Change the file owner to C<owner> and group to C<group>. This is like "
-"C<chown> but if C<path> is a symlink then the link itself is changed, not "
-"the target."
+#: ../fish/guestfish-actions.pod:2540
+msgid "See also L</mkdir>, L</umask>"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1939
-msgid "lgetxattrs"
+#: ../fish/guestfish-actions.pod:2542
+msgid "mkdir-p"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1941
+#: ../fish/guestfish-actions.pod:2544
#, no-wrap
msgid ""
-" lgetxattrs path\n"
+" mkdir-p path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1943
-msgid ""
-"This is the same as C<getxattrs>, but if C<path> is a symbolic link, then it "
-"returns the extended attributes of the link itself."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:1947
-msgid "list-devices"
+#: ../fish/guestfish-actions.pod:2549
+msgid "mkdtemp"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1949
+#: ../fish/guestfish-actions.pod:2551
#, no-wrap
msgid ""
-" list-devices\n"
+" mkdtemp template\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1955
-msgid "list-partitions"
+#: ../fish/guestfish-actions.pod:2572
+msgid "mke2fs-J"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1957
+#: ../fish/guestfish-actions.pod:2574
#, no-wrap
msgid ""
-" list-partitions\n"
+" mke2fs-J fstype blocksize device journal\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:1963
-msgid ""
-"This does not return logical volumes. For that you will need to call "
-"C<lvs>."
+#: ../fish/guestfish-actions.pod:2582
+msgid "See also L</mke2journal>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1966
-msgid "ll"
+#: ../fish/guestfish-actions.pod:2584
+msgid "mke2fs-JL"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1968
+#: ../fish/guestfish-actions.pod:2586
#, no-wrap
msgid ""
-" ll directory\n"
+" mke2fs-JL fstype blocksize device label\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1976
-msgid "ln"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1978
-#, no-wrap
-msgid ""
-" ln target linkname\n"
-"\n"
+# type: textblock
+#: ../fish/guestfish-actions.pod:2591
+msgid "See also L</mke2journal-L>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1982
-msgid "ln-f"
+#: ../fish/guestfish-actions.pod:2593
+msgid "mke2fs-JU"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1984
+#: ../fish/guestfish-actions.pod:2595
#, no-wrap
msgid ""
-" ln-f target linkname\n"
+" mke2fs-JU fstype blocksize device uuid\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2600
+msgid "See also L</mke2journal-U>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:1989
-msgid "ln-s"
+#: ../fish/guestfish-actions.pod:2602
+msgid "mke2journal"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1991
+#: ../fish/guestfish-actions.pod:2604
#, no-wrap
msgid ""
-" ln-s target linkname\n"
+" mke2journal blocksize device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:1995
-msgid "ln-sf"
+#: ../fish/guestfish-actions.pod:2611
+msgid "mke2journal-L"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:1997
+#: ../fish/guestfish-actions.pod:2613
#, no-wrap
msgid ""
-" ln-sf target linkname\n"
+" mke2journal-L blocksize label device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2002
-msgid "lremovexattr"
+#: ../fish/guestfish-actions.pod:2617
+msgid "mke2journal-U"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2004
+#: ../fish/guestfish-actions.pod:2619
#, no-wrap
msgid ""
-" lremovexattr xattr path\n"
+" mke2journal-U blocksize uuid device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2006
-msgid ""
-"This is the same as C<removexattr>, but if C<path> is a symbolic link, then "
-"it removes an extended attribute of the link itself."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2010
-msgid "ls"
+#: ../fish/guestfish-actions.pod:2623
+msgid "mkfifo"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2012
+#: ../fish/guestfish-actions.pod:2625
#, no-wrap
msgid ""
-" ls directory\n"
+" mkfifo mode path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2018
+#: ../fish/guestfish-actions.pod:2627
msgid ""
-"This command is mostly useful for interactive sessions. Programs should "
-"probably use C<readdir> instead."
+"This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
+"is just a convenient wrapper around L</mknod>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2021
-msgid "lsetxattr"
+#: ../fish/guestfish-actions.pod:2633
+msgid "mkfs"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2023
+#: ../fish/guestfish-actions.pod:2635
#, no-wrap
msgid ""
-" lsetxattr xattr val vallen path\n"
+" mkfs fstype device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2025
-msgid ""
-"This is the same as C<setxattr>, but if C<path> is a symbolic link, then it "
-"sets an extended attribute of the link itself."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2029
-msgid "lstat"
+#: ../fish/guestfish-actions.pod:2641
+msgid "mkfs-b"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2031
+#: ../fish/guestfish-actions.pod:2643
#, no-wrap
msgid ""
-" lstat path\n"
+" mkfs-b fstype blocksize device\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2035
+#: ../fish/guestfish-actions.pod:2645
msgid ""
-"This is the same as C<stat> except that if C<path> is a symbolic link, then "
-"the link is stat-ed, not the file it refers to."
+"This call is similar to L</mkfs>, but it allows you to control the block "
+"size of the resulting filesystem. Supported block sizes depend on the "
+"filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2041
-msgid "lstatlist"
+#: ../fish/guestfish-actions.pod:2653
+msgid "mkmountpoint"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2043
+#: ../fish/guestfish-actions.pod:2655
#, no-wrap
msgid ""
-" lstatlist path 'names ...'\n"
+" mkmountpoint exemptpath\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2045
+#: ../fish/guestfish-actions.pod:2657
msgid ""
-"This call allows you to perform the C<lstat> operation on multiple files, "
-"where all files are in the directory C<path>. C<names> is the list of files "
-"from this directory."
+"L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
+"to create extra mountpoints before mounting the first filesystem."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2054
-msgid ""
-"This call is intended for programs that want to efficiently list a directory "
-"contents without making many round-trips. See also C<lxattrlist> for a "
-"similarly efficient call for getting extended attributes. Very long "
-"directory listings might cause the protocol message size to be exceeded, "
-"causing this call to fail. The caller must split up such requests into "
-"smaller groups of names."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2062
-msgid "luks-add-key"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2064
-#, no-wrap
+#: ../fish/guestfish-actions.pod:2681
msgid ""
-" luks-add-key device keyslot\n"
-"\n"
+"L</mkmountpoint> is not compatible with L</umount-all>. You may get "
+"unexpected errors if you try to mix these calls. It is safest to manually "
+"unmount filesystems and remove mountpoints after use."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2071
+#: ../fish/guestfish-actions.pod:2685
msgid ""
-"Note that if C<keyslot> already contains a key, then this command will "
-"fail. You have to use C<luks-kill-slot> first to remove that key."
+"L</umount-all> unmounts filesystems by sorting the paths longest first, so "
+"for this to work for manual mountpoints, you must ensure that the innermost "
+"mountpoints have the longest pathnames, as in the example code above."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2075 ../fish/guestfish-actions.pod:2097 ../fish/guestfish-actions.pod:2110 ../fish/guestfish-actions.pod:2124 ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2157
+#: ../fish/guestfish-actions.pod:2692
msgid ""
-"This command has one or more key or passphrase parameters. Guestfish will "
-"prompt for these separately."
+"Autosync [see L</set-autosync>, this is set by default on handles] means "
+"that L</umount-all> is called when the handle is closed which can also "
+"trigger these issues."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2078
-msgid "luks-close"
+#: ../fish/guestfish-actions.pod:2696
+msgid "mknod"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2080
+#: ../fish/guestfish-actions.pod:2698
#, no-wrap
msgid ""
-" luks-close device\n"
+" mknod mode devmajor devminor path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2082
+#: ../fish/guestfish-actions.pod:2708
msgid ""
-"This closes a LUKS device that was created earlier by C<luks-open> or "
-"C<luks-open-ro>. The C<device> parameter must be the name of the LUKS "
-"mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
-"underlying block device."
+"Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
+"S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
+"regular file). These constants are available in the standard Linux header "
+"files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
+"wrappers around this command which bitwise OR in the appropriate constant "
+"for you."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2088
-msgid "luks-format"
+#: ../fish/guestfish-actions.pod:2718
+msgid "mknod-b"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2090
+#: ../fish/guestfish-actions.pod:2720
#, no-wrap
msgid ""
-" luks-format device keyslot\n"
+" mknod-b mode devmajor devminor path\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2722
+msgid ""
+"This call creates a block device node called C<path> with mode C<mode> and "
+"device major/minor C<devmajor> and C<devminor>. It is just a convenient "
+"wrapper around L</mknod>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2103
-msgid "luks-format-cipher"
+#: ../fish/guestfish-actions.pod:2728
+msgid "mknod-c"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2105
+#: ../fish/guestfish-actions.pod:2730
#, no-wrap
msgid ""
-" luks-format-cipher device keyslot cipher\n"
+" mknod-c mode devmajor devminor path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2107
+#: ../fish/guestfish-actions.pod:2732
msgid ""
-"This command is the same as C<luks-format> but it also allows you to set the "
-"C<cipher> used."
+"This call creates a char device node called C<path> with mode C<mode> and "
+"device major/minor C<devmajor> and C<devminor>. It is just a convenient "
+"wrapper around L</mknod>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2116
-msgid "luks-kill-slot"
+#: ../fish/guestfish-actions.pod:2738
+msgid "mkswap"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2118
+#: ../fish/guestfish-actions.pod:2740
#, no-wrap
msgid ""
-" luks-kill-slot device keyslot\n"
+" mkswap device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2127
-msgid "luks-open"
+#: ../fish/guestfish-actions.pod:2744
+msgid "mkswap-L"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2129
+#: ../fish/guestfish-actions.pod:2746
#, no-wrap
msgid ""
-" luks-open device mapname\n"
+" mkswap-L label device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2143
+# type: =head2
+#: ../fish/guestfish-actions.pod:2754
+msgid "mkswap-U"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:2756
+#, no-wrap
msgid ""
-"If this block device contains LVM volume groups, then calling C<vgscan> "
-"followed by C<vg-activate-all> will make them visible."
+" mkswap-U uuid device\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2150
-msgid "luks-open-ro"
+#: ../fish/guestfish-actions.pod:2760
+msgid "mkswap-file"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2152
+#: ../fish/guestfish-actions.pod:2762
#, no-wrap
msgid ""
-" luks-open-ro device mapname\n"
+" mkswap-file path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2154
-msgid "This is the same as C<luks-open> except that a read-only mapping is created."
+#: ../fish/guestfish-actions.pod:2766
+msgid ""
+"This command just writes a swap file signature to an existing file. To "
+"create the file itself, use something like L</fallocate>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2160
-msgid "lvcreate"
+#: ../fish/guestfish-actions.pod:2769
+msgid "modprobe"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2162
+#: ../fish/guestfish-actions.pod:2771
#, no-wrap
msgid ""
-" lvcreate logvol volgroup mbytes\n"
+" modprobe modulename\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2167
-msgid "lvm-clear-filter"
+#: ../fish/guestfish-actions.pod:2778
+msgid "mount"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2169
+#: ../fish/guestfish-actions.pod:2780
#, no-wrap
msgid ""
-" lvm-clear-filter\n"
+" mount device mountpoint\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2171
+#: ../fish/guestfish-actions.pod:2796
msgid ""
-"This undoes the effect of C<lvm-set-filter>. LVM will be able to see every "
-"block device."
+"B<Important note:> When you use this call, the filesystem options C<sync> "
+"and C<noatime> are set implicitly. This was originally done because we "
+"thought it would improve reliability, but it turns out that I<-o sync> has a "
+"very large negative performance impact and negligible effect on "
+"reliability. Therefore we recommend that you avoid using L</mount> in any "
+"code that needs performance, and instead use L</mount-options> (use an empty "
+"string for the first parameter if you don't want any options)."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2177
-msgid "lvm-remove-all"
+#: ../fish/guestfish-actions.pod:2806
+msgid "mount-loop"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2179
+#: ../fish/guestfish-actions.pod:2808
#, no-wrap
msgid ""
-" lvm-remove-all\n"
+" mount-loop file mountpoint\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2187
-msgid "lvm-set-filter"
+#: ../fish/guestfish-actions.pod:2814
+msgid "mount-options"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2189
+#: ../fish/guestfish-actions.pod:2816
#, no-wrap
msgid ""
-" lvm-set-filter 'devices ...'\n"
+" mount-options options device mountpoint\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2818
+msgid ""
+"This is the same as the L</mount> command, but it allows you to set the "
+"mount options as for the L<mount(8)> I<-o> flag."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2214
-msgid "lvremove"
+#: ../fish/guestfish-actions.pod:2826
+msgid "mount-ro"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2216
+#: ../fish/guestfish-actions.pod:2828
#, no-wrap
msgid ""
-" lvremove device\n"
+" mount-ro device mountpoint\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2830
+msgid ""
+"This is the same as the L</mount> command, but it mounts the filesystem with "
+"the read-only (I<-o ro>) flag."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2224
-msgid "lvrename"
+#: ../fish/guestfish-actions.pod:2833
+msgid "mount-vfs"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2226
+#: ../fish/guestfish-actions.pod:2835
#, no-wrap
msgid ""
-" lvrename logvol newlogvol\n"
+" mount-vfs options vfstype device mountpoint\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2837
+msgid ""
+"This is the same as the L</mount> command, but it allows you to set both the "
+"mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2230
-msgid "lvresize"
+#: ../fish/guestfish-actions.pod:2841
+msgid "mountpoints"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2232
+#: ../fish/guestfish-actions.pod:2843
#, no-wrap
msgid ""
-" lvresize device mbytes\n"
+" mountpoints\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2845
+msgid ""
+"This call is similar to L</mounts>. That call returns a list of devices. "
+"This one returns a hash table (map) of device name to directory where the "
+"device is mounted."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2238
-msgid "lvresize-free"
+#: ../fish/guestfish-actions.pod:2849
+msgid "mounts"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2240
+#: ../fish/guestfish-actions.pod:2851
#, no-wrap
msgid ""
-" lvresize-free lv percent\n"
+" mounts\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2858
+msgid "See also: L</mountpoints>"
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2248
-msgid "lvs"
+#: ../fish/guestfish-actions.pod:2860
+msgid "mv"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2250
+#: ../fish/guestfish-actions.pod:2862
#, no-wrap
msgid ""
-" lvs\n"
+" mv src dest\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2258
-msgid "See also C<lvs-full>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2260
-msgid "lvs-full"
+#: ../fish/guestfish-actions.pod:2867
+msgid "ntfs-3g-probe"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2262
+#: ../fish/guestfish-actions.pod:2869
#, no-wrap
msgid ""
-" lvs-full\n"
+" ntfs-3g-probe true|false device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2267
-msgid "lvuuid"
+#: ../fish/guestfish-actions.pod:2883
+msgid "ntfsresize"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2269
+#: ../fish/guestfish-actions.pod:2885
#, no-wrap
msgid ""
-" lvuuid device\n"
+" ntfsresize device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2273
-msgid "lxattrlist"
+#: ../fish/guestfish-actions.pod:2891
+msgid "ntfsresize-size"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2275
+#: ../fish/guestfish-actions.pod:2893
#, no-wrap
msgid ""
-" lxattrlist path 'names ...'\n"
+" ntfsresize-size device size\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2291
+#: ../fish/guestfish-actions.pod:2895
msgid ""
-"This call is intended for programs that want to efficiently list a directory "
-"contents without making many round-trips. See also C<lstatlist> for a "
-"similarly efficient call for getting standard stats. Very long directory "
-"listings might cause the protocol message size to be exceeded, causing this "
-"call to fail. The caller must split up such requests into smaller groups of "
-"names."
+"This command is the same as L</ntfsresize> except that it allows you to "
+"specify the new size (in bytes) explicitly."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2299
-msgid "mkdir"
+#: ../fish/guestfish-actions.pod:2898
+msgid "part-add"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2301
+#: ../fish/guestfish-actions.pod:2900
#, no-wrap
msgid ""
-" mkdir path\n"
+" part-add device prlogex startsect endsect\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2305
-msgid "mkdir-mode"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2307
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:2902
msgid ""
-" mkdir-mode path mode\n"
-"\n"
+"This command adds a partition to C<device>. If there is no partition table "
+"on the device, call L</part-init> first."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2316
-msgid "See also C<mkdir>, C<umask>"
+#: ../fish/guestfish-actions.pod:2914
+msgid ""
+"Creating a partition which covers the whole disk is not so easy. Use "
+"L</part-disk> to do that."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2318
-msgid "mkdir-p"
+#: ../fish/guestfish-actions.pod:2917
+msgid "part-del"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2320
+#: ../fish/guestfish-actions.pod:2919
#, no-wrap
msgid ""
-" mkdir-p path\n"
+" part-del device partnum\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2325
-msgid "mkdtemp"
+#: ../fish/guestfish-actions.pod:2927
+msgid "part-disk"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2327
+#: ../fish/guestfish-actions.pod:2929
#, no-wrap
msgid ""
-" mkdtemp template\n"
+" part-disk device parttype\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2348
-msgid "mke2fs-J"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2350
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:2931
msgid ""
-" mke2fs-J fstype blocksize device journal\n"
-"\n"
+"This command is simply a combination of L</part-init> followed by "
+"L</part-add> to create a single primary partition covering the whole disk."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2358
-msgid "See also C<mke2journal>."
+#: ../fish/guestfish-actions.pod:2935
+msgid ""
+"C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
+"possible values are described in L</part-init>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2360
-msgid "mke2fs-JL"
+#: ../fish/guestfish-actions.pod:2941
+msgid "part-get-bootable"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2362
+#: ../fish/guestfish-actions.pod:2943
#, no-wrap
msgid ""
-" mke2fs-JL fstype blocksize device label\n"
+" part-get-bootable device partnum\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2367
-msgid "See also C<mke2journal-L>."
+#: ../fish/guestfish-actions.pod:2948
+msgid "See also L</part-set-bootable>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2369
-msgid "mke2fs-JU"
+#: ../fish/guestfish-actions.pod:2950
+msgid "part-get-mbr-id"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2371
+#: ../fish/guestfish-actions.pod:2952
#, no-wrap
msgid ""
-" mke2fs-JU fstype blocksize device uuid\n"
+" part-get-mbr-id device partnum\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2376
-msgid "See also C<mke2journal-U>."
+#: ../fish/guestfish-actions.pod:2957 ../fish/guestfish-actions.pod:3095
+msgid ""
+"Note that only MBR (old DOS-style) partitions have type bytes. You will get "
+"undefined results for other partition table types (see "
+"L</part-get-parttype>)."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2378
-msgid "mke2journal"
+#: ../fish/guestfish-actions.pod:2961
+msgid "part-get-parttype"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2380
+#: ../fish/guestfish-actions.pod:2963
#, no-wrap
msgid ""
-" mke2journal blocksize device\n"
+" part-get-parttype device\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2968
+msgid ""
+"Common return values include: C<msdos> (a DOS/Windows style MBR partition "
+"table), C<gpt> (a GPT/EFI-style partition table). Other values are "
+"possible, although unusual. See L</part-init> for a full list."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2387
-msgid "mke2journal-L"
+#: ../fish/guestfish-actions.pod:2973
+msgid "part-init"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2389
+#: ../fish/guestfish-actions.pod:2975
#, no-wrap
msgid ""
-" mke2journal-L blocksize label device\n"
+" part-init device parttype\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:2981
+msgid ""
+"Initially there are no partitions. Following this, you should call "
+"L</part-add> for each partition required."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2393
-msgid "mke2journal-U"
+#: ../fish/guestfish-actions.pod:3044
+msgid "part-list"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2395
+#: ../fish/guestfish-actions.pod:3046
#, no-wrap
msgid ""
-" mke2journal-U blocksize uuid device\n"
+" part-list device\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:3061
+msgid ""
+"Start of the partition I<in bytes>. To get sectors you have to divide by "
+"the device's sector size, see L</blockdev-getss>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2399
-msgid "mkfifo"
+#: ../fish/guestfish-actions.pod:3074
+msgid "part-set-bootable"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2401
+#: ../fish/guestfish-actions.pod:3076
#, no-wrap
msgid ""
-" mkfifo mode path\n"
+" part-set-bootable device partnum true|false\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2403
-msgid ""
-"This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
-"is just a convenient wrapper around C<mknod>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2409
-msgid "mkfs"
+#: ../fish/guestfish-actions.pod:3085
+msgid "part-set-mbr-id"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2411
+#: ../fish/guestfish-actions.pod:3087
#, no-wrap
msgid ""
-" mkfs fstype device\n"
+" part-set-mbr-id device partnum idbyte\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2417
-msgid "mkfs-b"
+#: ../fish/guestfish-actions.pod:3099
+msgid "part-set-name"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2419
+#: ../fish/guestfish-actions.pod:3101
#, no-wrap
msgid ""
-" mkfs-b fstype blocksize device\n"
+" part-set-name device partnum name\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2421
-msgid ""
-"This call is similar to C<mkfs>, but it allows you to control the block size "
-"of the resulting filesystem. Supported block sizes depend on the filesystem "
-"type, but typically they are C<1024>, C<2048> or C<4096> only."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2429
-msgid "mkmountpoint"
+#: ../fish/guestfish-actions.pod:3109
+msgid "part-to-dev"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2431
+#: ../fish/guestfish-actions.pod:3111
#, no-wrap
msgid ""
-" mkmountpoint exemptpath\n"
+" part-to-dev partition\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2433
+#: ../fish/guestfish-actions.pod:3117
msgid ""
-"C<mkmountpoint> and C<rmmountpoint> are specialized calls that can be used "
-"to create extra mountpoints before mounting the first filesystem."
+"The named partition must exist, for example as a string returned from "
+"L</list-partitions>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2457
-msgid "mknod"
+#: ../fish/guestfish-actions.pod:3120
+msgid "ping-daemon"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2459
+#: ../fish/guestfish-actions.pod:3122
#, no-wrap
msgid ""
-" mknod mode devmajor devminor path\n"
+" ping-daemon\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2469
-msgid ""
-"Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
-"S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
-"regular file). These constants are available in the standard Linux header "
-"files, or you can use C<mknod-b>, C<mknod-c> or C<mkfifo> which are wrappers "
-"around this command which bitwise OR in the appropriate constant for you."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2479
-msgid "mknod-b"
+#: ../fish/guestfish-actions.pod:3129
+msgid "pread"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2481
+#: ../fish/guestfish-actions.pod:3131
#, no-wrap
msgid ""
-" mknod-b mode devmajor devminor path\n"
+" pread path count offset\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2483
-msgid ""
-"This call creates a block device node called C<path> with mode C<mode> and "
-"device major/minor C<devmajor> and C<devminor>. It is just a convenient "
-"wrapper around C<mknod>."
+#: ../fish/guestfish-actions.pod:3139
+msgid "See also L</pwrite>, L</pread-device>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2489
-msgid "mknod-c"
+#: ../fish/guestfish-actions.pod:3144
+msgid "pread-device"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2491
+#: ../fish/guestfish-actions.pod:3146
#, no-wrap
msgid ""
-" mknod-c mode devmajor devminor path\n"
+" pread-device device count offset\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2493
-msgid ""
-"This call creates a char device node called C<path> with mode C<mode> and "
-"device major/minor C<devmajor> and C<devminor>. It is just a convenient "
-"wrapper around C<mknod>."
+#: ../fish/guestfish-actions.pod:3154
+msgid "See also L</pread>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2499
-msgid "mkswap"
+#: ../fish/guestfish-actions.pod:3159
+msgid "pvcreate"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2501
+#: ../fish/guestfish-actions.pod:3161
#, no-wrap
msgid ""
-" mkswap device\n"
+" pvcreate device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2505
-msgid "mkswap-L"
+#: ../fish/guestfish-actions.pod:3167
+msgid "pvremove"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2507
+#: ../fish/guestfish-actions.pod:3169
#, no-wrap
msgid ""
-" mkswap-L label device\n"
+" pvremove device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2515
-msgid "mkswap-U"
+#: ../fish/guestfish-actions.pod:3178
+msgid "pvresize"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2517
+#: ../fish/guestfish-actions.pod:3180
#, no-wrap
msgid ""
-" mkswap-U uuid device\n"
+" pvresize device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2521
-msgid "mkswap-file"
+#: ../fish/guestfish-actions.pod:3185
+msgid "pvresize-size"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2523
+#: ../fish/guestfish-actions.pod:3187
#, no-wrap
msgid ""
-" mkswap-file path\n"
+" pvresize-size device size\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2527
+#: ../fish/guestfish-actions.pod:3189
msgid ""
-"This command just writes a swap file signature to an existing file. To "
-"create the file itself, use something like C<fallocate>."
+"This command is the same as L</pvresize> except that it allows you to "
+"specify the new size (in bytes) explicitly."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2530
-msgid "modprobe"
+#: ../fish/guestfish-actions.pod:3192
+msgid "pvs"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2532
+#: ../fish/guestfish-actions.pod:3194
#, no-wrap
msgid ""
-" modprobe modulename\n"
+" pvs\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:3202
+msgid "See also L</pvs-full>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2539
-msgid "mount"
+#: ../fish/guestfish-actions.pod:3204
+msgid "pvs-full"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2541
+#: ../fish/guestfish-actions.pod:3206
#, no-wrap
msgid ""
-" mount device mountpoint\n"
+" pvs-full\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2557
-msgid ""
-"B<Important note:> When you use this call, the filesystem options C<sync> "
-"and C<noatime> are set implicitly. This was originally done because we "
-"thought it would improve reliability, but it turns out that I<-o sync> has a "
-"very large negative performance impact and negligible effect on "
-"reliability. Therefore we recommend that you avoid using C<mount> in any "
-"code that needs performance, and instead use C<mount-options> (use an empty "
-"string for the first parameter if you don't want any options)."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2567
-msgid "mount-loop"
+#: ../fish/guestfish-actions.pod:3211
+msgid "pvuuid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2569
+#: ../fish/guestfish-actions.pod:3213
#, no-wrap
msgid ""
-" mount-loop file mountpoint\n"
+" pvuuid device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2575
-msgid "mount-options"
+#: ../fish/guestfish-actions.pod:3217
+msgid "pwrite"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2577
+#: ../fish/guestfish-actions.pod:3219
#, no-wrap
msgid ""
-" mount-options options device mountpoint\n"
+" pwrite path content offset\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2579
-msgid ""
-"This is the same as the C<mount> command, but it allows you to set the mount "
-"options as for the L<mount(8)> I<-o> flag."
+#: ../fish/guestfish-actions.pod:3230
+msgid "See also L</pread>, L</pwrite-device>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2587
-msgid "mount-ro"
+#: ../fish/guestfish-actions.pod:3235
+msgid "pwrite-device"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2589
+#: ../fish/guestfish-actions.pod:3237
#, no-wrap
msgid ""
-" mount-ro device mountpoint\n"
+" pwrite-device device content offset\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2591
-msgid ""
-"This is the same as the C<mount> command, but it mounts the filesystem with "
-"the read-only (I<-o ro>) flag."
+#: ../fish/guestfish-actions.pod:3247
+msgid "See also L</pwrite>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2594
-msgid "mount-vfs"
+#: ../fish/guestfish-actions.pod:3252
+msgid "read-file"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2596
+#: ../fish/guestfish-actions.pod:3254
#, no-wrap
msgid ""
-" mount-vfs options vfstype device mountpoint\n"
+" read-file path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2598
+#: ../fish/guestfish-actions.pod:3259
msgid ""
-"This is the same as the C<mount> command, but it allows you to set both the "
-"mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
+"Unlike L</cat>, this function can correctly handle files that contain "
+"embedded ASCII NUL characters. However unlike L</download>, this function "
+"is limited in the total size of file that can be handled."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2602
-msgid "mountpoints"
+#: ../fish/guestfish-actions.pod:3267
+msgid "read-lines"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2604
+#: ../fish/guestfish-actions.pod:3269
#, no-wrap
msgid ""
-" mountpoints\n"
+" read-lines path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2606
+#: ../fish/guestfish-actions.pod:3276
msgid ""
-"This call is similar to C<mounts>. That call returns a list of devices. "
-"This one returns a hash table (map) of device name to directory where the "
-"device is mounted."
+"Note that this function cannot correctly handle binary files (specifically, "
+"files containing C<\\0> character which is treated as end of line). For "
+"those you need to use the L</read-file> function which has a more complex "
+"interface."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2610
-msgid "mounts"
+#: ../fish/guestfish-actions.pod:3281
+msgid "readdir"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2612
+#: ../fish/guestfish-actions.pod:3283
#, no-wrap
msgid ""
-" mounts\n"
+" readdir dir\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2619
-msgid "See also: C<mountpoints>"
+#: ../fish/guestfish-actions.pod:3335
+msgid ""
+"This function is primarily intended for use by programs. To get a simple "
+"list of names, use L</ls>. To get a printable directory for human "
+"consumption, use L</ll>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2621
-msgid "mv"
+#: ../fish/guestfish-actions.pod:3339
+msgid "readlink"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2623
+#: ../fish/guestfish-actions.pod:3341
#, no-wrap
msgid ""
-" mv src dest\n"
+" readlink path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2628
-msgid "ntfs-3g-probe"
+#: ../fish/guestfish-actions.pod:3345
+msgid "readlinklist"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2630
+#: ../fish/guestfish-actions.pod:3347
#, no-wrap
msgid ""
-" ntfs-3g-probe true|false device\n"
+" readlinklist path 'names ...'\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2644
-msgid "ntfsresize"
+#: ../fish/guestfish-actions.pod:3371
+msgid "realpath"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2646
+#: ../fish/guestfish-actions.pod:3373
#, no-wrap
msgid ""
-" ntfsresize device\n"
+" realpath path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2652
-msgid "ntfsresize-size"
+#: ../fish/guestfish-actions.pod:3378
+msgid "removexattr"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2654
+#: ../fish/guestfish-actions.pod:3380
#, no-wrap
msgid ""
-" ntfsresize-size device size\n"
+" removexattr xattr path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2656
-msgid ""
-"This command is the same as C<ntfsresize> except that it allows you to "
-"specify the new size (in bytes) explicitly."
+#: ../fish/guestfish-actions.pod:3385
+msgid "See also: L</lremovexattr>, L<attr(5)>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2659
-msgid "part-add"
+#: ../fish/guestfish-actions.pod:3387
+msgid "resize2fs"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2661
+#: ../fish/guestfish-actions.pod:3389
#, no-wrap
msgid ""
-" part-add device prlogex startsect endsect\n"
+" resize2fs device\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2663
-msgid ""
-"This command adds a partition to C<device>. If there is no partition table "
-"on the device, call C<part-init> first."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:2675
+#: ../fish/guestfish-actions.pod:3394
msgid ""
-"Creating a partition which covers the whole disk is not so easy. Use "
-"C<part-disk> to do that."
+"I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
+"before calling this command. For unknown reasons C<resize2fs> sometimes "
+"gives an error about this and sometimes not. In any case, it is always safe "
+"to call L</e2fsck-f> before calling this function."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2678
-msgid "part-del"
+#: ../fish/guestfish-actions.pod:3400
+msgid "resize2fs-size"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2680
+#: ../fish/guestfish-actions.pod:3402
#, no-wrap
msgid ""
-" part-del device partnum\n"
+" resize2fs-size device size\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:3404
+msgid ""
+"This command is the same as L</resize2fs> except that it allows you to "
+"specify the new size (in bytes) explicitly."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2688
-msgid "part-disk"
+#: ../fish/guestfish-actions.pod:3407
+msgid "rm"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2690
+#: ../fish/guestfish-actions.pod:3409
#, no-wrap
msgid ""
-" part-disk device parttype\n"
+" rm path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2692
-msgid ""
-"This command is simply a combination of C<part-init> followed by C<part-add> "
-"to create a single primary partition covering the whole disk."
+# type: =head2
+#: ../fish/guestfish-actions.pod:3413
+msgid "rm-rf"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2696
+# type: verbatim
+#: ../fish/guestfish-actions.pod:3415
+#, no-wrap
msgid ""
-"C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
-"possible values are described in C<part-init>."
+" rm-rf path\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2702
-msgid "part-get-bootable"
+#: ../fish/guestfish-actions.pod:3421
+msgid "rmdir"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2704
+#: ../fish/guestfish-actions.pod:3423
#, no-wrap
msgid ""
-" part-get-bootable device partnum\n"
+" rmdir path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2709
-msgid "See also C<part-set-bootable>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2711
-msgid "part-get-mbr-id"
+#: ../fish/guestfish-actions.pod:3427
+msgid "rmmountpoint"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2713
+#: ../fish/guestfish-actions.pod:3429
#, no-wrap
msgid ""
-" part-get-mbr-id device partnum\n"
+" rmmountpoint exemptpath\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2718 ../fish/guestfish-actions.pod:2856
+#: ../fish/guestfish-actions.pod:3431
msgid ""
-"Note that only MBR (old DOS-style) partitions have type bytes. You will get "
-"undefined results for other partition table types (see "
-"C<part-get-parttype>)."
+"This calls removes a mountpoint that was previously created with "
+"L</mkmountpoint>. See L</mkmountpoint> for full details."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2722
-msgid "part-get-parttype"
+#: ../fish/guestfish-actions.pod:3435
+msgid "scrub-device"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2724
+#: ../fish/guestfish-actions.pod:3437
#, no-wrap
msgid ""
-" part-get-parttype device\n"
+" scrub-device device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2729
-msgid ""
-"Common return values include: C<msdos> (a DOS/Windows style MBR partition "
-"table), C<gpt> (a GPT/EFI-style partition table). Other values are "
-"possible, although unusual. See C<part-init> for a full list."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2734
-msgid "part-init"
+#: ../fish/guestfish-actions.pod:3448
+msgid "scrub-file"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2736
+#: ../fish/guestfish-actions.pod:3450
#, no-wrap
msgid ""
-" part-init device parttype\n"
+" scrub-file file\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2742
-msgid ""
-"Initially there are no partitions. Following this, you should call "
-"C<part-add> for each partition required."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:2805
-msgid "part-list"
+#: ../fish/guestfish-actions.pod:3460
+msgid "scrub-freespace"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2807
+#: ../fish/guestfish-actions.pod:3462
#, no-wrap
msgid ""
-" part-list device\n"
+" scrub-freespace dir\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2822
+#: ../fish/guestfish-actions.pod:3464
msgid ""
-"Start of the partition I<in bytes>. To get sectors you have to divide by "
-"the device's sector size, see C<blockdev-getss>."
+"This command creates the directory C<dir> and then fills it with files until "
+"the filesystem is full, and scrubs the files as for L</scrub-file>, and "
+"deletes them. The intention is to scrub any free space on the partition "
+"containing C<dir>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2835
-msgid "part-set-bootable"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2837
-#, no-wrap
-msgid ""
-" part-set-bootable device partnum true|false\n"
-"\n"
+#: ../fish/guestfish-actions.pod:3473
+msgid "set-append"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2846
-msgid "part-set-mbr-id"
+#: ../fish/guestfish-actions.pod:3475
+msgid "append"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2848
+#: ../fish/guestfish-actions.pod:3477
#, no-wrap
msgid ""
-" part-set-mbr-id device partnum idbyte\n"
+" set-append append\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2860
-msgid "part-set-name"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2862
-#, no-wrap
-msgid ""
-" part-set-name device partnum name\n"
-"\n"
+#: ../fish/guestfish-actions.pod:3488
+msgid "set-autosync"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2870
-msgid "ping-daemon"
+#: ../fish/guestfish-actions.pod:3490
+msgid "autosync"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2872
+#: ../fish/guestfish-actions.pod:3492
#, no-wrap
msgid ""
-" ping-daemon\n"
+" set-autosync true|false\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:3494
+msgid ""
+"If C<autosync> is true, this enables autosync. Libguestfs will make a best "
+"effort attempt to run L</umount-all> followed by L</sync> when the handle is "
+"closed (also if the program exits without closing handles)."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2879
-msgid "pread"
+#: ../fish/guestfish-actions.pod:3502
+msgid "set-direct"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:3504
+msgid "direct"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2881
+#: ../fish/guestfish-actions.pod:3506
#, no-wrap
msgid ""
-" pread path count offset\n"
+" set-direct true|false\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2889
-msgid "See also C<pwrite>."
+#: ../fish/guestfish-actions.pod:3512
+msgid ""
+"One consequence of this is that log messages aren't caught by the library "
+"and handled by L</set-log-message-callback>, but go straight to stdout."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2894
-msgid "pvcreate"
+#: ../fish/guestfish-actions.pod:3521
+msgid "set-e2label"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2896
+#: ../fish/guestfish-actions.pod:3523
#, no-wrap
msgid ""
-" pvcreate device\n"
+" set-e2label device label\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:3529
+msgid ""
+"You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
+"label on a filesystem."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:2902
-msgid "pvremove"
+#: ../fish/guestfish-actions.pod:3532
+msgid "set-e2uuid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2904
+#: ../fish/guestfish-actions.pod:3534
#, no-wrap
msgid ""
-" pvremove device\n"
+" set-e2uuid device uuid\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2913
-msgid "pvresize"
+# type: textblock
+#: ../fish/guestfish-actions.pod:3541
+msgid ""
+"You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
+"UUID of a filesystem."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2915
-#, no-wrap
-msgid ""
-" pvresize device\n"
-"\n"
+# type: =head2
+#: ../fish/guestfish-actions.pod:3544
+msgid "set-memsize"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2920
-msgid "pvresize-size"
+#: ../fish/guestfish-actions.pod:3546
+msgid "memsize"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2922
+#: ../fish/guestfish-actions.pod:3548
#, no-wrap
msgid ""
-" pvresize-size device size\n"
+" set-memsize memsize\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2924
+#: ../fish/guestfish-actions.pod:3550
msgid ""
-"This command is the same as C<pvresize> except that it allows you to specify "
-"the new size (in bytes) explicitly."
+"This sets the memory size in megabytes allocated to the qemu subprocess. "
+"This only has any effect if called before L</launch>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2927
-msgid "pvs"
+#: ../fish/guestfish-actions.pod:3561
+msgid "set-network"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:3563
+msgid "network"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2929
+#: ../fish/guestfish-actions.pod:3565
#, no-wrap
msgid ""
-" pvs\n"
+" set-network true|false\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2937
-msgid "See also C<pvs-full>."
+#: ../fish/guestfish-actions.pod:3573
+msgid "You must call this before calling L</launch>, otherwise it has no effect."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2939
-msgid "pvs-full"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2941
-#, no-wrap
-msgid ""
-" pvs-full\n"
-"\n"
+#: ../fish/guestfish-actions.pod:3576
+msgid "set-path"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2946
-msgid "pvuuid"
+#: ../fish/guestfish-actions.pod:3578
+msgid "path"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2948
+#: ../fish/guestfish-actions.pod:3580
#, no-wrap
msgid ""
-" pvuuid device\n"
+" set-path searchpath\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2952
-msgid "pwrite"
+#: ../fish/guestfish-actions.pod:3589
+msgid "set-qemu"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:3591
+msgid "qemu"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2954
+#: ../fish/guestfish-actions.pod:3593
#, no-wrap
msgid ""
-" pwrite path content offset\n"
+" set-qemu qemu\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2965
-msgid "See also C<pread>."
+# type: =head2
+#: ../fish/guestfish-actions.pod:3613
+msgid "set-recovery-proc"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2970
-msgid "read-file"
+#: ../fish/guestfish-actions.pod:3615
+msgid "recovery-proc"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2972
+#: ../fish/guestfish-actions.pod:3617
#, no-wrap
msgid ""
-" read-file path\n"
+" set-recovery-proc true|false\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:2977
+#: ../fish/guestfish-actions.pod:3619
+msgid ""
+"If this is called with the parameter C<false> then L</launch> does not "
+"create a recovery process. The purpose of the recovery process is to stop "
+"runaway qemu processes in the case where the main program aborts abruptly."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:3624
msgid ""
-"Unlike C<cat>, this function can correctly handle files that contain "
-"embedded ASCII NUL characters. However unlike C<download>, this function is "
-"limited in the total size of file that can be handled."
+"This only has any effect if called before L</launch>, and the default is "
+"true."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2985
-msgid "read-lines"
+#: ../fish/guestfish-actions.pod:3633
+msgid "set-selinux"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-actions.pod:3635
+msgid "selinux"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:2987
+#: ../fish/guestfish-actions.pod:3637
#, no-wrap
msgid ""
-" read-lines path\n"
+" set-selinux true|false\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2994
-msgid ""
-"Note that this function cannot correctly handle binary files (specifically, "
-"files containing C<\\0> character which is treated as end of line). For "
-"those you need to use the C<read-file> function which has a more complex "
-"interface."
+# type: =head2
+#: ../fish/guestfish-actions.pod:3648
+msgid "set-trace"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:2999
-msgid "readdir"
+#: ../fish/guestfish-actions.pod:3650
+msgid "trace"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3001
+#: ../fish/guestfish-actions.pod:3652
#, no-wrap
msgid ""
-" readdir dir\n"
+" set-trace true|false\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3053
-msgid ""
-"This function is primarily intended for use by programs. To get a simple "
-"list of names, use C<ls>. To get a printable directory for human "
-"consumption, use C<ll>."
+# type: =head2
+#: ../fish/guestfish-actions.pod:3668
+msgid "set-verbose"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3057
-msgid "readlink"
+#: ../fish/guestfish-actions.pod:3670
+msgid "verbose"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3059
+#: ../fish/guestfish-actions.pod:3672
#, no-wrap
msgid ""
-" readlink path\n"
+" set-verbose true|false\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3063
-msgid "readlinklist"
+#: ../fish/guestfish-actions.pod:3679
+msgid "setcon"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3065
+#: ../fish/guestfish-actions.pod:3681
#, no-wrap
msgid ""
-" readlinklist path 'names ...'\n"
+" setcon context\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3089
-msgid "realpath"
+#: ../fish/guestfish-actions.pod:3688
+msgid "setxattr"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3091
+#: ../fish/guestfish-actions.pod:3690
#, no-wrap
msgid ""
-" realpath path\n"
+" setxattr xattr val vallen path\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:3696
+msgid "See also: L</lsetxattr>, L<attr(5)>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3096
-msgid "removexattr"
+#: ../fish/guestfish-actions.pod:3698
+msgid "sfdisk"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3098
+#: ../fish/guestfish-actions.pod:3700
#, no-wrap
msgid ""
-" removexattr xattr path\n"
+" sfdisk device cyls heads sectors 'lines ...'\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3103
-msgid "See also: C<lremovexattr>, L<attr(5)>."
+#: ../fish/guestfish-actions.pod:3722
+msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3105
-msgid "resize2fs"
+#: ../fish/guestfish-actions.pod:3728
+msgid "sfdiskM"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3107
+#: ../fish/guestfish-actions.pod:3730
#, no-wrap
msgid ""
-" resize2fs device\n"
+" sfdiskM device 'lines ...'\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3112
+#: ../fish/guestfish-actions.pod:3732
msgid ""
-"I<Note:> It is sometimes required that you run C<e2fsck-f> on the C<device> "
-"before calling this command. For unknown reasons C<resize2fs> sometimes "
-"gives an error about this and sometimes not. In any case, it is always safe "
-"to call C<e2fsck-f> before calling this function."
+"This is a simplified interface to the L</sfdisk> command, where partition "
+"sizes are specified in megabytes only (rounded to the nearest cylinder) and "
+"you don't need to specify the cyls, heads and sectors parameters which were "
+"rarely if ever used anyway."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:3738
+msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3118
-msgid "resize2fs-size"
+#: ../fish/guestfish-actions.pod:3744
+msgid "sfdisk-N"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3120
+#: ../fish/guestfish-actions.pod:3746
#, no-wrap
msgid ""
-" resize2fs-size device size\n"
+" sfdisk-N device partnum cyls heads sectors line\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3122
+#: ../fish/guestfish-actions.pod:3751
msgid ""
-"This command is the same as C<resize2fs> except that it allows you to "
-"specify the new size (in bytes) explicitly."
+"For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
+"cyls/heads/sectors parameters."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:3754
+msgid "See also: L</part-add>"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3125
-msgid "rm"
+#: ../fish/guestfish-actions.pod:3759
+msgid "sfdisk-disk-geometry"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3127
+#: ../fish/guestfish-actions.pod:3761
#, no-wrap
msgid ""
-" rm path\n"
+" sfdisk-disk-geometry device\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:3763
+msgid ""
+"This displays the disk geometry of C<device> read from the partition table. "
+"Especially in the case where the underlying block device has been resized, "
+"this can be different from the kernel's idea of the geometry (see "
+"L</sfdisk-kernel-geometry>)."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3131
-msgid "rm-rf"
+#: ../fish/guestfish-actions.pod:3771
+msgid "sfdisk-kernel-geometry"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3133
+#: ../fish/guestfish-actions.pod:3773
#, no-wrap
msgid ""
-" rm-rf path\n"
+" sfdisk-kernel-geometry device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3139
-msgid "rmdir"
+#: ../fish/guestfish-actions.pod:3780
+msgid "sfdisk-l"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3141
+#: ../fish/guestfish-actions.pod:3782
#, no-wrap
msgid ""
-" rmdir path\n"
+" sfdisk-l device\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:3788
+msgid "See also: L</part-list>"
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3145
-msgid "rmmountpoint"
+#: ../fish/guestfish-actions.pod:3790
+msgid "sh"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3147
+#: ../fish/guestfish-actions.pod:3792
#, no-wrap
msgid ""
-" rmmountpoint exemptpath\n"
+" sh command\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3149
-msgid ""
-"This calls removes a mountpoint that was previously created with "
-"C<mkmountpoint>. See C<mkmountpoint> for full details."
+#: ../fish/guestfish-actions.pod:3797
+msgid "This is like L</command>, but passes the command to:"
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:3805
+msgid "All the provisos about L</command> apply to this call."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3153
-msgid "scrub-device"
+#: ../fish/guestfish-actions.pod:3807
+msgid "sh-lines"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3155
+#: ../fish/guestfish-actions.pod:3809
#, no-wrap
msgid ""
-" scrub-device device\n"
+" sh-lines command\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:3811
+msgid "This is the same as L</sh>, but splits the result into a list of lines."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:3814
+msgid "See also: L</command-lines>"
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3166
-msgid "scrub-file"
+#: ../fish/guestfish-actions.pod:3816
+msgid "sleep"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3168
+#: ../fish/guestfish-actions.pod:3818
#, no-wrap
msgid ""
-" scrub-file file\n"
+" sleep secs\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3178
-msgid "scrub-freespace"
+#: ../fish/guestfish-actions.pod:3822
+msgid "stat"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3180
+#: ../fish/guestfish-actions.pod:3824
#, no-wrap
msgid ""
-" scrub-freespace dir\n"
+" stat path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3182
+# type: =head2
+#: ../fish/guestfish-actions.pod:3830
+msgid "statvfs"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:3832
+#, no-wrap
msgid ""
-"This command creates the directory C<dir> and then fills it with files until "
-"the filesystem is full, and scrubs the files as for C<scrub-file>, and "
-"deletes them. The intention is to scrub any free space on the partition "
-"containing C<dir>."
+" statvfs path\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3191
-msgid "set-append | append"
+#: ../fish/guestfish-actions.pod:3840
+msgid "strings"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3193
+#: ../fish/guestfish-actions.pod:3842
#, no-wrap
msgid ""
-" set-append append\n"
+" strings path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3204
-msgid "set-autosync | autosync"
+#: ../fish/guestfish-actions.pod:3850
+msgid "strings-e"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3206
+#: ../fish/guestfish-actions.pod:3852
#, no-wrap
msgid ""
-" set-autosync true|false\n"
+" strings-e encoding path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3208
+#: ../fish/guestfish-actions.pod:3854
msgid ""
-"If C<autosync> is true, this enables autosync. Libguestfs will make a best "
-"effort attempt to run C<umount-all> followed by C<sync> when the handle is "
-"closed (also if the program exits without closing handles)."
+"This is like the L</strings> command, but allows you to specify the encoding "
+"of strings that are looked for in the source file C<path>."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:3864
+msgid ""
+"Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
+"ISO-8859-X (this is what L</strings> uses)."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3216
-msgid "set-direct | direct"
+#: ../fish/guestfish-actions.pod:3896
+msgid "swapoff-device"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3218
+#: ../fish/guestfish-actions.pod:3898
#, no-wrap
msgid ""
-" set-direct true|false\n"
+" swapoff-device device\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3224
+#: ../fish/guestfish-actions.pod:3900
msgid ""
-"One consequence of this is that log messages aren't caught by the library "
-"and handled by C<set-log-message-callback>, but go straight to stdout."
+"This command disables the libguestfs appliance swap device or partition "
+"named C<device>. See L</swapon-device>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3233
-msgid "set-e2label"
+#: ../fish/guestfish-actions.pod:3904
+msgid "swapoff-file"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3235
+#: ../fish/guestfish-actions.pod:3906
#, no-wrap
msgid ""
-" set-e2label device label\n"
+" swapoff-file file\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3241
+# type: =head2
+#: ../fish/guestfish-actions.pod:3910
+msgid "swapoff-label"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:3912
+#, no-wrap
msgid ""
-"You can use either C<tune2fs-l> or C<get-e2label> to return the existing "
-"label on a filesystem."
+" swapoff-label label\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3244
-msgid "set-e2uuid"
+#: ../fish/guestfish-actions.pod:3917
+msgid "swapoff-uuid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3246
+#: ../fish/guestfish-actions.pod:3919
#, no-wrap
msgid ""
-" set-e2uuid device uuid\n"
+" swapoff-uuid uuid\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3253
-msgid ""
-"You can use either C<tune2fs-l> or C<get-e2uuid> to return the existing UUID "
-"of a filesystem."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3256
-msgid "set-memsize | memsize"
+#: ../fish/guestfish-actions.pod:3924
+msgid "swapon-device"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3258
+#: ../fish/guestfish-actions.pod:3926
#, no-wrap
msgid ""
-" set-memsize memsize\n"
+" swapon-device device\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3260
+#: ../fish/guestfish-actions.pod:3928
msgid ""
-"This sets the memory size in megabytes allocated to the qemu subprocess. "
-"This only has any effect if called before C<launch>."
+"This command enables the libguestfs appliance to use the swap device or "
+"partition named C<device>. The increased memory is made available for all "
+"commands, for example those run using L</command> or L</sh>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3271
-msgid "set-network | network"
+#: ../fish/guestfish-actions.pod:3940
+msgid "swapon-file"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3273
+#: ../fish/guestfish-actions.pod:3942
#, no-wrap
msgid ""
-" set-network true|false\n"
+" swapon-file file\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3281
-msgid "You must call this before calling C<launch>, otherwise it has no effect."
+#: ../fish/guestfish-actions.pod:3944
+msgid "This command enables swap to a file. See L</swapon-device> for other notes."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3284
-msgid "set-path | path"
+#: ../fish/guestfish-actions.pod:3947
+msgid "swapon-label"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3286
+#: ../fish/guestfish-actions.pod:3949
#, no-wrap
msgid ""
-" set-path searchpath\n"
+" swapon-label label\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3295
-msgid "set-qemu | qemu"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3297
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-actions.pod:3951
msgid ""
-" set-qemu qemu\n"
-"\n"
+"This command enables swap to a labeled swap partition. See "
+"L</swapon-device> for other notes."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3317
-msgid "set-recovery-proc | recovery-proc"
+#: ../fish/guestfish-actions.pod:3954
+msgid "swapon-uuid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3319
+#: ../fish/guestfish-actions.pod:3956
#, no-wrap
msgid ""
-" set-recovery-proc true|false\n"
+" swapon-uuid uuid\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3321
-msgid ""
-"If this is called with the parameter C<false> then C<launch> does not create "
-"a recovery process. The purpose of the recovery process is to stop runaway "
-"qemu processes in the case where the main program aborts abruptly."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:3326
+#: ../fish/guestfish-actions.pod:3958
msgid ""
-"This only has any effect if called before C<launch>, and the default is "
-"true."
+"This command enables swap to a swap partition with the given UUID. See "
+"L</swapon-device> for other notes."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3335
-msgid "set-selinux | selinux"
+#: ../fish/guestfish-actions.pod:3961
+msgid "sync"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3337
+#: ../fish/guestfish-actions.pod:3963
#, no-wrap
msgid ""
-" set-selinux true|false\n"
+" sync\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3348
-msgid "set-trace | trace"
+#: ../fish/guestfish-actions.pod:3971
+msgid "tail"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3350
+#: ../fish/guestfish-actions.pod:3973
#, no-wrap
msgid ""
-" set-trace true|false\n"
+" tail path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3366
-msgid "set-verbose | verbose"
+#: ../fish/guestfish-actions.pod:3981
+msgid "tail-n"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3368
+#: ../fish/guestfish-actions.pod:3983
#, no-wrap
msgid ""
-" set-verbose true|false\n"
+" tail-n nrlines path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3375
-msgid "setcon"
+#: ../fish/guestfish-actions.pod:3996
+msgid "tar-in"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3377
+#: ../fish/guestfish-actions.pod:3998
#, no-wrap
msgid ""
-" setcon context\n"
+" tar-in (tarfile|-) directory\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:4003
+msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3384
-msgid "setxattr"
+#: ../fish/guestfish-actions.pod:4008
+msgid "tar-out"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3386
+#: ../fish/guestfish-actions.pod:4010
#, no-wrap
msgid ""
-" setxattr xattr val vallen path\n"
+" tar-out directory (tarfile|-)\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3392
-msgid "See also: C<lsetxattr>, L<attr(5)>."
+#: ../fish/guestfish-actions.pod:4015
+msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3394
-msgid "sfdisk"
+#: ../fish/guestfish-actions.pod:4020
+msgid "tgz-in"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3396
+#: ../fish/guestfish-actions.pod:4022
#, no-wrap
msgid ""
-" sfdisk device cyls heads sectors 'lines ...'\n"
+" tgz-in (tarball|-) directory\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3418
-msgid "See also: C<sfdisk-l>, C<sfdisk-N>, C<part-init>"
+#: ../fish/guestfish-actions.pod:4027
+msgid "To upload an uncompressed tarball, use L</tar-in>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3424
-msgid "sfdiskM"
+#: ../fish/guestfish-actions.pod:4031
+msgid "tgz-out"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3426
+#: ../fish/guestfish-actions.pod:4033
#, no-wrap
msgid ""
-" sfdiskM device 'lines ...'\n"
+" tgz-out directory (tarball|-)\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3428
-msgid ""
-"This is a simplified interface to the C<sfdisk> command, where partition "
-"sizes are specified in megabytes only (rounded to the nearest cylinder) and "
-"you don't need to specify the cyls, heads and sectors parameters which were "
-"rarely if ever used anyway."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:3434
-msgid "See also: C<sfdisk>, the L<sfdisk(8)> manpage and C<part-disk>"
+#: ../fish/guestfish-actions.pod:4038
+msgid "To download an uncompressed tarball, use L</tar-out>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3440
-msgid "sfdisk-N"
+#: ../fish/guestfish-actions.pod:4042
+msgid "touch"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3442
+#: ../fish/guestfish-actions.pod:4044
#, no-wrap
msgid ""
-" sfdisk-N device partnum cyls heads sectors line\n"
+" touch path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3447
-msgid ""
-"For other parameters, see C<sfdisk>. You should usually pass C<0> for the "
-"cyls/heads/sectors parameters."
+# type: =head2
+#: ../fish/guestfish-actions.pod:4053
+msgid "truncate"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3450
-msgid "See also: C<part-add>"
+# type: verbatim
+#: ../fish/guestfish-actions.pod:4055
+#, no-wrap
+msgid ""
+" truncate path\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3455
-msgid "sfdisk-disk-geometry"
+#: ../fish/guestfish-actions.pod:4060
+msgid "truncate-size"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3457
+#: ../fish/guestfish-actions.pod:4062
#, no-wrap
msgid ""
-" sfdisk-disk-geometry device\n"
+" truncate-size path size\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3459
+#: ../fish/guestfish-actions.pod:4067
msgid ""
-"This displays the disk geometry of C<device> read from the partition table. "
-"Especially in the case where the underlying block device has been resized, "
-"this can be different from the kernel's idea of the geometry (see "
-"C<sfdisk-kernel-geometry>)."
+"If the current file size is less than C<size> then the file is extended to "
+"the required size with zero bytes. This creates a sparse file (ie. disk "
+"blocks are not allocated for the file until you write to it). To create a "
+"non-sparse file of zeroes, use L</fallocate64> instead."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3467
-msgid "sfdisk-kernel-geometry"
+#: ../fish/guestfish-actions.pod:4073
+msgid "tune2fs-l"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3469
+#: ../fish/guestfish-actions.pod:4075
#, no-wrap
msgid ""
-" sfdisk-kernel-geometry device\n"
+" tune2fs-l device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3476
-msgid "sfdisk-l"
+#: ../fish/guestfish-actions.pod:4085
+msgid "txz-in"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3478
+#: ../fish/guestfish-actions.pod:4087
#, no-wrap
msgid ""
-" sfdisk-l device\n"
+" txz-in (tarball|-) directory\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3484
-msgid "See also: C<part-list>"
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3486
-msgid "sh"
+#: ../fish/guestfish-actions.pod:4094
+msgid "txz-out"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3488
+#: ../fish/guestfish-actions.pod:4096
#, no-wrap
msgid ""
-" sh command\n"
+" txz-out directory (tarball|-)\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3493
-msgid "This is like C<command>, but passes the command to:"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:3501
-msgid "All the provisos about C<command> apply to this call."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3503
-msgid "sh-lines"
+#: ../fish/guestfish-actions.pod:4103
+msgid "umask"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3505
+#: ../fish/guestfish-actions.pod:4105
#, no-wrap
msgid ""
-" sh-lines command\n"
+" umask mask\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3507
-msgid "This is the same as C<sh>, but splits the result into a list of lines."
+#: ../fish/guestfish-actions.pod:4119
+msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3510
-msgid "See also: C<command-lines>"
+# type: =head2
+#: ../fish/guestfish-actions.pod:4124
+msgid "umount"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3512
-msgid "sleep"
+#: ../fish/guestfish-actions.pod:4126
+msgid "unmount"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3514
+#: ../fish/guestfish-actions.pod:4128
#, no-wrap
msgid ""
-" sleep secs\n"
+" umount pathordevice\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3518
-msgid "stat"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3520
-#, no-wrap
-msgid ""
-" stat path\n"
-"\n"
+#: ../fish/guestfish-actions.pod:4134
+msgid "umount-all"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3526
-msgid "statvfs"
+#: ../fish/guestfish-actions.pod:4136
+msgid "unmount-all"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3528
+#: ../fish/guestfish-actions.pod:4138
#, no-wrap
msgid ""
-" statvfs path\n"
+" umount-all\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3536
-msgid "strings"
+#: ../fish/guestfish-actions.pod:4144
+msgid "upload"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3538
+#: ../fish/guestfish-actions.pod:4146
#, no-wrap
msgid ""
-" strings path\n"
+" upload (filename|-) remotefilename\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:4153
+msgid "See also L</download>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3546
-msgid "strings-e"
+#: ../fish/guestfish-actions.pod:4157
+msgid "upload-offset"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3548
+#: ../fish/guestfish-actions.pod:4159
#, no-wrap
msgid ""
-" strings-e encoding path\n"
+" upload-offset (filename|-) remotefilename offset\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3550
+#: ../fish/guestfish-actions.pod:4171
msgid ""
-"This is like the C<strings> command, but allows you to specify the encoding "
-"of strings that are looked for in the source file C<path>."
+"Note that there is no limit on the amount of data that can be uploaded with "
+"this call, unlike with L</pwrite>, and this call always writes the full "
+"amount unless an error occurs."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3560
-msgid ""
-"Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
-"ISO-8859-X (this is what C<strings> uses)."
+#: ../fish/guestfish-actions.pod:4176
+msgid "See also L</upload>, L</pwrite>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3592
-msgid "swapoff-device"
+#: ../fish/guestfish-actions.pod:4180
+msgid "utimens"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3594
+#: ../fish/guestfish-actions.pod:4182
#, no-wrap
msgid ""
-" swapoff-device device\n"
+" utimens path atsecs atnsecs mtsecs mtnsecs\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3596
-msgid ""
-"This command disables the libguestfs appliance swap device or partition "
-"named C<device>. See C<swapon-device>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3600
-msgid "swapoff-file"
+#: ../fish/guestfish-actions.pod:4201
+msgid "version"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3602
+#: ../fish/guestfish-actions.pod:4203
#, no-wrap
msgid ""
-" swapoff-file file\n"
+" version\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:4230
+msgid ""
+"I<Note:> Don't use this call to test for availability of features. In "
+"enterprise distributions we backport features from later versions into "
+"earlier versions, making this an unreliable way to test for features. Use "
+"L</available> instead."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3606
-msgid "swapoff-label"
+#: ../fish/guestfish-actions.pod:4236
+msgid "vfs-label"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3608
+#: ../fish/guestfish-actions.pod:4238
#, no-wrap
msgid ""
-" swapoff-label label\n"
+" vfs-label device\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:4245
+msgid "To find a filesystem from the label, use L</findfs-label>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3613
-msgid "swapoff-uuid"
+#: ../fish/guestfish-actions.pod:4247
+msgid "vfs-type"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3615
+#: ../fish/guestfish-actions.pod:4249
#, no-wrap
msgid ""
-" swapoff-uuid uuid\n"
+" vfs-type device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3620
-msgid "swapon-device"
+#: ../fish/guestfish-actions.pod:4259
+msgid "vfs-uuid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3622
+#: ../fish/guestfish-actions.pod:4261
#, no-wrap
msgid ""
-" swapon-device device\n"
+" vfs-uuid device\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3624
-msgid ""
-"This command enables the libguestfs appliance to use the swap device or "
-"partition named C<device>. The increased memory is made available for all "
-"commands, for example those run using C<command> or C<sh>."
+#: ../fish/guestfish-actions.pod:4268
+msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3636
-msgid "swapon-file"
+#: ../fish/guestfish-actions.pod:4270
+msgid "vg-activate"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3638
+#: ../fish/guestfish-actions.pod:4272
#, no-wrap
msgid ""
-" swapon-file file\n"
+" vg-activate true|false 'volgroups ...'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3640
-msgid "This command enables swap to a file. See C<swapon-device> for other notes."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3643
-msgid "swapon-label"
+#: ../fish/guestfish-actions.pod:4285
+msgid "vg-activate-all"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3645
+#: ../fish/guestfish-actions.pod:4287
#, no-wrap
msgid ""
-" swapon-label label\n"
+" vg-activate-all true|false\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3647
+# type: =head2
+#: ../fish/guestfish-actions.pod:4297
+msgid "vgcreate"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:4299
+#, no-wrap
msgid ""
-"This command enables swap to a labeled swap partition. See C<swapon-device> "
-"for other notes."
+" vgcreate volgroup 'physvols ...'\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3650
-msgid "swapon-uuid"
+#: ../fish/guestfish-actions.pod:4304
+msgid "vglvuuids"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3652
+#: ../fish/guestfish-actions.pod:4306
#, no-wrap
msgid ""
-" swapon-uuid uuid\n"
+" vglvuuids vgname\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3654
+#: ../fish/guestfish-actions.pod:4311
msgid ""
-"This command enables swap to a swap partition with the given UUID. See "
-"C<swapon-device> for other notes."
+"You can use this along with L</lvs> and L</lvuuid> calls to associate "
+"logical volumes and volume groups."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:4314
+msgid "See also L</vgpvuuids>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3657
-msgid "sync"
+#: ../fish/guestfish-actions.pod:4316
+msgid "vgpvuuids"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3659
+#: ../fish/guestfish-actions.pod:4318
#, no-wrap
msgid ""
-" sync\n"
+" vgpvuuids vgname\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:4323
+msgid ""
+"You can use this along with L</pvs> and L</pvuuid> calls to associate "
+"physical volumes and volume groups."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-actions.pod:4326
+msgid "See also L</vglvuuids>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3667
-msgid "tail"
+#: ../fish/guestfish-actions.pod:4328
+msgid "vgremove"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3669
+#: ../fish/guestfish-actions.pod:4330
#, no-wrap
msgid ""
-" tail path\n"
+" vgremove vgname\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3677
-msgid "tail-n"
+#: ../fish/guestfish-actions.pod:4337
+msgid "vgrename"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3679
+#: ../fish/guestfish-actions.pod:4339
#, no-wrap
msgid ""
-" tail-n nrlines path\n"
+" vgrename volgroup newvolgroup\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3692
-msgid "tar-in"
+#: ../fish/guestfish-actions.pod:4343
+msgid "vgs"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3694
+#: ../fish/guestfish-actions.pod:4345
#, no-wrap
msgid ""
-" tar-in (tarfile|-) directory\n"
+" vgs\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3699
-msgid "To upload a compressed tarball, use C<tgz-in> or C<txz-in>."
+#: ../fish/guestfish-actions.pod:4353
+msgid "See also L</vgs-full>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3704
-msgid "tar-out"
+#: ../fish/guestfish-actions.pod:4355
+msgid "vgs-full"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3706
+#: ../fish/guestfish-actions.pod:4357
#, no-wrap
msgid ""
-" tar-out directory (tarfile|-)\n"
+" vgs-full\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3711
-msgid "To download a compressed tarball, use C<tgz-out> or C<txz-out>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3716
-msgid "tgz-in"
+#: ../fish/guestfish-actions.pod:4362
+msgid "vgscan"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3718
+#: ../fish/guestfish-actions.pod:4364
#, no-wrap
msgid ""
-" tgz-in (tarball|-) directory\n"
+" vgscan\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3723
-msgid "To upload an uncompressed tarball, use C<tar-in>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3727
-msgid "tgz-out"
+#: ../fish/guestfish-actions.pod:4369
+msgid "vguuid"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3729
+#: ../fish/guestfish-actions.pod:4371
#, no-wrap
msgid ""
-" tgz-out directory (tarball|-)\n"
+" vguuid vgname\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3734
-msgid "To download an uncompressed tarball, use C<tar-out>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3738
-msgid "touch"
+#: ../fish/guestfish-actions.pod:4375
+msgid "wc-c"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3740
+#: ../fish/guestfish-actions.pod:4377
#, no-wrap
msgid ""
-" touch path\n"
+" wc-c path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3749
-msgid "truncate"
+#: ../fish/guestfish-actions.pod:4382
+msgid "wc-l"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3751
+#: ../fish/guestfish-actions.pod:4384
#, no-wrap
msgid ""
-" truncate path\n"
+" wc-l path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3756
-msgid "truncate-size"
+#: ../fish/guestfish-actions.pod:4389
+msgid "wc-w"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3758
+#: ../fish/guestfish-actions.pod:4391
#, no-wrap
msgid ""
-" truncate-size path size\n"
+" wc-w path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3763
+# type: =head2
+#: ../fish/guestfish-actions.pod:4396
+msgid "write"
+msgstr ""
+
+# type: verbatim
+#: ../fish/guestfish-actions.pod:4398
+#, no-wrap
msgid ""
-"If the current file size is less than C<size> then the file is extended to "
-"the required size with zero bytes. This creates a sparse file (ie. disk "
-"blocks are not allocated for the file until you write to it). To create a "
-"non-sparse file of zeroes, use C<fallocate64> instead."
+" write path content\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3769
-msgid "tune2fs-l"
+#: ../fish/guestfish-actions.pod:4406
+msgid "write-file"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3771
+#: ../fish/guestfish-actions.pod:4408
#, no-wrap
msgid ""
-" tune2fs-l device\n"
+" write-file path content size\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3781
-msgid "txz-in"
+#: ../fish/guestfish-actions.pod:4431
+msgid "zegrep"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3783
+#: ../fish/guestfish-actions.pod:4433
#, no-wrap
msgid ""
-" txz-in (tarball|-) directory\n"
+" zegrep regex path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3790
-msgid "txz-out"
+#: ../fish/guestfish-actions.pod:4441
+msgid "zegrepi"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3792
+#: ../fish/guestfish-actions.pod:4443
#, no-wrap
msgid ""
-" txz-out directory (tarball|-)\n"
+" zegrepi regex path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3799
-msgid "umask"
+#: ../fish/guestfish-actions.pod:4451
+msgid "zero"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3801
+#: ../fish/guestfish-actions.pod:4453
#, no-wrap
msgid ""
-" umask mask\n"
+" zero device\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3815
-msgid "See also C<get-umask>, L<umask(2)>, C<mknod>, C<mkdir>."
+#: ../fish/guestfish-actions.pod:4461
+msgid "See also: L</zero-device>, L</scrub-device>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3820
-msgid "umount | unmount"
+#: ../fish/guestfish-actions.pod:4463
+msgid "zero-device"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3822
+#: ../fish/guestfish-actions.pod:4465
#, no-wrap
msgid ""
-" umount pathordevice\n"
+" zero-device device\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-actions.pod:4467
+msgid ""
+"This command writes zeroes over the entire C<device>. Compare with L</zero> "
+"which just zeroes the first few blocks of a device."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:3828
-msgid "umount-all | unmount-all"
+#: ../fish/guestfish-actions.pod:4474
+msgid "zerofree"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3830
+#: ../fish/guestfish-actions.pod:4476
#, no-wrap
msgid ""
-" umount-all\n"
+" zerofree device\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3836
-msgid "upload"
+#: ../fish/guestfish-actions.pod:4489
+msgid "zfgrep"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3838
+#: ../fish/guestfish-actions.pod:4491
#, no-wrap
msgid ""
-" upload (filename|-) remotefilename\n"
+" zfgrep pattern path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3845
-msgid "See also C<download>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3849
-msgid "utimens"
+#: ../fish/guestfish-actions.pod:4499
+msgid "zfgrepi"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3851
+#: ../fish/guestfish-actions.pod:4501
#, no-wrap
msgid ""
-" utimens path atsecs atnsecs mtsecs mtnsecs\n"
+" zfgrepi pattern path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3870
-msgid "version"
+#: ../fish/guestfish-actions.pod:4509
+msgid "zfile"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3872
+#: ../fish/guestfish-actions.pod:4511
#, no-wrap
msgid ""
-" version\n"
+" zfile meth path\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3899
-msgid ""
-"I<Note:> Don't use this call to test for availability of features. In "
-"enterprise distributions we backport features from later versions into "
-"earlier versions, making this an unreliable way to test for features. Use "
-"C<available> instead."
+#: ../fish/guestfish-actions.pod:4518
+msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3905
-msgid "vfs-label"
+#: ../fish/guestfish-actions.pod:4528
+msgid "zgrep"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3907
+#: ../fish/guestfish-actions.pod:4530
#, no-wrap
msgid ""
-" vfs-label device\n"
+" zgrep regex path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3914
-msgid "To find a filesystem from the label, use C<findfs-label>."
-msgstr ""
-
# type: =head2
-#: ../fish/guestfish-actions.pod:3916
-msgid "vfs-type"
+#: ../fish/guestfish-actions.pod:4538
+msgid "zgrepi"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3918
+#: ../fish/guestfish-actions.pod:4540
#, no-wrap
msgid ""
-" vfs-type device\n"
+" zgrepi regex path\n"
"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3928
-msgid "vfs-uuid"
+#: ../fish/guestfish-commands.pod:1
+msgid "alloc"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-commands.pod:3
+msgid "allocate"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3930
+#: ../fish/guestfish-commands.pod:5
#, no-wrap
msgid ""
-" vfs-uuid device\n"
+" alloc filename size\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3937
-msgid "To find a filesystem from the UUID, use C<findfs-uuid>."
+#: ../fish/guestfish-commands.pod:7
+msgid ""
+"This creates an empty (zeroed) file of the given size, and then adds so it "
+"can be further examined."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3939
-msgid "vg-activate"
+# type: textblock
+#: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
+msgid "For more advanced image creation, see L<qemu-img(1)> utility."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3941
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
+msgid "Size can be specified using standard suffixes, eg. C<1M>."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-commands.pod:14
msgid ""
-" vg-activate true|false 'volgroups ...'\n"
-"\n"
+"To create a sparse file, use L</sparse> instead. To create a prepared disk "
+"image, see L</PREPARED DISK IMAGES>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3954
-msgid "vg-activate-all"
+#: ../fish/guestfish-commands.pod:17
+msgid "copy-in"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3956
+#: ../fish/guestfish-commands.pod:19
#, no-wrap
msgid ""
-" vg-activate-all true|false\n"
+" copy-in local [local ...] /remotedir\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3966
-msgid "vgcreate"
+# type: textblock
+#: ../fish/guestfish-commands.pod:21
+msgid ""
+"C<copy-in> copies local files or directories recursively into the disk "
+"image, placing them in the directory called C</remotedir> (which must "
+"exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
+"other commands as necessary."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3968
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-commands.pod:26
msgid ""
-" vgcreate volgroup 'physvols ...'\n"
-"\n"
+"Multiple local files and directories can be specified, but the last "
+"parameter must always be a remote directory. Wildcards cannot be used."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3973
-msgid "vglvuuids"
+#: ../fish/guestfish-commands.pod:30
+msgid "copy-out"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3975
+#: ../fish/guestfish-commands.pod:32
#, no-wrap
msgid ""
-" vglvuuids vgname\n"
+" copy-out remote [remote ...] localdir\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3980
+#: ../fish/guestfish-commands.pod:34
msgid ""
-"You can use this along with C<lvs> and C<lvuuid> calls to associate logical "
-"volumes and volume groups."
+"C<copy-out> copies remote files or directories recursively out of the disk "
+"image, placing them on the host disk in a local directory called C<localdir> "
+"(which must exist). This guestfish meta-command turns into a sequence of "
+"L</download>, L</tar-out> and other commands as necessary."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3983
-msgid "See also C<vgpvuuids>."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:3985
-msgid "vgpvuuids"
+#: ../fish/guestfish-commands.pod:40
+msgid ""
+"Multiple remote files and directories can be specified, but the last "
+"parameter must always be a local directory. To download to the current "
+"directory, use C<.> as in:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3987
+#: ../fish/guestfish-commands.pod:44
#, no-wrap
msgid ""
-" vgpvuuids vgname\n"
+" copy-out /home .\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:3992
+#: ../fish/guestfish-commands.pod:46
msgid ""
-"You can use this along with C<pvs> and C<pvuuid> calls to associate physical "
-"volumes and volume groups."
+"Wildcards cannot be used in the ordinary command, but you can use them with "
+"the help of L</glob> like this:"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3995
-msgid "See also C<vglvuuids>."
+# type: verbatim
+#: ../fish/guestfish-commands.pod:49
+#, no-wrap
+msgid ""
+" glob copy-out /home/* .\n"
+"\n"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:3997
-msgid "vgremove"
+#: ../fish/guestfish-commands.pod:51
+msgid "echo"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:3999
+#: ../fish/guestfish-commands.pod:53
#, no-wrap
msgid ""
-" vgremove vgname\n"
+" echo [params ...]\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-commands.pod:55
+msgid "This echos the parameters to the terminal."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:4006
-msgid "vgrename"
+#: ../fish/guestfish-commands.pod:57
+msgid "edit"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4008
-#, no-wrap
-msgid ""
-" vgrename volgroup newvolgroup\n"
-"\n"
+# type: =head2
+#: ../fish/guestfish-commands.pod:59
+msgid "vi"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:4012
-msgid "vgs"
+#: ../fish/guestfish-commands.pod:61
+msgid "emacs"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4014
+#: ../fish/guestfish-commands.pod:63
#, no-wrap
msgid ""
-" vgs\n"
+" edit filename\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:4022
-msgid "See also C<vgs-full>."
+#: ../fish/guestfish-commands.pod:65
+msgid ""
+"This is used to edit a file. It downloads the file, edits it locally using "
+"your editor, then uploads the result."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-commands.pod:68
+msgid ""
+"The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
+"or C<emacs> you will get those corresponding editors."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:4024
-msgid "vgs-full"
+#: ../fish/guestfish-commands.pod:72
+msgid "glob"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4026
+#: ../fish/guestfish-commands.pod:74
#, no-wrap
msgid ""
-" vgs-full\n"
+" glob command args...\n"
"\n"
msgstr ""
+# type: textblock
+#: ../fish/guestfish-commands.pod:76
+msgid ""
+"Expand wildcards in any paths in the args list, and run C<command> "
+"repeatedly on each matching path."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-commands.pod:79
+msgid "See L</WILDCARDS AND GLOBBING>."
+msgstr ""
+
# type: =head2
-#: ../fish/guestfish-actions.pod:4031
-msgid "vgscan"
+#: ../fish/guestfish-commands.pod:81
+msgid "hexedit"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4033
+#: ../fish/guestfish-commands.pod:83
#, no-wrap
msgid ""
-" vgscan\n"
+" hexedit <filename|device>\n"
+" hexedit <filename|device> <max>\n"
+" hexedit <filename|device> <start> <max>\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4038
-msgid "vguuid"
+# type: textblock
+#: ../fish/guestfish-commands.pod:87
+msgid ""
+"Use hexedit (a hex editor) to edit all or part of a binary file or block "
+"device."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-commands.pod:90
+msgid ""
+"This command works by downloading potentially the whole file or device, "
+"editing it locally, then uploading it. If the file or device is large, you "
+"have to specify which part you wish to edit by using C<max> and/or C<start> "
+"C<max> parameters. C<start> and C<max> are specified in bytes, with the "
+"usual modifiers allowed such as C<1M> (1 megabyte)."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-commands.pod:97
+msgid "For example to edit the first few sectors of a disk you might do:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4040
+#: ../fish/guestfish-commands.pod:100
#, no-wrap
msgid ""
-" vguuid vgname\n"
+" hexedit /dev/sda 1M\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4044
-msgid "wc-c"
+# type: textblock
+#: ../fish/guestfish-commands.pod:102
+msgid ""
+"which would allow you to edit anywhere within the first megabyte of the "
+"disk."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-commands.pod:105
+msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4046
+#: ../fish/guestfish-commands.pod:107
#, no-wrap
msgid ""
-" wc-c path\n"
+" hexedit /dev/sda1 0x400 0x400\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4051
-msgid "wc-l"
+# type: textblock
+#: ../fish/guestfish-commands.pod:109
+msgid "(assuming the superblock is in the standard location)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4053
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-commands.pod:111
msgid ""
-" wc-l path\n"
-"\n"
+"This command requires the external L<hexedit(1)> program. You can specify "
+"another program to use by setting the C<HEXEDITOR> environment variable."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-commands.pod:115
+msgid "See also L</hexdump>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:4058
-msgid "wc-w"
+#: ../fish/guestfish-commands.pod:117
+msgid "lcd"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4060
+#: ../fish/guestfish-commands.pod:119
#, no-wrap
msgid ""
-" wc-w path\n"
+" lcd directory\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4065
-msgid "write"
+# type: textblock
+#: ../fish/guestfish-commands.pod:121
+msgid "Change the local directory, ie. the current directory of guestfish itself."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4067
-#, no-wrap
-msgid ""
-" write path content\n"
-"\n"
+# type: textblock
+#: ../fish/guestfish-commands.pod:124
+msgid "Note that C<!cd> won't do what you might expect."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:4075
-msgid "write-file"
+#: ../fish/guestfish-commands.pod:126
+msgid "man"
+msgstr ""
+
+# type: =head2
+#: ../fish/guestfish-commands.pod:128
+msgid "manual"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4077
+#: ../fish/guestfish-commands.pod:130
#, no-wrap
msgid ""
-" write-file path content size\n"
+" man\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4100
-msgid "zegrep"
+# type: textblock
+#: ../fish/guestfish-commands.pod:132
+msgid "Opens the manual page for guestfish."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4102
-#, no-wrap
-msgid ""
-" zegrep regex path\n"
-"\n"
+# type: =head2
+#: ../fish/guestfish-commands.pod:134
+msgid "more"
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:4110
-msgid "zegrepi"
+#: ../fish/guestfish-commands.pod:136
+msgid "less"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4112
+#: ../fish/guestfish-commands.pod:138
#, no-wrap
msgid ""
-" zegrepi regex path\n"
+" more filename\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4120
-msgid "zero"
-msgstr ""
-
# type: verbatim
-#: ../fish/guestfish-actions.pod:4122
+#: ../fish/guestfish-commands.pod:140
#, no-wrap
msgid ""
-" zero device\n"
+" less filename\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:4130
-msgid "See also: C<zero-device>, C<scrub-device>."
+#: ../fish/guestfish-commands.pod:142
+msgid "This is used to view a file."
+msgstr ""
+
+# type: textblock
+#: ../fish/guestfish-commands.pod:144
+msgid ""
+"The default viewer is C<$PAGER>. However if you use the alternate command "
+"C<less> you will get the C<less> command specifically."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:4132
-msgid "zero-device"
+#: ../fish/guestfish-commands.pod:147
+msgid "reopen"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4134
+#: ../fish/guestfish-commands.pod:149
#, no-wrap
msgid ""
-" zero-device device\n"
+" reopen\n"
"\n"
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:4136
+#: ../fish/guestfish-commands.pod:151
msgid ""
-"This command writes zeroes over the entire C<device>. Compare with C<zero> "
-"which just zeroes the first few blocks of a device."
+"Close and reopen the libguestfs handle. It is not necessary to use this "
+"normally, because the handle is closed properly when guestfish exits. "
+"However this is occasionally useful for testing."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:4143
-msgid "zerofree"
+#: ../fish/guestfish-commands.pod:155
+msgid "sparse"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4145
+#: ../fish/guestfish-commands.pod:157
#, no-wrap
msgid ""
-" zerofree device\n"
+" sparse filename size\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4158
-msgid "zfgrep"
+# type: textblock
+#: ../fish/guestfish-commands.pod:159
+msgid ""
+"This creates an empty sparse file of the given size, and then adds so it can "
+"be further examined."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4160
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-commands.pod:162
msgid ""
-" zfgrep pattern path\n"
-"\n"
+"In all respects it works the same as the L</alloc> command, except that the "
+"image file is allocated sparsely, which means that disk blocks are not "
+"assigned to the file until they are needed. Sparse disk files only use "
+"space when written to, but they are slower and there is a danger you could "
+"run out of real disk space during a write operation."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:4168
-msgid "zfgrepi"
+#: ../fish/guestfish-commands.pod:172
+msgid "supported"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4170
+#: ../fish/guestfish-commands.pod:174
#, no-wrap
msgid ""
-" zfgrepi pattern path\n"
+" supported\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4178
-msgid "zfile"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4180
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-commands.pod:176
msgid ""
-" zfile meth path\n"
-"\n"
+"This command returns a list of the optional groups known to the daemon, and "
+"indicates which ones are supported by this build of the libguestfs "
+"appliance."
msgstr ""
# type: textblock
-#: ../fish/guestfish-actions.pod:4187
-msgid "Since 1.0.63, use C<file> instead which can now process compressed files."
+#: ../fish/guestfish-commands.pod:180
+msgid "See also L<guestfs(3)/AVAILABILITY>."
msgstr ""
# type: =head2
-#: ../fish/guestfish-actions.pod:4197
-msgid "zgrep"
+#: ../fish/guestfish-commands.pod:182
+msgid "time"
msgstr ""
# type: verbatim
-#: ../fish/guestfish-actions.pod:4199
+#: ../fish/guestfish-commands.pod:184
#, no-wrap
msgid ""
-" zgrep regex path\n"
+" time command args...\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4207
-msgid "zgrepi"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4209
-#, no-wrap
+# type: textblock
+#: ../fish/guestfish-commands.pod:186
msgid ""
-" zgrepi regex path\n"
-"\n"
+"Run the command as usual, but print the elapsed time afterwards. This can "
+"be useful for benchmarking operations."
msgstr ""
# type: textblock
msgstr ""
# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:121 ../fuse/guestmount.pod:195
+#: ../test-tool/libguestfs-test-tool.pod:121
msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
msgstr ""
"\n"
msgstr ""
-# type: textblock
+# type: verbatim
+#: ../fuse/guestmount.pod:11
+#, no-wrap
+msgid ""
+" guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
+"\n"
+msgstr ""
+
+# type: verbatim
#: ../fuse/guestmount.pod:13
+#, no-wrap
+msgid ""
+" guestmount [--options] -d Guest -i [--ro] mountpoint\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../fuse/guestmount.pod:17
msgid ""
"You must I<not> use C<guestmount> in read-write mode on live virtual "
"machines. If you do this, you risk disk corruption in the VM."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:18
+#: ../fuse/guestmount.pod:22
msgid ""
"The guestmount program can be used to mount virtual machine filesystems and "
"other disk images on the host. It uses libguestfs for access to the guest "
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:23
+#: ../fuse/guestmount.pod:27
msgid ""
"Along with other options, you have to give at least one device (I<-a> "
-"option) and at least one mountpoint (I<-m> option). How this works is "
-"better explained in the L<guestfish(1)> manual page, or you can use "
-"L<virt-inspector(1)> and/or the wrapper script C<guestmount-wrapper> to help "
-"you."
+"option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
+"option) or use the I<-i> inspection option. How this works is better "
+"explained in the L<guestfish(1)> manual page, or by looking at the examples "
+"below."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:29
+#: ../fuse/guestmount.pod:33
msgid ""
"FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
"by you, and the filesystem will not be visible to any other users unless you "
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:37
+#: ../fuse/guestmount.pod:41
msgid ""
"For a typical Windows guest which has its main filesystem on the first "
"partition:"
msgstr ""
# type: verbatim
-#: ../fuse/guestmount.pod:40
+#: ../fuse/guestmount.pod:44
#, no-wrap
msgid ""
" guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:42
+#: ../fuse/guestmount.pod:46
msgid ""
"For a typical Linux guest which has a /boot filesystem on the first "
"partition, and the root filesystem on a logical volume:"
msgstr ""
# type: verbatim
-#: ../fuse/guestmount.pod:45
+#: ../fuse/guestmount.pod:49
#, no-wrap
msgid ""
" guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:47
-msgid ""
-"To get L<virt-inspector(1)> to do the hard work of detecting guest "
-"mountpoints for you:"
+#: ../fuse/guestmount.pod:51
+msgid "To get libguestfs to detect guest mountpoints for you:"
msgstr ""
# type: verbatim
-#: ../fuse/guestmount.pod:50
+#: ../fuse/guestmount.pod:53
#, no-wrap
msgid ""
-" guestmount $(virt-inspector --ro-fish MyGuest) /mnt\n"
+" guestmount -a guest.img -i --ro /mnt\n"
"\n"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:52
+#: ../fuse/guestmount.pod:55
+msgid "For a libvirt guest called \"Guest\" you could do:"
+msgstr ""
+
+# type: verbatim
+#: ../fuse/guestmount.pod:57
+#, no-wrap
msgid ""
-"(or use --fish if you don't want it to be a read only mount). The option is "
-"called I<--ro-fish> or I<--fish> because these parameters are compatible "
-"with L<guestfish(1)>."
+" guestmount -d Guest -i --ro /mnt\n"
+"\n"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:56
+#: ../fuse/guestmount.pod:59
msgid ""
"If you don't know what filesystems are contained in a guest or disk image, "
"use L<virt-list-filesystems(1)> first:"
msgstr ""
# type: verbatim
-#: ../fuse/guestmount.pod:59
+#: ../fuse/guestmount.pod:62
#, no-wrap
msgid ""
" virt-list-filesystems MyGuest\n"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:61
+#: ../fuse/guestmount.pod:64
msgid ""
-"If you want to trace the libguestfs calls but without excessive debugging, "
-"we recommend:"
+"If you want to trace the libguestfs calls but without excessive debugging "
+"information, we recommend:"
msgstr ""
# type: verbatim
-#: ../fuse/guestmount.pod:64
+#: ../fuse/guestmount.pod:67
#, no-wrap
msgid ""
-" guestmount [-a ... -m ...] --trace /mnt\n"
+" guestmount [...] --trace /mnt\n"
"\n"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:66
+#: ../fuse/guestmount.pod:69
msgid "If you want to debug the program, we recommend:"
msgstr ""
# type: verbatim
-#: ../fuse/guestmount.pod:68
+#: ../fuse/guestmount.pod:71
#, no-wrap
msgid ""
-" guestmount [-a ... -m ...] --trace --verbose /mnt\n"
+" guestmount [...] --trace --verbose /mnt\n"
"\n"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:76
+#: ../fuse/guestmount.pod:79
msgid "Add a block device or virtual machine image."
msgstr ""
# type: =item
-#: ../fuse/guestmount.pod:78
+#: ../fuse/guestmount.pod:96
msgid "B<--dir-cache-timeout N>"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:80
+#: ../fuse/guestmount.pod:98
msgid ""
"Set the readdir cache timeout to I<N> seconds, the default being 60 "
"seconds. The readdir cache [actually, there are several semi-independent "
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:86
+#: ../fuse/guestmount.pod:104
msgid ""
"There is also a different attribute cache implemented by FUSE (see the FUSE "
"option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
"requests, only cache existing ones."
msgstr ""
+# type: textblock
+#: ../fuse/guestmount.pod:122
+msgid ""
+"If you have untrusted raw-format guest disk images, you should use this "
+"option to specify the disk format. This avoids a possible security problem "
+"with malicious guests (CVE-2010-3851). See also "
+"L<guestfs(3)/guestfs_add_drive_opts>."
+msgstr ""
+
# type: =item
-#: ../fuse/guestmount.pod:90
+#: ../fuse/guestmount.pod:127
msgid "B<--fuse-help>"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:92
+#: ../fuse/guestmount.pod:129
msgid "Display help on special FUSE options (see I<-o> below)."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:96
+#: ../fuse/guestmount.pod:133
msgid "Display brief help and exit."
msgstr ""
# type: =item
-#: ../fuse/guestmount.pod:98
+#: ../fuse/guestmount.pod:146
msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:100
+#: ../fuse/guestmount.pod:148
msgid ""
"Mount the named partition or logical volume on the given mountpoint B<in the "
"guest> (this has nothing to do with mountpoints in the host)."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:103
+#: ../fuse/guestmount.pod:151
msgid ""
"If the mountpoint is omitted, it defaults to C</>. You have to mount "
"something on C</>."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:108
+#: ../fuse/guestmount.pod:156
msgid ""
"By default, we attempt to sync the guest disk when the FUSE mountpoint is "
"unmounted. If you specify this option, then we don't attempt to sync the "
msgstr ""
# type: =item
-#: ../fuse/guestmount.pod:113
+#: ../fuse/guestmount.pod:161
msgid "B<-o option> | B<--option option>"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:115
+#: ../fuse/guestmount.pod:163
msgid "Pass extra options to FUSE."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:117
+#: ../fuse/guestmount.pod:165
msgid ""
"To get a list of all the extra options supported by FUSE, use the command "
"below. Note that only the FUSE I<-o> options can be passed, and only some "
msgstr ""
# type: verbatim
-#: ../fuse/guestmount.pod:121
+#: ../fuse/guestmount.pod:169
#, no-wrap
msgid ""
" guestmount --fuse-help\n"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:123
+#: ../fuse/guestmount.pod:171
msgid "Some potentially useful FUSE options:"
msgstr ""
# type: =item
-#: ../fuse/guestmount.pod:127
+#: ../fuse/guestmount.pod:175
msgid "B<-o allow_other>"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:129
+#: ../fuse/guestmount.pod:177
msgid "Allow other users to see the filesystem."
msgstr ""
# type: =item
-#: ../fuse/guestmount.pod:131
+#: ../fuse/guestmount.pod:179
msgid "B<-o attr_timeout=N>"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:133
+#: ../fuse/guestmount.pod:181
msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
msgstr ""
# type: =item
-#: ../fuse/guestmount.pod:135
+#: ../fuse/guestmount.pod:183
msgid "B<-o kernel_cache>"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:137
+#: ../fuse/guestmount.pod:185
msgid ""
"Allow the kernel to cache files (reduces the number of reads that have to go "
"through the L<guestfs(3)> API). This is generally a good idea if you can "
msgstr ""
# type: =item
-#: ../fuse/guestmount.pod:141
+#: ../fuse/guestmount.pod:189
msgid "B<-o uid=N> B<-o gid=N>"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:143
+#: ../fuse/guestmount.pod:191
msgid ""
"Use these options to map all UIDs and GIDs inside the guest filesystem to "
"the chosen values."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:150
+#: ../fuse/guestmount.pod:198
msgid ""
"Add devices and mount everything read-only. Also disallow writes and make "
"the disk appear read-only to FUSE."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:153
+#: ../fuse/guestmount.pod:201
msgid ""
"This is highly recommended if you are not going to edit the guest disk. If "
"the guest is running and this option is I<not> supplied, then there is a "
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:160
+#: ../fuse/guestmount.pod:206
+msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
+msgstr ""
+
+# type: textblock
+#: ../fuse/guestmount.pod:210
msgid "Enable SELinux support for the guest."
msgstr ""
-# type: =item
-#: ../fuse/guestmount.pod:162
-msgid "B<--trace>"
+# type: textblock
+#: ../fuse/guestmount.pod:214
+msgid "Enable verbose messages from underlying libguestfs."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:164
-msgid "Trace libguestfs calls (to stderr)."
+#: ../fuse/guestmount.pod:218
+msgid "Display the program version and exit."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:166
-msgid "This also stops the daemon from forking into the background."
+#: ../fuse/guestmount.pod:222
+msgid ""
+"This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
+"FOR READ AND WRITE>."
+msgstr ""
+
+# type: =item
+#: ../fuse/guestmount.pod:225
+msgid "B<-x> | B<--trace>"
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:170
-msgid "Enable verbose messages from underlying libguestfs."
+#: ../fuse/guestmount.pod:227
+msgid "Trace libguestfs calls."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:174
-msgid "Display the program version and exit."
+#: ../fuse/guestmount.pod:229
+msgid "This also stops the daemon from forking into the background."
msgstr ""
# type: textblock
-#: ../fuse/guestmount.pod:180
+#: ../fuse/guestmount.pod:235
msgid ""
"L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
"L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:40
+#: ../inspector/virt-inspector.pl:35
msgid ""
-"virt-inspector - Display OS version, kernel, drivers, mount points, "
-"applications, etc. in a virtual machine"
+"virt-inspector - Display operating system version and other information "
+"about a virtual machine"
msgstr ""
# type: verbatim
-#: ../inspector/virt-inspector.pl:44
+#: ../inspector/virt-inspector.pl:39
#, no-wrap
msgid ""
" virt-inspector [--connect URI] domname\n"
msgstr ""
# type: verbatim
-#: ../inspector/virt-inspector.pl:46
+#: ../inspector/virt-inspector.pl:41
#, no-wrap
msgid ""
" virt-inspector guest.img [guest.img ...]\n"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:50
+#: ../inspector/virt-inspector.pl:45
msgid ""
-"B<virt-inspector> examines a virtual machine and tries to determine the "
-"version of the OS, the kernel version, what drivers are installed, whether "
-"the virtual machine is fully virtualized (FV) or para-virtualized (PV), what "
-"applications are installed and more."
+"B<virt-inspector> examines a virtual machine or disk image and tries to "
+"determine the version of the operating system and other information about "
+"the virtual machine."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:55
-msgid ""
-"Virt-inspector can produce output in several formats, including a readable "
-"text report, and XML for feeding into other programs."
+#: ../inspector/virt-inspector.pl:49
+msgid "Virt-inspector produces XML output for feeding into other programs."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:58
+#: ../inspector/virt-inspector.pl:51
msgid ""
"In the normal usage, use C<virt-inspector domname> where C<domname> is the "
"libvirt domain (see: C<virsh list --all>)."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:61
+#: ../inspector/virt-inspector.pl:54
msgid ""
"You can also run virt-inspector directly on disk images from a single "
"virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:67
+#: ../inspector/virt-inspector.pl:60
msgid ""
"Virt-inspector can only inspect and report upon I<one domain at a time>. To "
"inspect several virtual machines, you have to run virt-inspector several "
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:72
+#: ../inspector/virt-inspector.pl:65
msgid ""
"Because virt-inspector needs direct access to guest images, it won't "
"normally work over remote libvirt connections."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:85 ../tools/virt-cat.pl:90 ../tools/virt-df.pl:81 ../tools/virt-edit.pl:83 ../tools/virt-list-filesystems.pl:60 ../tools/virt-list-partitions.pl:61 ../tools/virt-ls.pl:89 ../tools/virt-make-fs.pl:163 ../tools/virt-rescue.pl:113 ../tools/virt-tar.pl:109 ../tools/virt-win-reg.pl:182
+#: ../inspector/virt-inspector.pl:78 ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:88 ../tools/virt-list-filesystems.pl:60 ../tools/virt-tar.pl:108 ../tools/virt-rescue.pl:113 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:61
msgid "Display brief help."
msgstr ""
# type: =item
-#: ../inspector/virt-inspector.pl:91 ../tools/virt-cat.pl:96 ../tools/virt-df.pl:87 ../tools/virt-edit.pl:89 ../tools/virt-list-filesystems.pl:66 ../tools/virt-list-partitions.pl:67 ../tools/virt-ls.pl:95 ../tools/virt-make-fs.pl:169 ../tools/virt-rescue.pl:119 ../tools/virt-resize.pl:249 ../tools/virt-tar.pl:115 ../tools/virt-win-reg.pl:188
+#: ../inspector/virt-inspector.pl:84 ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:94 ../tools/virt-resize.pl:273 ../tools/virt-list-filesystems.pl:66 ../tools/virt-tar.pl:114 ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:67
msgid "B<--version>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:93 ../tools/virt-cat.pl:98 ../tools/virt-df.pl:89 ../tools/virt-edit.pl:91 ../tools/virt-list-filesystems.pl:68 ../tools/virt-list-partitions.pl:69 ../tools/virt-ls.pl:97 ../tools/virt-make-fs.pl:171 ../tools/virt-rescue.pl:121 ../tools/virt-resize.pl:251 ../tools/virt-tar.pl:117 ../tools/virt-win-reg.pl:190
+#: ../inspector/virt-inspector.pl:86 ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:96 ../tools/virt-resize.pl:275 ../tools/virt-list-filesystems.pl:68 ../tools/virt-tar.pl:116 ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:69
msgid "Display version number and exit."
msgstr ""
# type: =item
-#: ../inspector/virt-inspector.pl:99 ../tools/virt-cat.pl:104 ../tools/virt-df.pl:95 ../tools/virt-edit.pl:113 ../tools/virt-list-filesystems.pl:74 ../tools/virt-list-partitions.pl:75 ../tools/virt-ls.pl:103 ../tools/virt-rescue.pl:135 ../tools/virt-tar.pl:123 ../tools/virt-win-reg.pl:204
+#: ../inspector/virt-inspector.pl:92 ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:102 ../tools/virt-list-filesystems.pl:74 ../tools/virt-tar.pl:122 ../tools/virt-rescue.pl:135 ../tools/virt-list-partitions.pl:75
msgid "B<--connect URI> | B<-c URI>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:101 ../tools/virt-cat.pl:106 ../tools/virt-df.pl:97 ../tools/virt-edit.pl:115 ../tools/virt-list-filesystems.pl:76 ../tools/virt-list-partitions.pl:77 ../tools/virt-ls.pl:105 ../tools/virt-rescue.pl:137 ../tools/virt-tar.pl:125 ../tools/virt-win-reg.pl:206
+#: ../inspector/virt-inspector.pl:94 ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:104 ../tools/virt-list-filesystems.pl:76 ../tools/virt-tar.pl:124 ../tools/virt-rescue.pl:137 ../tools/virt-list-partitions.pl:77
msgid ""
"If using libvirt, connect to the given I<URI>. If omitted, then we connect "
"to the default libvirt hypervisor."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:104
+#: ../inspector/virt-inspector.pl:97
msgid ""
"Libvirt is only used if you specify a C<domname> on the command line. If "
"you specify guest block devices directly, then libvirt is not used at all."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:114
-msgid ""
-"The following options select the output format. Use only one of them. The "
-"default is a readable text report."
-msgstr ""
-
# type: =item
-#: ../inspector/virt-inspector.pl:119
-msgid "B<--text> (default)"
+#: ../inspector/virt-inspector.pl:105 ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117 ../tools/virt-ls.pl:114 ../tools/virt-resize.pl:523 ../tools/virt-list-filesystems.pl:86 ../tools/virt-tar.pl:134 ../tools/virt-rescue.pl:147 ../tools/virt-list-partitions.pl:87
+msgid "B<--format> raw"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:121
-msgid "Plain text report."
-msgstr ""
-
-# type: =item
-#: ../inspector/virt-inspector.pl:123
-msgid "B<--none>"
+#: ../inspector/virt-inspector.pl:107 ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119 ../tools/virt-ls.pl:116 ../tools/virt-list-filesystems.pl:88 ../tools/virt-tar.pl:136 ../tools/virt-rescue.pl:149 ../tools/virt-list-partitions.pl:89
+msgid ""
+"Specify the format of disk images given on the command line. If this is "
+"omitted then the format is autodetected from the content of the disk image."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:125
-msgid "Produce no output at all."
-msgstr ""
-
-# type: =item
-#: ../inspector/virt-inspector.pl:127
-msgid "B<--xml>"
+#: ../inspector/virt-inspector.pl:111 ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123 ../tools/virt-ls.pl:120 ../tools/virt-list-filesystems.pl:92 ../tools/virt-tar.pl:140 ../tools/virt-rescue.pl:153 ../tools/virt-list-partitions.pl:93
+msgid ""
+"If disk images are requested from libvirt, then this program asks libvirt "
+"for this information. In this case, the value of the format parameter is "
+"ignored."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:129
+#: ../inspector/virt-inspector.pl:115 ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127 ../tools/virt-ls.pl:124 ../tools/virt-resize.pl:528 ../tools/virt-resize.pl:543 ../tools/virt-list-filesystems.pl:96 ../tools/virt-tar.pl:144 ../tools/virt-rescue.pl:157 ../tools/virt-list-partitions.pl:97
msgid ""
-"If you select I<--xml> then you get XML output which can be fed to other "
-"programs."
+"If working with untrusted raw-format guest disk images, you should ensure "
+"the format is always specified."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:132
-msgid "B<--yaml>"
+# type: =head1
+#: ../inspector/virt-inspector.pl:149
+msgid "XML FORMAT"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:134
+#: ../inspector/virt-inspector.pl:151
msgid ""
-"If you select I<--yaml> then you get YAML output which can be fed to other "
-"programs."
-msgstr ""
-
-# type: =item
-#: ../inspector/virt-inspector.pl:137
-msgid "B<--perl>"
+"The virt-inspector XML is described precisely in a RELAX NG schema which is "
+"supplied with libguestfs. This section is just an overview."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:139
+#: ../inspector/virt-inspector.pl:154
msgid ""
-"If you select I<--perl> then you get Perl structures output which can be "
-"used directly in another Perl program."
-msgstr ""
-
-# type: =item
-#: ../inspector/virt-inspector.pl:142
-msgid "B<--fish>"
+"The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
+"more E<lt>operatingsystemE<gt> elements. You would only see more than one "
+"E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
+"which is vanishingly rare in real world VMs."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:144
-msgid "B<--ro-fish>"
+# type: =head2
+#: ../inspector/virt-inspector.pl:159
+msgid "E<lt>operatingsystemE<gt>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:146
+#: ../inspector/virt-inspector.pl:161
msgid ""
-"If you select I<--fish> then we print a L<guestfish(1)> command line which "
-"will automatically mount up the filesystems on the correct mount points. "
-"Try this for example:"
+"In the E<lt>operatingsystemE<gt> tag are various optional fields that "
+"describe the operating system, its architecture, the descriptive \"product "
+"name\" string, the type of OS and so on, as in this example:"
msgstr ""
# type: verbatim
-#: ../inspector/virt-inspector.pl:150
+#: ../inspector/virt-inspector.pl:165
#, no-wrap
msgid ""
-" guestfish $(virt-inspector --fish guest.img)\n"
+" <operatingsystems>\n"
+" <operatingsystem>\n"
+" <root>/dev/sda2</root>\n"
+" <name>windows</name>\n"
+" <arch>i386</arch>\n"
+" <distro>windows</distro>\n"
+" <product_name>Windows 7 Enterprise</product_name>\n"
+" <major_version>6</major_version>\n"
+" <minor_version>1</minor_version>\n"
+" <windows_systemroot>/Windows</windows_systemroot>\n"
"\n"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:152
+#: ../inspector/virt-inspector.pl:176
msgid ""
-"I<--ro-fish> is the same, but the I<--ro> option is passed to guestfish so "
-"that the filesystems are mounted read-only."
-msgstr ""
-
-# type: =item
-#: ../inspector/virt-inspector.pl:155
-msgid "B<--query>"
+"These fields are derived from the libguestfs inspection API, and you can "
+"find more details in L<guestfs(3)/INSPECTION>."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:157
+#: ../inspector/virt-inspector.pl:179
msgid ""
-"In \"query mode\" we answer common questions about the guest, such as "
-"whether it is fullvirt or needs a Xen hypervisor to run."
+"The E<lt>rootE<gt> element is the root filesystem device, but from the point "
+"of view of libguestfs (block devices may have completely different names "
+"inside the VM itself)."
+msgstr ""
+
+# type: =head2
+#: ../inspector/virt-inspector.pl:240
+msgid "E<lt>mountpointsE<gt>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:160
-msgid "See section I<QUERY MODE> below."
+#: ../inspector/virt-inspector.pl:242
+msgid ""
+"Un*x-like guests typically have multiple filesystems which are mounted at "
+"various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
+"element which looks like this:"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:166
-msgid "B<--windows-registry>"
+# type: verbatim
+#: ../inspector/virt-inspector.pl:246
+#, no-wrap
+msgid ""
+" <operatingsystems>\n"
+" <operatingsystem>\n"
+" ...\n"
+" <mountpoints>\n"
+" <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
+" <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
+" </mountpoints>\n"
+"\n"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:168
+#: ../inspector/virt-inspector.pl:254
msgid ""
-"This flag is ignored for compatibility with earlier releases of the "
-"software."
+"As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
+"and may have completely different names inside the guest. Only mountable "
+"filesystems appear in this list, not things like swap devices."
+msgstr ""
+
+# type: =head2
+#: ../inspector/virt-inspector.pl:276
+msgid "E<lt>filesystemsE<gt>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:171
+#: ../inspector/virt-inspector.pl:278
msgid ""
-"In this version, if L<Win::Hivex(3)> is available, then we attempt to parse "
-"information out of the Registry for any Windows guest."
+"E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
+"filesystems belonging to the guest, including swap and empty partitions. "
+"(In the rare case of a multi-boot guest, it covers filesystems belonging to "
+"this OS or shared by this OS and other OSes)."
msgstr ""
-# type: =head1
-#: ../inspector/virt-inspector.pl:218
-msgid "OUTPUT FORMAT"
+# type: textblock
+#: ../inspector/virt-inspector.pl:283
+msgid "You might see something like this:"
msgstr ""
# type: verbatim
-#: ../inspector/virt-inspector.pl:220
+#: ../inspector/virt-inspector.pl:285
#, no-wrap
msgid ""
-" Operating system(s)\n"
-" -------------------\n"
-" Linux (distro + version)\n"
-" Windows (version)\n"
-" |\n"
-" |\n"
-" +--- Filesystems ---------- Installed apps --- Kernel & drivers\n"
-" ----------- -------------- ----------------\n"
-" mount point => device List of apps Extra information\n"
-" mount point => device and versions about kernel(s)\n"
-" ... and drivers\n"
-" swap => swap device\n"
-" (plus lots of extra information\n"
-" about each filesystem)\n"
+" <operatingsystems>\n"
+" <operatingsystem>\n"
+" ...\n"
+" <filesystems>\n"
+" <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
+" <type>ext4</type>\n"
+" <label>Fedora-13-x86_64</label>\n"
+" <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
+" </filesystem>\n"
"\n"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:235
-msgid "The output of virt-inspector is a complex two-level data structure."
+#: ../inspector/virt-inspector.pl:295
+msgid ""
+"The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
+"the label, and the UUID."
+msgstr ""
+
+# type: =head2
+#: ../inspector/virt-inspector.pl:337
+msgid "E<lt>applicationsE<gt>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:237
+#: ../inspector/virt-inspector.pl:339
msgid ""
-"At the top level is a list of the operating systems installed on the guest. "
-"(For the vast majority of guests, only a single OS is installed.) The data "
-"returned for the OS includes the name (Linux, Windows), the distribution and "
-"version."
+"The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
+"and E<lt>applicationsE<gt> describe applications installed in the virtual "
+"machine. At the moment we are only able to list RPMs and Debian packages "
+"installed, but in future we will support other Linux distros and Windows."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:242
-msgid "The diagram above shows what we return for each OS."
+#: ../inspector/virt-inspector.pl:345
+msgid ""
+"E<lt>package_formatE<gt>, if present, describes the packaging system used. "
+"Typical values would be C<rpm> and C<deb>."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:244
+#: ../inspector/virt-inspector.pl:348
msgid ""
-"With the I<--xml> option the output is mapped into an XML document. There "
-"is a RELAX-NG schema for this XML in the file I<virt-inspector.rng> which "
-"normally ships with virt-inspector, or can be found in the source."
+"E<lt>package_managementE<gt>, if present, describes the package manager. "
+"Typical values include C<yum>, C<up2date> and C<apt>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:249
-msgid ""
-"With the I<--fish> or I<--ro-fish> option the mount points are mapped to "
-"L<guestfish(1)> command line parameters, so that you can go in afterwards "
-"and inspect the guest with everything mounted in the right place. For "
-"example:"
+#: ../inspector/virt-inspector.pl:351
+msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
msgstr ""
# type: verbatim
-#: ../inspector/virt-inspector.pl:254
+#: ../inspector/virt-inspector.pl:354
#, no-wrap
msgid ""
-" guestfish $(virt-inspector --ro-fish guest.img)\n"
-" ==> guestfish --ro -a guest.img -m /dev/VG/LV:/ -m /dev/sda1:/boot\n"
+" <operatingsystems>\n"
+" <operatingsystem>\n"
+" ...\n"
+" <applications>\n"
+" <application>\n"
+" <name>coreutils</name>\n"
+" <version>8.5</version>\n"
+" <release>1</release>\n"
+" </application>\n"
"\n"
msgstr ""
+# type: textblock
+#: ../inspector/virt-inspector.pl:364
+msgid ""
+"(The version and release fields may not be available for some package "
+"types)."
+msgstr ""
+
# type: =head1
-#: ../inspector/virt-inspector.pl:589
-msgid "QUERY MODE"
+#: ../inspector/virt-inspector.pl:510
+msgid "USING XPATH"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:591
+#: ../inspector/virt-inspector.pl:512
msgid ""
-"When you use C<virt-inspector --query>, the output is a series of lines of "
-"the form:"
+"You can use the XPath query language, and/or the xpath tool, in order to "
+"select parts of the XML."
msgstr ""
# type: verbatim
-#: ../inspector/virt-inspector.pl:594
+#: ../inspector/virt-inspector.pl:517
#, no-wrap
msgid ""
-" windows=no\n"
-" linux=yes\n"
-" fullvirt=yes\n"
-" xen_pv_drivers=no\n"
+" $ virt-inspector Guest | xpath //filesystems\n"
+" Found 1 nodes:\n"
+" -- NODE --\n"
+" <filesystems>\n"
+" <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
+" <type>ext4</type>\n"
+" [etc]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:599
+# type: verbatim
+#: ../inspector/virt-inspector.pl:525
+#, no-wrap
msgid ""
-"(each answer is usually C<yes> or C<no>, or the line is completely missing "
-"if we could not determine the answer at all)."
+" $ virt-inspector Guest | \\\n"
+" xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
+" Query didn't return a nodeset. Value: ext4\n"
+"\n"
+msgstr ""
+
+# type: =head1
+#: ../inspector/virt-inspector.pl:529 ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477 ../tools/virt-df.pl:633 ../tools/virt-ls.pl:225 ../tools/virt-resize.pl:1479 ../tools/virt-list-filesystems.pl:179 ../tools/virt-tar.pl:274 ../tools/virt-rescue.pl:260 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:247
+msgid "SHELL QUOTING"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:602
+#: ../inspector/virt-inspector.pl:531 ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635 ../tools/virt-ls.pl:227 ../tools/virt-resize.pl:1481 ../tools/virt-list-filesystems.pl:181 ../tools/virt-tar.pl:276 ../tools/virt-rescue.pl:262 ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:249
msgid ""
-"If the guest is multiboot, you can get apparently conflicting answers "
-"(eg. C<windows=yes> and C<linux=yes>, or a guest which is both fullvirt and "
-"has a Xen PV kernel). This is normal, and just means that the guest can do "
-"both things, although it might require operator intervention such as "
-"selecting a boot option when the guest is booting."
+"Libvirt guest names can contain arbitrary characters, some of which have "
+"meaning to the shell such as C<#> and space. You may need to quote or "
+"escape these characters on the command line. See the shell manual page "
+"L<sh(1)> for details."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:609
-msgid "This section describes the full range of answers possible."
+#: ../inspector/virt-inspector.pl:538
+msgid ""
+"L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
+"L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:630
-msgid "windows=(yes|no)"
+# type: textblock
+#: ../inspector/virt-inspector.pl:552 ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651 ../tools/virt-ls.pl:245 ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:200 ../tools/virt-tar.pl:294 ../tools/virt-rescue.pl:279 ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:267
+msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:632
-msgid "Answer C<yes> if Microsoft Windows is installed in the guest."
+#: ../inspector/virt-inspector.pl:556
+msgid "Matthew Booth L<mbooth@redhat.com>"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:645
-msgid "linux=(yes|no)"
+# type: textblock
+#: ../inspector/virt-inspector.pl:562 ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
+msgid "Copyright (C) 2010 Red Hat Inc."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:647
-msgid "Answer C<yes> if a Linux kernel is installed in the guest."
+#: ../tools/virt-edit.pl:34
+msgid "virt-edit - Edit a file in a virtual machine"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:660
-msgid "rhel=(yes|no)"
+# type: verbatim
+#: ../tools/virt-edit.pl:38
+#, no-wrap
+msgid ""
+" virt-edit [--options] domname file\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:662
-msgid "Answer C<yes> if the guest contains Red Hat Enterprise Linux."
+# type: verbatim
+#: ../tools/virt-edit.pl:40
+#, no-wrap
+msgid ""
+" virt-edit [--options] disk.img [disk.img ...] file\n"
+"\n"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:676
-msgid "fedora=(yes|no)"
+# type: verbatim
+#: ../tools/virt-edit.pl:42
+#, no-wrap
+msgid ""
+" virt-edit [domname|disk.img] file -e 'expr'\n"
+"\n"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:678
-msgid "Answer C<yes> if the guest contains the Fedora Linux distribution."
+#: ../tools/virt-edit.pl:46
+msgid ""
+"You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
+"you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
+"doing this, but doesn't catch all cases."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:691
-msgid "debian=(yes|no)"
+# type: textblock
+#: ../tools/virt-edit.pl:52
+msgid ""
+"C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
+"the named virtual machine (or disk image)."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:693
-msgid "Answer C<yes> if the guest contains the Debian Linux distribution."
+#: ../tools/virt-edit.pl:55
+msgid ""
+"If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
+"you should look at the L<guestfish(1)> tool."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:706
-msgid "fullvirt=(yes|no)"
+# type: textblock
+#: ../tools/virt-edit.pl:60
+msgid "Edit the named files interactively:"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:708
+# type: verbatim
+#: ../tools/virt-edit.pl:62
+#, no-wrap
msgid ""
-"Answer C<yes> if there is at least one operating system kernel installed in "
-"the guest which runs fully virtualized. Such a guest would require a "
-"hypervisor which supports full system virtualization."
+" virt-edit mydomain /boot/grub/grub.conf\n"
+"\n"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:731
-msgid "xen_domU_kernel=(yes|no)"
+# type: verbatim
+#: ../tools/virt-edit.pl:64
+#, no-wrap
+msgid ""
+" virt-edit mydomain /etc/passwd\n"
+"\n"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:733
+#: ../tools/virt-edit.pl:66
+msgid ""
+"You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
+"below). To change the init default level to 5:"
+msgstr ""
+
+# type: verbatim
+#: ../tools/virt-edit.pl:70
+#, no-wrap
msgid ""
-"Answer C<yes> if there is at least one Linux kernel installed in the guest "
-"which is compiled as a Xen DomU (a Xen paravirtualized guest)."
+" virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
+"\n"
msgstr ""
# type: =item
-#: ../inspector/virt-inspector.pl:753
-msgid "xen_pv_drivers=(yes|no)"
+#: ../tools/virt-edit.pl:96
+msgid "B<--backup extension> | B<-b extension>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:755
+#: ../tools/virt-edit.pl:98
msgid ""
-"Answer C<yes> if the guest has Xen paravirtualized drivers installed "
-"(usually the kernel itself will be fully virtualized, but the PV drivers "
-"have been installed by the administrator for performance reasons)."
-msgstr ""
-
-# type: =item
-#: ../inspector/virt-inspector.pl:777
-msgid "virtio_drivers=(yes|no)"
+"Create a backup of the original file I<in the guest disk image>. The backup "
+"has the original filename with C<extension> added."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:779
+#: ../tools/virt-edit.pl:101
msgid ""
-"Answer C<yes> if the guest has virtio paravirtualized drivers installed. "
-"Virtio drivers are commonly used to improve the performance of KVM."
+"Usually the first character of C<extension> would be a dot C<.> so you would "
+"write:"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:800
-msgid "userspace_arch=(x86_64|...)"
+# type: verbatim
+#: ../tools/virt-edit.pl:104
+#, no-wrap
+msgid ""
+" virt-edit -b .orig [etc]\n"
+"\n"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:802
-msgid "Print the architecture of userspace."
+#: ../tools/virt-edit.pl:106
+msgid "By default, no backup file is made."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:804 ../inspector/virt-inspector.pl:825
-msgid "NB. For multi-boot VMs this can print several lines."
+#: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208 ../tools/virt-df.pl:100 ../tools/virt-ls.pl:107 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:127 ../tools/virt-rescue.pl:140 ../tools/virt-list-partitions.pl:80
+msgid ""
+"If you specify guest block devices directly, then libvirt is not used at "
+"all."
msgstr ""
# type: =item
-#: ../inspector/virt-inspector.pl:821
-msgid "kernel_arch=(x86_64|...)"
+#: ../tools/virt-edit.pl:141
+msgid "B<--expr EXPR> | B<-e EXPR>"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:823
-msgid "Print the architecture of the kernel."
+#: ../tools/virt-edit.pl:143
+msgid ""
+"Instead of launching the external editor, non-interactively apply the Perl "
+"expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
+"EDITING> below."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:848 ../tools/virt-df.pl:484
+#: ../tools/virt-edit.pl:147
msgid ""
-"L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
-"L<Sys::Virt(3)>, L<http://libguestfs.org/>."
+"Be careful to properly quote the expression to prevent it from being altered "
+"by the shell."
+msgstr ""
+
+# type: =head1
+#: ../tools/virt-edit.pl:268
+msgid "NON-INTERACTIVE EDITING"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:857 ../tools/virt-cat.pl:175 ../tools/virt-df.pl:493 ../tools/virt-edit.pl:339 ../tools/virt-list-filesystems.pl:205 ../tools/virt-list-partitions.pl:242 ../tools/virt-ls.pl:223 ../tools/virt-make-fs.pl:554 ../tools/virt-rescue.pl:243 ../tools/virt-resize.pl:1409 ../tools/virt-tar.pl:270 ../tools/virt-win-reg.pl:489
-msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
+#: ../tools/virt-edit.pl:270
+msgid ""
+"C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
+"administrator can interactively edit the file."
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:859
-msgid "Matthew Booth L<mbooth@redhat.com>"
+#: ../tools/virt-edit.pl:273
+msgid ""
+"There are two ways also to use C<virt-edit> from scripts in order to make "
+"automated edits to files. (Note that although you I<can> use C<virt-edit> "
+"like this, it's less error-prone to write scripts directly using the "
+"libguestfs API and Augeas for configuration file editing.)"
msgstr ""
# type: textblock
-#: ../inspector/virt-inspector.pl:863 ../tools/virt-cat.pl:179 ../tools/virt-list-filesystems.pl:209 ../tools/virt-ls.pl:227 ../tools/virt-tar.pl:274
-msgid "Copyright (C) 2009 Red Hat Inc."
+#: ../tools/virt-edit.pl:279
+msgid ""
+"The first method is to temporarily set C<$EDITOR> to any script or program "
+"you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
+"update C<tmpfile> in place however it likes."
msgstr ""
# type: textblock
-#: ../tools/virt-cat.pl:34
-msgid "virt-cat - Display a file in a virtual machine"
+#: ../tools/virt-edit.pl:283
+msgid ""
+"The second method is to use the C<-e> parameter of C<virt-edit> to run a "
+"short Perl snippet in the style of L<sed(1)>. For example to replace all "
+"instances of C<foo> with C<bar> in a file:"
msgstr ""
# type: verbatim
-#: ../tools/virt-cat.pl:38
+#: ../tools/virt-edit.pl:287
#, no-wrap
msgid ""
-" virt-cat [--options] domname file\n"
+" virt-edit domname filename -e 's/foo/bar/'\n"
"\n"
msgstr ""
+# type: textblock
+#: ../tools/virt-edit.pl:289
+msgid ""
+"The full power of Perl regular expressions can be used (see L<perlre(1)>). "
+"For example to delete root's password you could do:"
+msgstr ""
+
# type: verbatim
-#: ../tools/virt-cat.pl:40
+#: ../tools/virt-edit.pl:292
#, no-wrap
msgid ""
-" virt-cat [--options] disk.img [disk.img ...] file\n"
+" virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-cat.pl:44
+#: ../tools/virt-edit.pl:294
msgid ""
-"C<virt-cat> is a command line tool to display the contents of C<file> where "
-"C<file> exists in the named virtual machine (or disk image)."
+"What really happens is that the snippet is evaluated as a Perl expression "
+"for each line of the file. The line, including the final C<\\n>, is passed "
+"in C<$_> and the expression should update C<$_> or leave it unchanged."
msgstr ""
# type: textblock
-#: ../tools/virt-cat.pl:47
+#: ../tools/virt-edit.pl:299
msgid ""
-"C<virt-cat> can be used to quickly view a single file. To edit a file, use "
-"C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
-"tool."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-cat.pl:53
-msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
+"To delete a line, set C<$_> to the empty string. For example, to delete the "
+"C<apache> user account from the password file you can do:"
msgstr ""
# type: verbatim
-#: ../tools/virt-cat.pl:56
+#: ../tools/virt-edit.pl:302
#, no-wrap
msgid ""
-" virt-cat mydomain /etc/fstab\n"
+" virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-cat.pl:58
-msgid "List syslog messages from a VM:"
-msgstr ""
-
-# type: verbatim
-#: ../tools/virt-cat.pl:60
-#, no-wrap
+#: ../tools/virt-edit.pl:304
msgid ""
-" virt-cat mydomain /var/log/messages | tail\n"
-"\n"
+"To insert a line, prepend or append it to C<$_>. However appending lines to "
+"the end of the file is rather difficult this way since there is no concept "
+"of \"last line of the file\" - your expression just doesn't get called "
+"again. You might want to use the first method (setting C<$EDITOR>) if you "
+"want to do this."
msgstr ""
# type: textblock
-#: ../tools/virt-cat.pl:62
-msgid "Find out what DHCP IP address a VM acquired:"
+#: ../tools/virt-edit.pl:310
+msgid ""
+"The variable C<$lineno> contains the current line number. As is "
+"traditional, the first line in the file is number C<1>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-cat.pl:64
-#, no-wrap
+# type: textblock
+#: ../tools/virt-edit.pl:313
msgid ""
-" virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
-"\n"
+"The return value from the expression is ignored, but the expression may call "
+"C<die> in order to abort the whole program, leaving the original file "
+"untouched."
msgstr ""
# type: textblock
-#: ../tools/virt-cat.pl:66
-msgid "Find out what packages were recently installed:"
+#: ../tools/virt-edit.pl:317
+msgid ""
+"Remember when matching the end of a line that C<$_> may contain the final "
+"C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
+"newline then neither of these. Thus to match or substitute some text at the "
+"end of a line, use this regular expression:"
msgstr ""
# type: verbatim
-#: ../tools/virt-cat.pl:68
+#: ../tools/virt-edit.pl:322
#, no-wrap
msgid ""
-" virt-cat mydomain /var/log/yum.log | tail\n"
+" /some text(\\r?\\n)?$/\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-cat.pl:70
-msgid "Find out who is logged on inside a virtual machine:"
+#: ../tools/virt-edit.pl:324
+msgid ""
+"Alternately, use the perl C<chomp> function, being careful not to chomp "
+"C<$_> itself (since that would remove all newlines from the file):"
msgstr ""
# type: verbatim
-#: ../tools/virt-cat.pl:72
+#: ../tools/virt-edit.pl:328
#, no-wrap
msgid ""
-" virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
-" who /tmp/utmp\n"
+" my $m = $_; chomp $m; $m =~ /some text$/\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-cat.pl:75
-msgid "or who was logged on:"
+# type: =item
+#: ../tools/virt-edit.pl:334
+msgid "C<EDITOR>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-cat.pl:77
-#, no-wrap
+# type: textblock
+#: ../tools/virt-edit.pl:336
msgid ""
-" virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
-" last -f /tmp/wtmp\n"
-"\n"
+"If set, this string is used as the editor. It may contain arguments, "
+"eg. C<\"emacs -nw\">"
msgstr ""
# type: textblock
-#: ../tools/virt-cat.pl:109 ../tools/virt-df.pl:100 ../tools/virt-edit.pl:118 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-ls.pl:108 ../tools/virt-rescue.pl:140 ../tools/virt-tar.pl:128 ../tools/virt-win-reg.pl:209
-msgid ""
-"If you specify guest block devices directly, then libvirt is not used at "
-"all."
+#: ../tools/virt-edit.pl:339
+msgid "If not set, C<vi> is used."
msgstr ""
# type: textblock
-#: ../tools/virt-cat.pl:165
+#: ../tools/virt-edit.pl:352
msgid ""
-"L<guestfs(3)>, L<guestfish(1)>, L<virt-edit(1)>, L<Sys::Guestfs(3)>, "
-"L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
+"L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
+"L<perl(1)>, L<perlre(1)>."
msgstr ""
# type: =head1
-#: ../tools/virt-cat.pl:173 ../tools/virt-df.pl:491 ../tools/virt-edit.pl:337 ../tools/virt-list-filesystems.pl:203 ../tools/virt-list-partitions.pl:240 ../tools/virt-ls.pl:221 ../tools/virt-make-fs.pl:552 ../tools/virt-rescue.pl:241 ../tools/virt-resize.pl:1407 ../tools/virt-tar.pl:268 ../tools/virt-win-reg.pl:487
+#: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510 ../tools/virt-df.pl:649 ../tools/virt-ls.pl:243 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:198 ../tools/virt-tar.pl:292 ../tools/virt-rescue.pl:277 ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:265
msgid "AUTHOR"
msgstr ""
# type: textblock
-#: ../tools/virt-df.pl:36
-msgid "virt-df - Display free space on virtual filesystems"
+#: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655 ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
+msgid "Copyright (C) 2009-2010 Red Hat Inc."
msgstr ""
-# type: verbatim
-#: ../tools/virt-df.pl:40
-#, no-wrap
+# type: textblock
+#: ../tools/virt-win-reg.pl:37
msgid ""
-" virt-df [--options]\n"
-"\n"
+"virt-win-reg - Export and merge Windows Registry entries from a Windows "
+"guest"
msgstr ""
# type: verbatim
-#: ../tools/virt-df.pl:42
+#: ../tools/virt-win-reg.pl:41
#, no-wrap
msgid ""
-" virt-df [--options] domname\n"
+" virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-df.pl:44
+#: ../tools/virt-win-reg.pl:43
#, no-wrap
msgid ""
-" virt-df [--options] disk.img [disk.img ...]\n"
+" virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:48
-msgid ""
-"C<virt-df> is a command line tool to display free space on virtual machine "
-"filesystems. Unlike other tools, it doesn't just display the amount of "
-"space allocated to a virtual machine, but can look inside the virtual "
-"machine to see how much space is really being used."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-df.pl:53
-msgid ""
-"It is like the L<df(1)> command, but for virtual machines, except that it "
-"also works for Windows virtual machines."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-df.pl:56
-msgid ""
-"If used without any arguments, C<virt-df> checks with libvirt to get a list "
-"of all active and inactive guests, and performs a C<df>-type operation on "
-"each one in turn, printing out the results."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-df.pl:60
-msgid ""
-"If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
-"either the single named libvirt domain, or on the disk image(s) listed on "
-"the command line (which must all belong to a single VM). In this mode (with "
-"arguments), C<virt-df> will I<only work for a single guest>. If you want to "
-"run on multiple guests, then you have to invoke C<virt-df> multiple times."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-df.pl:67
+# type: verbatim
+#: ../tools/virt-win-reg.pl:45
+#, no-wrap
msgid ""
-"Use the C<--csv> option to get a format which can be easily parsed by other "
-"programs. Other options are mostly similar to standard C<df> options. See "
-"below for the complete list."
-msgstr ""
-
-# type: =item
-#: ../tools/virt-df.pl:107
-msgid "B<--csv>"
+" virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:109
+# type: verbatim
+#: ../tools/virt-win-reg.pl:47
+#, no-wrap
msgid ""
-"Write out the results in CSV format (comma-separated values). This format "
-"can be imported easily into databases and spreadsheets, but read L</NOTE "
-"ABOUT CSV FORMAT> below."
+" virt-win-reg --merge domname [input.reg ...]\n"
+"\n"
msgstr ""
-
-# type: =item
-#: ../tools/virt-df.pl:117
-msgid "B<--human-readable> | B<-h>"
+
+# type: verbatim
+#: ../tools/virt-win-reg.pl:49
+#, no-wrap
+msgid ""
+" virt-win-reg [--options] disk.img ... # instead of domname\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-df.pl:119
-msgid "Print sizes in human-readable format."
+#: ../tools/virt-win-reg.pl:53
+msgid ""
+"You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
+"virtual machines. If you do this, you I<will> get irreversible disk "
+"corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
+"but doesn't catch all cases."
msgstr ""
# type: textblock
-#: ../tools/virt-df.pl:121
-msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
+#: ../tools/virt-win-reg.pl:58
+msgid ""
+"Modifying the Windows Registry is an inherently risky operation. The format "
+"is deliberately obscure and undocumented, and Registry changes can leave the "
+"system unbootable. Therefore when using the C<--merge> option, make sure "
+"you have a reliable backup first."
msgstr ""
-# type: =item
-#: ../tools/virt-df.pl:127
-msgid "B<--inodes> | B<-i>"
+# type: textblock
+#: ../tools/virt-win-reg.pl:65
+msgid ""
+"This program can export and merge Windows Registry entries from a Windows "
+"guest."
msgstr ""
# type: textblock
-#: ../tools/virt-df.pl:129
-msgid "Print inodes instead of blocks."
+#: ../tools/virt-win-reg.pl:68
+msgid ""
+"The first parameter is the libvirt guest name or the raw disk image of a "
+"Windows guest."
msgstr ""
-# type: =head1
-#: ../tools/virt-df.pl:458
-msgid "NOTE ABOUT CSV FORMAT"
+# type: textblock
+#: ../tools/virt-win-reg.pl:71
+msgid ""
+"If C<--merge> is I<not> specified, then the chosen registry key is "
+"displayed/exported (recursively). For example:"
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:460
+# type: verbatim
+#: ../tools/virt-win-reg.pl:74
+#, no-wrap
msgid ""
-"Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
-"should be easy to parse, but it is definitely not easy to parse."
+" $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-df.pl:463
-msgid ""
-"Myth: Just split fields at commas. Reality: This does I<not> work "
-"reliably. This example has two columns:"
+#: ../tools/virt-win-reg.pl:76
+msgid "You can also display single values from within registry keys, for example:"
msgstr ""
# type: verbatim
-#: ../tools/virt-df.pl:466
+#: ../tools/virt-win-reg.pl:79
#, no-wrap
msgid ""
-" \"foo,bar\",baz\n"
+" $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
+" $ virt-win-reg Windows7 $cvkey ProductName\n"
+" Windows 7 Enterprise\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-df.pl:468
+#: ../tools/virt-win-reg.pl:83
msgid ""
-"Myth: Read the file one line at a time. Reality: This does I<not> work "
-"reliably. This example has one row:"
+"With C<--merge>, you can merge a textual regedit file into the Windows "
+"Registry:"
msgstr ""
# type: verbatim
-#: ../tools/virt-df.pl:471
+#: ../tools/virt-win-reg.pl:86
#, no-wrap
msgid ""
-" \"foo\n"
-" bar\",baz\n"
+" $ virt-win-reg --merge Windows7 changes.reg\n"
"\n"
msgstr ""
+# type: =head2
+#: ../tools/virt-win-reg.pl:88
+msgid "SUPPORTED SYSTEMS"
+msgstr ""
+
# type: textblock
-#: ../tools/virt-df.pl:474
+#: ../tools/virt-win-reg.pl:90
msgid ""
-"For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
-"packaged in major Linux distributions)."
+"The program currently supports Windows NT-derived guests starting with "
+"Windows XP through to at least Windows 7."
msgstr ""
# type: textblock
-#: ../tools/virt-df.pl:477
+#: ../tools/virt-win-reg.pl:93
msgid ""
-"For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
-"or Python's built-in csv library)."
+"Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
+"C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
+"C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
msgstr ""
# type: textblock
-#: ../tools/virt-df.pl:480
-msgid "Most spreadsheets and databases can import CSV directly."
+#: ../tools/virt-win-reg.pl:97
+msgid ""
+"You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
+"C<HKEY_USERS>."
msgstr ""
# type: textblock
-#: ../tools/virt-df.pl:497 ../tools/virt-edit.pl:343 ../tools/virt-list-partitions.pl:246 ../tools/virt-rescue.pl:247
-msgid "Copyright (C) 2009-2010 Red Hat Inc."
+#: ../tools/virt-win-reg.pl:100
+msgid ""
+"C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
+"time."
+msgstr ""
+
+# type: =head2
+#: ../tools/virt-win-reg.pl:103
+msgid "NOTE"
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:35
-msgid "virt-edit - Edit a file in a virtual machine"
+#: ../tools/virt-win-reg.pl:105
+msgid ""
+"This program is only meant for simple access to the registry. If you want "
+"to do complicated things with the registry, we suggest you download the "
+"Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
+"and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
+"L<hivexregedit(1)>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:39
-#, no-wrap
+# type: =head2
+#: ../tools/virt-win-reg.pl:111
+msgid "ENCODING"
+msgstr ""
+
+# type: textblock
+#: ../tools/virt-win-reg.pl:113
msgid ""
-" virt-edit [--options] domname file\n"
-"\n"
+"C<virt-win-reg> expects that regedit files have already been reencoded in "
+"the local encoding. Usually on Linux hosts, this means UTF-8 with "
+"Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
+"with Windows-style line endings, you may need to reencode the whole file "
+"before or after processing."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:41
-#, no-wrap
+# type: textblock
+#: ../tools/virt-win-reg.pl:119
msgid ""
-" virt-edit [--options] disk.img [disk.img ...] file\n"
-"\n"
+"To reencode a file from Windows format to Linux (before processing it with "
+"the C<--merge> option), you would do something like this:"
msgstr ""
# type: verbatim
-#: ../tools/virt-edit.pl:43
+#: ../tools/virt-win-reg.pl:122
#, no-wrap
msgid ""
-" virt-edit [domname|disk.img] file -e 'expr'\n"
+" iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:47
+#: ../tools/virt-win-reg.pl:124
msgid ""
-"You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
-"you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
-"doing this, but doesn't catch all cases."
+"To go in the opposite direction, after exporting and before sending the file "
+"to a Windows user, do something like this:"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:53
+# type: verbatim
+#: ../tools/virt-win-reg.pl:127
+#, no-wrap
msgid ""
-"C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
-"the named virtual machine (or disk image)."
+" unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:56
-msgid ""
-"If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
-"you should look at the L<guestfish(1)> tool."
+#: ../tools/virt-win-reg.pl:129
+msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:61
-msgid "Edit the named files interactively:"
+#: ../tools/virt-win-reg.pl:131
+msgid ""
+"If you are unsure about the current encoding, use the L<file(1)> command. "
+"Recent versions of Windows regedit.exe produce a UTF-16LE file with "
+"Windows-style (CRLF) line endings, like this:"
msgstr ""
# type: verbatim
-#: ../tools/virt-edit.pl:63
+#: ../tools/virt-win-reg.pl:135
#, no-wrap
msgid ""
-" virt-edit mydomain /boot/grub/grub.conf\n"
+" $ file software.reg\n"
+" software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
+" with CRLF line terminators\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:65
-#, no-wrap
-msgid ""
-" virt-edit mydomain /etc/passwd\n"
-"\n"
+# type: textblock
+#: ../tools/virt-win-reg.pl:139
+msgid "This file would need conversion before you could C<--merge> it."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:67
+#: ../tools/virt-win-reg.pl:143
msgid ""
-"You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
-"below). To change the init default level to 5:"
+"Be careful when passing parameters containing C<\\> (backslash) in the "
+"shell. Usually you will have to use 'single quotes' or double backslashes "
+"(but not both) to protect them from the shell."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:71
-#, no-wrap
-msgid ""
-" virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
-"\n"
+# type: textblock
+#: ../tools/virt-win-reg.pl:147
+msgid "Paths and value names are case-insensitive."
msgstr ""
-# type: =item
-#: ../tools/virt-edit.pl:97
-msgid "B<--backup extension> | B<-b extension>"
+# type: =head2
+#: ../tools/virt-win-reg.pl:149
+msgid "CurrentControlSet etc."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:99
+#: ../tools/virt-win-reg.pl:151
msgid ""
-"Create a backup of the original file I<in the guest disk image>. The backup "
-"has the original filename with C<extension> added."
+"Registry keys like C<CurrentControlSet> don't really exist in the Windows "
+"Registry at the level of the hive file, and therefore you cannot modify "
+"these."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:102
+#: ../tools/virt-win-reg.pl:155
msgid ""
-"Usually the first character of C<extension> would be a dot C<.> so you would "
-"write:"
+"C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
+"circumstances it might refer to another control set. The way to find out is "
+"to look at the C<HKLM\\SYSTEM\\Select> key:"
msgstr ""
# type: verbatim
-#: ../tools/virt-edit.pl:105
+#: ../tools/virt-win-reg.pl:159
#, no-wrap
msgid ""
-" virt-edit -b .orig [etc]\n"
+" # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
+" [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
+" \"Current\"=dword:00000001\n"
+" \"Default\"=dword:00000001\n"
+" \"Failed\"=dword:00000000\n"
+" \"LastKnownGood\"=dword:00000002\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:107
-msgid "By default, no backup file is made."
+#: ../tools/virt-win-reg.pl:166
+msgid "\"Current\" is the one which Windows will choose when it boots."
+msgstr ""
+
+# type: textblock
+#: ../tools/virt-win-reg.pl:168
+msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
msgstr ""
# type: =item
-#: ../tools/virt-edit.pl:125
-msgid "B<--expr EXPR> | B<-e EXPR>"
+#: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
+msgid "B<--debug>"
+msgstr ""
+
+# type: textblock
+#: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
+msgid "Enable debugging messages."
+msgstr ""
+
+# type: =item
+#: ../tools/virt-win-reg.pl:232
+msgid "B<--merge>"
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:127
+#: ../tools/virt-win-reg.pl:234
msgid ""
-"Instead of launching the external editor, non-interactively apply the Perl "
-"expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
-"EDITING> below."
+"In merge mode, this merges a textual regedit file into the Windows Registry "
+"of the virtual machine. If this flag is I<not> given then virt-win-reg "
+"displays or exports Registry entries instead."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:131
+#: ../tools/virt-win-reg.pl:238
msgid ""
-"Be careful to properly quote the expression to prevent it from being altered "
-"by the shell."
+"Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
+"result in disk corruption. However exporting (without this flag) is always "
+"safe."
msgstr ""
-# type: =head1
-#: ../tools/virt-edit.pl:250
-msgid "NON-INTERACTIVE EDITING"
+# type: =item
+#: ../tools/virt-win-reg.pl:246
+msgid "B<--encoding> UTF-16LE|ASCII"
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:252
+#: ../tools/virt-win-reg.pl:248
msgid ""
-"C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
-"administrator can interactively edit the file."
+"When merging (only), you may need to specify the encoding for strings to be "
+"used in the hive file. This is explained in detail in "
+"L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:255
+#: ../tools/virt-win-reg.pl:252
msgid ""
-"There are two ways also to use C<virt-edit> from scripts in order to make "
-"automated edits to files. (Note that although you I<can> use C<virt-edit> "
-"like this, it's less error-prone to write scripts directly using the "
-"libguestfs API and Augeas for configuration file editing.)"
+"The default is to use UTF-16LE, which should work with recent versions of "
+"Windows."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:261
+#: ../tools/virt-win-reg.pl:486
msgid ""
-"The first method is to temporarily set C<$EDITOR> to any script or program "
-"you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
-"update C<tmpfile> in place however it likes."
+"L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
+"L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
+"L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
+"L<Sys::Virt(3)>, L<http://libguestfs.org/>."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:265
+#: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
msgid ""
-"The second method is to use the C<-e> parameter of C<virt-edit> to run a "
-"short Perl snippet in the style of L<sed(1)>. For example to replace all "
-"instances of C<foo> with C<bar> in a file:"
+"When reporting bugs, please enable debugging and capture the I<complete> "
+"output:"
msgstr ""
# type: verbatim
-#: ../tools/virt-edit.pl:269
+#: ../tools/virt-win-reg.pl:504
#, no-wrap
msgid ""
-" virt-edit domname filename -e 's/foo/bar/'\n"
+" export LIBGUESTFS_DEBUG=1\n"
+" virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:271
+#: ../tools/virt-win-reg.pl:507
msgid ""
-"The full power of Perl regular expressions can be used (see L<perlre(1)>). "
-"For example to delete root's password you could do:"
+"Attach /tmp/virt-win-reg.log to a new bug report at "
+"L<https://bugzilla.redhat.com/>"
+msgstr ""
+
+# type: textblock
+#: ../tools/virt-df.pl:36
+msgid "virt-df - Display free space on virtual filesystems"
msgstr ""
# type: verbatim
-#: ../tools/virt-edit.pl:274
+#: ../tools/virt-df.pl:40
#, no-wrap
msgid ""
-" virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
+" virt-df [--options]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:276
-msgid ""
-"What really happens is that the snippet is evaluated as a Perl expression "
-"for each line of the file. The line, including the final C<\\n>, is passed "
-"in C<$_> and the expression should update C<$_> or leave it unchanged."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-edit.pl:281
+# type: verbatim
+#: ../tools/virt-df.pl:42
+#, no-wrap
msgid ""
-"To delete a line, set C<$_> to the empty string. For example, to delete the "
-"C<apache> user account from the password file you can do:"
+" virt-df [--options] domname\n"
+"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-edit.pl:284
+#: ../tools/virt-df.pl:44
#, no-wrap
msgid ""
-" virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
+" virt-df [--options] disk.img [disk.img ...]\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:286
+#: ../tools/virt-df.pl:48
msgid ""
-"To insert a line, prepend or append it to C<$_>. However appending lines to "
-"the end of the file is rather difficult this way since there is no concept "
-"of \"last line of the file\" - your expression just doesn't get called "
-"again. You might want to use the first method (setting C<$EDITOR>) if you "
-"want to do this."
+"C<virt-df> is a command line tool to display free space on virtual machine "
+"filesystems. Unlike other tools, it doesn't just display the amount of "
+"space allocated to a virtual machine, but can look inside the virtual "
+"machine to see how much space is really being used."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:292
+#: ../tools/virt-df.pl:53
msgid ""
-"The variable C<$lineno> contains the current line number. As is "
-"traditional, the first line in the file is number C<1>."
+"It is like the L<df(1)> command, but for virtual machines, except that it "
+"also works for Windows virtual machines."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:295
+#: ../tools/virt-df.pl:56
msgid ""
-"The return value from the expression is ignored, but the expression may call "
-"C<die> in order to abort the whole program, leaving the original file "
-"untouched."
+"If used without any arguments, C<virt-df> checks with libvirt to get a list "
+"of all active and inactive guests, and performs a C<df>-type operation on "
+"each one in turn, printing out the results."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:299
+#: ../tools/virt-df.pl:60
msgid ""
-"Remember when matching the end of a line that C<$_> may contain the final "
-"C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
-"newline then neither of these. Thus to match or substitute some text at the "
-"end of a line, use this regular expression:"
+"If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
+"either the single named libvirt domain, or on the disk image(s) listed on "
+"the command line (which must all belong to a single VM). In this mode (with "
+"arguments), C<virt-df> will I<only work for a single guest>. If you want to "
+"run on multiple guests, then you have to invoke C<virt-df> multiple times."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:304
-#, no-wrap
+# type: textblock
+#: ../tools/virt-df.pl:67
msgid ""
-" /some text(\\r?\\n)?$/\n"
-"\n"
+"Use the C<--csv> option to get a format which can be easily parsed by other "
+"programs. Other options are mostly similar to standard C<df> options. See "
+"below for the complete list."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:306
-msgid ""
-"Alternately, use the perl C<chomp> function, being careful not to chomp "
-"C<$_> itself (since that would remove all newlines from the file):"
+# type: =item
+#: ../tools/virt-df.pl:107
+msgid "B<--csv>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:310
-#, no-wrap
+# type: textblock
+#: ../tools/virt-df.pl:109
msgid ""
-" my $m = $_; chomp $m; $m =~ /some text$/\n"
-"\n"
+"Write out the results in CSV format (comma-separated values). This format "
+"can be imported easily into databases and spreadsheets, but read L</NOTE "
+"ABOUT CSV FORMAT> below."
msgstr ""
# type: =item
-#: ../tools/virt-edit.pl:316
-msgid "C<EDITOR>"
+#: ../tools/virt-df.pl:134
+msgid "B<--human-readable> | B<-h>"
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:318
-msgid ""
-"If set, this string is used as the editor. It may contain arguments, "
-"eg. C<\"emacs -nw\">"
+#: ../tools/virt-df.pl:136
+msgid "Print sizes in human-readable format."
msgstr ""
# type: textblock
-#: ../tools/virt-edit.pl:321
-msgid "If not set, C<vi> is used."
+#: ../tools/virt-df.pl:138
+msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:327
-msgid ""
-"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
-"L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
-"L<perl(1)>, L<perlre(1)>."
+# type: =item
+#: ../tools/virt-df.pl:144
+msgid "B<--inodes> | B<-i>"
msgstr ""
# type: textblock
-#: ../tools/virt-list-filesystems.pl:32
-msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
+#: ../tools/virt-df.pl:146
+msgid "Print inodes instead of blocks."
msgstr ""
-# type: verbatim
-#: ../tools/virt-list-filesystems.pl:36
-#, no-wrap
-msgid ""
-" virt-list-filesystems [--options] domname\n"
-"\n"
+# type: =item
+#: ../tools/virt-df.pl:152
+msgid "B<--one-per-guest>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-list-filesystems.pl:38
-#, no-wrap
+# type: textblock
+#: ../tools/virt-df.pl:154
msgid ""
-" virt-list-filesystems [--options] disk.img [disk.img ...]\n"
-"\n"
+"Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
+"disks from several guests to a single libguestfs appliance."
msgstr ""
# type: textblock
-#: ../tools/virt-list-filesystems.pl:42
-msgid ""
-"C<virt-list-filesystems> is a command line tool to list the filesystems that "
-"are contained in a virtual machine or disk image."
+#: ../tools/virt-df.pl:157
+msgid "You might use this option in the following circumstances:"
msgstr ""
# type: textblock
-#: ../tools/virt-list-filesystems.pl:46
+#: ../tools/virt-df.pl:163
msgid ""
-"C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
-"functionality. For more complex cases you should look at the "
-"L<guestfish(1)> tool."
-msgstr ""
-
-# type: =item
-#: ../tools/virt-list-filesystems.pl:86 ../tools/virt-list-partitions.pl:95 ../tools/virt-ls.pl:115
-msgid "B<-l> | B<--long>"
+"If you think an untrusted guest might actively try to exploit the libguestfs "
+"appliance kernel, then this prevents one guest from interfering with the "
+"stats printed for another guest."
msgstr ""
# type: textblock
-#: ../tools/virt-list-filesystems.pl:88
+#: ../tools/virt-df.pl:169
msgid ""
-"With this option, C<virt-list-filesystems> displays the type of each "
-"filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
+"If the kernel has a bug which stops it from accessing a filesystem in one "
+"guest (see for example RHBZ#635373) then this allows libguestfs to continue "
+"and report stats for further guests."
msgstr ""
# type: =item
-#: ../tools/virt-list-filesystems.pl:95
-msgid "B<-a> | B<--all>"
+#: ../tools/virt-df.pl:180
+msgid "B<--uuid>"
msgstr ""
# type: textblock
-#: ../tools/virt-list-filesystems.pl:97
+#: ../tools/virt-df.pl:182
msgid ""
-"Normally we only show mountable filesystems. If this option is given then "
-"swap devices are shown too."
+"Print UUIDs instead of names. This is useful for following a guest even "
+"when the guest is migrated or renamed, or when two guests happen to have the "
+"same name."
msgstr ""
# type: textblock
-#: ../tools/virt-list-filesystems.pl:193
+#: ../tools/virt-df.pl:186
msgid ""
-"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
-"L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
-"L<Sys::Virt(3)>, L<http://libguestfs.org/>."
+"Note that only domains that we fetch from libvirt come with UUIDs. For disk "
+"images, we still print the disk image name even when this option is "
+"specified."
+msgstr ""
+
+# type: =head1
+#: ../tools/virt-df.pl:609
+msgid "NOTE ABOUT CSV FORMAT"
msgstr ""
# type: textblock
-#: ../tools/virt-list-partitions.pl:32
-msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
+#: ../tools/virt-df.pl:611
+msgid ""
+"Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
+"should be easy to parse, but it is definitely not easy to parse."
msgstr ""
-# type: verbatim
-#: ../tools/virt-list-partitions.pl:36
-#, no-wrap
+# type: textblock
+#: ../tools/virt-df.pl:614
msgid ""
-" virt-list-partitions [--options] domname\n"
-"\n"
+"Myth: Just split fields at commas. Reality: This does I<not> work "
+"reliably. This example has two columns:"
msgstr ""
# type: verbatim
-#: ../tools/virt-list-partitions.pl:38
+#: ../tools/virt-df.pl:617
#, no-wrap
msgid ""
-" virt-list-partitions [--options] disk.img [disk.img ...]\n"
+" \"foo,bar\",baz\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-list-partitions.pl:42
+#: ../tools/virt-df.pl:619
msgid ""
-"C<virt-list-partitions> is a command line tool to list the partitions that "
-"are contained in a virtual machine or disk image. It is mainly useful as a "
-"first step to using L<virt-resize(1)>."
+"Myth: Read the file one line at a time. Reality: This does I<not> work "
+"reliably. This example has one row:"
msgstr ""
-# type: textblock
-#: ../tools/virt-list-partitions.pl:47
+# type: verbatim
+#: ../tools/virt-df.pl:622
+#, no-wrap
msgid ""
-"C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
-"functionality. For more complex cases you should look at the "
-"L<guestfish(1)> tool."
-msgstr ""
-
-# type: =item
-#: ../tools/virt-list-partitions.pl:87
-msgid "B<-h> | B<--human-readable>"
+" \"foo\n"
+" bar\",baz\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-list-partitions.pl:89
-msgid "Show sizes in human-readable form (eg. \"1G\")."
+#: ../tools/virt-df.pl:625
+msgid ""
+"For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
+"packaged in major Linux distributions)."
msgstr ""
# type: textblock
-#: ../tools/virt-list-partitions.pl:97
+#: ../tools/virt-df.pl:628
msgid ""
-"With this option, C<virt-list-partitions> displays the type and size of each "
-"partition too (where \"type\" means C<ext3>, C<pv> etc.)"
-msgstr ""
-
-# type: =item
-#: ../tools/virt-list-partitions.pl:104
-msgid "B<-t> | B<--total>"
+"For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
+"or Python's built-in csv library)."
msgstr ""
# type: textblock
-#: ../tools/virt-list-partitions.pl:106
-msgid "Display the total size of each block device (as a separate row or rows)."
+#: ../tools/virt-df.pl:631
+msgid "Most spreadsheets and databases can import CSV directly."
msgstr ""
# type: textblock
-#: ../tools/virt-list-partitions.pl:231
+#: ../tools/virt-df.pl:642
msgid ""
-"L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, "
-"L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
+"L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
"L<Sys::Virt(3)>, L<http://libguestfs.org/>."
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:35
+#: ../tools/virt-ls.pl:34
msgid "virt-ls - List files in a virtual machine"
msgstr ""
# type: verbatim
-#: ../tools/virt-ls.pl:39
+#: ../tools/virt-ls.pl:38
#, no-wrap
msgid ""
" virt-ls [--options] domname directory\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-ls.pl:41
+#: ../tools/virt-ls.pl:40
#, no-wrap
msgid ""
" virt-ls [--options] disk.img [disk.img ...] directory\n"
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:45
+#: ../tools/virt-ls.pl:44
msgid ""
"C<virt-ls> is a command line tool to list the names of files in a directory "
"inside a virtual machine or disk image."
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:48
+#: ../tools/virt-ls.pl:47
msgid ""
"C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
"For more complex cases you should look at the L<guestfish(1)> tool."
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:52
+#: ../tools/virt-ls.pl:51
msgid ""
"C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
"simple listing is like the ordinary L<ls(1)> command:"
msgstr ""
# type: verbatim
-#: ../tools/virt-ls.pl:55
+#: ../tools/virt-ls.pl:54
#, no-wrap
msgid ""
" $ virt-ls myguest /\n"
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:60
+#: ../tools/virt-ls.pl:59
msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
msgstr ""
# type: verbatim
-#: ../tools/virt-ls.pl:62
+#: ../tools/virt-ls.pl:61
#, no-wrap
msgid ""
" $ virt-ls -l myguest /\n"
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:68
+#: ../tools/virt-ls.pl:67
msgid ""
"With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
"and directories recursively:"
msgstr ""
# type: verbatim
-#: ../tools/virt-ls.pl:71
+#: ../tools/virt-ls.pl:70
#, no-wrap
msgid ""
" $ virt-ls -R myguest /tmp\n"
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:76
+#: ../tools/virt-ls.pl:75
msgid ""
"You I<cannot> combine these options. To do more complicated things, use "
"L<guestfish(1)>."
msgstr ""
# type: =item
-#: ../tools/virt-ls.pl:117
+#: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103 ../tools/virt-list-partitions.pl:112
+msgid "B<-l> | B<--long>"
+msgstr ""
+
+# type: =item
+#: ../tools/virt-ls.pl:133
msgid "B<-R> | B<--recursive>"
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:119
+#: ../tools/virt-ls.pl:135
msgid ""
"Select the mode. With neither of these options, C<virt-ls> produces a "
"simple, flat list of the files in the named directory."
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:122
+#: ../tools/virt-ls.pl:138
msgid ""
"C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
"like the plain C<ls -l> command)."
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:125
+#: ../tools/virt-ls.pl:141
msgid ""
"C<virt-ls -R> produces a recursive list of files starting at the named "
-"directory. See the documentation for the C<guestfs_find> command "
-"L<guestfs(3)> for precise details."
+"directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
+"details."
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:129
+#: ../tools/virt-ls.pl:145
msgid "You cannot combine these options."
msgstr ""
# type: textblock
-#: ../tools/virt-ls.pl:212
+#: ../tools/virt-ls.pl:234
msgid ""
"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
"L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:37
-msgid "virt-make-fs - Make a filesystem from a tar archive or files"
-msgstr ""
-
-# type: verbatim
-#: ../tools/virt-make-fs.pl:41
-#, no-wrap
-msgid ""
-" virt-make-fs [--options] input.tar output.img\n"
-"\n"
-msgstr ""
-
-# type: verbatim
-#: ../tools/virt-make-fs.pl:43
-#, no-wrap
-msgid ""
-" virt-make-fs [--options] input.tar.gz output.img\n"
-"\n"
-msgstr ""
-
-# type: verbatim
-#: ../tools/virt-make-fs.pl:45
-#, no-wrap
-msgid ""
-" virt-make-fs [--options] directory output.img\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-make-fs.pl:49
-msgid ""
-"Virt-make-fs is a command line tool for creating a filesystem from a tar "
-"archive or some files in a directory. It is similar to tools like "
-"L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
-"it can create common filesystem types like ext2/3 or NTFS, which can be "
-"useful if you want to attach these filesystems to existing virtual machines "
-"(eg. to import large amounts of read-only data to a VM)."
+#: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:298
+msgid "Copyright (C) 2009 Red Hat Inc."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:57
-msgid "Basic usage is:"
+#: ../tools/virt-resize.pl:42
+msgid "virt-resize - Resize a virtual machine disk"
msgstr ""
# type: verbatim
-#: ../tools/virt-make-fs.pl:59
+#: ../tools/virt-resize.pl:46
#, no-wrap
msgid ""
-" virt-make-fs input output\n"
+" virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
+" [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
+" [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:61
+#: ../tools/virt-resize.pl:52
msgid ""
-"where C<input> is either a directory containing files that you want to add, "
-"or a tar archive (either uncompressed tar or gzip-compressed tar); and "
-"C<output> is a disk image. The input type is detected automatically. The "
-"output disk image defaults to a raw ext2 image unless you specify extra "
-"flags (see L</OPTIONS> below)."
-msgstr ""
-
-# type: =head2
-#: ../tools/virt-make-fs.pl:67
-msgid "EXTRA SPACE"
+"Virt-resize is a tool which can resize a virtual machine disk, making it "
+"larger or smaller overall, and resizing or deleting any partitions contained "
+"within."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:69
+#: ../tools/virt-resize.pl:56
msgid ""
-"Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
-"the files that it contains, but might have extra space. Depending on how "
-"you are going to use the output, you might think this extra space is wasted "
-"and want to minimize it, or you might want to leave space so that more files "
-"can be added later. Virt-make-fs defaults to minimizing the extra space, "
-"but you can use the C<--size> flag to leave space in the filesystem if you "
-"want it."
+"Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
+"not> be used on live virtual machines - for consistent results, shut the "
+"virtual machine down before resizing it."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:77
+#: ../tools/virt-resize.pl:60
msgid ""
-"An alternative way to leave extra space but not make the output image any "
-"bigger is to use an alternative disk image format (instead of the default "
-"\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
-"image format (check your hypervisor supports this before using it). This "
-"allows you to choose a large C<--size> but the extra space won't actually be "
-"allocated in the image until you try to store something in it."
+"If you are not familiar with the associated tools: "
+"L<virt-list-partitions(1)>, L<virt-list-filesystems(1)> and L<virt-df(1)>, "
+"we recommend you go and read those manual pages first."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:85
+#: ../tools/virt-resize.pl:68
msgid ""
-"Don't forget that you can also use local commands including L<resize2fs(8)> "
-"and L<virt-resize(1)> to resize existing filesystems, or rerun "
-"virt-make-resize to build another image from scratch."
+"Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
+"fill the extra 5GB of space."
msgstr ""
-# type: =head3
-#: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
-msgid "EXAMPLE"
+# type: verbatim
+#: ../tools/virt-resize.pl:71
+#, no-wrap
+msgid ""
+" truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
+" virt-list-partitions -lht olddisk\n"
+" # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
+" virt-resize --expand /dev/sda2 olddisk newdisk\n"
+"\n"
+msgstr ""
+
+# type: textblock
+#: ../tools/virt-resize.pl:76
+msgid ""
+"As above, but make the /boot partition 200MB bigger, while giving the "
+"remaining space to /dev/sda2:"
msgstr ""
# type: verbatim
-#: ../tools/virt-make-fs.pl:91
+#: ../tools/virt-resize.pl:79
#, no-wrap
msgid ""
-" virt-make-fs --format=qcow2 --size=+200M input output.img\n"
+" virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
"\n"
msgstr ""
-# type: =head2
-#: ../tools/virt-make-fs.pl:93
-msgid "FILESYSTEM TYPE"
+# type: textblock
+#: ../tools/virt-resize.pl:81
+msgid "As above, but the output format will be uncompressed qcow2:"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:95
+# type: verbatim
+#: ../tools/virt-resize.pl:83
+#, no-wrap
msgid ""
-"The default filesystem type is C<ext2>. Just about any filesystem type that "
-"libguestfs supports can be used (but I<not> read-only formats like "
-"ISO9660). Here are some of the more common choices:"
+" qemu-img create -f qcow2 newdisk.qcow2 15G\n"
+" virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
+"\n"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:101
-msgid "I<ext3>"
+# type: =head1
+#: ../tools/virt-resize.pl:86
+msgid "DETAILED USAGE"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:103
-msgid ""
-"Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
-"you are not going to use the filesystem in a way that requires the journal, "
-"then this is just wasted overhead."
+# type: =head2
+#: ../tools/virt-resize.pl:88
+msgid "EXPANDING A VIRTUAL MACHINE DISK"
msgstr ""
# type: =item
-#: ../tools/virt-make-fs.pl:107
-msgid "I<ntfs> or I<vfat>"
+#: ../tools/virt-resize.pl:92
+msgid "1. Shut down the virtual machine"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:109
-msgid "Useful if exporting data to a Windows guest."
+# type: =item
+#: ../tools/virt-resize.pl:94
+msgid "2. Locate input disk image"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:111
+#: ../tools/virt-resize.pl:96
msgid ""
-"I<Note for vfat>: The tar archive or local directory must only contain files "
-"which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
-"program running within libguestfs is unable to change the ownership of "
-"non-root files, since vfat itself does not support this."
+"Locate the input disk image (ie. the file or device on the host containing "
+"the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
+"dumpxml> like this to find the disk image name:"
+msgstr ""
+
+# type: verbatim
+#: ../tools/virt-resize.pl:100
+#, no-wrap
+msgid ""
+" # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
+" Found 1 nodes:\n"
+" -- NODE --\n"
+" <source dev=\"/dev/vg/lv_guest\" />\n"
+"\n"
msgstr ""
# type: =item
-#: ../tools/virt-make-fs.pl:116
-msgid "I<minix>"
+#: ../tools/virt-resize.pl:105
+msgid "3. Look at current sizing"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:118
-msgid ""
-"Lower overhead than C<ext2>, but certain limitations on filename length and "
-"total filesystem size."
+#: ../tools/virt-resize.pl:107
+msgid "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
msgstr ""
# type: verbatim
-#: ../tools/virt-make-fs.pl:125
+#: ../tools/virt-resize.pl:110
#, no-wrap
msgid ""
-" virt-make-fs --type=minix input minixfs.img\n"
+" # virt-list-partitions -lht /dev/vg/lv_guest\n"
+" /dev/sda1 ext3 101.9M\n"
+" /dev/sda2 pv 7.9G\n"
+" /dev/sda device 8.0G\n"
"\n"
msgstr ""
-# type: =head2
-#: ../tools/virt-make-fs.pl:127
-msgid "TO PARTITION OR NOT TO PARTITION"
+# type: textblock
+#: ../tools/virt-resize.pl:115
+msgid ""
+"(This example is a virtual machine with an 8 GB disk which we would like to "
+"expand up to 10 GB)."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:129
-msgid "Optionally virt-make-fs can add a partition table to the output disk."
+# type: =item
+#: ../tools/virt-resize.pl:118
+msgid "4. Create output disk"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:131
+#: ../tools/virt-resize.pl:120
msgid ""
-"Adding a partition can make the disk image more compatible with certain "
-"virtualized operating systems which don't expect to see a filesystem "
-"directly located on a block device (Linux doesn't care and will happily "
-"handle both types)."
+"Virt-resize cannot do in-place disk modifications. You have to have space "
+"to store the resized output disk."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:136
+#: ../tools/virt-resize.pl:123
+msgid "To store the resized disk image in a file, create a file of a suitable size:"
+msgstr ""
+
+# type: verbatim
+#: ../tools/virt-resize.pl:126
+#, no-wrap
msgid ""
-"On the other hand, if you have a partition table then the output image is no "
-"longer a straight filesystem. For example you cannot run L<fsck(8)> "
-"directly on a partitioned disk image. (However libguestfs tools such as "
-"L<guestfish(1)> and L<virt-resize(1)> can still be used)."
+" # rm -f outdisk\n"
+" # truncate -s 10G outdisk\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:144
-msgid "Add an MBR partition:"
+#: ../tools/virt-resize.pl:129
+msgid "Or use L<lvcreate(1)> to create a logical volume:"
msgstr ""
# type: verbatim
-#: ../tools/virt-make-fs.pl:146
+#: ../tools/virt-resize.pl:131
#, no-wrap
msgid ""
-" virt-make-fs --partition -- input disk.img\n"
+" # lvcreate -L 10G -n lv_name vg_name\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:148
-msgid ""
-"If the output disk image could be terabyte-sized or larger, it's better to "
-"use an EFI/GPT-compatible partition table:"
+#: ../tools/virt-resize.pl:133
+msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
msgstr ""
# type: verbatim
-#: ../tools/virt-make-fs.pl:151
+#: ../tools/virt-resize.pl:135
#, no-wrap
msgid ""
-" virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
+" # virsh pool-list\n"
+" # virsh vol-create-as poolname newvol 10G\n"
"\n"
msgstr ""
# type: =item
-#: ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:196
-msgid "B<--debug>"
+#: ../tools/virt-resize.pl:138
+msgid "5. Resize"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:179
-msgid "Enable debugging information."
+#: ../tools/virt-resize.pl:140
+msgid ""
+"virt-resize takes two mandatory parameters, the input disk (eg. device or "
+"file) and the output disk. The output disk is the one created in the "
+"previous step."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:185
-msgid "B<--size=E<lt>NE<gt>>"
+# type: verbatim
+#: ../tools/virt-resize.pl:144
+#, no-wrap
+msgid ""
+" # virt-resize indisk outdisk\n"
+"\n"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:187
-msgid "B<--size=+E<lt>NE<gt>>"
+# type: textblock
+#: ../tools/virt-resize.pl:146
+msgid ""
+"This command just copies disk image C<indisk> to disk image C<outdisk> "
+"I<without> resizing or changing any existing partitions. If C<outdisk> is "
+"larger, then an extra, empty partition is created at the end of the disk "
+"covering the extra space. If C<outdisk> is smaller, then it will give an "
+"error."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:189
-msgid "B<-s E<lt>NE<gt>>"
+# type: textblock
+#: ../tools/virt-resize.pl:152
+msgid ""
+"More realistically you'd want to expand existing partitions in the disk "
+"image by passing extra options (for the full list see the L</OPTIONS> "
+"section below)."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:191
-msgid "B<-s +E<lt>NE<gt>>"
+# type: textblock
+#: ../tools/virt-resize.pl:156
+msgid ""
+"L</--expand> is the most useful option. It expands the named partition "
+"within the disk to fill any extra space:"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:193
-msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
+# type: verbatim
+#: ../tools/virt-resize.pl:159
+#, no-wrap
+msgid ""
+" # virt-resize --expand /dev/sda2 indisk outdisk\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:196
+#: ../tools/virt-resize.pl:161
msgid ""
-"If this option is I<not> given, then the output image will be just large "
-"enough to contain all the files, with not much wasted space."
+"(In this case, an extra partition is I<not> created at the end of the disk, "
+"because there will be no unused space)."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:199
+#: ../tools/virt-resize.pl:164
msgid ""
-"To choose a fixed size output disk, specify an absolute number followed by "
-"b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
-"Petabytes or Exabytes. This must be large enough to contain all the input "
-"files, else you will get an error."
+"L</--resize> is the other commonly used option. The following would "
+"increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
+"rest of the available space:"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:204
+# type: verbatim
+#: ../tools/virt-resize.pl:168
+#, no-wrap
msgid ""
-"To leave extra space, specify C<+> (plus sign) and a number followed by "
-"b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
-"Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
-"the input files, and (approximately) an extra 200 MB free space."
+" # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
+" indisk outdisk\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:210
+#: ../tools/virt-resize.pl:171
msgid ""
-"Note that virt-make-fs estimates free space, and therefore will not produce "
-"filesystems containing precisely the free space requested. (It is much more "
-"expensive and time-consuming to produce a filesystem which has precisely the "
-"desired free space)."
+"If the expanded partition in the image contains a filesystem or LVM PV, then "
+"if virt-resize knows how, it will resize the contents, the equivalent of "
+"calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
+"L<ntfsresize(8)>. However virt-resize does not know how to resize some "
+"filesystems, so you would have to online resize them after booting the "
+"guest. And virt-resize also does not resize anything inside an LVM PV, it "
+"just resizes the PV itself and leaves the user to resize any LVs inside that "
+"PV as desired."
+msgstr ""
+
+# type: textblock
+#: ../tools/virt-resize.pl:180
+msgid "Other options are covered below."
msgstr ""
# type: =item
-#: ../tools/virt-make-fs.pl:219
-msgid "B<--format=E<lt>fmtE<gt>>"
+#: ../tools/virt-resize.pl:182
+msgid "6. Test"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:221
-msgid "B<-F E<lt>fmtE<gt>>"
+# type: textblock
+#: ../tools/virt-resize.pl:184
+msgid "Thoroughly test the new disk image I<before> discarding the old one."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:223
-msgid "Choose the output disk image format."
+#: ../tools/virt-resize.pl:186
+msgid "If you are using libvirt, edit the XML to point at the new disk:"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:225
-msgid "The default is C<raw> (raw disk image)."
+# type: verbatim
+#: ../tools/virt-resize.pl:188
+#, no-wrap
+msgid ""
+" # virsh edit guestname\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:227
+#: ../tools/virt-resize.pl:190
msgid ""
-"For other choices, see the L<qemu-img(1)> manpage. The only other choice "
-"that would really make sense here is C<qcow2>."
+"Change E<lt>source ...E<gt>, see "
+"L<http://libvirt.org/formatdomain.html#elementsDisks>"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:234
-msgid "B<--type=E<lt>fsE<gt>>"
+# type: textblock
+#: ../tools/virt-resize.pl:193
+msgid "Then start up the domain with the new, resized disk:"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:236
-msgid "B<-t E<lt>fsE<gt>>"
+# type: verbatim
+#: ../tools/virt-resize.pl:195
+#, no-wrap
+msgid ""
+" # virsh start guestname\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:238
-msgid "Choose the output filesystem type."
+#: ../tools/virt-resize.pl:197
+msgid ""
+"and check that it still works. See also the L</NOTES> section below for "
+"additional information."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:240
-msgid "The default is C<ext2>."
+# type: =item
+#: ../tools/virt-resize.pl:200
+msgid "7. Resize LVs etc inside the guest"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:242
-msgid "Any filesystem which is supported read-write by libguestfs can be used here."
+#: ../tools/virt-resize.pl:202
+msgid "(This can also be done offline using L<guestfish(1)>)"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:249
-msgid "B<--partition>"
+# type: textblock
+#: ../tools/virt-resize.pl:204
+msgid ""
+"Once the guest has booted you should see the new space available, at least "
+"for filesystems that virt-resize knows how to resize, and for PVs. The user "
+"may need to resize LVs inside PVs, and also resize filesystem types that "
+"virt-resize does not know how to expand."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:251
-msgid "B<--partition=E<lt>parttypeE<gt>>"
+# type: =head2
+#: ../tools/virt-resize.pl:211
+msgid "SHRINKING A VIRTUAL MACHINE DISK"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:253
+#: ../tools/virt-resize.pl:213
msgid ""
-"If specified, this flag adds an MBR partition table to the output disk "
-"image."
+"Shrinking is somewhat more complex than expanding, and only an overview is "
+"given here."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:256
+#: ../tools/virt-resize.pl:216
msgid ""
-"You can change the partition table type, eg. C<--partition=gpt> for large "
-"disks."
+"Firstly virt-resize will not attempt to shrink any partition content (PVs, "
+"filesystems). The user has to shrink content before passing the disk image "
+"to virt-resize, and virt-resize will check that the content has been shrunk "
+"properly."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:259
-msgid ""
-"Note that if you just use a lonesome C<--partition>, the Perl option parser "
-"might consider the next parameter to be the partition type. For example:"
+#: ../tools/virt-resize.pl:221
+msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:263
-#, no-wrap
+# type: textblock
+#: ../tools/virt-resize.pl:223
msgid ""
-" virt-make-fs --partition input.tar ...\n"
-"\n"
+"After shrinking PVs and filesystems, shut down the guest, and proceed with "
+"steps 3 and 4 above to allocate a new disk image."
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:265
-msgid ""
-"would cause virt-make-fs to think you wanted to use a partition type of "
-"C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
-"dash) between options and the input file argument:"
+#: ../tools/virt-resize.pl:226
+msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:269
-#, no-wrap
-msgid ""
-" virt-make-fs --partition -- input.tar ...\n"
-"\n"
+# type: =head2
+#: ../tools/virt-resize.pl:229
+msgid "IGNORING OR DELETING PARTITIONS"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:529
+#: ../tools/virt-resize.pl:231
msgid ""
-"L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
-"L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
-"L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
+"virt-resize also gives a convenient way to ignore or delete partitions when "
+"copying from the input disk to the output disk. Ignoring a partition speeds "
+"up the copy where you don't care about the existing contents of a "
+"partition. Deleting a partition removes it completely, but note that it "
+"also renumbers any partitions after the one which is deleted, which can "
+"leave some guests unbootable."
+msgstr ""
+
+# type: =head2
+#: ../tools/virt-resize.pl:238
+msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:543 ../tools/virt-win-reg.pl:478
+#: ../tools/virt-resize.pl:240
msgid ""
-"When reporting bugs, please enable debugging and capture the I<complete> "
-"output:"
+"If the input disk is in qcow2 format, then you may prefer that the output is "
+"in qcow2 format as well. Alternately, virt-resize can convert the format on "
+"the fly. The output format is simply determined by the format of the empty "
+"output container that you provide. Thus to create qcow2 output, use:"
msgstr ""
# type: verbatim
-#: ../tools/virt-make-fs.pl:546
+#: ../tools/virt-resize.pl:246
#, no-wrap
msgid ""
-" export LIBGUESTFS_DEBUG=1\n"
-" virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
+" qemu-img create [-c] -f qcow2 outdisk [size]\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-make-fs.pl:549
-msgid ""
-"Attach /tmp/virt-make-fs.log to a new bug report at "
-"L<https://bugzilla.redhat.com/>"
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-make-fs.pl:558 ../tools/virt-resize.pl:1413 ../tools/virt-win-reg.pl:493
-msgid "Copyright (C) 2010 Red Hat Inc."
+#: ../tools/virt-resize.pl:248
+msgid "instead of the truncate command (use C<-c> for a compressed disk)."
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:33
-msgid "virt-rescue - Run a rescue shell on a virtual machine"
+#: ../tools/virt-resize.pl:250
+msgid "Similarly, to get non-sparse raw output use:"
msgstr ""
# type: verbatim
-#: ../tools/virt-rescue.pl:37
+#: ../tools/virt-resize.pl:252
#, no-wrap
msgid ""
-" virt-rescue [--options] domname\n"
+" fallocate -l size outdisk\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-rescue.pl:39
-#, no-wrap
+# type: textblock
+#: ../tools/virt-resize.pl:254
msgid ""
-" virt-rescue [--options] disk.img [disk.img ...]\n"
-"\n"
+"(on older systems that don't have the L<fallocate(1)> command use C<dd "
+"if=/dev/zero of=outdisk bs=1M count=..>)"
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:43
-msgid ""
-"You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
-"probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
-"you from doing this, but doesn't catch all cases."
+#: ../tools/virt-resize.pl:267
+msgid "Display help."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:47
-msgid ""
-"However if you use the I<--ro> (read only) option, then you can attach a "
-"shell to a live virtual machine. The results might be strange or "
-"inconsistent at times but you won't get disk corruption."
+# type: =item
+#: ../tools/virt-resize.pl:281
+msgid "B<--resize part=size>"
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:53
+#: ../tools/virt-resize.pl:283
msgid ""
-"virt-rescue is like a Rescue CD, but for virtual machines, and without the "
-"need for a CD. virt-rescue gives you a rescue shell and some simple "
-"recovery tools which you can use to examine or rescue a virtual machine or "
-"disk image."
+"Resize the named partition (expanding or shrinking it) so that it has the "
+"given size."
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:58
+#: ../tools/virt-resize.pl:286
msgid ""
-"You can run virt-rescue on any virtual machine known to libvirt, or directly "
-"on disk image(s):"
+"C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
+"mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
+"Exabytes; or as a percentage of the current size; or as a relative number or "
+"percentage. For example:"
msgstr ""
# type: verbatim
-#: ../tools/virt-rescue.pl:61
+#: ../tools/virt-resize.pl:291
#, no-wrap
msgid ""
-" virt-rescue GuestName\n"
+" --resize /dev/sda2=10G\n"
"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-rescue.pl:63
+#: ../tools/virt-resize.pl:293
#, no-wrap
msgid ""
-" virt-rescue --ro /path/to/disk.img\n"
+" --resize /dev/sda4=90%\n"
"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-rescue.pl:65
+#: ../tools/virt-resize.pl:295
#, no-wrap
msgid ""
-" virt-rescue /dev/sdc\n"
+" --resize /dev/sda2=+1G\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:67
-msgid "For live VMs you I<must> use the --ro option."
+# type: verbatim
+#: ../tools/virt-resize.pl:297
+#, no-wrap
+msgid ""
+" --resize /dev/sda2=-200M\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:69
+# type: verbatim
+#: ../tools/virt-resize.pl:299
+#, no-wrap
msgid ""
-"When you run virt-rescue on a virtual machine or disk image, you are placed "
-"in an interactive bash shell where you can use many ordinary Linux "
-"commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
-"appliance. You must mount the virtual machine's filesystems by hand. There "
-"is an empty directory called C</sysroot> where you can mount filesystems."
+" --resize /dev/sda1=+128K\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:76
+# type: verbatim
+#: ../tools/virt-resize.pl:301
+#, no-wrap
msgid ""
-"In the example below, we list logical volumes, then choose one to mount "
-"under C</sysroot>:"
+" --resize /dev/sda1=+10%\n"
+"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-rescue.pl:79
+#: ../tools/virt-resize.pl:303
#, no-wrap
msgid ""
-" ><rescue> lvs\n"
-" LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
-" lv_root vg_f11x64 -wi-a- 8.83G\n"
-" lv_swap vg_f11x64 -wi-a- 992.00M\n"
-" ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
-" ><rescue> ls /sysroot\n"
+" --resize /dev/sda1=-10%\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:86
+#: ../tools/virt-resize.pl:305
msgid ""
-"If you don't know what filesystems are available on the virtual machine then "
-"you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
-msgstr ""
-
-# type: =head1
-#: ../tools/virt-rescue.pl:90 ../tools/virt-resize.pl:1350
-msgid "NOTES"
+"You can increase the size of any partition. Virt-resize will expand the "
+"direct content of the partition if it knows how (see C<--expand> below)."
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:92
+#: ../tools/virt-resize.pl:309
msgid ""
-"Virt-rescue can be used on I<any> disk image file or device, not just a "
-"virtual machine. For example you can use it on a blank file if you want to "
-"partition that file (although we would recommend using L<guestfish(1)> "
-"instead as it is more suitable for this purpose). You can even use "
-"virt-rescue on things like SD cards."
+"You can only I<decrease> the size of partitions that contain filesystems or "
+"PVs which have already been shrunk. Virt-resize will check this has been "
+"done before proceeding, or else will print an error (see also "
+"C<--resize-force>)."
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:98
-msgid ""
-"This tool is just designed for quick interactive hacking on a virtual "
-"machine. For more structured access to a virtual machine disk image, you "
-"should use L<guestfs(3)>. To get a structured shell that you can use to "
-"make scripted changes to guests, use L<guestfish(1)>."
+#: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406 ../tools/virt-resize.pl:423
+msgid "You can give this option multiple times."
msgstr ""
# type: =item
-#: ../tools/virt-rescue.pl:127
-msgid "B<--append kernelopts>"
+#: ../tools/virt-resize.pl:320
+msgid "B<--resize-force part=size>"
+msgstr ""
+
+# type: textblock
+#: ../tools/virt-resize.pl:322
+msgid ""
+"This is the same as C<--resize> except that it will let you decrease the "
+"size of any partition. Generally this means you will lose any data which "
+"was at the end of the partition you shrink, but you may not care about that "
+"(eg. if shrinking an unused partition, or if you can easily recreate it such "
+"as a swap partition)."
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:129
-msgid "Pass additional options to the rescue kernel."
+#: ../tools/virt-resize.pl:328
+msgid "See also the C<--ignore> option."
msgstr ""
# type: =item
-#: ../tools/virt-rescue.pl:147
-msgid "B<--memsize MB> | B<-m MB>"
+#: ../tools/virt-resize.pl:334
+msgid "B<--expand part>"
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:149
+#: ../tools/virt-resize.pl:336
msgid ""
-"Change the amount of memory allocated to the rescue system. The default is "
-"set by libguestfs and is small but adequate for running system tools. The "
-"occasional program might need more memory. The parameter is specified in "
-"megabytes."
+"Expand the named partition so it uses up all extra space (space left over "
+"after any other resize changes that you request have been done)."
msgstr ""
-# type: =item
-#: ../tools/virt-rescue.pl:158
-msgid "B<--ro> | B<-r>"
+# type: textblock
+#: ../tools/virt-resize.pl:339
+msgid ""
+"If virt-resize knows how, it will expand the direct content of the "
+"partition. For example, if the partition is an LVM PV, it will expand the "
+"PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
+"content it doesn't know about alone."
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:160
-msgid "Open the image read-only."
+#: ../tools/virt-resize.pl:344
+msgid "Currently virt-resize can resize:"
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:172
+#: ../tools/virt-resize.pl:350
msgid ""
-"Enable SELinux in the rescue appliance. You should read "
-"L<guestfs(3)/SELINUX> before using this option."
+"ext2, ext3 and ext4 filesystems when they are contained directly inside a "
+"partition."
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:228
+#: ../tools/virt-resize.pl:355
msgid ""
-"Several environment variables affect virt-rescue. See "
-"L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
+"NTFS filesystems contained directly in a partition, if libguestfs was "
+"compiled with support for NTFS."
msgstr ""
# type: textblock
-#: ../tools/virt-rescue.pl:233
+#: ../tools/virt-resize.pl:358
msgid ""
-"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
-"L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
+"The filesystem must have been shut down consistently last time it was used. "
+"Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
+"consistency check, so at the first boot after resizing Windows will check "
+"the disk."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:42
-msgid "virt-resize - Resize a virtual machine disk"
-msgstr ""
-
-# type: verbatim
-#: ../tools/virt-resize.pl:46
-#, no-wrap
+#: ../tools/virt-resize.pl:365
msgid ""
-" virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
-" [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
-" [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
-"\n"
+"LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
+"inside the PV. The user will have to resize LVs as desired."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:52
-msgid ""
-"Virt-resize is a tool which can resize a virtual machine disk, making it "
-"larger or smaller overall, and resizing or deleting any partitions contained "
-"within."
+#: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
+msgid "Note that you cannot use C<--expand> and C<--shrink> together."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:56
-msgid ""
-"Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
-"not> be used on live virtual machines - for consistent results, shut the "
-"virtual machine down before resizing it."
+# type: =item
+#: ../tools/virt-resize.pl:377
+msgid "B<--shrink part>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:60
+#: ../tools/virt-resize.pl:379
msgid ""
-"If you are not familiar with the associated tools: "
-"L<virt-list-partitions(1)>, L<virt-list-filesystems(1)> and L<virt-df(1)>, "
-"we recommend you go and read those manual pages first."
+"Shrink the named partition until the overall disk image fits in the "
+"destination. The named partition B<must> contain a filesystem or PV which "
+"has already been shrunk using another tool (eg. L<guestfish(1)> or other "
+"online tools). Virt-resize will check this and give an error if it has not "
+"been done."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:68
+#: ../tools/virt-resize.pl:385
msgid ""
-"Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
-"fill the extra 5GB of space."
+"The amount by which the overall disk must be shrunk (after carrying out all "
+"other operations requested by the user) is called the \"deficit\". For "
+"example, a straight copy (assume no other operations) from a 5GB disk image "
+"to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
+"would give an error unless the user specified a partition to shrink and that "
+"partition had more than a gigabyte of free space."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:71
-#, no-wrap
-msgid ""
-" truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
-" virt-list-partitions -lht olddisk\n"
-" # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
-" virt-resize --expand /dev/sda2 olddisk newdisk\n"
-"\n"
+# type: =item
+#: ../tools/virt-resize.pl:399
+msgid "B<--ignore part>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:76
+#: ../tools/virt-resize.pl:401
msgid ""
-"As above, but make the /boot partition 200MB bigger, while giving the "
-"remaining space to /dev/sda2:"
-msgstr ""
-
-# type: verbatim
-#: ../tools/virt-resize.pl:79
-#, no-wrap
-msgid ""
-" virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
-"\n"
+"Ignore the named partition. Effectively this means the partition is "
+"allocated on the destination disk, but the content is not copied across from "
+"the source disk. The content of the partition will be blank (all zero "
+"bytes)."
msgstr ""
-# type: =head1
-#: ../tools/virt-resize.pl:81
-msgid "DETAILED USAGE"
+# type: =item
+#: ../tools/virt-resize.pl:412
+msgid "B<--delete part>"
msgstr ""
-# type: =head2
-#: ../tools/virt-resize.pl:83
-msgid "EXPANDING A VIRTUAL MACHINE DISK"
+# type: textblock
+#: ../tools/virt-resize.pl:414
+msgid ""
+"Delete the named partition. It would be more accurate to describe this as "
+"\"don't copy it over\", since virt-resize doesn't do in-place changes and "
+"the original disk image is left intact."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:87
-msgid "1. Shut down the virtual machine"
+# type: textblock
+#: ../tools/virt-resize.pl:418
+msgid ""
+"Note that when you delete a partition, then anything contained in the "
+"partition is also deleted. Furthermore, this causes any partitions that "
+"come after to be I<renumbered>, which can easily make your guest unbootable."
msgstr ""
# type: =item
-#: ../tools/virt-resize.pl:89
-msgid "2. Locate input disk image"
+#: ../tools/virt-resize.pl:429
+msgid "B<--LV-expand logvol>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:91
+#: ../tools/virt-resize.pl:431
msgid ""
-"Locate the input disk image (ie. the file or device on the host containing "
-"the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
-"dumpxml> like this to find the disk image name:"
+"This takes the logical volume and, as a final step, expands it to fill all "
+"the space available in its volume group. A typical usage, assuming a Linux "
+"guest with a single PV C</dev/sda2> and a root device called "
+"C</dev/vg_guest/lv_root> would be:"
msgstr ""
# type: verbatim
-#: ../tools/virt-resize.pl:95
+#: ../tools/virt-resize.pl:436
#, no-wrap
msgid ""
-" # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
-" Found 1 nodes:\n"
-" -- NODE --\n"
-" <source dev=\"/dev/vg/lv_guest\" />\n"
+" virt-resize indisk outdisk \\\n"
+" --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
"\n"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:100
-msgid "3. Look at current sizing"
+# type: textblock
+#: ../tools/virt-resize.pl:439
+msgid ""
+"This would first expand the partition (and PV), and then expand the root "
+"device to fill the extra space in the PV."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:102
-msgid "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
+#: ../tools/virt-resize.pl:442
+msgid ""
+"The contents of the LV are also resized if virt-resize knows how to do "
+"that. You can stop virt-resize from trying to expand the content by using "
+"the option C<--no-expand-content>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:105
-#, no-wrap
-msgid ""
-" # virt-list-partitions -lht /dev/vg/lv_guest\n"
-" /dev/sda1 ext3 101.9M\n"
-" /dev/sda2 pv 7.9G\n"
-" /dev/sda device 8.0G\n"
-"\n"
+# type: textblock
+#: ../tools/virt-resize.pl:446
+msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:110
+#: ../tools/virt-resize.pl:449
msgid ""
-"(This example is a virtual machine with an 8 GB disk which we would like to "
-"expand up to 10 GB)."
+"You can give this option multiple times, I<but> it doesn't make sense to do "
+"this unless the logical volumes you specify are all in different volume "
+"groups."
msgstr ""
# type: =item
-#: ../tools/virt-resize.pl:113
-msgid "4. Create output disk"
+#: ../tools/virt-resize.pl:457
+msgid "B<--no-copy-boot-loader>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:115
+#: ../tools/virt-resize.pl:459
msgid ""
-"Virt-resize cannot do in-place disk modifications. You have to have space "
-"to store the resized output disk."
+"By default, virt-resize copies over some sectors at the start of the disk "
+"(up to the beginning of the first partition). Commonly these sectors "
+"contain the Master Boot Record (MBR) and the boot loader, and are required "
+"in order for the guest to boot correctly."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:118
-msgid "To store the resized disk image in a file, create a file of a suitable size:"
+#: ../tools/virt-resize.pl:464
+msgid ""
+"If you specify this flag, then this initial copy is not done. You may need "
+"to reinstall the boot loader in this case."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:121
-#, no-wrap
-msgid ""
-" # rm -f outdisk\n"
-" # truncate -s 10G outdisk\n"
-"\n"
+# type: =item
+#: ../tools/virt-resize.pl:472
+msgid "B<--no-extra-partition>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:124
-msgid "Or use L<lvcreate(1)> to create a logical volume:"
+#: ../tools/virt-resize.pl:474
+msgid ""
+"By default, virt-resize creates an extra partition if there is any extra, "
+"unused space after all resizing has happened. Use this option to prevent "
+"the extra partition from being created. If you do this then the extra space "
+"will be inaccessible until you run fdisk, parted, or some other partitioning "
+"tool in the guest."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:126
-#, no-wrap
+# type: textblock
+#: ../tools/virt-resize.pl:480
msgid ""
-" # lvcreate -L 10G -n lv_name vg_name\n"
-"\n"
+"Note that if the surplus space is smaller than 10 MB, no extra partition "
+"will be created."
+msgstr ""
+
+# type: =item
+#: ../tools/virt-resize.pl:487
+msgid "B<--no-expand-content>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:128
-msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
+#: ../tools/virt-resize.pl:489
+msgid ""
+"By default, virt-resize will try to expand the direct contents of "
+"partitions, if it knows how (see C<--expand> option above)."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:130
-#, no-wrap
+# type: textblock
+#: ../tools/virt-resize.pl:492
msgid ""
-" # virsh pool-list\n"
-" # virsh vol-create-as poolname newvol 10G\n"
-"\n"
+"If you give the C<--no-expand-content> option then virt-resize will not "
+"attempt this."
msgstr ""
# type: =item
-#: ../tools/virt-resize.pl:133
-msgid "5. Resize"
+#: ../tools/virt-resize.pl:499
+msgid "B<-d> | B<--debug>"
+msgstr ""
+
+# type: =item
+#: ../tools/virt-resize.pl:507
+msgid "B<-n> | B<--dryrun>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:135
-msgid ""
-"virt-resize takes two mandatory parameters, the input disk (eg. device or "
-"file) and the output disk. The output disk is the one created in the "
-"previous step."
+#: ../tools/virt-resize.pl:509
+msgid "Print a summary of what would be done, but don't do anything."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:139
-#, no-wrap
-msgid ""
-" # virt-resize indisk outdisk\n"
-"\n"
+# type: =item
+#: ../tools/virt-resize.pl:515
+msgid "B<-q> | B<--quiet>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:141
-msgid ""
-"This command just copies disk image C<indisk> to disk image C<outdisk> "
-"I<without> resizing or changing any existing partitions. If C<outdisk> is "
-"larger, then an extra, empty partition is created at the end of the disk "
-"covering the extra space. If C<outdisk> is smaller, then it will give an "
-"error."
+#: ../tools/virt-resize.pl:517
+msgid "Don't print the summary."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:147
+#: ../tools/virt-resize.pl:525
msgid ""
-"More realistically you'd want to expand existing partitions in the disk "
-"image by passing extra options (for the full list see the L</OPTIONS> "
-"section below)."
+"Specify the format of the input disk image. If this flag is not given then "
+"it is auto-detected from the image itself."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:151
+#: ../tools/virt-resize.pl:531
msgid ""
-"L</--expand> is the most useful option. It expands the named partition "
-"within the disk to fill any extra space:"
+"Note that this option I<does not> affect the output format. See L</QCOW2 "
+"AND NON-SPARSE RAW FORMATS>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:154
-#, no-wrap
-msgid ""
-" # virt-resize --expand /dev/sda2 indisk outdisk\n"
-"\n"
+# type: =item
+#: ../tools/virt-resize.pl:538
+msgid "B<--output-format> raw"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:156
+#: ../tools/virt-resize.pl:540
msgid ""
-"(In this case, an extra partition is I<not> created at the end of the disk, "
-"because there will be no unused space)."
+"Specify the format of the output disk image. If this flag is not given then "
+"it is auto-detected from the image itself."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:159
+#: ../tools/virt-resize.pl:546
msgid ""
-"L</--resize> is the other commonly used option. The following would "
-"increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
-"rest of the available space:"
+"Note that you still need to create the output disk with the right format. "
+"See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:163
-#, no-wrap
-msgid ""
-" # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
-" indisk outdisk\n"
-"\n"
+# type: =head2
+#: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
+msgid "NOTES"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:166
-msgid ""
-"If the expanded partition in the image contains a filesystem or LVM PV, then "
-"if virt-resize knows how, it will resize the contents, the equivalent of "
-"calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
-"L<ntfsresize(8)>. However virt-resize does not know how to resize some "
-"filesystems, so you would have to online resize them after booting the "
-"guest. And virt-resize also does not resize anything inside an LVM PV, it "
-"just resizes the PV itself and leaves the user to resize any LVs inside that "
-"PV as desired."
+# type: =head2
+#: ../tools/virt-resize.pl:1424
+msgid "\"Partition 1 does not end on cylinder boundary.\""
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:175
-msgid "Other options are covered below."
+#: ../tools/virt-resize.pl:1426
+msgid ""
+"Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
+"means the partitions will not be aligned to the ancient CHS geometry. "
+"However CHS geometry is meaningless for disks manufactured since the early "
+"1990s, and doubly so for virtual hard drives. Alignment of partitions to "
+"cylinders is not required by any modern operating system."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:177
-msgid "6. Test"
+# type: =head2
+#: ../tools/virt-resize.pl:1433
+msgid "RESIZING WINDOWS VIRTUAL MACHINES"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:179
-msgid "Thoroughly test the new disk image I<before> discarding the old one."
+#: ../tools/virt-resize.pl:1435
+msgid ""
+"In Windows Vista and later versions, Microsoft switched to using a separate "
+"boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
+"and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
+"the boot partition. Doing so seems to break the guest completely. However "
+"expanding the second partition (ie. C: drive) should work."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:181
-msgid "If you are using libvirt, edit the XML to point at the new disk:"
-msgstr ""
-
-# type: verbatim
-#: ../tools/virt-resize.pl:183
-#, no-wrap
+#: ../tools/virt-resize.pl:1442
msgid ""
-" # virsh edit guestname\n"
-"\n"
+"Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
+"NTFS partitions have been expanded. This is just a safety check and (unless "
+"it find errors) is nothing to worry about."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:185
-msgid ""
-"Change E<lt>source ...E<gt>, see "
-"L<http://libvirt.org/formatdomain.html#elementsDisks>"
+# type: =head2
+#: ../tools/virt-resize.pl:1446
+msgid "GUEST BOOT STUCK AT \"GRUB\""
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:188
-msgid "Then start up the domain with the new, resized disk:"
+#: ../tools/virt-resize.pl:1448
+msgid ""
+"If a Linux guest does not boot after resizing, and the boot is stuck after "
+"printing C<GRUB> on the console, try reinstalling grub. This sometimes "
+"happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
+"although we think is to do with partition alignment."
msgstr ""
# type: verbatim
-#: ../tools/virt-resize.pl:190
+#: ../tools/virt-resize.pl:1453
#, no-wrap
msgid ""
-" # virsh start guestname\n"
+" guestfish -i -a newdisk\n"
+" ><fs> cat /boot/grub/device.map\n"
+" # check the contents of this file are sensible or\n"
+" # edit the file if necessary\n"
+" ><fs> grub-install / /dev/vda\n"
+" ><fs> exit\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:192
+#: ../tools/virt-resize.pl:1460
msgid ""
-"and check that it still works. See also the L</NOTES> section below for "
-"additional information."
+"For more flexible guest reconfiguration, including if you need to specify "
+"other parameters to grub-install, use L<virt-rescue(1)>."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:195
-msgid "7. Resize LVs etc inside the guest"
+# type: =head1
+#: ../tools/virt-resize.pl:1463
+msgid "ALTERNATIVE TOOLS"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:197
-msgid "(This can also be done offline using L<guestfish(1)>)"
+#: ../tools/virt-resize.pl:1465
+msgid ""
+"There are several proprietary tools for resizing partitions. We won't "
+"mention any here."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:199
+#: ../tools/virt-resize.pl:1468
msgid ""
-"Once the guest has booted you should see the new space available, at least "
-"for filesystems that virt-resize knows how to resize, and for PVs. The user "
-"may need to resize LVs inside PVs, and also resize filesystem types that "
-"virt-resize does not know how to expand."
-msgstr ""
-
-# type: =head2
-#: ../tools/virt-resize.pl:206
-msgid "SHRINKING A VIRTUAL MACHINE DISK"
+"L<parted(8)> and its graphical shell gparted can do some types of resizing "
+"operations on disk images. They can resize and move partitions, but I don't "
+"think they can do anything with the contents, and they certainly don't "
+"understand LVM."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:208
+#: ../tools/virt-resize.pl:1473
msgid ""
-"Shrinking is somewhat more complex than expanding, and only an overview is "
-"given here."
+"L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
+"but at a much lower level. You will probably end up hand-calculating sector "
+"offsets, which is something that virt-resize was designed to avoid. If you "
+"want to see the guestfish-equivalent commands that virt-resize runs, use the "
+"C<--debug> flag."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:211
+#: ../tools/virt-resize.pl:1488
msgid ""
-"Firstly virt-resize will not attempt to shrink any partition content (PVs, "
-"filesystems). The user has to shrink content before passing the disk image "
-"to virt-resize, and virt-resize will check that the content has been shrunk "
-"properly."
+"L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
+"L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
+"L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, "
+"L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, "
+"L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:216
-msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
+#: ../tools/virt-list-filesystems.pl:32
+msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:218
+# type: verbatim
+#: ../tools/virt-list-filesystems.pl:36
+#, no-wrap
msgid ""
-"After shrinking PVs and filesystems, shut down the guest, and proceed with "
-"steps 3 and 4 above to allocate a new disk image."
+" virt-list-filesystems [--options] domname\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:221
-msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
+# type: verbatim
+#: ../tools/virt-list-filesystems.pl:38
+#, no-wrap
+msgid ""
+" virt-list-filesystems [--options] disk.img [disk.img ...]\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../tools/virt-resize.pl:224
-msgid "IGNORING OR DELETING PARTITIONS"
+# type: textblock
+#: ../tools/virt-list-filesystems.pl:42
+msgid ""
+"C<virt-list-filesystems> is a command line tool to list the filesystems that "
+"are contained in a virtual machine or disk image."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:226
+#: ../tools/virt-list-filesystems.pl:46
msgid ""
-"virt-resize also gives a convenient way to ignore or delete partitions when "
-"copying from the input disk to the output disk. Ignoring a partition speeds "
-"up the copy where you don't care about the existing contents of a "
-"partition. Deleting a partition removes it completely, but note that it "
-"also renumbers any partitions after the one which is deleted, which can "
-"leave some guests unbootable."
+"C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
+"functionality. For more complex cases you should look at the "
+"L<guestfish(1)> tool."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:243
-msgid "Display help."
+#: ../tools/virt-list-filesystems.pl:105
+msgid ""
+"With this option, C<virt-list-filesystems> displays the type of each "
+"filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
msgstr ""
# type: =item
-#: ../tools/virt-resize.pl:257
-msgid "B<--resize part=size>"
+#: ../tools/virt-list-filesystems.pl:112
+msgid "B<-a> | B<--all>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:259
+#: ../tools/virt-list-filesystems.pl:114
msgid ""
-"Resize the named partition (expanding or shrinking it) so that it has the "
-"given size."
+"Normally we only show mountable filesystems. If this option is given then "
+"swap devices are shown too."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:262
+#: ../tools/virt-list-filesystems.pl:188
msgid ""
-"C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
-"mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
-"Exabytes; or as a percentage of the current size; or as a relative number or "
-"percentage. For example:"
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
+"L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
+"L<Sys::Virt(3)>, L<http://libguestfs.org/>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:267
-#, no-wrap
-msgid ""
-" --resize /dev/sda2=10G\n"
-"\n"
+# type: textblock
+#: ../tools/virt-tar.pl:33
+msgid "virt-tar - Extract or upload files to a virtual machine"
msgstr ""
# type: verbatim
-#: ../tools/virt-resize.pl:269
+#: ../tools/virt-tar.pl:37
#, no-wrap
msgid ""
-" --resize /dev/sda4=90%\n"
+" virt-tar [--options] -x domname directory tarball\n"
"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-resize.pl:271
+#: ../tools/virt-tar.pl:39
#, no-wrap
msgid ""
-" --resize /dev/sda2=+1G\n"
+" virt-tar [--options] -u domname tarball directory\n"
"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-resize.pl:273
+#: ../tools/virt-tar.pl:41
#, no-wrap
msgid ""
-" --resize /dev/sda2=-200M\n"
+" virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-resize.pl:275
+#: ../tools/virt-tar.pl:43
#, no-wrap
msgid ""
-" --resize /dev/sda1=+128K\n"
+" virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
"\n"
msgstr ""
+# type: textblock
+#: ../tools/virt-tar.pl:47
+msgid "Download C</home> from the VM into a local tarball:"
+msgstr ""
+
# type: verbatim
-#: ../tools/virt-resize.pl:277
+#: ../tools/virt-tar.pl:49
#, no-wrap
msgid ""
-" --resize /dev/sda1=+10%\n"
+" virt-tar -x domname /home home.tar\n"
"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-resize.pl:279
+#: ../tools/virt-tar.pl:51
#, no-wrap
msgid ""
-" --resize /dev/sda1=-10%\n"
+" virt-tar -zx domname /home home.tar.gz\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:281
-msgid ""
-"You can increase the size of any partition. Virt-resize will expand the "
-"direct content of the partition if it knows how (see C<--expand> below)."
+#: ../tools/virt-tar.pl:53
+msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:285
+# type: verbatim
+#: ../tools/virt-tar.pl:55
+#, no-wrap
msgid ""
-"You can only I<decrease> the size of partitions that contain filesystems or "
-"PVs which have already been shrunk. Virt-resize will check this has been "
-"done before proceeding, or else will print an error (see also "
-"C<--resize-force>)."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-resize.pl:290 ../tools/virt-resize.pl:382 ../tools/virt-resize.pl:399
-msgid "You can give this option multiple times."
-msgstr ""
-
-# type: =item
-#: ../tools/virt-resize.pl:296
-msgid "B<--resize-force part=size>"
+" virt-tar -u domname uploadstuff.tar /tmp\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:298
+# type: verbatim
+#: ../tools/virt-tar.pl:57
+#, no-wrap
msgid ""
-"This is the same as C<--resize> except that it will let you decrease the "
-"size of any partition. Generally this means you will lose any data which "
-"was at the end of the partition you shrink, but you may not care about that "
-"(eg. if shrinking an unused partition, or if you can easily recreate it such "
-"as a swap partition)."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-resize.pl:304
-msgid "See also the C<--ignore> option."
-msgstr ""
-
-# type: =item
-#: ../tools/virt-resize.pl:310
-msgid "B<--expand part>"
+" virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:312
+#: ../tools/virt-tar.pl:61
msgid ""
-"Expand the named partition so it uses up all extra space (space left over "
-"after any other resize changes that you request have been done)."
+"You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
+"virtual machines. If you do this, you risk disk corruption in the VM. "
+"C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:315
+#: ../tools/virt-tar.pl:66
msgid ""
-"If virt-resize knows how, it will expand the direct content of the "
-"partition. For example, if the partition is an LVM PV, it will expand the "
-"PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
-"content it doesn't know about alone."
+"You can use C<-x> (extract) on live virtual machines, but you might get "
+"inconsistent results or errors if there is filesystem activity inside the "
+"VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
+"work, but the only way to guarantee consistent results is if the virtual "
+"machine is shut down."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:320
-msgid "Currently virt-resize can resize:"
+#: ../tools/virt-tar.pl:74
+msgid ""
+"C<virt-tar> is a general purpose archive tool for downloading and uploading "
+"parts of a guest filesystem. There are many possibilities: making backups, "
+"uploading data files, snooping on guest activity, fixing or customizing "
+"guests, etc."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:326
+#: ../tools/virt-tar.pl:79
msgid ""
-"ext2, ext3 and ext4 filesystems when they are contained directly inside a "
-"partition."
+"If you want to just view a single file, use L<virt-cat(1)>. If you just "
+"want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
+"should look at the L<guestfish(1)> tool."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:331
+#: ../tools/virt-tar.pl:83
msgid ""
-"NTFS filesystems contained directly in a partition, if libguestfs was "
-"compiled with support for NTFS."
+"There are two modes of operation: C<-x> (eXtract) downloads a directory and "
+"its contents (recursively) from the virtual machine into a local tarball. "
+"C<-u> uploads from a local tarball, unpacking it into a directory inside the "
+"virtual machine. You cannot use these two options together."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:334
+#: ../tools/virt-tar.pl:89
msgid ""
-"The filesystem must have been shut down consistently last time it was used. "
-"Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
-"consistency check, so at the first boot after resizing Windows will check "
-"the disk."
+"In addition, you may need to use the C<-z> (gZip) option to enable "
+"compression. When uploading, you have to specify C<-z> if the upload file "
+"is compressed because virt-tar won't detect this on its own."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:341
+#: ../tools/virt-tar.pl:93
msgid ""
-"LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
-"inside the PV. The user will have to resize LVs as desired."
+"C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
+"example it cannot do PKZip files or bzip2 compression. If you want that "
+"then you'll have to rebuild the tarballs yourself. (This is a limitation of "
+"the L<libguestfs(3)> API)."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:347 ../tools/virt-resize.pl:369
-msgid "Note that you cannot use C<--expand> and C<--shrink> together."
+# type: =item
+#: ../tools/virt-tar.pl:151
+msgid "B<-x> | B<--extract> | B<--download>"
msgstr ""
# type: =item
-#: ../tools/virt-resize.pl:353
-msgid "B<--shrink part>"
+#: ../tools/virt-tar.pl:153
+msgid "B<-u> | B<--upload>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:355
+#: ../tools/virt-tar.pl:155
msgid ""
-"Shrink the named partition until the overall disk image fits in the "
-"destination. The named partition B<must> contain a filesystem or PV which "
-"has already been shrunk using another tool (eg. L<guestfish(1)> or other "
-"online tools). Virt-resize will check this and give an error if it has not "
-"been done."
+"Use C<-x> to extract (download) a directory from a virtual machine to a "
+"local tarball."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:361
+#: ../tools/virt-tar.pl:158
msgid ""
-"The amount by which the overall disk must be shrunk (after carrying out all "
-"other operations requested by the user) is called the \"deficit\". For "
-"example, a straight copy (assume no other operations) from a 5GB disk image "
-"to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
-"would give an error unless the user specified a partition to shrink and that "
-"partition had more than a gigabyte of free space."
-msgstr ""
-
-# type: =item
-#: ../tools/virt-resize.pl:375
-msgid "B<--ignore part>"
+"Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
+"Please read the L</WARNING> section above before using this option."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:377
-msgid ""
-"Ignore the named partition. Effectively this means the partition is "
-"allocated on the destination disk, but the content is not copied across from "
-"the source disk. The content of the partition will be blank (all zero "
-"bytes)."
+#: ../tools/virt-tar.pl:162
+msgid "You must specify exactly one of these options."
msgstr ""
# type: =item
-#: ../tools/virt-resize.pl:388
-msgid "B<--delete part>"
+#: ../tools/virt-tar.pl:168
+msgid "B<-z> | B<--gzip>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:390
-msgid ""
-"Delete the named partition. It would be more accurate to describe this as "
-"\"don't copy it over\", since virt-resize doesn't do in-place changes and "
-"the original disk image is left intact."
+#: ../tools/virt-tar.pl:170
+msgid "Specify that the input or output tarball is gzip-compressed."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:394
+#: ../tools/virt-tar.pl:283
msgid ""
-"Note that when you delete a partition, then anything contained in the "
-"partition is also deleted. Furthermore, this causes any partitions that "
-"come after to be I<renumbered>, which can easily make your guest unbootable."
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
+"L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
+"L<http://libguestfs.org/>."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:405
-msgid "B<--LV-expand logvol>"
+# type: textblock
+#: ../tools/virt-rescue.pl:33
+msgid "virt-rescue - Run a rescue shell on a virtual machine"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:407
+# type: verbatim
+#: ../tools/virt-rescue.pl:37
+#, no-wrap
msgid ""
-"This takes the logical volume and, as a final step, expands it to fill all "
-"the space available in its volume group. A typical usage, assuming a Linux "
-"guest with a single PV C</dev/sda2> and a root device called "
-"C</dev/vg_guest/lv_root> would be:"
+" virt-rescue [--options] domname\n"
+"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-resize.pl:412
+#: ../tools/virt-rescue.pl:39
#, no-wrap
msgid ""
-" virt-resize indisk outdisk \\\n"
-" --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
+" virt-rescue [--options] disk.img [disk.img ...]\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:415
+#: ../tools/virt-rescue.pl:43
msgid ""
-"This would first expand the partition (and PV), and then expand the root "
-"device to fill the extra space in the PV."
+"You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
+"probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
+"you from doing this, but doesn't catch all cases."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:418
+#: ../tools/virt-rescue.pl:47
msgid ""
-"The contents of the LV are also resized if virt-resize knows how to do "
-"that. You can stop virt-resize from trying to expand the content by using "
-"the option C<--no-expand-content>."
+"However if you use the I<--ro> (read only) option, then you can attach a "
+"shell to a live virtual machine. The results might be strange or "
+"inconsistent at times but you won't get disk corruption."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:422
-msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
+#: ../tools/virt-rescue.pl:53
+msgid ""
+"virt-rescue is like a Rescue CD, but for virtual machines, and without the "
+"need for a CD. virt-rescue gives you a rescue shell and some simple "
+"recovery tools which you can use to examine or rescue a virtual machine or "
+"disk image."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:425
+#: ../tools/virt-rescue.pl:58
msgid ""
-"You can give this option multiple times, I<but> it doesn't make sense to do "
-"this unless the logical volumes you specify are all in different volume "
-"groups."
+"You can run virt-rescue on any virtual machine known to libvirt, or directly "
+"on disk image(s):"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:433
-msgid "B<--no-copy-boot-loader>"
+# type: verbatim
+#: ../tools/virt-rescue.pl:61
+#, no-wrap
+msgid ""
+" virt-rescue GuestName\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:435
+# type: verbatim
+#: ../tools/virt-rescue.pl:63
+#, no-wrap
msgid ""
-"By default, virt-resize copies over some sectors at the start of the disk "
-"(up to the beginning of the first partition). Commonly these sectors "
-"contain the Master Boot Record (MBR) and the boot loader, and are required "
-"in order for the guest to boot correctly."
+" virt-rescue --ro /path/to/disk.img\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:440
+# type: verbatim
+#: ../tools/virt-rescue.pl:65
+#, no-wrap
msgid ""
-"If you specify this flag, then this initial copy is not done. You may need "
-"to reinstall the boot loader in this case."
+" virt-rescue /dev/sdc\n"
+"\n"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:448
-msgid "B<--no-extra-partition>"
+# type: textblock
+#: ../tools/virt-rescue.pl:67
+msgid "For live VMs you I<must> use the --ro option."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:450
+#: ../tools/virt-rescue.pl:69
msgid ""
-"By default, virt-resize creates an extra partition if there is any extra, "
-"unused space after all resizing has happened. Use this option to prevent "
-"the extra partition from being created. If you do this then the extra space "
-"will be inaccessible until you run fdisk, parted, or some other partitioning "
-"tool in the guest."
+"When you run virt-rescue on a virtual machine or disk image, you are placed "
+"in an interactive bash shell where you can use many ordinary Linux "
+"commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
+"appliance. You must mount the virtual machine's filesystems by hand. There "
+"is an empty directory called C</sysroot> where you can mount filesystems."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:456
+#: ../tools/virt-rescue.pl:76
msgid ""
-"Note that if the surplus space is smaller than 10 MB, no extra partition "
-"will be created."
+"In the example below, we list logical volumes, then choose one to mount "
+"under C</sysroot>:"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:463
-msgid "B<--no-expand-content>"
+# type: verbatim
+#: ../tools/virt-rescue.pl:79
+#, no-wrap
+msgid ""
+" ><rescue> lvs\n"
+" LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
+" lv_root vg_f11x64 -wi-a- 8.83G\n"
+" lv_swap vg_f11x64 -wi-a- 992.00M\n"
+" ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
+" ><rescue> ls /sysroot\n"
+"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:465
+#: ../tools/virt-rescue.pl:86
msgid ""
-"By default, virt-resize will try to expand the direct contents of "
-"partitions, if it knows how (see C<--expand> option above)."
+"If you don't know what filesystems are available on the virtual machine then "
+"you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:468
+#: ../tools/virt-rescue.pl:92
msgid ""
-"If you give the C<--no-expand-content> option then virt-resize will not "
-"attempt this."
-msgstr ""
-
-# type: =item
-#: ../tools/virt-resize.pl:475
-msgid "B<-d> | B<--debug>"
+"Virt-rescue can be used on I<any> disk image file or device, not just a "
+"virtual machine. For example you can use it on a blank file if you want to "
+"partition that file (although we would recommend using L<guestfish(1)> "
+"instead as it is more suitable for this purpose). You can even use "
+"virt-rescue on things like SD cards."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:477 ../tools/virt-win-reg.pl:198
-msgid "Enable debugging messages."
+#: ../tools/virt-rescue.pl:98
+msgid ""
+"This tool is just designed for quick interactive hacking on a virtual "
+"machine. For more structured access to a virtual machine disk image, you "
+"should use L<guestfs(3)>. To get a structured shell that you can use to "
+"make scripted changes to guests, use L<guestfish(1)>."
msgstr ""
# type: =item
-#: ../tools/virt-resize.pl:483
-msgid "B<-n> | B<--dryrun>"
+#: ../tools/virt-rescue.pl:127
+msgid "B<--append kernelopts>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:485
-msgid "Print a summary of what would be done, but don't do anything."
+#: ../tools/virt-rescue.pl:129
+msgid "Pass additional options to the rescue kernel."
msgstr ""
# type: =item
-#: ../tools/virt-resize.pl:491
-msgid "B<-q> | B<--quiet>"
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-resize.pl:493
-msgid "Don't print the summary."
-msgstr ""
-
-# type: =head2
-#: ../tools/virt-resize.pl:1352
-msgid "\"Partition 1 does not end on cylinder boundary.\""
+#: ../tools/virt-rescue.pl:164
+msgid "B<--memsize MB> | B<-m MB>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:1354
+#: ../tools/virt-rescue.pl:166
msgid ""
-"Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
-"means the partitions will not be aligned to the ancient CHS geometry. "
-"However CHS geometry is meaningless for disks manufactured since the early "
-"1990s, and doubly so for virtual hard drives. Alignment of partitions to "
-"cylinders is not required by any modern operating system."
-msgstr ""
-
-# type: =head2
-#: ../tools/virt-resize.pl:1361
-msgid "RESIZING WINDOWS VIRTUAL MACHINES"
+"Change the amount of memory allocated to the rescue system. The default is "
+"set by libguestfs and is small but adequate for running system tools. The "
+"occasional program might need more memory. The parameter is specified in "
+"megabytes."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:1363
-msgid ""
-"In Windows Vista and later versions, Microsoft switched to using a separate "
-"boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
-"and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
-"the boot partition. Doing so seems to break the guest completely. However "
-"expanding the second partition (ie. C: drive) should work."
+# type: =item
+#: ../tools/virt-rescue.pl:175
+msgid "B<--network MB>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:1370
-msgid ""
-"Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
-"NTFS partitions have been expanded. This is just a safety check and (unless "
-"it find errors) is nothing to worry about."
+#: ../tools/virt-rescue.pl:177
+msgid "Enable QEMU user networking in the guest."
msgstr ""
-# type: =head1
-#: ../tools/virt-resize.pl:1374
-msgid "ALTERNATIVE TOOLS"
+# type: =item
+#: ../tools/virt-rescue.pl:183
+msgid "B<--ro> | B<-r>"
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:1376
-msgid ""
-"There are several proprietary tools for resizing partitions. We won't "
-"mention any here."
+#: ../tools/virt-rescue.pl:185
+msgid "Open the image read-only."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:1379
-msgid ""
-"L<parted(8)> and its graphical shell gparted can do some types of resizing "
-"operations on disk images. They can resize and move partitions, but I don't "
-"think they can do anything with the contents, and they certainly don't "
-"understand LVM."
+#: ../tools/virt-rescue.pl:197
+msgid ""
+"Enable SELinux in the rescue appliance. You should read "
+"L<guestfs(3)/SELINUX> before using this option."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:1384
+#: ../tools/virt-rescue.pl:257
msgid ""
-"L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
-"but at a much lower level. You will probably end up hand-calculating sector "
-"offsets, which is something that virt-resize was designed to avoid. If you "
-"want to see the guestfish-equivalent commands that virt-resize runs, use the "
-"C<--debug> flag."
+"Several environment variables affect virt-rescue. See "
+"L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
msgstr ""
# type: textblock
-#: ../tools/virt-resize.pl:1392
+#: ../tools/virt-rescue.pl:269
msgid ""
-"L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
-"L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
-"L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, "
-"L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
+"L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
msgstr ""
# type: textblock
-#: ../tools/virt-tar.pl:34
-msgid "virt-tar - Extract or upload files to a virtual machine"
+#: ../tools/virt-make-fs.pl:37
+msgid "virt-make-fs - Make a filesystem from a tar archive or files"
msgstr ""
# type: verbatim
-#: ../tools/virt-tar.pl:38
+#: ../tools/virt-make-fs.pl:41
#, no-wrap
msgid ""
-" virt-tar [--options] -x domname directory tarball\n"
+" virt-make-fs [--options] input.tar output.img\n"
"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-tar.pl:40
+#: ../tools/virt-make-fs.pl:43
#, no-wrap
msgid ""
-" virt-tar [--options] -u domname tarball directory\n"
+" virt-make-fs [--options] input.tar.gz output.img\n"
"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-tar.pl:42
+#: ../tools/virt-make-fs.pl:45
#, no-wrap
msgid ""
-" virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
+" virt-make-fs [--options] directory output.img\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:44
-#, no-wrap
+# type: textblock
+#: ../tools/virt-make-fs.pl:49
msgid ""
-" virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
-"\n"
+"Virt-make-fs is a command line tool for creating a filesystem from a tar "
+"archive or some files in a directory. It is similar to tools like "
+"L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
+"it can create common filesystem types like ext2/3 or NTFS, which can be "
+"useful if you want to attach these filesystems to existing virtual machines "
+"(eg. to import large amounts of read-only data to a VM)."
msgstr ""
# type: textblock
-#: ../tools/virt-tar.pl:48
-msgid "Download C</home> from the VM into a local tarball:"
+#: ../tools/virt-make-fs.pl:57
+msgid "Basic usage is:"
msgstr ""
# type: verbatim
-#: ../tools/virt-tar.pl:50
+#: ../tools/virt-make-fs.pl:59
#, no-wrap
msgid ""
-" virt-tar -x domname /home home.tar\n"
+" virt-make-fs input output\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:52
-#, no-wrap
+# type: textblock
+#: ../tools/virt-make-fs.pl:61
msgid ""
-" virt-tar -zx domname /home home.tar.gz\n"
-"\n"
+"where C<input> is either a directory containing files that you want to add, "
+"or a tar archive (either uncompressed tar or gzip-compressed tar); and "
+"C<output> is a disk image. The input type is detected automatically. The "
+"output disk image defaults to a raw ext2 image unless you specify extra "
+"flags (see L</OPTIONS> below)."
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:54
-msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
+# type: =head2
+#: ../tools/virt-make-fs.pl:67
+msgid "EXTRA SPACE"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:56
-#, no-wrap
+# type: textblock
+#: ../tools/virt-make-fs.pl:69
msgid ""
-" virt-tar -u domname uploadstuff.tar /tmp\n"
-"\n"
+"Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
+"the files that it contains, but might have extra space. Depending on how "
+"you are going to use the output, you might think this extra space is wasted "
+"and want to minimize it, or you might want to leave space so that more files "
+"can be added later. Virt-make-fs defaults to minimizing the extra space, "
+"but you can use the C<--size> flag to leave space in the filesystem if you "
+"want it."
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:58
-#, no-wrap
+# type: textblock
+#: ../tools/virt-make-fs.pl:77
msgid ""
-" virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
-"\n"
+"An alternative way to leave extra space but not make the output image any "
+"bigger is to use an alternative disk image format (instead of the default "
+"\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
+"image format (check your hypervisor supports this before using it). This "
+"allows you to choose a large C<--size> but the extra space won't actually be "
+"allocated in the image until you try to store something in it."
msgstr ""
# type: textblock
-#: ../tools/virt-tar.pl:62
+#: ../tools/virt-make-fs.pl:85
msgid ""
-"You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
-"virtual machines. If you do this, you risk disk corruption in the VM. "
-"C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
+"Don't forget that you can also use local commands including L<resize2fs(8)> "
+"and L<virt-resize(1)> to resize existing filesystems, or rerun "
+"virt-make-resize to build another image from scratch."
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:67
-msgid ""
-"You can use C<-x> (extract) on live virtual machines, but you might get "
-"inconsistent results or errors if there is filesystem activity inside the "
-"VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
-"work, but the only way to guarantee consistent results is if the virtual "
-"machine is shut down."
+# type: =head3
+#: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
+msgid "EXAMPLE"
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:75
+# type: verbatim
+#: ../tools/virt-make-fs.pl:91
+#, no-wrap
msgid ""
-"C<virt-tar> is a general purpose archive tool for downloading and uploading "
-"parts of a guest filesystem. There are many possibilities: making backups, "
-"uploading data files, snooping on guest activity, fixing or customizing "
-"guests, etc."
+" virt-make-fs --format=qcow2 --size=+200M input output.img\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:80
-msgid ""
-"If you want to just view a single file, use L<virt-cat(1)>. If you just "
-"want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
-"should look at the L<guestfish(1)> tool."
+# type: =head2
+#: ../tools/virt-make-fs.pl:93
+msgid "FILESYSTEM TYPE"
msgstr ""
# type: textblock
-#: ../tools/virt-tar.pl:84
+#: ../tools/virt-make-fs.pl:95
msgid ""
-"There are two modes of operation: C<-x> (eXtract) downloads a directory and "
-"its contents (recursively) from the virtual machine into a local tarball. "
-"C<-u> uploads from a local tarball, unpacking it into a directory inside the "
-"virtual machine. You cannot use these two options together."
+"The default filesystem type is C<ext2>. Just about any filesystem type that "
+"libguestfs supports can be used (but I<not> read-only formats like "
+"ISO9660). Here are some of the more common choices:"
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:90
-msgid ""
-"In addition, you may need to use the C<-z> (gZip) option to enable "
-"compression. When uploading, you have to specify C<-z> if the upload file "
-"is compressed because virt-tar won't detect this on its own."
+# type: =item
+#: ../tools/virt-make-fs.pl:101
+msgid "I<ext3>"
msgstr ""
# type: textblock
-#: ../tools/virt-tar.pl:94
+#: ../tools/virt-make-fs.pl:103
msgid ""
-"C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
-"example it cannot do PKZip files or bzip2 compression. If you want that "
-"then you'll have to rebuild the tarballs yourself. (This is a limitation of "
-"the L<libguestfs(3)> API)."
+"Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
+"you are not going to use the filesystem in a way that requires the journal, "
+"then this is just wasted overhead."
msgstr ""
# type: =item
-#: ../tools/virt-tar.pl:135
-msgid "B<-x> | B<--extract> | B<--download>"
+#: ../tools/virt-make-fs.pl:107
+msgid "I<ntfs> or I<vfat>"
msgstr ""
-# type: =item
-#: ../tools/virt-tar.pl:137
-msgid "B<-u> | B<--upload>"
+# type: textblock
+#: ../tools/virt-make-fs.pl:109
+msgid "Useful if exporting data to a Windows guest."
msgstr ""
# type: textblock
-#: ../tools/virt-tar.pl:139
+#: ../tools/virt-make-fs.pl:111
msgid ""
-"Use C<-x> to extract (download) a directory from a virtual machine to a "
-"local tarball."
+"I<Note for vfat>: The tar archive or local directory must only contain files "
+"which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
+"program running within libguestfs is unable to change the ownership of "
+"non-root files, since vfat itself does not support this."
+msgstr ""
+
+# type: =item
+#: ../tools/virt-make-fs.pl:116
+msgid "I<minix>"
msgstr ""
# type: textblock
-#: ../tools/virt-tar.pl:142
+#: ../tools/virt-make-fs.pl:118
msgid ""
-"Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
-"Please read the L</WARNING> section above before using this option."
+"Lower overhead than C<ext2>, but certain limitations on filename length and "
+"total filesystem size."
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:146
-msgid "You must specify exactly one of these options."
+# type: verbatim
+#: ../tools/virt-make-fs.pl:125
+#, no-wrap
+msgid ""
+" virt-make-fs --type=minix input minixfs.img\n"
+"\n"
msgstr ""
-# type: =item
-#: ../tools/virt-tar.pl:152
-msgid "B<-z> | B<--gzip>"
+# type: =head2
+#: ../tools/virt-make-fs.pl:127
+msgid "TO PARTITION OR NOT TO PARTITION"
msgstr ""
# type: textblock
-#: ../tools/virt-tar.pl:154
-msgid "Specify that the input or output tarball is gzip-compressed."
+#: ../tools/virt-make-fs.pl:129
+msgid "Optionally virt-make-fs can add a partition table to the output disk."
msgstr ""
# type: textblock
-#: ../tools/virt-tar.pl:259
+#: ../tools/virt-make-fs.pl:131
msgid ""
-"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
-"L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
-"L<http://libguestfs.org/>."
+"Adding a partition can make the disk image more compatible with certain "
+"virtualized operating systems which don't expect to see a filesystem "
+"directly located on a block device (Linux doesn't care and will happily "
+"handle both types)."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:38
+#: ../tools/virt-make-fs.pl:136
msgid ""
-"virt-win-reg - Export and merge Windows Registry entries from a Windows "
-"guest"
+"On the other hand, if you have a partition table then the output image is no "
+"longer a straight filesystem. For example you cannot run L<fsck(8)> "
+"directly on a partitioned disk image. (However libguestfs tools such as "
+"L<guestfish(1)> and L<virt-resize(1)> can still be used)."
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:42
-#, no-wrap
-msgid ""
-" virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
-"\n"
+# type: textblock
+#: ../tools/virt-make-fs.pl:144
+msgid "Add an MBR partition:"
msgstr ""
# type: verbatim
-#: ../tools/virt-win-reg.pl:44
+#: ../tools/virt-make-fs.pl:146
#, no-wrap
msgid ""
-" virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
+" virt-make-fs --partition -- input disk.img\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:46
-#, no-wrap
+# type: textblock
+#: ../tools/virt-make-fs.pl:148
msgid ""
-" virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
-"\n"
+"If the output disk image could be terabyte-sized or larger, it's better to "
+"use an EFI/GPT-compatible partition table:"
msgstr ""
# type: verbatim
-#: ../tools/virt-win-reg.pl:48
+#: ../tools/virt-make-fs.pl:151
#, no-wrap
msgid ""
-" virt-win-reg --merge domname [input.reg ...]\n"
+" virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:50
-#, no-wrap
-msgid ""
-" virt-win-reg [--options] disk.img ... # instead of domname\n"
-"\n"
+# type: textblock
+#: ../tools/virt-make-fs.pl:179
+msgid "Enable debugging information."
+msgstr ""
+
+# type: =item
+#: ../tools/virt-make-fs.pl:185
+msgid "B<--size=E<lt>NE<gt>>"
+msgstr ""
+
+# type: =item
+#: ../tools/virt-make-fs.pl:187
+msgid "B<--size=+E<lt>NE<gt>>"
+msgstr ""
+
+# type: =item
+#: ../tools/virt-make-fs.pl:189
+msgid "B<-s E<lt>NE<gt>>"
+msgstr ""
+
+# type: =item
+#: ../tools/virt-make-fs.pl:191
+msgid "B<-s +E<lt>NE<gt>>"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:54
-msgid ""
-"You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
-"virtual machines. If you do this, you I<will> get irreversible disk "
-"corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
-"but doesn't catch all cases."
+#: ../tools/virt-make-fs.pl:193
+msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:59
+#: ../tools/virt-make-fs.pl:196
msgid ""
-"Modifying the Windows Registry is an inherently risky operation. The format "
-"is deliberately obscure and undocumented, and Registry changes can leave the "
-"system unbootable. Therefore when using the C<--merge> option, make sure "
-"you have a reliable backup first."
+"If this option is I<not> given, then the output image will be just large "
+"enough to contain all the files, with not much wasted space."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:66
+#: ../tools/virt-make-fs.pl:199
msgid ""
-"This program can export and merge Windows Registry entries from a Windows "
-"guest."
+"To choose a fixed size output disk, specify an absolute number followed by "
+"b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
+"Petabytes or Exabytes. This must be large enough to contain all the input "
+"files, else you will get an error."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:69
+#: ../tools/virt-make-fs.pl:204
msgid ""
-"The first parameter is the libvirt guest name or the raw disk image of a "
-"Windows guest."
+"To leave extra space, specify C<+> (plus sign) and a number followed by "
+"b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
+"Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
+"the input files, and (approximately) an extra 200 MB free space."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:72
+#: ../tools/virt-make-fs.pl:210
msgid ""
-"If C<--merge> is I<not> specified, then the chosen registry key is "
-"displayed/exported (recursively). For example:"
+"Note that virt-make-fs estimates free space, and therefore will not produce "
+"filesystems containing precisely the free space requested. (It is much more "
+"expensive and time-consuming to produce a filesystem which has precisely the "
+"desired free space)."
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:75
-#, no-wrap
-msgid ""
-" $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
-"\n"
+# type: =item
+#: ../tools/virt-make-fs.pl:219
+msgid "B<--format=E<lt>fmtE<gt>>"
+msgstr ""
+
+# type: =item
+#: ../tools/virt-make-fs.pl:221
+msgid "B<-F E<lt>fmtE<gt>>"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:77
-msgid "You can also display single values from within registry keys, for example:"
+#: ../tools/virt-make-fs.pl:223
+msgid "Choose the output disk image format."
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:80
-#, no-wrap
-msgid ""
-" $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
-" $ virt-win-reg Windows7 $cvkey ProductName\n"
-" Windows 7 Enterprise\n"
-"\n"
+# type: textblock
+#: ../tools/virt-make-fs.pl:225
+msgid "The default is C<raw> (raw disk image)."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:84
+#: ../tools/virt-make-fs.pl:227
msgid ""
-"With C<--merge>, you can merge a textual regedit file into the Windows "
-"Registry:"
+"For other choices, see the L<qemu-img(1)> manpage. The only other choice "
+"that would really make sense here is C<qcow2>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:87
-#, no-wrap
-msgid ""
-" $ virt-win-reg --merge Windows7 changes.reg\n"
-"\n"
+# type: =item
+#: ../tools/virt-make-fs.pl:234
+msgid "B<--type=E<lt>fsE<gt>>"
msgstr ""
-# type: =head2
-#: ../tools/virt-win-reg.pl:89
-msgid "SUPPORTED SYSTEMS"
+# type: =item
+#: ../tools/virt-make-fs.pl:236
+msgid "B<-t E<lt>fsE<gt>>"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:91
-msgid ""
-"The program currently supports Windows NT-derived guests starting with "
-"Windows XP through to at least Windows 7."
+#: ../tools/virt-make-fs.pl:238
+msgid "Choose the output filesystem type."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:94
-msgid ""
-"Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
-"C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
-"C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
+#: ../tools/virt-make-fs.pl:240
+msgid "The default is C<ext2>."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:98
-msgid ""
-"You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
-"C<HKEY_USERS>."
+#: ../tools/virt-make-fs.pl:242
+msgid "Any filesystem which is supported read-write by libguestfs can be used here."
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:101
-msgid ""
-"C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
-"time."
+# type: =item
+#: ../tools/virt-make-fs.pl:249
+msgid "B<--partition>"
msgstr ""
-# type: =head2
-#: ../tools/virt-win-reg.pl:104
-msgid "NOTE"
+# type: =item
+#: ../tools/virt-make-fs.pl:251
+msgid "B<--partition=E<lt>parttypeE<gt>>"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:106
+#: ../tools/virt-make-fs.pl:253
msgid ""
-"This program is only meant for simple access to the registry. If you want "
-"to do complicated things with the registry, we suggest you download the "
-"Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
-"and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
-"L<hivexregedit(1)>."
-msgstr ""
-
-# type: =head2
-#: ../tools/virt-win-reg.pl:112
-msgid "ENCODING"
+"If specified, this flag adds an MBR partition table to the output disk "
+"image."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:114
+#: ../tools/virt-make-fs.pl:256
msgid ""
-"C<virt-win-reg> expects that regedit files have already been reencoded in "
-"the local encoding. Usually on Linux hosts, this means UTF-8 with "
-"Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
-"with Windows-style line endings, you may need to reencode the whole file "
-"before or after processing."
+"You can change the partition table type, eg. C<--partition=gpt> for large "
+"disks."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:120
+#: ../tools/virt-make-fs.pl:259
msgid ""
-"To reencode a file from Windows format to Linux (before processing it with "
-"the C<--merge> option), you would do something like this:"
+"Note that if you just use a lonesome C<--partition>, the Perl option parser "
+"might consider the next parameter to be the partition type. For example:"
msgstr ""
# type: verbatim
-#: ../tools/virt-win-reg.pl:123
+#: ../tools/virt-make-fs.pl:263
#, no-wrap
msgid ""
-" iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
+" virt-make-fs --partition input.tar ...\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:125
+#: ../tools/virt-make-fs.pl:265
msgid ""
-"To go in the opposite direction, after exporting and before sending the file "
-"to a Windows user, do something like this:"
+"would cause virt-make-fs to think you wanted to use a partition type of "
+"C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
+"dash) between options and the input file argument:"
msgstr ""
# type: verbatim
-#: ../tools/virt-win-reg.pl:128
+#: ../tools/virt-make-fs.pl:269
#, no-wrap
msgid ""
-" unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
+" virt-make-fs --partition -- input.tar ...\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:130
-msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-win-reg.pl:132
+#: ../tools/virt-make-fs.pl:536
msgid ""
-"If you are unsure about the current encoding, use the L<file(1)> command. "
-"Recent versions of Windows regedit.exe produce a UTF-16LE file with "
-"Windows-style (CRLF) line endings, like this:"
+"L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
+"L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
+"L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
msgstr ""
# type: verbatim
-#: ../tools/virt-win-reg.pl:136
+#: ../tools/virt-make-fs.pl:553
#, no-wrap
msgid ""
-" $ file software.reg\n"
-" software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
-" with CRLF line terminators\n"
+" export LIBGUESTFS_DEBUG=1\n"
+" virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:140
-msgid "This file would need conversion before you could C<--merge> it."
-msgstr ""
-
-# type: =head2
-#: ../tools/virt-win-reg.pl:142
-msgid "SHELL QUOTING"
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-win-reg.pl:144
+#: ../tools/virt-make-fs.pl:556
msgid ""
-"Be careful when passing parameters containing C<\\> (backslash) in the "
-"shell. Usually you will have to use 'single quotes' or double backslashes "
-"(but not both) to protect them from the shell."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-win-reg.pl:148
-msgid "Paths and value names are case-insensitive."
-msgstr ""
-
-# type: =head2
-#: ../tools/virt-win-reg.pl:150
-msgid "CurrentControlSet etc."
+"Attach /tmp/virt-make-fs.log to a new bug report at "
+"L<https://bugzilla.redhat.com/>"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:152
-msgid ""
-"Registry keys like C<CurrentControlSet> don't really exist in the Windows "
-"Registry at the level of the hive file, and therefore you cannot modify "
-"these."
+#: ../tools/virt-list-partitions.pl:32
+msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:156
+# type: verbatim
+#: ../tools/virt-list-partitions.pl:36
+#, no-wrap
msgid ""
-"C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
-"circumstances it might refer to another control set. The way to find out is "
-"to look at the C<HKLM\\SYSTEM\\Select> key:"
+" virt-list-partitions [--options] domname\n"
+"\n"
msgstr ""
# type: verbatim
-#: ../tools/virt-win-reg.pl:160
+#: ../tools/virt-list-partitions.pl:38
#, no-wrap
msgid ""
-" # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
-" [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
-" \"Current\"=dword:00000001\n"
-" \"Default\"=dword:00000001\n"
-" \"Failed\"=dword:00000000\n"
-" \"LastKnownGood\"=dword:00000002\n"
+" virt-list-partitions [--options] disk.img [disk.img ...]\n"
"\n"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:167
-msgid "\"Default\" is the one which Windows will choose when it boots."
+#: ../tools/virt-list-partitions.pl:42
+msgid ""
+"C<virt-list-partitions> is a command line tool to list the partitions that "
+"are contained in a virtual machine or disk image. It is mainly useful as a "
+"first step to using L<virt-resize(1)>."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:169
-msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
+#: ../tools/virt-list-partitions.pl:47
+msgid ""
+"C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
+"functionality. For more complex cases you should look at the "
+"L<guestfish(1)> tool."
msgstr ""
# type: =item
-#: ../tools/virt-win-reg.pl:216
-msgid "B<--merge>"
+#: ../tools/virt-list-partitions.pl:104
+msgid "B<-h> | B<--human-readable>"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:218
-msgid ""
-"In merge mode, this merges a textual regedit file into the Windows Registry "
-"of the virtual machine. If this flag is I<not> given then virt-win-reg "
-"displays or exports Registry entries instead."
+#: ../tools/virt-list-partitions.pl:106
+msgid "Show sizes in human-readable form (eg. \"1G\")."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:222
+#: ../tools/virt-list-partitions.pl:114
msgid ""
-"Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
-"result in disk corruption. However exporting (without this flag) is always "
-"safe."
+"With this option, C<virt-list-partitions> displays the type and size of each "
+"partition too (where \"type\" means C<ext3>, C<pv> etc.)"
msgstr ""
# type: =item
-#: ../tools/virt-win-reg.pl:230
-msgid "B<--encoding> UTF-16LE|ASCII"
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-win-reg.pl:232
-msgid ""
-"When merging (only), you may need to specify the encoding for strings to be "
-"used in the hive file. This is explained in detail in "
-"L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
+#: ../tools/virt-list-partitions.pl:121
+msgid "B<-t> | B<--total>"
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:236
-msgid ""
-"The default is to use UTF-16LE, which should work with recent versions of "
-"Windows."
+#: ../tools/virt-list-partitions.pl:123
+msgid "Display the total size of each block device (as a separate row or rows)."
msgstr ""
# type: textblock
-#: ../tools/virt-win-reg.pl:463
+#: ../tools/virt-list-partitions.pl:256
msgid ""
-"L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
-"L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
-"L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, "
+"L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
"L<Sys::Virt(3)>, L<http://libguestfs.org/>."
msgstr ""
-
-# type: verbatim
-#: ../tools/virt-win-reg.pl:481
-#, no-wrap
-msgid ""
-" export LIBGUESTFS_DEBUG=1\n"
-" virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-win-reg.pl:484
-msgid ""
-"Attach /tmp/virt-win-reg.log to a new bug report at "
-"L<https://bugzilla.redhat.com/>"
-msgstr ""
git.annexia.org / libguestfs.git / blobdiff