-# SOME DESCRIPTIVE TITLE.
-# Copyright (C) YEAR Free Software Foundation, Inc.
-# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+# SOME DESCRIPTIVE TITLE
+# Copyright (C) YEAR Red Hat Inc.
+# This file is distributed under the same license as the libguestfs package.
#
-#, fuzzy
+# Translators:
+# rjones <rjones@redhat.com>, 2011.
+# <www.carrotsoft@gmail.com>, 2011.
msgid ""
msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
+"Project-Id-Version: libguestfs\n"
"Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
-"POT-Creation-Date: 2010-09-10 10:25+0200\n"
-"PO-Revision-Date: 2010-09-02 14:46+0100\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
+"POT-Creation-Date: 2011-10-26 21:10+0200\n"
+"PO-Revision-Date: 2011-10-19 15:46+0000\n"
+"Last-Translator: rjones <rjones@redhat.com>\n"
+"Language-Team: Japanese <trans-ja@lists.fedoraproject.org>\n"
+"Language: ja\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
-
-# type: =encoding
-#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1
-#: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1
-#: ../inspector/virt-inspector.pl:36 ../tools/virt-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
-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
+"Plural-Forms: nplurals=1; plural=0\n"
+
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:3 ../cat/virt-cat.pod:3
+#: ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3
+#: ../clone/virt-sysprep.pod:3 ../df/virt-df.pod:3 ../edit/virt-edit.pod:3
+#: ../erlang/examples/guestfs-erlang.pod:3 ../examples/guestfs-examples.pod:3
+#: ../examples/guestfs-recipes.pod:14 ../fish/guestfish.pod:3
+#: ../fish/virt-copy-in.pod:3 ../fish/virt-copy-out.pod:3
+#: ../fish/virt-tar-in.pod:3 ../fish/virt-tar-out.pod:3
+#: ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pod:3
+#: ../java/examples/guestfs-java.pod:3 ../ocaml/examples/guestfs-ocaml.pod:3
+#: ../perl/examples/guestfs-perl.pod:3 ../python/examples/guestfs-python.pod:3
+#: ../rescue/virt-rescue.pod:3 ../resize/virt-resize.pod:3
+#: ../ruby/examples/guestfs-ruby.pod:3 ../sparsify/virt-sparsify.pod:3
+#: ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3
#: ../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
+#: ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31
+#: ../tools/virt-win-reg.pl:35
msgid "NAME"
msgstr "名前"
-# type: textblock
-#: ../src/guestfs.pod:5
-msgid "guestfs - Library for accessing and modifying virtual machine images"
-msgstr ""
-
-# type: =head1
-#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
-#: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
-#: ../inspector/virt-inspector.pl:42 ../tools/virt-cat.pl:36
-#: ../tools/virt-df.pl:38 ../tools/virt-edit.pl:37
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:5
+msgid "virt-alignment-scan - Check alignment of virtual machine partitions"
+msgstr ""
+
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:7 ../cat/virt-cat.pod:7
+#: ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7
+#: ../clone/virt-sysprep.pod:7 ../df/virt-df.pod:7 ../edit/virt-edit.pod:7
+#: ../erlang/examples/guestfs-erlang.pod:7 ../examples/guestfs-examples.pod:7
+#: ../fish/guestfish.pod:7 ../fish/virt-copy-in.pod:7
+#: ../fish/virt-copy-out.pod:7 ../fish/virt-tar-in.pod:7
+#: ../fish/virt-tar-out.pod:7 ../fuse/guestmount.pod:7
+#: ../inspector/virt-inspector.pod:7 ../java/examples/guestfs-java.pod:7
+#: ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7
+#: ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7
+#: ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7
+#: ../sparsify/virt-sparsify.pod:7 ../src/guestfs.pod:7
+#: ../test-tool/libguestfs-test-tool.pod:7
#: ../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
+#: ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35
+#: ../tools/virt-win-reg.pl:39
msgid "SYNOPSIS"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:9
-#, no-wrap
-msgid ""
-" #include <guestfs.h>\n"
-" \n"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs.pod:11
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:9
#, no-wrap
msgid ""
-" guestfs_h *g = guestfs_create ();\n"
-" guestfs_add_drive (g, \"guest.img\");\n"
-" guestfs_launch (g);\n"
-" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
-" guestfs_touch (g, \"/hello\");\n"
-" guestfs_umount (g, \"/\");\n"
-" guestfs_sync (g);\n"
-" guestfs_close (g);\n"
+" virt-alignment-scan [--options] -d domname\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:20
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:11
#, no-wrap
msgid ""
-" cc prog.c -o prog -lguestfs\n"
-"or:\n"
-" cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
+" virt-alignment-scan [--options] -a disk.img [-a disk.img ...]\n"
"\n"
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
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:13 ../cat/virt-cat.pod:19
+#: ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19
+#: ../clone/virt-sysprep.pod:13 ../df/virt-df.pod:21 ../edit/virt-edit.pod:27
+#: ../erlang/examples/guestfs-erlang.pod:16
+#: ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18
+#: ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19
+#: ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21
+#: ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20
+#: ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15
+#: ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18
+#: ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29
+#: ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15
+#: ../sparsify/virt-sparsify.pod:11 ../src/guestfs.pod:23
+#: ../test-tool/libguestfs-test-tool.pod:11
#: ../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
+#: ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77
+#: ../tools/virt-win-reg.pl:63
msgid "DESCRIPTION"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:26
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:15
msgid ""
-"Libguestfs is a library for accessing and modifying guest disk images. "
-"Amongst the things this is good for: making batch configuration changes to "
-"guests, getting disk used/free statistics (see also: virt-df), migrating "
-"between virtualization systems (see also: virt-p2v), performing partial "
-"backups, performing partial guest clones, cloning guests and changing "
-"registry/UUID/hostname info, and much else besides."
+"When older operating systems install themselves, the partitioning tools "
+"place partitions at a sector misaligned with the underlying storage "
+"(commonly the first partition starts on sector C<63>). Misaligned "
+"partitions can result in an operating system issuing more I/O than should be "
+"necessary."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:34
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:21
msgid ""
-"Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
-"filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
-"btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
-"qcow2, vmdk."
+"The virt-alignment-scan tool checks the alignment of partitions in virtual "
+"machines and disk images and warns you if there are alignment problems."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:39
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:25
msgid ""
-"Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
-"what filesystem is in each LV, etc.). It can also run commands in the "
-"context of the guest. Also you can access filesystems over FUSE."
+"Currently there is no virt tool for fixing alignment problems. You can only "
+"reinstall the guest operating system. The following NetApp document "
+"summarises the problem and possible solutions: L<http://media.netapp.com/"
+"documents/tr-3747.pdf>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:44
-msgid ""
-"Libguestfs is a library that can be linked with C and C++ management "
-"programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
-"PHP, Haskell or C#). You can also use it from shell scripts or the command "
-"line."
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:30
+msgid "OUTPUT"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:49
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:32
+msgid "To run this tool on a disk image directly, use the I<-a> option:"
+msgstr ""
+
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:34
+#, no-wrap
msgid ""
-"You don't need to be root to use libguestfs, although obviously you do need "
-"enough permissions to access the disk images."
+" $ virt-alignment-scan -a winxp.img\n"
+" /dev/sda1 32256 512 bad (alignment < 4K)\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:52
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:37
+#, no-wrap
msgid ""
-"Libguestfs is a large API because it can do many things. For a gentle "
-"introduction, please read the L</API OVERVIEW> section next."
+" $ virt-alignment-scan -a fedora16.img\n"
+" /dev/sda1 1048576 1024K ok\n"
+" /dev/sda2 2097152 2048K ok\n"
+" /dev/sda3 526385152 2048K ok\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:55
-msgid "API OVERVIEW"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:42
+msgid ""
+"To run the tool on a guest known to libvirt, use the I<-d> option and "
+"possibly the I<-c> option:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:57
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:45
+#, no-wrap
msgid ""
-"This section provides a gentler overview of the libguestfs API. We also try "
-"to group API calls together, where that may not be obvious from reading "
-"about the individual calls in the main section of this manual."
+" # virt-alignment-scan -d RHEL5\n"
+" /dev/sda1 32256 512 bad (alignment < 4K)\n"
+" /dev/sda2 106928640 512 bad (alignment < 4K)\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:62
-msgid "HANDLES"
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:49
+#, no-wrap
+msgid ""
+" $ virt-alignment-scan -c qemu:///system -d Win7TwoDisks\n"
+" /dev/sda1 1048576 1024K ok\n"
+" /dev/sda2 105906176 1024K ok\n"
+" /dev/sdb1 65536 64K ok\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:64
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:54
msgid ""
-"Before you can use libguestfs calls, you have to create a handle. Then you "
-"must add at least one disk image to the handle, followed by launching the "
-"handle, then performing whatever operations you want, and finally closing "
-"the handle. By convention we use the single letter C<g> for the name of the "
-"handle variable, although of course you can use any name you want."
+"The output consists of 4 or more whitespace-separated columns. Only the "
+"first 4 columns are signficant if you want to parse this from a program. "
+"The columns are:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:71
-msgid "The general structure of all libguestfs-using programs looks like this:"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:60
+msgid "col 1"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:74
-#, no-wrap
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:62
msgid ""
-" guestfs_h *g = guestfs_create ();\n"
-" \n"
+"the device and partition name (eg. C</dev/sda1> meaning the first partition "
+"on the first block device)"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:76
-#, no-wrap
-msgid ""
-" /* Call guestfs_add_drive additional times if there are\n"
-" * multiple disk images.\n"
-" */\n"
-" guestfs_add_drive (g, \"guest.img\");\n"
-" \n"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:65
+msgid "col 2"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:81
-#, no-wrap
-msgid ""
-" /* Most manipulation calls won't work until you've launched\n"
-" * the handle 'g'. You have to do this _after_ adding drives\n"
-" * and _before_ other commands.\n"
-" */\n"
-" guestfs_launch (g);\n"
-" \n"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:67
+msgid "the start of the partition in bytes"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:87
-#, no-wrap
-msgid ""
-" /* Now you can examine what partitions, LVs etc are available.\n"
-" */\n"
-" char **partitions = guestfs_list_partitions (g);\n"
-" char **logvols = guestfs_lvs (g);\n"
-" \n"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:69
+msgid "col 3"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:92
-#, no-wrap
-msgid ""
-" /* To access a filesystem in the image, you must mount it.\n"
-" */\n"
-" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
-" \n"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:71
+msgid "the alignment in bytes or Kbytes (eg. C<512> or C<4K>)"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:96
-#, no-wrap
-msgid ""
-" /* Now you can perform filesystem actions on the guest\n"
-" * disk image.\n"
-" */\n"
-" guestfs_touch (g, \"/hello\");\n"
-" \n"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:73
+msgid "col 4"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:101
-#, no-wrap
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:75
msgid ""
-" /* You only need to call guestfs_sync if you have made\n"
-" * changes to the guest image. (But if you've made changes\n"
-" * then you *must* sync). See also: guestfs_umount and\n"
-" * guestfs_umount_all calls.\n"
-" */\n"
-" guestfs_sync (g);\n"
-" \n"
+"C<ok> if the alignment is best for performance, or C<bad> if the alignment "
+"can cause performance problems"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:108
-#, no-wrap
-msgid ""
-" /* Close the handle 'g'. */\n"
-" guestfs_close (g);\n"
-"\n"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:78
+msgid "cols 5+"
+msgstr ""
+
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:80
+msgid "optional free-text explanation."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:111
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:84
msgid ""
-"The code above doesn't include any error checking. In real code you should "
-"check return values carefully for errors. In general all functions that "
-"return integers return C<-1> on error, and all functions that return "
-"pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
-"how to handle errors, and consult the documentation for each function call "
-"below to see precisely how they return error indications."
+"The exit code from the program changes depending on whether poorly aligned "
+"partitions were found. See L</EXIT STATUS> below."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:119
-msgid "DISK IMAGES"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:87
+msgid "If you just want the exit code with no output, use the I<-q> option."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:121
-msgid ""
-"The image filename (C<\"guest.img\"> in the example above) could be a disk "
-"image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
-"actual block device, or simply an empty file of zeroes that you have created "
-"through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
-"of these."
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:89 ../cat/virt-cat.pod:62
+#: ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261
+#: ../clone/virt-sysprep.pod:42 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62
+#: ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45
+#: ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42
+#: ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:92
+#: ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84
+#: ../resize/virt-resize.pod:262 ../sparsify/virt-sparsify.pod:99
+#: ../test-tool/libguestfs-test-tool.pod:36
+#: ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54
+#: ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103
+#: ../tools/virt-win-reg.pl:96
+msgid "OPTIONS"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:127
-msgid ""
-"You can add a disk read-only using L</guestfs_add_drive_ro>, in which case "
-"libguestfs won't modify the file."
+#. type: =item
+#: ../align/virt-alignment-scan.pod:93 ../cat/virt-cat.pod:66
+#: ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265
+#: ../clone/virt-sysprep.pod:46 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66
+#: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:160
+#: ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88
+#: ../resize/virt-resize.pod:266 ../sparsify/virt-sparsify.pod:103
+#: ../test-tool/libguestfs-test-tool.pod:40
+#: ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62
+#: ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111
+#: ../tools/virt-win-reg.pl:104
+msgid "B<--help>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:130
-msgid ""
-"Be extremely cautious if the disk image is in use, eg. if it is being used "
-"by a virtual machine. Adding it read-write will almost certainly cause disk "
-"corruption, but adding it read-only is safe."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:95 ../cat/virt-cat.pod:68
+#: ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267
+#: ../clone/virt-sysprep.pod:48 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68
+#: ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90
+#: ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64
+#: ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113
+#: ../tools/virt-win-reg.pl:106
+msgid "Display brief help."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:134
-msgid ""
-"You must add at least one disk image, and you may add multiple disk images. "
-"In the API, the disk images are usually referred to as C</dev/sda> (for the "
-"first one you added), C</dev/sdb> (for the second one you added), etc."
+#. type: =item
+#: ../align/virt-alignment-scan.pod:97 ../cat/virt-cat.pod:70
+#: ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269
+#: ../clone/virt-sysprep.pod:50 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70
+#: ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
+msgid "B<-a> file"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:139
-msgid ""
-"Once L</guestfs_launch> has been called you cannot add any more images. You "
-"can call L</guestfs_list_devices> to get a list of the device names, in the "
-"order that you added them. See also L</BLOCK DEVICE NAMING> below."
+#. type: =item
+#: ../align/virt-alignment-scan.pod:99 ../cat/virt-cat.pod:72
+#: ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271
+#: ../clone/virt-sysprep.pod:52 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72
+#: ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
+msgid "B<--add> file"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:144
-msgid "MOUNTING"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:101 ../clone/virt-sysprep.pod:54
+msgid "Add I<file> which should be a disk image from a virtual machine."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:146
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:103 ../cat/virt-cat.pod:78
+#: ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277
+#: ../clone/virt-sysprep.pod:56 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78
+#: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:102
+#: ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
msgid ""
-"Before you can read or write files, create directories and so on in a disk "
-"image that contains filesystems, you have to mount those filesystems using "
-"L</guestfs_mount>. If you already know that a disk image contains (for "
-"example) one partition with a filesystem on that partition, then you can "
-"mount it directly:"
+"The format of the disk image is auto-detected. To override this and force a "
+"particular format use the I<--format=..> option."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:152
-#, no-wrap
-msgid ""
-" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
-"\n"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:106 ../cat/virt-cat.pod:81
+#: ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291
+#: ../clone/virt-sysprep.pod:59 ../df/virt-df.pod:78
+#: ../rescue/virt-rescue.pod:107
+msgid "B<-c> URI"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:154
-msgid ""
-"where C</dev/sda1> means literally the first partition (C<1>) of the first "
-"disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
-"logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
+#. type: =item
+#: ../align/virt-alignment-scan.pod:108 ../cat/virt-cat.pod:83
+#: ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293
+#: ../clone/virt-sysprep.pod:61 ../df/virt-df.pod:80
+#: ../rescue/virt-rescue.pod:109
+msgid "B<--connect> URI"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:158
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:110 ../cat/virt-cat.pod:85
+#: ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295
+#: ../clone/virt-sysprep.pod:63 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99
+#: ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111
+#: ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82
+#: ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
msgid ""
-"If you are given a disk image and you don't know what it contains then you "
-"have to find out. Libguestfs can do that too: use L</"
-"guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
-"LVs, and either try mounting each to see what is mountable, or else examine "
-"them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also has a "
-"set of APIs for inspection of disk images (see L</INSPECTION> below). But "
-"you might find it easier to look at higher level programs built on top of "
-"libguestfs, in particular L<virt-inspector(1)>."
+"If using libvirt, connect to the given I<URI>. If omitted, then we connect "
+"to the default libvirt hypervisor."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:168
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:113 ../cat/virt-cat.pod:88
+#: ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298
+#: ../clone/virt-sysprep.pod:66 ../df/virt-df.pod:85
+#: ../rescue/virt-rescue.pod:114
msgid ""
-"To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
-"several other variations of the C<guestfs_mount_*> call."
+"If you specify guest block devices directly (I<-a>), then libvirt is not "
+"used at all."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:171
-msgid "FILESYSTEM ACCESS AND MODIFICATION"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:116 ../cat/virt-cat.pod:91
+#: ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307
+#: ../clone/virt-sysprep.pod:69 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105
+#: ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
+msgid "B<-d> guest"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:173
-msgid ""
-"The majority of the libguestfs API consists of fairly low-level calls for "
-"accessing and modifying the files, directories, symlinks etc on mounted "
-"filesystems. There are over a hundred such calls which you can find listed "
-"in detail below in this man page, and we don't even pretend to cover them "
-"all in this overview."
+#. type: =item
+#: ../align/virt-alignment-scan.pod:118 ../cat/virt-cat.pod:93
+#: ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309
+#: ../clone/virt-sysprep.pod:71 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107
+#: ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
+msgid "B<--domain> guest"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:179
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:120 ../cat/virt-cat.pod:95
+#: ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311
+#: ../clone/virt-sysprep.pod:73 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109
+#: ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
msgid ""
-"Specify filenames as full paths, starting with C<\"/\"> and including the "
-"mount point."
+"Add all the disks from the named libvirt guest. Domain UUIDs can be used "
+"instead of names."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:182
-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:"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:123 ../cat/virt-cat.pod:105
+#: ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328
+#: ../clone/virt-sysprep.pod:95 ../df/virt-df.pod:101
+#: ../fish/guestfish.pod:233 ../fuse/guestmount.pod:142
+#: ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:124
+msgid "B<--format=raw|qcow2|..>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:185
-#, no-wrap
-msgid ""
-" char *data = guestfs_cat (g, \"/etc/passwd\");\n"
-"\n"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:125 ../cat/virt-cat.pod:107
+#: ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330
+#: ../clone/virt-sysprep.pod:97 ../df/virt-df.pod:103
+#: ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235
+#: ../fuse/guestmount.pod:144 ../inspector/virt-inspector.pod:101
+#: ../rescue/virt-rescue.pod:126
+msgid "B<--format>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:187
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:127 ../cat/virt-cat.pod:109
+#: ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332
+#: ../clone/virt-sysprep.pod:99 ../df/virt-df.pod:105
+#: ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237
+#: ../fuse/guestmount.pod:146 ../rescue/virt-rescue.pod:128
msgid ""
-"This would return C<data> as a newly allocated buffer containing the full "
-"content of that file (with some conditions: see also L</DOWNLOADING> below), "
-"or C<NULL> if there was an error."
+"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: textblock
-#: ../src/guestfs.pod:191
-msgid ""
-"As another example, to create a top-level directory on that filesystem "
-"called C<\"var\"> you would do:"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:132 ../cat/virt-cat.pod:114
+#: ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337
+#: ../clone/virt-sysprep.pod:104 ../df/virt-df.pod:110
+#: ../edit/virt-edit.pod:141 ../fish/guestfish.pod:242
+#: ../fish/guestfish.pod:673 ../inspector/virt-inspector.pod:336
+#: ../rescue/virt-rescue.pod:133 ../src/guestfs.pod:2877
+msgid "For example:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:194
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:134
#, no-wrap
msgid ""
-" guestfs_mkdir (g, \"/var\");\n"
+" virt-alignment-scan --format=raw -a disk.img\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:196
-msgid "To create a symlink you could do:"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:136 ../cat/virt-cat.pod:118
+#: ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341
+#: ../clone/virt-sysprep.pod:108 ../df/virt-df.pod:114
+#: ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246
+#: ../rescue/virt-rescue.pod:137
+msgid "forces raw format (no auto-detection) for C<disk.img>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:198
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:138
#, no-wrap
msgid ""
-" guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
-" \"/etc/rc3.d/S30portmap\");\n"
+" virt-alignment-scan --format=raw -a disk.img --format -a another.img\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:201
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:140 ../cat/virt-cat.pod:122
+#: ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345
+#: ../clone/virt-sysprep.pod:112 ../df/virt-df.pod:118
+#: ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250
+#: ../rescue/virt-rescue.pod:141
msgid ""
-"Libguestfs will reject attempts to use relative paths and there is no "
-"concept of a current working directory."
+"forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
+"detection for C<another.img>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:204
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:143 ../cat/virt-cat.pod:125
+#: ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348
+#: ../clone/virt-sysprep.pod:115 ../df/virt-df.pod:121
+#: ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:144
msgid ""
-"Libguestfs can return errors in many situations: for example if the "
-"filesystem isn't writable, or if a file or directory that you requested "
-"doesn't exist. If you are using the C API (documented here) you have to "
-"check for those error conditions after each call. (Other language bindings "
-"turn these errors into exceptions)."
+"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)."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:210
-msgid ""
-"File writes are affected by the per-handle umask, set by calling L</"
-"guestfs_umask> and defaulting to 022. See L</UMASK>."
+#. type: =item
+#: ../align/virt-alignment-scan.pod:147 ../resize/virt-resize.pod:491
+#: ../sparsify/virt-sparsify.pod:153
+msgid "B<-q>"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:213
-msgid "PARTITIONING"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:149 ../resize/virt-resize.pod:493
+#: ../sparsify/virt-sparsify.pod:155
+msgid "B<--quiet>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:215
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:151
msgid ""
-"Libguestfs contains API calls to read, create and modify partition tables on "
-"disk images."
+"Don't produce any output. Just set the exit code (see L</EXIT STATUS> "
+"below)."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:218
-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:"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:154 ../cat/virt-cat.pod:134
+#: ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425
+#: ../clone/virt-sysprep.pod:138 ../df/virt-df.pod:173
+#: ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390
+#: ../fuse/guestmount.pod:266 ../inspector/virt-inspector.pod:119
+#: ../rescue/virt-rescue.pod:182 ../sparsify/virt-sparsify.pod:159
+msgid "B<-v>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:222
-#, no-wrap
-msgid ""
-" const char *parttype = \"mbr\";\n"
-" if (disk_is_larger_than_2TB)\n"
-" parttype = \"gpt\";\n"
-" guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
-"\n"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:156 ../cat/virt-cat.pod:136
+#: ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427
+#: ../clone/virt-sysprep.pod:140 ../df/virt-df.pod:175
+#: ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392
+#: ../fuse/guestmount.pod:268 ../inspector/virt-inspector.pod:121
+#: ../rescue/virt-rescue.pod:184 ../sparsify/virt-sparsify.pod:161
+msgid "B<--verbose>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:227
-msgid ""
-"Obviously this effectively wipes anything that was on that disk image before."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:158 ../cat/virt-cat.pod:138
+#: ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429
+#: ../clone/virt-sysprep.pod:142 ../df/virt-df.pod:177
+#: ../edit/virt-edit.pod:165 ../inspector/virt-inspector.pod:123
+#: ../rescue/virt-rescue.pod:186 ../sparsify/virt-sparsify.pod:163
+msgid "Enable verbose messages for debugging."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:230
-msgid "LVM2"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:160 ../cat/virt-cat.pod:140
+#: ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431
+#: ../clone/virt-sysprep.pod:144 ../df/virt-df.pod:179
+#: ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397
+#: ../fuse/guestmount.pod:272 ../inspector/virt-inspector.pod:125
+#: ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:561
+#: ../sparsify/virt-sparsify.pod:165
+msgid "B<-V>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:232
-msgid ""
-"Libguestfs provides access to a large part of the LVM2 API, such as L</"
-"guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
-"you familiarize yourself with the concepts of physical volumes, volume "
-"groups and logical volumes."
+#. type: =item
+#: ../align/virt-alignment-scan.pod:162 ../cat/virt-cat.pod:142
+#: ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433
+#: ../clone/virt-sysprep.pod:146 ../df/virt-df.pod:181
+#: ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399
+#: ../fuse/guestmount.pod:274 ../inspector/virt-inspector.pod:127
+#: ../rescue/virt-rescue.pod:190 ../resize/virt-resize.pod:563
+#: ../sparsify/virt-sparsify.pod:167 ../tools/virt-list-filesystems.pl:69
+#: ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169
+#: ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
+msgid "B<--version>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:237
-msgid ""
-"This author strongly recommends reading the LVM HOWTO, online at L<http://"
-"tldp.org/HOWTO/LVM-HOWTO/>."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:164 ../cat/virt-cat.pod:144
+#: ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435
+#: ../clone/virt-sysprep.pod:148 ../df/virt-df.pod:183
+#: ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129
+#: ../rescue/virt-rescue.pod:192 ../resize/virt-resize.pod:565
+#: ../sparsify/virt-sparsify.pod:169 ../tools/virt-list-filesystems.pl:71
+#: ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171
+#: ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
+msgid "Display version number and exit."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:240
-msgid "DOWNLOADING"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:166 ../cat/virt-cat.pod:146
+#: ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437
+#: ../clone/virt-sysprep.pod:150 ../df/virt-df.pod:185
+#: ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412
+#: ../fuse/guestmount.pod:287 ../inspector/virt-inspector.pod:131
+#: ../rescue/virt-rescue.pod:203 ../sparsify/virt-sparsify.pod:171
+#: ../tools/virt-tar.pl:158
+msgid "B<-x>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:242
-msgid ""
-"Use L</guestfs_cat> to download small, text only files. This call is "
-"limited to files which are less than 2 MB and which cannot contain any ASCII "
-"NUL (C<\\0>) characters. However it has a very simple to use API."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:168 ../cat/virt-cat.pod:148
+#: ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439
+#: ../clone/virt-sysprep.pod:152 ../df/virt-df.pod:187
+#: ../edit/virt-edit.pod:175 ../inspector/virt-inspector.pod:133
+#: ../rescue/virt-rescue.pod:205 ../sparsify/virt-sparsify.pod:173
+msgid "Enable tracing of libguestfs API calls."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:247
-msgid ""
-"L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
-"bit data, since it returns a (pointer, size) pair. However it is still "
-"limited to \"small\" files, less than 2 MB."
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:172
+msgid "RECOMMENDED ALIGNMENT"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:251
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:174
msgid ""
-"L</guestfs_download> can be used to download any file, with no limits on "
-"content or size (even files larger than 4 GB)."
+"Operating systems older than Windows 2008 and Linux before ca.2010 place the "
+"first sector of the first partition at sector 63, with a 512 byte sector "
+"size. This happens because of a historical accident. Drives have to report "
+"a cylinder / head / sector (CHS) geometry to the BIOS. The geometry is "
+"completely meaningless on modern drives, but it happens that the geometry "
+"reported always has 63 sectors per track. The operating system therefore "
+"places the first partition at the start of the second \"track\", at sector "
+"63."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:254
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:183
msgid ""
-"To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
+"When the guest OS is virtualized, the host operating system and hypervisor "
+"may prefer accesses aligned to one of:"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:257
-msgid "UPLOADING"
+#. type: =item
+#: ../align/virt-alignment-scan.pod:188
+msgid "* 512 bytes"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:259
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:190
msgid ""
-"It's often the case that you want to write a file or files to the disk image."
+"if the host OS uses local storage directly on hard drive partitions, and the "
+"hard drive has 512 byte physical sectors."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:262
+#. type: =item
+#: ../align/virt-alignment-scan.pod:193
+msgid "* 4 Kbytes"
+msgstr ""
+
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:195
msgid ""
-"To write a small file with fixed content, use L</guestfs_write>. To create "
-"a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
-"guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
-"of other functions for creating test files, for example L</guestfs_fill> and "
-"L</guestfs_fill_pattern>."
+"for local storage on new hard drives with 4Kbyte physical sectors; for file-"
+"backed storage on filesystems with 4Kbyte block size; or for some types of "
+"network-attached storage."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:268
-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)."
+#. type: =item
+#: ../align/virt-alignment-scan.pod:199
+msgid "* 64 Kbytes"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:271
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:201
msgid ""
-"To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
+"for high-end network-attached storage. This is the optimal block size for "
+"some NetApp hardware."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:273
-msgid ""
-"However the fastest way to upload I<large numbers of arbitrary files> is to "
-"turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
-">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
-"in a predictable way (eg. adding it last after all other drives) then you "
-"can get the device name from L</guestfs_list_devices> and mount it directly "
-"using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
-"portable between kernel versions, and they don't support labels or UUIDs. "
-"If you want to pre-build an image or you need to mount it using a label or "
-"UUID, use an ISO image instead."
+#. type: =item
+#: ../align/virt-alignment-scan.pod:204
+msgid "* 1 Mbyte"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:284
-msgid "COPYING"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:206
+msgid "see L</1 MB PARTITION ALIGNMENT> below."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:286
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:210
msgid ""
-"There are various different commands for copying between files and devices "
-"and in and out of the guest filesystem. These are summarised in the table "
-"below."
+"Partitions which are not aligned correctly to the underlying storage cause "
+"extra I/O. For example:"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:292
-msgid "B<file> to B<file>"
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:213
+#, no-wrap
+msgid ""
+" sect#63\n"
+" +--------------------------+------\n"
+" | guest |\n"
+" | filesystem block |\n"
+" ---+------------------+------+-------------------+-----+---\n"
+" | host block | host block |\n"
+" | | |\n"
+" ---+-------------------------+-------------------------+---\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:294
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:222
msgid ""
-"Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
-"directories recursively."
+"In this example, each time a 4K guest block is read, two blocks on the host "
+"must be accessed (so twice as much I/O is done). When a 4K guest block is "
+"written, two host blocks must first be read, the old and new data combined, "
+"and the two blocks written back (4x I/O)."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:297
-msgid "B<file or device> to B<file or device>"
+#. type: =head2
+#: ../align/virt-alignment-scan.pod:227
+msgid "LINUX HOST BLOCK AND I/O SIZE"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:299
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:229
msgid ""
-"Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
-"devices in the guest."
+"New versions of the Linux kernel expose the physical and logical block size, "
+"and minimum and recommended I/O size."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:302
-msgid "Example: duplicate the contents of an LV:"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:232
+msgid "For a typical hard drive with 512 byte sectors:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:304
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:234
#, no-wrap
msgid ""
-" guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
+" $ cat /sys/block/sda/queue/physical_block_size\n"
+" 512\n"
+" $ cat /sys/block/sda/queue/logical_block_size\n"
+" 512\n"
+" $ cat /sys/block/sda/queue/minimum_io_size\n"
+" 512\n"
+" $ cat /sys/block/sda/queue/optimal_io_size\n"
+" 0\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:306
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:243
+msgid "For a NetApp LUN:"
+msgstr ""
+
+#. type: verbatim
+#: ../align/virt-alignment-scan.pod:245
+#, no-wrap
msgid ""
-"The destination (C</dev/VG/Copy>) must be at least as large as the source "
-"(C</dev/VG/Original>). To copy less than the whole source device, use L</"
-"guestfs_copy_size>."
+" $ cat /sys/block/sdc/queue/logical_block_size\n"
+" 512\n"
+" $ cat /sys/block/sdc/queue/physical_block_size\n"
+" 512\n"
+" $ cat /sys/block/sdc/queue/minimum_io_size\n"
+" 4096\n"
+" $ cat /sys/block/sdc/queue/optimal_io_size\n"
+" 65536\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:310
-msgid "B<file on the host> to B<file or device>"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:254
+msgid ""
+"The NetApp allows 512 byte accesses (but they will be very inefficient), "
+"prefers a minimum 4K I/O size, but the optimal I/O size is 64K."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:312
-msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:258
+msgid ""
+"For detailed information about what these numbers mean, see L<http://docs."
+"redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/"
+"Storage_Administration_Guide/newstorage-iolimits.html>"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:314
-msgid "B<file or device> to B<file on the host>"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:261
+msgid ""
+"[Thanks to Mike Snitzer for providing NetApp data and additional "
+"information.]"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:316
-msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
+#. type: =head2
+#: ../align/virt-alignment-scan.pod:264
+msgid "1 MB PARTITION ALIGNMENT"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:320
-msgid "LISTING FILES"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:266
+msgid ""
+"Microsoft picked 1 MB as the default alignment for all partitions starting "
+"with Windows 2008 Server, and Linux has followed this."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:322
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:269
msgid ""
-"L</guestfs_ll> is just designed for humans to read (mainly when using the "
-"L<guestfish(1)>-equivalent command C<ll>)."
+"Assuming 512 byte sectors in the guest, you will now see the first partition "
+"starting at sector 2048, and subsequent partitions (if any) will start at a "
+"multiple of 2048 sectors."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:325
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:273
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."
+"1 MB alignment is compatible with all current alignment requirements (4K, "
+"64K) and provides room for future growth in physical block sizes."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:328
+#. type: =head2
+#: ../align/virt-alignment-scan.pod:276
+msgid "SETTING ALIGNMENT"
+msgstr ""
+
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:278
msgid ""
-"L</guestfs_readdir> is a programmatic way to get a list of files in a "
-"directory, plus additional information about each one. It is more "
-"equivalent to using the L<readdir(3)> call on a local filesystem."
+"L<virt-resize(1)> can change the alignment of the partitions of some "
+"guests. Currently it can fully align all the partitions of all Windows "
+"guests, and it will fix the bootloader where necessary. For Linux guests, "
+"it can align the second and subsequent partitions, so the majority of OS "
+"accesses except at boot will be aligned."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:332
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:284
msgid ""
-"L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
+"Another way to correct partition alignment problems is to reinstall your "
+"guest operating systems. If you install operating systems from templates, "
+"ensure these have correct partition alignment too."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:335
-msgid "RUNNING COMMANDS"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:288
+msgid ""
+"For older versions of Windows, the following NetApp document contains useful "
+"information: L<http://media.netapp.com/documents/tr-3747.pdf>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:337
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:291
msgid ""
-"Although libguestfs is primarily an API for manipulating files inside guest "
-"images, we also provide some limited facilities for running commands inside "
-"guests."
+"For Red Hat Enterprise Linux E<le> 5, use a Kickstart script that contains "
+"an explicit C<%pre> section that creates aligned partitions using L<parted(8)"
+">. Do not use the Kickstart C<part> command. The NetApp document above "
+"contains an example."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:341
-msgid "There are many limitations to this:"
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:296 ../cat/virt-cat.pod:231
+#: ../cat/virt-filesystems.pod:373 ../cat/virt-ls.pod:483
+#: ../clone/virt-sysprep.pod:475 ../df/virt-df.pod:215
+#: ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:352
+#: ../rescue/virt-rescue.pod:266 ../resize/virt-resize.pod:676
+#: ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258
+#: ../tools/virt-make-fs.pl:550 ../tools/virt-tar.pl:289
+#: ../tools/virt-win-reg.pl:744
+msgid "SHELL QUOTING"
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
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:298 ../cat/virt-cat.pod:233
+#: ../cat/virt-filesystems.pod:375 ../cat/virt-ls.pod:485
+#: ../clone/virt-sysprep.pod:477 ../df/virt-df.pod:217
+#: ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:354
+#: ../rescue/virt-rescue.pod:268 ../resize/virt-resize.pod:678
+#: ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260
+#: ../tools/virt-make-fs.pl:552 ../tools/virt-tar.pl:291
+#: ../tools/virt-win-reg.pl:752
+msgid ""
+"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: =head1
+#: ../align/virt-alignment-scan.pod:303 ../cat/virt-cat.pod:238
+#: ../cat/virt-filesystems.pod:380 ../cat/virt-ls.pod:490
+#: ../clone/virt-sysprep.pod:482 ../df/virt-df.pod:222
+#: ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1114
+#: ../fuse/guestmount.pod:312 ../inspector/virt-inspector.pod:375
+#: ../resize/virt-resize.pod:683 ../sparsify/virt-sparsify.pod:227
+#: ../test-tool/libguestfs-test-tool.pod:90
+msgid "EXIT STATUS"
+msgstr ""
+
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:305
+msgid "This program returns:"
+msgstr ""
+
+#. type: =item
+#: ../align/virt-alignment-scan.pod:309 ../align/virt-alignment-scan.pod:315
+#: ../align/virt-alignment-scan.pod:321 ../align/virt-alignment-scan.pod:328
+#: ../cat/virt-cat.pod:177 ../cat/virt-cat.pod:182 ../cat/virt-cat.pod:187
+#: ../cat/virt-cat.pod:198 ../cat/virt-cat.pod:202
+#: ../clone/virt-sysprep.pod:283 ../clone/virt-sysprep.pod:287
+#: ../clone/virt-sysprep.pod:291 ../clone/virt-sysprep.pod:295
+#: ../clone/virt-sysprep.pod:310 ../clone/virt-sysprep.pod:314
+#: ../clone/virt-sysprep.pod:318 ../clone/virt-sysprep.pod:322
+#: ../clone/virt-sysprep.pod:326 ../clone/virt-sysprep.pod:362
+#: ../clone/virt-sysprep.pod:384 ../clone/virt-sysprep.pod:388
+#: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266
+#: ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276
+#: ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291
+#: ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102
+#: ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132
+#: ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227
+#: ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235
+#: ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243
#: ../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
+#: ../fish/guestfish-actions.pod:441 ../fish/guestfish-actions.pod:449
+#: ../fish/guestfish-actions.pod:456 ../fish/guestfish-actions.pod:463
+#: ../fish/guestfish-actions.pod:1262 ../fish/guestfish-actions.pod:1266
+#: ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1274
+#: ../fish/guestfish-actions.pod:1282 ../fish/guestfish-actions.pod:1286
+#: ../fish/guestfish-actions.pod:1290 ../fish/guestfish-actions.pod:1300
+#: ../fish/guestfish-actions.pod:1304 ../fish/guestfish-actions.pod:1308
+#: ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:1402
+#: ../fish/guestfish-actions.pod:1407 ../fish/guestfish-actions.pod:1412
+#: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:1458
+#: ../fish/guestfish-actions.pod:1463 ../fish/guestfish-actions.pod:1719
+#: ../fish/guestfish-actions.pod:1726 ../fish/guestfish-actions.pod:1733
+#: ../fish/guestfish-actions.pod:2136 ../fish/guestfish-actions.pod:2142
+#: ../fish/guestfish-actions.pod:2150 ../fish/guestfish-actions.pod:2157
+#: ../fish/guestfish-actions.pod:2164 ../fish/guestfish.pod:445
+#: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
+#: ../fish/guestfish.pod:457 ../inspector/virt-inspector.pod:393
+#: ../inspector/virt-inspector.pod:397 ../resize/virt-resize.pod:359
+#: ../resize/virt-resize.pod:363 ../resize/virt-resize.pod:372
+#: ../resize/virt-resize.pod:378 ../sparsify/virt-sparsify.pod:32
+#: ../sparsify/virt-sparsify.pod:39 ../sparsify/virt-sparsify.pod:43
+#: ../sparsify/virt-sparsify.pod:49 ../sparsify/virt-sparsify.pod:54
+#: ../sparsify/virt-sparsify.pod:58 ../sparsify/virt-sparsify.pod:64
+#: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:29
+#: ../src/guestfs-actions.pod:641 ../src/guestfs-actions.pod:649
+#: ../src/guestfs-actions.pod:656 ../src/guestfs-actions.pod:663
+#: ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2075
+#: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:2083
+#: ../src/guestfs-actions.pod:2091 ../src/guestfs-actions.pod:2095
+#: ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2109
+#: ../src/guestfs-actions.pod:2113 ../src/guestfs-actions.pod:2117
+#: ../src/guestfs-actions.pod:2255 ../src/guestfs-actions.pod:2259
+#: ../src/guestfs-actions.pod:2264 ../src/guestfs-actions.pod:2269
+#: ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:2334
+#: ../src/guestfs-actions.pod:2339 ../src/guestfs-actions.pod:2754
+#: ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2768
+#: ../src/guestfs-actions.pod:3313 ../src/guestfs-actions.pod:3319
+#: ../src/guestfs-actions.pod:3327 ../src/guestfs-actions.pod:3334
+#: ../src/guestfs-actions.pod:3341 ../src/guestfs.pod:403
+#: ../src/guestfs.pod:408 ../src/guestfs.pod:413 ../src/guestfs.pod:417
+#: ../src/guestfs.pod:422 ../src/guestfs.pod:426 ../src/guestfs.pod:431
+#: ../src/guestfs.pod:436 ../src/guestfs.pod:1109 ../src/guestfs.pod:1113
+#: ../src/guestfs.pod:1117 ../src/guestfs.pod:1122 ../src/guestfs.pod:1130
+#: ../src/guestfs.pod:1149 ../src/guestfs.pod:1157 ../src/guestfs.pod:1179
+#: ../src/guestfs.pod:1183 ../src/guestfs.pod:1187 ../src/guestfs.pod:1191
+#: ../src/guestfs.pod:1195 ../src/guestfs.pod:1199 ../src/guestfs.pod:1689
+#: ../src/guestfs.pod:1694 ../src/guestfs.pod:1698 ../src/guestfs.pod:1800
+#: ../src/guestfs.pod:1805 ../src/guestfs.pod:1809 ../src/guestfs.pod:1819
+#: ../src/guestfs.pod:2108 ../src/guestfs.pod:2113 ../src/guestfs.pod:2119
+#: ../src/guestfs.pod:2127 ../src/guestfs.pod:2645 ../src/guestfs.pod:2651
+#: ../src/guestfs.pod:2656 ../src/guestfs.pod:2662 ../src/guestfs.pod:3062
+#: ../src/guestfs.pod:3067 ../src/guestfs.pod:3071 ../src/guestfs.pod:3075
+#: ../src/guestfs.pod:3079 ../src/guestfs.pod:3093 ../src/guestfs.pod:3098
+#: ../src/guestfs.pod:3329 ../src/guestfs.pod:3333 ../src/guestfs.pod:3337
+#: ../src/guestfs.pod:3341 ../tools/virt-win-reg.pl:197
+#: ../tools/virt-win-reg.pl:202 ../tools/virt-win-reg.pl:208
+#: ../tools/virt-win-reg.pl:721 ../tools/virt-win-reg.pl:727
+#: ../tools/virt-win-reg.pl:733
msgid "*"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:347
-msgid ""
-"The kernel version that the command runs under will be different from what "
-"it expects."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:311
+msgid "0"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:352
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:313
msgid ""
-"If the command needs to communicate with daemons, then most likely they "
-"won't be running."
+"successful exit, all partitions are aligned E<ge> 64K for best performance"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:357
-msgid "The command will be running in limited memory."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:317
+msgid "1"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:361
-msgid ""
-"The network may not be available unless you enable it (see L</"
-"guestfs_set_network>)."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:319
+msgid "an error scanning the disk image or guest"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:366
-msgid "Only supports Linux guests (not Windows, BSD, etc)."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:323
+msgid "2"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:370
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:325
msgid ""
-"Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
+"successful exit, some partitions have alignment E<lt> 64K which can result "
+"in poor performance on high end network storage"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:375
-msgid ""
-"For SELinux guests, you may need to enable SELinux and load policy first. "
-"See L</SELINUX> in this manpage."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:330
+msgid "3"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:380
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:332
msgid ""
-"The two main API calls to run commands are L</guestfs_command> and L</"
-"guestfs_sh> (there are also variations)."
+"successful exit, some partitions have alignment E<lt> 4K which can result in "
+"poor performance on most hypervisors"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:383
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:337 ../cat/virt-cat.pod:243
+#: ../cat/virt-filesystems.pod:385 ../cat/virt-ls.pod:495
+#: ../clone/virt-sysprep.pod:486 ../df/virt-df.pod:227
+#: ../edit/virt-edit.pod:354 ../erlang/examples/guestfs-erlang.pod:97
+#: ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384
+#: ../fish/guestfish.pod:1268 ../fish/virt-copy-in.pod:50
+#: ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47
+#: ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:317
+#: ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:45
+#: ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39
+#: ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:288
+#: ../resize/virt-resize.pod:688 ../ruby/examples/guestfs-ruby.pod:36
+#: ../sparsify/virt-sparsify.pod:251 ../src/guestfs.pod:3270
+#: ../test-tool/libguestfs-test-tool.pod:100
+#: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265
+#: ../tools/virt-make-fs.pl:557 ../tools/virt-tar.pl:296
+#: ../tools/virt-win-reg.pl:757
+msgid "SEE ALSO"
+msgstr ""
+
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:339
msgid ""
-"The difference is that L</guestfs_sh> runs commands using the shell, so any "
-"shell globs, redirections, etc will work."
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-rescue(1)>, "
+"L<virt-resize(1)>, L<http://libguestfs.org/>."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:386
-msgid "CONFIGURATION FILES"
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:346 ../cat/virt-cat.pod:252
+#: ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:507
+#: ../clone/virt-sysprep.pod:501 ../df/virt-df.pod:235
+#: ../edit/virt-edit.pod:368 ../rescue/virt-rescue.pod:296
+#: ../resize/virt-resize.pod:711 ../sparsify/virt-sparsify.pod:264
+#: ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277
+#: ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:311
+#: ../tools/virt-win-reg.pl:783
+msgid "AUTHOR"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:388
-msgid ""
-"To read and write configuration files in Linux guest filesystems, we "
-"strongly recommend using Augeas. For example, Augeas understands how to "
-"read and write, say, a Linux shadow password file or X.org configuration "
-"file, and so avoids you having to write that code."
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:348 ../cat/virt-cat.pod:254
+#: ../cat/virt-filesystems.pod:398 ../cat/virt-ls.pod:509
+#: ../clone/virt-sysprep.pod:503 ../df/virt-df.pod:237
+#: ../edit/virt-edit.pod:370 ../inspector/virt-inspector.pod:395
+#: ../rescue/virt-rescue.pod:298 ../resize/virt-resize.pod:713
+#: ../sparsify/virt-sparsify.pod:266 ../tools/virt-list-filesystems.pl:210
+#: ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:584
+#: ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:785
+msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:393
-msgid ""
-"The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
-"document Augeas itself here because there is excellent documentation on the "
-"L<http://augeas.net/> website."
+#. type: =head1
+#: ../align/virt-alignment-scan.pod:350 ../cat/virt-cat.pod:256
+#: ../cat/virt-filesystems.pod:400 ../cat/virt-ls.pod:511
+#: ../clone/virt-sysprep.pod:505 ../df/virt-df.pod:239
+#: ../edit/virt-edit.pod:372 ../erlang/examples/guestfs-erlang.pod:114
+#: ../examples/guestfs-examples.pod:49 ../examples/guestfs-recipes.pod:401
+#: ../fish/guestfish.pod:1300 ../fish/virt-copy-in.pod:64
+#: ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62
+#: ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:332
+#: ../inspector/virt-inspector.pod:403 ../java/examples/guestfs-java.pod:62
+#: ../ocaml/examples/guestfs-ocaml.pod:95 ../perl/examples/guestfs-perl.pod:56
+#: ../python/examples/guestfs-python.pod:58 ../rescue/virt-rescue.pod:300
+#: ../resize/virt-resize.pod:715 ../ruby/examples/guestfs-ruby.pod:52
+#: ../sparsify/virt-sparsify.pod:268 ../src/guestfs.pod:3352
+#: ../test-tool/libguestfs-test-tool.pod:110
+#: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281
+#: ../tools/virt-make-fs.pl:586 ../tools/virt-tar.pl:315
+#: ../tools/virt-win-reg.pl:787
+msgid "COPYRIGHT"
+msgstr ""
+
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:352 ../clone/virt-sysprep.pod:507
+#: ../sparsify/virt-sparsify.pod:270
+msgid "Copyright (C) 2011 Red Hat Inc."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:397
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:354 ../cat/virt-cat.pod:260
+#: ../cat/virt-filesystems.pod:404 ../cat/virt-ls.pod:515
+#: ../clone/virt-sysprep.pod:509 ../df/virt-df.pod:243
+#: ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1305
+#: ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58
+#: ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60
+#: ../fuse/guestmount.pod:337 ../inspector/virt-inspector.pod:407
+#: ../rescue/virt-rescue.pod:304 ../resize/virt-resize.pod:719
+#: ../sparsify/virt-sparsify.pod:272 ../test-tool/libguestfs-test-tool.pod:115
+#: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285
+#: ../tools/virt-make-fs.pl:590 ../tools/virt-tar.pl:319
+#: ../tools/virt-win-reg.pl:791
msgid ""
-"If you don't want to use Augeas (you fool!) then try calling L</"
-"guestfs_read_lines> to get the file as a list of lines which you can iterate "
-"over."
+"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
-#: ../src/guestfs.pod:401
-msgid "SELINUX"
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:359 ../cat/virt-cat.pod:265
+#: ../cat/virt-filesystems.pod:409 ../cat/virt-ls.pod:520
+#: ../clone/virt-sysprep.pod:514 ../df/virt-df.pod:248
+#: ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1310
+#: ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63
+#: ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65
+#: ../fuse/guestmount.pod:342 ../inspector/virt-inspector.pod:412
+#: ../rescue/virt-rescue.pod:309 ../resize/virt-resize.pod:724
+#: ../sparsify/virt-sparsify.pod:277 ../test-tool/libguestfs-test-tool.pod:120
+#: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290
+#: ../tools/virt-make-fs.pl:595 ../tools/virt-tar.pl:324
+#: ../tools/virt-win-reg.pl:796
+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
-#: ../src/guestfs.pod:403
+#. type: textblock
+#: ../align/virt-alignment-scan.pod:364 ../cat/virt-cat.pod:270
+#: ../cat/virt-filesystems.pod:414 ../cat/virt-ls.pod:525
+#: ../clone/virt-sysprep.pod:519 ../df/virt-df.pod:253
+#: ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1315
+#: ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68
+#: ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70
+#: ../fuse/guestmount.pod:347 ../inspector/virt-inspector.pod:417
+#: ../rescue/virt-rescue.pod:314 ../resize/virt-resize.pod:729
+#: ../sparsify/virt-sparsify.pod:282 ../test-tool/libguestfs-test-tool.pod:125
+#: ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295
+#: ../tools/virt-make-fs.pl:600 ../tools/virt-tar.pl:329
+#: ../tools/virt-win-reg.pl:801
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:"
+"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: =item
-#: ../src/guestfs.pod:409
-msgid "1."
+#. type: textblock
+#: ../cat/virt-cat.pod:5
+msgid "virt-cat - Display files in a virtual machine"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:411
-msgid "Before launching, do:"
+#. type: verbatim
+#: ../cat/virt-cat.pod:9
+#, no-wrap
+msgid ""
+" virt-cat [--options] -d domname file [file ...]\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:413
+#. type: verbatim
+#: ../cat/virt-cat.pod:11
#, no-wrap
msgid ""
-" guestfs_set_selinux (g, 1);\n"
+" virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:415
-msgid "2."
+#. type: textblock
+#: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15
+#: ../inspector/virt-inspector.pod:13
+msgid "Old-style:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:417
+#. type: verbatim
+#: ../cat/virt-cat.pod:15
+#, no-wrap
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:"
+" virt-cat domname file\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:421
+#. type: verbatim
+#: ../cat/virt-cat.pod:17
#, no-wrap
msgid ""
-" guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
+" virt-cat disk.img file\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:423
+#. type: textblock
+#: ../cat/virt-cat.pod:21
msgid ""
-"(Older versions of C<load_policy> require you to specify the name of the "
-"policy file)."
+"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)."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:426
-msgid "3."
+#. type: textblock
+#: ../cat/virt-cat.pod:24
+msgid ""
+"Multiple filenames can be given, in which case they are concatenated "
+"together. Each filename must be a full path, starting at the root directory "
+"(starting with '/')."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:428
+#. type: textblock
+#: ../cat/virt-cat.pod:28
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:"
+"C<virt-cat> can be used to quickly view a file. To edit a file, use C<virt-"
+"edit>. For more complex cases you should look at the L<guestfish(1)> tool "
+"(see L</USING GUESTFISH> below)."
+msgstr ""
+
+#. type: =head1
+#: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43
+#: ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41
+#: ../fish/guestfish.pod:1051 ../fish/virt-copy-in.pod:29
+#: ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30
+#: ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39
+#: ../resize/virt-resize.pod:27 ../sparsify/virt-sparsify.pod:75
+#: ../tools/virt-tar.pl:50
+msgid "EXAMPLES"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-cat.pod:34
+msgid ""
+"Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:432
+#. type: verbatim
+#: ../cat/virt-cat.pod:37
#, no-wrap
msgid ""
-" guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
+" virt-cat -d mydomain /etc/fstab\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:436
-msgid "This will work for running commands and editing existing files."
+#. type: textblock
+#: ../cat/virt-cat.pod:39
+msgid "List syslog messages from a VM disk image file:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:438
+#. type: verbatim
+#: ../cat/virt-cat.pod:41
+#, no-wrap
msgid ""
-"When new files are created, you may need to label them explicitly, for "
-"example by running the external command C<restorecon pathname>."
+" virt-cat -a disk.img /var/log/messages | tail\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:442
-msgid "UMASK"
+#. type: textblock
+#: ../cat/virt-cat.pod:43
+msgid "Find out what DHCP IP address a VM acquired:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:444
+#. type: verbatim
+#: ../cat/virt-cat.pod:45
+#, no-wrap
msgid ""
-"Certain calls are affected by the current file mode creation mask (the "
-"\"umask\"). In particular ones which create files or directories, such as "
-"L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
-"either the default mode that the file is created with or modifies the mode "
-"that you supply."
+" virt-cat -d mydomain /var/log/messages | \\\n"
+" grep 'dhclient: bound to' | tail\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:450
-msgid ""
-"The default umask is C<022>, so files are created with modes such as C<0644> "
-"and directories with C<0755>."
+#. type: textblock
+#: ../cat/virt-cat.pod:48
+msgid "Find out what packages were recently installed:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:453
+#. type: verbatim
+#: ../cat/virt-cat.pod:50
+#, no-wrap
msgid ""
-"There are two ways to avoid being affected by umask. Either set umask to 0 "
-"(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
-"guestfs_chmod> after creating each file or directory."
+" virt-cat -d mydomain /var/log/yum.log | tail\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:457
-msgid "For more information about umask, see L<umask(2)>."
+#. type: textblock
+#: ../cat/virt-cat.pod:52
+msgid "Find out who is logged on inside a virtual machine:"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:459 ../fish/guestfish.pod:559
-msgid "ENCRYPTED DISKS"
+#. type: verbatim
+#: ../cat/virt-cat.pod:54
+#, no-wrap
+msgid ""
+" virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
+" who /tmp/utmp\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:461
-msgid ""
-"Libguestfs allows you to access Linux guests which have been encrypted using "
-"whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
-"standard. This includes nearly all whole disk encryption systems used by "
-"modern Linux guests."
+#. type: textblock
+#: ../cat/virt-cat.pod:57
+msgid "or who was logged on:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:467
+#. type: verbatim
+#: ../cat/virt-cat.pod:59
+#, no-wrap
msgid ""
-"Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
-"returns the string C<crypto_LUKS>)."
+" virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
+" last -f /tmp/wtmp\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:470
+#. type: textblock
+#: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103
+#: ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74
+#: ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
msgid ""
-"Then open these devices by calling L</guestfs_luks_open>. Obviously you "
-"will require the passphrase!"
+"Add I<file> which should be a disk image from a virtual machine. If the "
+"virtual machine has multiple block devices, you must supply all of them with "
+"separate I<-a> options."
+msgstr ""
+
+#. type: =item
+#: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148
+#: ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217
+#: ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:92
+msgid "B<--echo-keys>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:473
+#. type: textblock
+#: ../cat/virt-cat.pod:100
msgid ""
-"Opening a LUKS device creates a new device mapper device called C</dev/"
-"mapper/mapname> (where C<mapname> is the string you supply to L</"
-"guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
-"from and encrypted to the underlying block device respectively."
+"When prompting for keys and passphrases, virt-cat 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: textblock
-#: ../src/guestfs.pod:479
+#. type: verbatim
+#: ../cat/virt-cat.pod:116
+#, no-wrap
msgid ""
-"LVM volume groups on the device can be made visible by calling L</"
-"guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
-"(s) can now be mounted in the usual way."
+" virt-cat --format=raw -a disk.img file\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:483
+#. type: verbatim
+#: ../cat/virt-cat.pod:120
+#, no-wrap
msgid ""
-"Use the reverse process to close a LUKS device. Unmount any logical volumes "
-"on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
-"[\"/dev/VG\"])>. Then close the mapper device by calling L</"
-"guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
-"underlying encrypted block device)."
+" virt-cat --format=raw -a disk.img --format -a another.img file\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:490
-msgid "INSPECTION"
+#. type: =item
+#: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200
+#: ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289
+#: ../fuse/guestmount.pod:172 ../inspector/virt-inspector.pod:114
+msgid "B<--keys-from-stdin>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:492
+#. type: textblock
+#: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202
+#: ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291
+#: ../fuse/guestmount.pod:174 ../inspector/virt-inspector.pod:116
msgid ""
-"Libguestfs has APIs for inspecting an unknown disk image to find out if it "
-"contains operating systems. (These APIs used to be in a separate Perl-only "
-"library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
-"frequently used part of this library has been rewritten in C and moved into "
-"the core code)."
+"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: textblock
-#: ../src/guestfs.pod:498
-msgid ""
-"Add all disks belonging to the unknown virtual machine and call L</"
-"guestfs_launch> in the usual way."
+#. type: =head1
+#: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179
+#: ../inspector/virt-inspector.pod:137 ../rescue/virt-rescue.pod:209
+msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:501
-msgid ""
-"Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
-"and certain heuristics, and returns a list of operating systems that were "
-"found. An empty list means none were found. A single element is the root "
-"filesystem of the operating system. For dual- or multi-boot guests, "
-"multiple roots can be returned, each one corresponding to a separate "
-"operating system. (Multi-boot virtual machines are extremely rare in the "
-"world of virtualization, but since this scenario can happen, we have built "
-"libguestfs to deal with it.)"
+#. type: textblock
+#: ../cat/virt-cat.pod:154
+msgid "Previous versions of virt-cat allowed you to write either:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:510
+#. type: verbatim
+#: ../cat/virt-cat.pod:156
+#, no-wrap
msgid ""
-"For each root, you can then call various C<guestfs_inspect_get_*> functions "
-"to get additional details about that operating system. For example, call L</"
-"guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
-"Windows and Linux-based operating systems respectively."
+" virt-cat disk.img [disk.img ...] file\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:516
-msgid ""
-"Un*x-like and Linux-based operating systems usually consist of several "
-"filesystems which are mounted at boot time (for example, a separate boot "
-"partition mounted on C</boot>). The inspection rules are able to detect how "
-"filesystems correspond to mount points. Call "
-"C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
-"hash table like this example:"
+#. type: textblock
+#: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185
+#: ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:215
+msgid "or"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:523
+#. type: verbatim
+#: ../cat/virt-cat.pod:160
#, no-wrap
msgid ""
-" /boot => /dev/sda1\n"
-" / => /dev/vg_guest/lv_root\n"
-" /usr => /dev/vg_guest/lv_usr\n"
+" virt-cat guestname file\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:527
+#. type: textblock
+#: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189
+#: ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:219
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
-msgid ""
-"Be careful to mount filesystems in the right order (eg. C</> before C</"
-"usr>). Sorting the keys of the hash by length, shortest first, should work."
+"whereas in this version you should use I<-a> or I<-d> respectively to avoid "
+"the confusing case where a disk image might have the same name as a guest."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:534
-msgid ""
-"Inspection currently only works for some common operating systems. "
-"Contributors are welcome to send patches for other operating systems that we "
-"currently cannot detect."
+#. type: textblock
+#: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193
+#: ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:223
+msgid "For compatibility the old style is still supported."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:538
-msgid ""
-"Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
-"for more details. The L</guestfs_inspect_os> function just ignores any "
-"encrypted devices."
+#. type: =head1
+#: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
+msgid "WINDOWS PATHS"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:542
+#. type: textblock
+#: ../cat/virt-cat.pod:170
msgid ""
-"A note on the implementation: The call L</guestfs_inspect_os> performs "
-"inspection and caches the results in the guest handle. Subsequent calls to "
-"C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
-"read the disks. If you change the content of the guest disks, you can redo "
-"inspection by calling L</guestfs_inspect_os> again."
+"C<virt-cat> has a limited ability to understand Windows drive letters and "
+"paths (eg. C<E:\\foo\\bar.txt>)."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:549
-msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
+#. type: textblock
+#: ../cat/virt-cat.pod:173 ../edit/virt-edit.pod:262
+msgid "If and only if the guest is running Windows then:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:551
+#. type: textblock
+#: ../cat/virt-cat.pod:179 ../edit/virt-edit.pod:268
msgid ""
-"Libguestfs can mount NTFS partitions. It does this using the L<http://www."
-"ntfs-3g.org/> driver."
+"Drive letter prefixes like C<C:> are resolved against the Windows Registry "
+"to the correct filesystem."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:554
+#. type: textblock
+#: ../cat/virt-cat.pod:184 ../edit/virt-edit.pod:273
msgid ""
-"DOS and Windows still use drive letters, and the filesystems are always "
-"treated as case insensitive by Windows itself, and therefore you might find "
-"a Windows configuration file referring to a path like C<c:\\windows"
-"\\system32>. When the filesystem is mounted in libguestfs, that directory "
-"might be referred to as C</WINDOWS/System32>."
+"Any backslash (C<\\>) characters in the path are replaced with forward "
+"slashes so that libguestfs can process it."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:560
+#. type: textblock
+#: ../cat/virt-cat.pod:189
msgid ""
-"Drive letter mappings are outside the scope of libguestfs. You have to use "
-"libguestfs to read the appropriate Windows Registry and configuration files, "
-"to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
-"inspector(1)>)."
+"The path is resolved case insensitively to locate the file that should be "
+"displayed."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:565
-msgid ""
-"Replacing backslash characters with forward slash characters is also outside "
-"the scope of libguestfs, but something that you can easily do."
+#. type: textblock
+#: ../cat/virt-cat.pod:194 ../edit/virt-edit.pod:283
+msgid "There are some known shortcomings:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:568
-msgid ""
-"Where we can help is in resolving the case insensitivity of paths. For "
-"this, call L</guestfs_case_sensitive_path>."
+#. type: textblock
+#: ../cat/virt-cat.pod:200 ../edit/virt-edit.pod:289
+msgid "Some NTFS symbolic links may not be followed correctly."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:571
-msgid ""
-"Libguestfs also provides some help for decoding Windows Registry \"hive\" "
-"files, through the library C<hivex> which is part of the libguestfs project "
-"although ships as a separate tarball. You have to locate and download the "
-"hive file(s) yourself, and then pass them to C<hivex> functions. See also "
-"the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
-"reg(1)> for more help on this issue."
+#. type: textblock
+#: ../cat/virt-cat.pod:204 ../edit/virt-edit.pod:293
+msgid "NTFS junction points that cross filesystems are not followed."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:579
-msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
+#. type: =head1
+#: ../cat/virt-cat.pod:208 ../edit/virt-edit.pod:297
+msgid "USING GUESTFISH"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:581
+#. type: textblock
+#: ../cat/virt-cat.pod:210
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."
+"L<guestfish(1)> is a more powerful, lower level tool which you can use when "
+"C<virt-cat> doesn't work."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:584
-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, C<g."
-"mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
-"words, a straightforward, predictable isomorphism between each language."
+#. type: textblock
+#: ../cat/virt-cat.pod:213
+msgid "Using C<virt-cat> is approximately equivalent to doing:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:590
+#. type: verbatim
+#: ../cat/virt-cat.pod:215
+#, no-wrap
msgid ""
-"Error messages are automatically transformed into exceptions if the language "
-"supports it."
+" guestfish --ro -i -d domname download file -\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:593
+#. type: textblock
+#: ../cat/virt-cat.pod:217
msgid ""
-"We don't try to \"object orientify\" parts of the API in OO languages, "
-"although contributors are welcome to write higher level APIs above what we "
-"provide in their favourite languages if they wish."
-msgstr ""
-
-# type: =item
-#: ../src/guestfs.pod:599
-msgid "B<C++>"
+"where C<domname> is the name of the libvirt guest, and C<file> is the full "
+"path to the file. Note the final C<-> (meaning \"output to stdout\")."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:601
+#. type: textblock
+#: ../cat/virt-cat.pod:221
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."
+"The command above uses libguestfs's guest inspection feature and so does not "
+"work on guests that libguestfs cannot inspect, or on things like arbitrary "
+"disk images that don't contain guests. To display a file from a disk image "
+"directly, use:"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:605
-msgid "B<C#>"
+#. type: verbatim
+#: ../cat/virt-cat.pod:226
+#, no-wrap
+msgid ""
+" guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:607
+#. type: textblock
+#: ../cat/virt-cat.pod:228
msgid ""
-"The C# bindings are highly experimental. Please read the warnings at the "
-"top of C<csharp/Libguestfs.cs>."
+"where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
+"the disk image, and C<file> is the full path to the file."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:610
-msgid "B<Haskell>"
+#. type: textblock
+#: ../cat/virt-cat.pod:240 ../cat/virt-filesystems.pod:382
+#: ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351
+#: ../fuse/guestmount.pod:314 ../inspector/virt-inspector.pod:377
+#: ../resize/virt-resize.pod:685 ../sparsify/virt-sparsify.pod:229
+msgid ""
+"This program returns 0 if successful, or non-zero if there was an error."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:612
+#. type: textblock
+#: ../cat/virt-cat.pod:245
msgid ""
-"This is the only language binding that is working but incomplete. Only "
-"calls which return simple integers have been bound in Haskell, and we are "
-"looking for help to complete this binding."
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, L<virt-"
+"tar-out(1)>, L<http://libguestfs.org/>."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:616
-msgid "B<Java>"
+#. type: textblock
+#: ../cat/virt-cat.pod:258 ../inspector/virt-inspector.pod:405
+#: ../resize/virt-resize.pod:717 ../tools/virt-make-fs.pl:588
+msgid "Copyright (C) 2010-2011 Red Hat Inc."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:618
+#. type: textblock
+#: ../cat/virt-filesystems.pod:5
msgid ""
-"Full documentation is contained in the Javadoc which is distributed with "
-"libguestfs."
+"virt-filesystems - List filesystems, partitions, block devices, LVM in a "
+"virtual machine or disk image"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:621
-msgid "B<OCaml>"
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:9
+#, no-wrap
+msgid ""
+" virt-filesystems [--options] -d domname\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:623
-msgid "For documentation see the file C<guestfs.mli>."
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:11
+#, no-wrap
+msgid ""
+" virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:625
-msgid "B<Perl>"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:15
+msgid ""
+"This tool allows you to discover filesystems, partitions, logical volumes, "
+"and their sizes in a disk image or virtual machine. It is a replacement for "
+"L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:627
-msgid "For documentation see L<Sys::Guestfs(3)>."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:20
+msgid ""
+"One use for this tool is from shell scripts to iterate over all filesystems "
+"from a disk image:"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:629
-msgid "B<PHP>"
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:23
+#, no-wrap
+msgid ""
+" for fs in $(virt-filesystems -a disk.img); do\n"
+" # ...\n"
+" done\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:631
+#. type: textblock
+#: ../cat/virt-filesystems.pod:27
msgid ""
-"For documentation see C<README-PHP> supplied with libguestfs sources or in "
-"the php-libguestfs package for your distribution."
+"Another use is to list partitions before using another tool to modify those "
+"partitions (such as L<virt-resize(1)>). If you are curious about what an "
+"unknown disk image contains, use this tool along with L<virt-inspector(1)>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:634
-msgid "The PHP binding only works correctly on 64 bit machines."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:32
+msgid ""
+"Various command line options control what this program displays. You need "
+"to give either I<-a> or I<-d> options to specify the disk image or libvirt "
+"guest respectively. If you just specify that then the program shows "
+"filesystems found, one per line, like this:"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:636
-msgid "B<Python>"
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:37
+#, no-wrap
+msgid ""
+" $ virt-filesystems -a disk.img\n"
+" /dev/sda1\n"
+" /dev/vg_guest/lv_root\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:638
-msgid "For documentation do:"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:41
+msgid ""
+"If you add I<-l> or I<--long> then the output includes extra information:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:640
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:44
#, no-wrap
msgid ""
-" $ python\n"
-" >>> import guestfs\n"
-" >>> help (guestfs)\n"
+" $ virt-filesystems -a disk.img -l\n"
+" Name Type VFS Label Size\n"
+" /dev/sda1 filesystem ext4 boot 524288000\n"
+" /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:644
-msgid "B<Ruby>"
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs.pod:646
+#. type: textblock
+#: ../cat/virt-filesystems.pod:49
msgid ""
-"Use the Guestfs module. There is no Ruby-specific documentation, but you "
-"can find examples written in Ruby in the libguestfs source."
+"If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
+"shown as well:"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:649
-msgid "B<shell scripts>"
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:52
+#, no-wrap
+msgid ""
+" $ virt-filesystems -a disk.img --extra\n"
+" /dev/sda1\n"
+" /dev/vg_guest/lv_root\n"
+" /dev/vg_guest/lv_swap\n"
+" /dev/vg_guest/lv_data\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:651
-msgid "For documentation see L<guestfish(1)>."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:58
+msgid ""
+"If you add I<--partitions> then partitions are shown instead of filesystems:"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:655
-msgid "LIBGUESTFS GOTCHAS"
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:60
+#, no-wrap
+msgid ""
+" $ virt-filesystems -a disk.img --partitions\n"
+" /dev/sda1\n"
+" /dev/sda2\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:657
+#. type: textblock
+#: ../cat/virt-filesystems.pod:64
msgid ""
-"L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
-"system [...] that works in the way it is documented but is counterintuitive "
-"and almost invites mistakes.\""
+"Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-"
+"volumes>, I<--block-devices> to list those items."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:661
+#. type: textblock
+#: ../cat/virt-filesystems.pod:67
msgid ""
-"Since we developed libguestfs and the associated tools, there are several "
-"things we would have designed differently, but are now stuck with for "
-"backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
-"release, you can expect these to change. Beware of them."
+"You can use these options in combination as well (if you want a combination "
+"including filesystems, you have to add I<--filesystems>). Notice that some "
+"items fall into several categories (eg. C</dev/sda1> might be both a "
+"partition and a filesystem). These items are listed several times. To get "
+"a list which includes absolutely everything that virt-filesystems knows "
+"about, use the I<--all> option."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:669
-msgid "Autosync / forgetting to sync."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:74
+msgid ""
+"UUIDs (because they are quite long) are not shown by default. Add the I<--"
+"uuid> option to display device and filesystem UUIDs in the long output."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:671
+#. type: textblock
+#: ../cat/virt-filesystems.pod:78
msgid ""
-"When modifying a filesystem from C or another language, you B<must> unmount "
-"all filesystems and call L</guestfs_sync> explicitly before you close the "
-"libguestfs handle. You can also call:"
+"I<--all --long --uuid> is a useful combination to display all possible "
+"information about everything."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:675
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:81
#, no-wrap
msgid ""
-" guestfs_set_autosync (g, 1);\n"
+" $ virt-filesystems -a win.img --all --long --uuid -h\n"
+" Name Type VFS Label Size Parent UUID\n"
+" /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
+" /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
+" /dev/sda1 partition - - 100M /dev/sda -\n"
+" /dev/sda2 partition - - 20G /dev/sda -\n"
+" /dev/sda device - - 20G - -\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:677
+#. type: textblock
+#: ../cat/virt-filesystems.pod:89
msgid ""
-"to have the unmount/sync done automatically for you when the handle 'g' is "
-"closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
+"For machine-readable output, use I<--csv> to get Comma-Separated Values."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:681
-msgid ""
-"If you forget to do this, then it is entirely possible that your changes "
-"won't be written out, or will be partially written, or (very rarely) that "
-"you'll get disk corruption."
+#. type: =item
+#: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
+msgid "B<--all>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:685
+#. type: textblock
+#: ../cat/virt-filesystems.pod:112
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."
+"Display everything. This is currently the same as specifying these options: "
+"I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--"
+"logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may be "
+"added to this list in future)."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:689
-msgid "Mount option C<-o sync> should not be the default."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:117
+msgid "See also I<--long>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:691
-msgid ""
-"If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
-"However C<-o sync> does not add any reliability benefit, but does have a "
-"very large performance impact."
+#. type: =item
+#: ../cat/virt-filesystems.pod:119
+msgid "B<--blkdevs>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:695
-msgid ""
-"The work around is to use L</guestfs_mount_options> and set the mount "
-"options that you actually want to use."
+#. type: =item
+#: ../cat/virt-filesystems.pod:121
+msgid "B<--block-devices>"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:698
-msgid "Read-only should be the default."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:123
+msgid "Display block devices."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:700
-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."
+#. type: =item
+#: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
+msgid "B<--csv>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:703
-msgid "This would reduce the potential to corrupt live VM images."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
+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."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:705
+#. type: textblock
+#: ../cat/virt-filesystems.pod:150
msgid ""
-"Note that many filesystems change the disk when you just mount and unmount, "
-"even if you didn't perform any writes. You need to use L</"
-"guestfs_add_drive_ro> to guarantee that the disk is not changed."
+"When prompting for keys and passphrases, virt-filesystems 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: =item
-#: ../src/guestfs.pod:709
-msgid "guestfish command line is hard to use."
+#. type: =item
+#: ../cat/virt-filesystems.pod:155
+msgid "B<--extra>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:711
+#. type: textblock
+#: ../cat/virt-filesystems.pod:157
msgid ""
-"C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
-"examination). It tries to run a guestfish command C<disk.img> which doesn't "
-"exist, so it fails. In earlier versions of guestfish the error message was "
-"also unintuitive, but we have corrected this since. Like the Bourne shell, "
-"we should have used C<guestfish -c command> to run commands."
+"This causes filesystems that are not ordinary, mountable filesystems to be "
+"displayed. This category includes swapspace, and filesystems that are empty "
+"or contain unknown data."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:718
-msgid "guestfish megabyte modifiers don't work right on all commands"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:161
+msgid "This option implies I<--filesystems>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:720
+#. type: =item
+#: ../cat/virt-filesystems.pod:163
+msgid "B<--filesystems>"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-filesystems.pod:165
msgid ""
-"In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
-"other modifiers). What guestfish actually does is to multiply the number "
-"part by the modifier part and pass the result to the C API. However this "
-"doesn't work for a few APIs which aren't expecting bytes, but are already "
-"expecting some other unit (eg. megabytes)."
+"Display mountable filesystems. If no display option was selected then this "
+"option is implied."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:727
-msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:168
+msgid "With I<--extra>, non-mountable filesystems are shown too."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:729
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:181
#, no-wrap
msgid ""
-" lvcreate LV VG 100M\n"
+" virt-filesystems --format=raw -a disk.img\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:731
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:185
+#, no-wrap
msgid ""
-"does not do what you might expect. Instead because L</guestfs_lvcreate> is "
-"already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
-"megabytes * megabytes) logical volume. The error message you get from this "
-"is also a little obscure."
+" virt-filesystems --format=raw -a disk.img --format -a another.img\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:736
-msgid ""
-"This could be fixed in the generator by specially marking parameters and "
-"return values which take bytes or other units."
+#. type: =item
+#: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352
+#: ../df/virt-df.pod:125 ../fish/guestfish.pod:156
+#: ../tools/virt-list-partitions.pl:109
+msgid "B<-h>"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:739
-msgid "Library should return errno with error messages."
+#. type: =item
+#: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354
+#: ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
+msgid "B<--human-readable>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:741
-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."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:198
+msgid "In I<--long> mode, display sizes in human-readable format."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:747
-msgid ""
-"In libguestfs 1.5.4, the protocol was changed so that the Linux errno is "
-"sent back from the daemon."
+#. type: =item
+#: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366
+#: ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
+msgid "B<-l>"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:752
-msgid "PROTOCOL LIMITS"
+#. type: =item
+#: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368
+#: ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
+msgid "B<--long>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:754
-msgid ""
-"Internally libguestfs uses a message-based protocol to pass API calls and "
-"their responses to and from a small \"appliance\" (see L</INTERNALS> for "
-"plenty more detail about this). The maximum message size used by the "
-"protocol is slightly less than 4 MB. For some API calls you may need to be "
-"aware of this limit. The API calls which may be affected are individually "
-"documented, with a link back to this section of the documentation."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:209
+msgid "Display extra columns of data (\"long format\")."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:762
-msgid ""
-"A simple call such as L</guestfs_cat> returns its result (the file data) in "
-"a simple string. Because this string is at some point internally encoded as "
-"a message, the maximum size that it can return is slightly under 4 MB. If "
-"the requested file is larger than this then you will get an error."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:211
+msgid "A title row is added unless you also specify I<--no-title>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:768
+#. type: textblock
+#: ../cat/virt-filesystems.pod:213
msgid ""
-"In order to transfer large files into and out of the guest filesystem, you "
-"need to use particular calls that support this. The sections L</UPLOADING> "
-"and L</DOWNLOADING> document how to do this."
+"The extra columns displayed depend on what output you select, and the "
+"ordering of columns may change in future versions. Use the title row, I<--"
+"csv> output and/or L<csvtool(1)> to match columns to data in external "
+"programs."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:772
+#. type: textblock
+#: ../cat/virt-filesystems.pod:218
msgid ""
-"You might also consider mounting the disk image using our FUSE filesystem "
-"support (L<guestmount(1)>)."
+"Use I<-h> if you want sizes to be displayed in human-readable format. The "
+"default is to show raw numbers of I<bytes>."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:775
-msgid "KEYS AND PASSPHRASES"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:221
+msgid "Use I<--uuid> to display UUIDs too."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:777
-msgid ""
-"Certain libguestfs calls take a parameter that contains sensitive key "
-"material, passed in as a C string."
+#. type: =item
+#: ../cat/virt-filesystems.pod:223
+msgid "B<--lvs>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:780
-msgid ""
-"In the future we would hope to change the libguestfs implementation so that "
-"keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
-"swap. However this is I<not> done at the moment, because of the complexity "
-"of such an implementation."
+#. type: =item
+#: ../cat/virt-filesystems.pod:225
+msgid "B<--logvols>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:785
+#. type: =item
+#: ../cat/virt-filesystems.pod:227
+msgid "B<--logical-volumes>"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-filesystems.pod:229
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."
+"Display LVM logical volumes. In this mode, these are displayed irrespective "
+"of whether the LVs contain filesystems."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:790
-msgid "CONNECTION MANAGEMENT"
+#. type: =item
+#: ../cat/virt-filesystems.pod:232
+msgid "B<--no-title>"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:792
-msgid "guestfs_h *"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:234
+msgid "In I<--long> mode, don't add a title row."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:794
+#. type: textblock
+#: ../cat/virt-filesystems.pod:236
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."
+"Note that the order of the columns is not fixed, and may change in future "
+"versions of virt-filesystems, so using this option may give you unexpected "
+"surprises."
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."
+#. type: =item
+#: ../cat/virt-filesystems.pod:240
+msgid "B<--parts>"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:801
-msgid "guestfs_create"
+#. type: =item
+#: ../cat/virt-filesystems.pod:242
+msgid "B<--partitions>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:803
-#, no-wrap
+#. type: textblock
+#: ../cat/virt-filesystems.pod:244
msgid ""
-" guestfs_h *guestfs_create (void);\n"
-"\n"
+"Display partitions. In this mode, these are displayed irrespective of "
+"whether the partitions contain filesystems."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:805
-msgid "Create a connection handle."
+#. type: =item
+#: ../cat/virt-filesystems.pod:247
+msgid "B<--pvs>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:807
-msgid "You have to call L</guestfs_add_drive> on the handle at least once."
+#. type: =item
+#: ../cat/virt-filesystems.pod:249
+msgid "B<--physvols>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:809
-msgid ""
-"This function returns a non-NULL pointer to a handle on success or NULL on "
-"error."
+#. type: =item
+#: ../cat/virt-filesystems.pod:251
+msgid "B<--physical-volumes>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:812
-msgid "After configuring the handle, you have to call L</guestfs_launch>."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:253
+msgid "Display LVM physical volumes."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:814
-msgid ""
-"You may also want to configure error handling for the handle. See L</ERROR "
-"HANDLING> section below."
+#. type: =item
+#: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
+msgid "B<--uuid>"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:817
-msgid "guestfs_close"
+#. type: =item
+#: ../cat/virt-filesystems.pod:257
+msgid "B<--uuids>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:819
-#, no-wrap
-msgid ""
-" void guestfs_close (guestfs_h *g);\n"
-"\n"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:259
+msgid "In I<--long> mode, display UUIDs as well."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:821
-msgid "This closes the connection handle and frees up all resources used."
+#. type: =item
+#: ../cat/virt-filesystems.pod:273
+msgid "B<--vgs>"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:823
-msgid "ERROR HANDLING"
+#. type: =item
+#: ../cat/virt-filesystems.pod:275
+msgid "B<--volgroups>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:825
-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>."
+#. type: =item
+#: ../cat/virt-filesystems.pod:277
+msgid "B<--volume-groups>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:830
-msgid "The default error handler prints the information string to C<stderr>."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:279
+msgid "Display LVM volume groups."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:832
-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>."
+#. type: =head1
+#: ../cat/virt-filesystems.pod:287
+msgid "COLUMNS"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:836
-msgid "guestfs_last_error"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:289
+msgid ""
+"Note that columns in the output are subject to reordering and change in "
+"future versions of this tool."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:838
-#, no-wrap
-msgid ""
-" const char *guestfs_last_error (guestfs_h *g);\n"
-"\n"
+#. type: =item
+#: ../cat/virt-filesystems.pod:294
+msgid "B<Name>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:840
-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>."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:296
+msgid "The filesystem, partition, block device or LVM name."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:844
+#. type: textblock
+#: ../cat/virt-filesystems.pod:298
msgid ""
-"The lifetime of the returned string is until the next error occurs, or L</"
-"guestfs_close> is called."
+"For device and partition names these are displayed as canonical libguestfs "
+"names, so that for example C</dev/sda2> is the second partition on the first "
+"device."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:847
+#. type: textblock
+#: ../cat/virt-filesystems.pod:302
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."
+"If the I<--long> option is B<not> specified, then only the name column is "
+"shown in the output."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:851
-msgid "guestfs_set_error_handler"
+#. type: =item
+#: ../cat/virt-filesystems.pod:305
+msgid "B<Type>"
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
+#: ../cat/virt-filesystems.pod:307
+msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:860
-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."
+#. type: =item
+#: ../cat/virt-filesystems.pod:309
+msgid "B<VFS>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:864
+#. type: textblock
+#: ../cat/virt-filesystems.pod:311
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."
+"If there is a filesystem, then this column displays the filesystem type if "
+"one could be detected, eg. C<ext4>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:868
-msgid "The default handler prints messages on C<stderr>."
+#. type: =item
+#: ../cat/virt-filesystems.pod:314
+msgid "B<Label>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:870
-msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:316
+msgid ""
+"If the object has a label (used for identifying and mounting filesystems) "
+"then this column contains the label."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:872
-msgid "guestfs_get_error_handler"
+#. type: =item
+#: ../cat/virt-filesystems.pod:319
+msgid "B<MBR>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:874
-#, no-wrap
+#. type: textblock
+#: ../cat/virt-filesystems.pod:321
msgid ""
-" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
-" void **opaque_rtn);\n"
-"\n"
+"The partition type byte, displayed as a two digit hexadecimal number. A "
+"comprehensive list of partition types can be found here: L<http://www.win."
+"tue.nl/~aeb/partitions/partition_types-1.html>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:877
-msgid "Returns the current error handler callback."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:325
+msgid "This is only applicable for DOS (MBR) partitions."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:879
-msgid "guestfs_set_out_of_memory_handler"
+#. type: =item
+#: ../cat/virt-filesystems.pod:327
+msgid "B<Size>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:881
-#, no-wrap
+#. type: textblock
+#: ../cat/virt-filesystems.pod:329
msgid ""
-" typedef void (*guestfs_abort_cb) (void);\n"
-" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
-" guestfs_abort_cb);\n"
-"\n"
+"The size of the object in bytes. If the I<--human> option is used then the "
+"size is displayed in a human-readable form."
+msgstr ""
+
+#. type: =item
+#: ../cat/virt-filesystems.pod:332
+msgid "B<Parent>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:885
+#. type: textblock
+#: ../cat/virt-filesystems.pod:334
msgid ""
-"The callback C<cb> will be called if there is an out of memory situation. "
-"I<Note this callback must not return>."
+"The parent column records the parent relationship between objects. For "
+"example, if the object is a partition, then this column contains the name of "
+"the containing device. If the object is a logical volume, then this column "
+"is the name of the volume group."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:888
-msgid "The default is to call L<abort(3)>."
+#. type: =item
+#: ../cat/virt-filesystems.pod:339
+msgid "B<UUID>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:890
+#. type: textblock
+#: ../cat/virt-filesystems.pod:341
msgid ""
-"You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
+"If the object has a UUID (used for identifying and mounting filesystems and "
+"block devices) then this column contains the UUID as a string."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:893
-msgid "guestfs_get_out_of_memory_handler"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:345
+msgid "The UUID is only displayed if the I<--uuid> option is given."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:895
-#, no-wrap
+#. type: =head1
+#: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:459
+#: ../df/virt-df.pod:191
+msgid "NOTE ABOUT CSV FORMAT"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:461
+#: ../df/virt-df.pod:193
msgid ""
-" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
-"\n"
+"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: textblock
-#: ../src/guestfs.pod:897
-msgid "This returns the current out of memory handler."
+#. type: textblock
+#: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:464
+#: ../df/virt-df.pod:196
+msgid ""
+"Myth: Just split fields at commas. Reality: This does I<not> work "
+"reliably. This example has two columns:"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:899
-msgid "PATH"
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:467
+#: ../df/virt-df.pod:199
+#, no-wrap
+msgid ""
+" \"foo,bar\",baz\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:901
+#. type: textblock
+#: ../cat/virt-filesystems.pod:359 ../cat/virt-ls.pod:469
+#: ../df/virt-df.pod:201
msgid ""
-"Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
-"internal path."
+"Myth: Read the file one line at a time. Reality: This does I<not> work "
+"reliably. This example has one row:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:904
+#. type: verbatim
+#: ../cat/virt-filesystems.pod:362 ../cat/virt-ls.pod:472
+#: ../df/virt-df.pod:204
+#, no-wrap
msgid ""
-"By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
-"usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
+" \"foo\n"
+" bar\",baz\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:907
+#. type: textblock
+#: ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:475
+#: ../df/virt-df.pod:207
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>."
+"For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
+"packaged in major Linux distributions)."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:914
-msgid "HIGH-LEVEL API ACTIONS"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:368 ../cat/virt-ls.pod:478
+#: ../df/virt-df.pod:210
+msgid ""
+"For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
+"or Python's built-in csv library)."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:916
-msgid "ABI GUARANTEE"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:371 ../cat/virt-ls.pod:481
+#: ../df/virt-df.pod:213
+msgid "Most spreadsheets and databases can import CSV directly."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:918
+#. type: textblock
+#: ../cat/virt-filesystems.pod:387
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."
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-list-"
+"filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://"
+"libguestfs.org/>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:924 ../fish/guestfish.pod:926
-msgid "@ACTIONS@"
+#. type: textblock
+#: ../cat/virt-filesystems.pod:402 ../tools/virt-win-reg.pl:789
+msgid "Copyright (C) 2010 Red Hat Inc."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:926
-msgid "STRUCTURES"
+#. type: textblock
+#: ../cat/virt-ls.pod:5
+msgid "virt-ls - List files in a virtual machine"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:928
-msgid "@STRUCTS@"
+#. type: verbatim
+#: ../cat/virt-ls.pod:9
+#, no-wrap
+msgid ""
+" virt-ls [--options] -d domname directory [directory ...]\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:930
-msgid "AVAILABILITY"
+#. type: verbatim
+#: ../cat/virt-ls.pod:11
+#, no-wrap
+msgid ""
+" virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:932
-msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
+#. type: textblock
+#: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
+msgid "Old style:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:934
+#. type: verbatim
+#: ../cat/virt-ls.pod:15
+#, no-wrap
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."
+" virt-ls [--options] domname directory\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:939
-msgid "@AVAILABILITY@"
+#. type: verbatim
+#: ../cat/virt-ls.pod:17
+#, no-wrap
+msgid ""
+" virt-ls [--options] disk.img [disk.img ...] directory\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:941
-msgid "GUESTFISH supported COMMAND"
+#. type: textblock
+#: ../cat/virt-ls.pod:21
+msgid ""
+"C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
+"more from a virtual machine or disk image."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:943
+#. type: textblock
+#: ../cat/virt-ls.pod:24
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."
+"Multiple directory names can be given, in which case the output from each is "
+"concatenated."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:948
-msgid "SINGLE CALLS AT COMPILE TIME"
+#. type: textblock
+#: ../cat/virt-ls.pod:27
+msgid ""
+"To list directories from a libvirt guest use the I<-d> option to specify the "
+"name of the guest. For a disk image, use the I<-a> option."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:950
+#. type: textblock
+#: ../cat/virt-ls.pod:31
msgid ""
-"Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
-"function, such as:"
+"C<virt-ls> can do many simple file listings. For more complicated cases you "
+"may need to use L<guestfish(1)>, or write a program directly to the L<guestfs"
+"(3)> API."
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:37
+msgid "Get a list of all files and directories in a virtual machine:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:953
+#. type: verbatim
+#: ../cat/virt-ls.pod:39
#, no-wrap
msgid ""
-" #define LIBGUESTFS_HAVE_DD 1\n"
+" virt-ls -R -d guest /\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:955
-msgid "if L</guestfs_dd> is available."
+#. type: textblock
+#: ../cat/virt-ls.pod:41
+msgid "List all setuid or setgid programs in a Linux virtual machine:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:957
+#. type: verbatim
+#: ../cat/virt-ls.pod:43
+#, no-wrap
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:"
+" virt-ls -lR -d guest / | grep '^- [42]'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:45
+msgid "List all public-writable directories in a Linux virtual machine:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:962
+#. type: verbatim
+#: ../cat/virt-ls.pod:47
#, no-wrap
msgid ""
-" AC_CHECK_LIB([guestfs],[guestfs_create])\n"
-" AC_CHECK_FUNCS([guestfs_dd])\n"
+" virt-ls -lR -d guest / | grep '^d ...7'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:965
+#. type: textblock
+#: ../cat/virt-ls.pod:49
+msgid "List all Unix domain sockets in a Linux virtual machine:"
+msgstr ""
+
+#. type: verbatim
+#: ../cat/virt-ls.pod:51
+#, no-wrap
msgid ""
-"which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
-"in your program."
+" virt-ls -lR -d guest / | grep '^s'\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:968
-msgid "SINGLE CALLS AT RUN TIME"
+#. type: textblock
+#: ../cat/virt-ls.pod:53
+msgid "List all regular files with filenames ending in '.png':"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:970
+#. type: verbatim
+#: ../cat/virt-ls.pod:55
+#, no-wrap
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."
+" virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:977
-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):"
+#. type: textblock
+#: ../cat/virt-ls.pod:57
+msgid "To display files larger than 10MB in home directories:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:981
+#. type: verbatim
+#: ../cat/virt-ls.pod:59
#, no-wrap
msgid ""
-" #include <stdio.h>\n"
-" #include <stdlib.h>\n"
-" #include <unistd.h>\n"
-" #include <dlfcn.h>\n"
-" #include <guestfs.h>\n"
-" \n"
+" virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:987
-#, no-wrap
-msgid ""
-" main ()\n"
-" {\n"
-" #ifdef LIBGUESTFS_HAVE_DD\n"
-" void *dl;\n"
-" int has_function;\n"
-" \n"
+#. type: textblock
+#: ../cat/virt-ls.pod:61
+msgid "Find everything modified in the last 7 days:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:993
+#. type: verbatim
+#: ../cat/virt-ls.pod:63
#, no-wrap
msgid ""
-" /* Test if the function guestfs_dd is really available. */\n"
-" dl = dlopen (NULL, RTLD_LAZY);\n"
-" if (!dl) {\n"
-" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
-" exit (EXIT_FAILURE);\n"
-" }\n"
-" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
-" dlclose (dl);\n"
-" \n"
+" virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:65
+msgid "Find regular files modified in the last 24 hours:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1002
+#. type: verbatim
+#: ../cat/virt-ls.pod:67
#, 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"
+" virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1015
+#. type: =head2
+#: ../cat/virt-ls.pod:69
+msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:71
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:"
+"Find the differences between files in a guest and an earlier snapshot of the "
+"same guest."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1020
+#. type: verbatim
+#: ../cat/virt-ls.pod:74
#, no-wrap
msgid ""
-" Requires: libguestfs >= 1.0.80\n"
+" virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
+" virt-ls -lR -a current.img / --uids --time-t > new\n"
+" diff -u old new | less\n"
"\n"
msgstr ""
-# type: =end
-#: ../src/guestfs.pod:1022 ../src/guestfs.pod:1027
-msgid "html"
+#. type: textblock
+#: ../cat/virt-ls.pod:78
+msgid ""
+"The commands above won't find files where the content has changed but the "
+"metadata (eg. file size and modification date) is the same. To do that, you "
+"need to add the I<--checksum> parameter to both C<virt-ls> commands. I<--"
+"checksum> can be quite slow since it has to read and compute a checksum of "
+"every regular file in the virtual machine."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1024
+#. type: =head1
+#: ../cat/virt-ls.pod:84
+msgid "OUTPUT MODES"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:86
msgid ""
-"<!-- old anchor for the next section --> <a name="
-"\"state_machine_and_low_level_event_api\"/>"
+"C<virt-ls> has four output modes, controlled by different combinations of "
+"the I<-l> and I<-R> options."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1029
-msgid "ARCHITECTURE"
+#. type: =head2
+#: ../cat/virt-ls.pod:89
+msgid "SIMPLE LISTING"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1031
-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."
+#. type: textblock
+#: ../cat/virt-ls.pod:91
+msgid "A simple listing is like the ordinary L<ls(1)> command:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1035
+#. type: verbatim
+#: ../cat/virt-ls.pod:93
#, 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"
+" $ virt-ls -d guest /\n"
+" bin\n"
+" boot\n"
+" [etc.]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1055
+#. type: =head2
+#: ../cat/virt-ls.pod:98
+msgid "LONG LISTING"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:100
msgid ""
-"The library, linked to the main program, creates the child process and hence "
-"the appliance in the L</guestfs_launch> function."
+"With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
+"(more specifically, like the C<guestfs_ll> function)."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1058
+#. type: verbatim
+#: ../cat/virt-ls.pod:103
+#, no-wrap
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."
+" $ virt-ls -l -d guest /\n"
+" total 204\n"
+" dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
+" dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
+" [etc.]\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1067
+#. type: textblock
+#: ../cat/virt-ls.pod:109
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)."
+"Note that while this is useful for displaying a directory, do not try "
+"parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
+"instead."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1074
-msgid "STATE MACHINE"
+#. type: =head2
+#: ../cat/virt-ls.pod:113
+msgid "RECURSIVE LISTING"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1076
-msgid "libguestfs uses a state machine to model the child process:"
+#. type: textblock
+#: ../cat/virt-ls.pod:115
+msgid ""
+"With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
+"and directories recursively:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1078
+#. type: verbatim
+#: ../cat/virt-ls.pod:118
#, 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"
+" $ virt-ls -R -d guest /tmp\n"
+" foo\n"
+" foo/bar\n"
+" [etc.]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1100
+#. type: textblock
+#: ../cat/virt-ls.pod:123
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."
+"To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
+"converts C<\\0> characters to C<\\n>."
+msgstr ""
+
+#. type: =head2
+#: ../cat/virt-ls.pod:126
+msgid "RECURSIVE LONG LISTING"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1105
+#. type: textblock
+#: ../cat/virt-ls.pod:128
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."
+"Using I<-lR> options together changes the output to display directories "
+"recursively, with file stats, and optionally other features such as "
+"checksums and extended attributes."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1109
+#. type: textblock
+#: ../cat/virt-ls.pod:132
msgid ""
-"Configuration commands for qemu such as L</guestfs_add_drive> can only be "
-"issued when in the CONFIG state."
+"Most of the interesting features of C<virt-ls> are only available when using "
+"I<-lR> mode."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1112
+#. type: textblock
+#: ../cat/virt-ls.pod:135
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."
+"The fields are normally space-separated. Filenames are B<not> quoted, so "
+"you cannot use the output in another program (because filenames can contain "
+"spaces and other unsafe characters). If the guest was untrusted and someone "
+"knew you were using C<virt-ls> to analyze the guest, they could play tricks "
+"on you by creating filenames with embedded newline characters. To B<safely> "
+"parse the output in another program, use the I<--csv> (Comma-Separated "
+"Values) option."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1118
+#. type: textblock
+#: ../cat/virt-ls.pod:143
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."
+"Note that this output format is completely unrelated to the C<ls -lR> "
+"command."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1124
+#. type: verbatim
+#: ../cat/virt-ls.pod:146
+#, no-wrap
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."
+" $ virt-ls -lR -d guest /bin\n"
+" d 0555 4096 /bin\n"
+" - 0755 123 /bin/alsaunmute\n"
+" - 0755 28328 /bin/arch\n"
+" l 0777 4 /bin/awk -> gawk\n"
+" - 0755 27216 /bin/basename\n"
+" - 0755 943360 /bin/bash\n"
+" [etc.]\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1128
-msgid "SETTING CALLBACKS TO HANDLE EVENTS"
+#. type: textblock
+#: ../cat/virt-ls.pod:155
+msgid "These basic fields are always shown:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1130
-msgid ""
-"The child process generates events in some situations. Current events "
-"include: receiving a log message, the child process exits."
+#. type: =item
+#: ../cat/virt-ls.pod:159
+msgid "type"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1133
+#. type: textblock
+#: ../cat/virt-ls.pod:161
msgid ""
-"Use the C<guestfs_set_*_callback> functions to set a callback for different "
-"types of events."
+"The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
+"(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
+"link), C<s> (socket) or C<u> (unknown)."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1136
-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>."
+#. type: =item
+#: ../cat/virt-ls.pod:171
+msgid "permissions"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1141
-msgid "guestfs_set_log_message_callback"
+#. type: textblock
+#: ../cat/virt-ls.pod:173
+msgid "The Unix permissions, displayed as a 4 digit octal number."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1143
-#, 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"
+#. type: =item
+#: ../cat/virt-ls.pod:175
+msgid "size"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1149
+#. type: textblock
+#: ../cat/virt-ls.pod:177
msgid ""
-"The callback function C<cb> will be called whenever qemu or the guest writes "
-"anything to the console."
+"The size of the file. This is shown in bytes unless I<-h> or I<--human-"
+"readable> option is given, in which case this is shown as a human-readable "
+"number."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1152
-msgid "Use this function to capture kernel messages and similar."
+#. type: =head2
+#: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4395
+msgid "path"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1154
-msgid ""
-"Normally there is no log message handler, and log messages are just "
-"discarded."
+#. type: textblock
+#: ../cat/virt-ls.pod:183
+msgid "The full path of the file or directory."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1157
-msgid "guestfs_set_subprocess_quit_callback"
+#. type: =item
+#: ../cat/virt-ls.pod:185
+msgid "link"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1159
-#, no-wrap
+#. type: textblock
+#: ../cat/virt-ls.pod:187
+msgid "For symbolic links only, the link target."
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:191
msgid ""
-" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
-" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
-" guestfs_subprocess_quit_cb cb,\n"
-" void *opaque);\n"
-"\n"
+"In I<-lR> mode, additional command line options enable the display of more "
+"fields."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1164
+#. type: textblock
+#: ../cat/virt-ls.pod:194
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)."
+"With the I<--uids> flag, these additional fields are displayed before the "
+"path:"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1169
-msgid "guestfs_set_launch_done_callback"
+#. type: =item
+#: ../cat/virt-ls.pod:199
+msgid "uid"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1171
-#, no-wrap
-msgid ""
-" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
-" void guestfs_set_launch_done_callback (guestfs_h *g,\n"
-" guestfs_launch_done_cb cb,\n"
-" void *opaque);\n"
-"\n"
+#. type: =item
+#: ../cat/virt-ls.pod:201
+msgid "gid"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1176
+#. type: textblock
+#: ../cat/virt-ls.pod:203
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)."
+"The UID and GID of the owner of the file (displayed numerically). Note "
+"these only make sense in the context of a Unix-like guest."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1180
-msgid "guestfs_set_close_callback"
+#. type: textblock
+#: ../cat/virt-ls.pod:208
+msgid "With the I<--times> flag, these additional fields are displayed:"
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: =item
+#: ../cat/virt-ls.pod:212
+msgid "atime"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1187
-msgid ""
-"The callback function C<cb> will be called while the handle is being closed "
-"(synchronously from L</guestfs_close>)."
+#. type: textblock
+#: ../cat/virt-ls.pod:214
+msgid "The time of last access."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1190
-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)."
+#. type: =item
+#: ../cat/virt-ls.pod:216
+msgid "mtime"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1198
-msgid "guestfs_set_progress_callback"
+#. type: textblock
+#: ../cat/virt-ls.pod:218
+msgid "The time of last modification."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1200
-#, no-wrap
-msgid ""
-" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
-" int proc_nr, int serial,\n"
-" uint64_t position, uint64_t total);\n"
-" void guestfs_set_progress_callback (guestfs_h *g,\n"
-" guestfs_progress_cb cb,\n"
-" void *opaque);\n"
-"\n"
+#. type: =item
+#: ../cat/virt-ls.pod:220
+msgid "ctime"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1207
-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)."
+#. type: textblock
+#: ../cat/virt-ls.pod:222
+msgid "The time of last status change."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1213
+#. type: textblock
+#: ../cat/virt-ls.pod:226
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."
+"The time fields are displayed as string dates and times, unless one of the "
+"I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1219
-msgid "The only defined and stable parts of the API are:"
+#. type: textblock
+#: ../cat/virt-ls.pod:229
+msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1225
+#. type: =item
+#: ../cat/virt-ls.pod:233
+msgid "device"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:235
msgid ""
-"The callback can display to the user some type of progress bar or indicator "
-"which shows the ratio of C<position>:C<total>."
+"The device containing the file (displayed as major:minor). This may not "
+"match devices as known to the guest."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1230
-msgid "0 E<lt>= C<position> E<lt>= C<total>"
+#. type: =item
+#: ../cat/virt-ls.pod:238
+msgid "inode"
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>."
+#. type: textblock
+#: ../cat/virt-ls.pod:240
+msgid "The inode number."
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: =item
+#: ../cat/virt-ls.pod:242
+msgid "nlink"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1243
+#. type: textblock
+#: ../cat/virt-ls.pod:244
+msgid "The number of hard links."
+msgstr ""
+
+#. type: =item
+#: ../cat/virt-ls.pod:246
+msgid "rdev"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:248
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."
+"For block and char special files, the device (displayed as major:minor)."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1248
-msgid "PRIVATE DATA AREA"
+#. type: =item
+#: ../cat/virt-ls.pod:251
+msgid "blocks"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1250
+#. type: textblock
+#: ../cat/virt-ls.pod:253
+msgid "The number of 512 byte blocks allocated to the file."
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:257
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."
+"With the I<--checksum> flag, the checksum of the file contents is shown "
+"(only for regular files). Computing file checksums can take a considerable "
+"amount of time."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1254
-msgid "To attach a named piece of data, use the following call:"
+#. type: =item
+#: ../cat/virt-ls.pod:280
+msgid "B<--checksum>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1256
-#, no-wrap
+#. type: =item
+#: ../cat/virt-ls.pod:282
+msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:284
msgid ""
-" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
-"\n"
+"Display checksum over file contents for regular files. With no argument, "
+"this defaults to using I<md5>. Using an argument, you can select the "
+"checksum type to use."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1258
+#. type: textblock
+#: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358
+#: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408
+#: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
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."
+"This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
+"LISTING> above."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1262
+#. type: textblock
+#: ../cat/virt-ls.pod:316
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."
+"When prompting for keys and passphrases, virt-ls 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: textblock
-#: ../src/guestfs.pod:1267
-msgid "To retrieve the pointer, use:"
+#. type: =item
+#: ../cat/virt-ls.pod:321
+msgid "B<--extra-stats>"
+msgstr ""
+
+#. type: textblock
+#: ../cat/virt-ls.pod:323
+msgid "Display extra stats."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1269
+#. type: verbatim
+#: ../cat/virt-ls.pod:339
#, no-wrap
msgid ""
-" void *guestfs_get_private (guestfs_h *g, const char *key);\n"
+" virt-ls --format=raw -a disk.img /dir\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1271
+#. type: verbatim
+#: ../cat/virt-ls.pod:343
+#, no-wrap
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>."
+" virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
+"\n"
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: textblock
+#: ../cat/virt-ls.pod:356
+msgid "Display file sizes in human-readable format."
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."
+#. type: =item
+#: ../cat/virt-ls.pod:370
+msgid "B<-R>"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1286
-msgid "BLOCK DEVICE NAMING"
+#. type: =item
+#: ../cat/virt-ls.pod:372
+msgid "B<--recursive>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1288
+#. type: textblock
+#: ../cat/virt-ls.pod:374
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."
+"Select the mode. With neither of these options, C<virt-ls> produces a "
+"simple, flat list of the files in the named directory. See L</SIMPLE "
+"LISTING>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1300
+#. type: textblock
+#: ../cat/virt-ls.pod:378
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."
+"C<virt-ls -l> produces a \"long listing\", which shows more detail. See L</"
+"LONG LISTING>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1304
+#. type: textblock
+#: ../cat/virt-ls.pod:381
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."
+"C<virt-ls -R> produces a recursive list of files starting at the named "
+"directory. See L</RECURSIVE LISTING>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1309
+#. type: textblock
+#: ../cat/virt-ls.pod:384
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."
+"C<virt-ls -lR> produces a recursive long listing which can be more easily "
+"parsed. See L</RECURSIVE LONG LISTING>."
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."
+#. type: =item
+#: ../cat/virt-ls.pod:387
+msgid "B<--times>"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1320
-msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
+#. type: textblock
+#: ../cat/virt-ls.pod:389
+msgid "Display time fields."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1322
-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."
+#. type: =item
+#: ../cat/virt-ls.pod:394
+msgid "B<--time-days>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1328
-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."
+#. type: textblock
+#: ../cat/virt-ls.pod:396
+msgid "Display time fields as days before now (negative if in the future)."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1336
-msgid "Is the string a parameter which is a device or partition name?"
+#. type: textblock
+#: ../cat/virt-ls.pod:398
+msgid ""
+"Note that C<0> in output means \"up to 1 day before now\", or that the age "
+"of the file is between 0 and 86399 seconds."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1340
-msgid "Does the string begin with C</dev/sd>?"
+#. type: =item
+#: ../cat/virt-ls.pod:404
+msgid "B<--time-relative>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1344
-msgid ""
-"Does the named device exist? If so, we use that device. However if I<not> "
-"then we continue with this algorithm."
+#. type: textblock
+#: ../cat/virt-ls.pod:406
+msgid "Display time fields as seconds before now (negative if in the future)."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1349
-msgid "Replace initial C</dev/sd> string with C</dev/hd>."
+#. type: =item
+#: ../cat/virt-ls.pod:411
+msgid "B<--time-t>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1351
-msgid "For example, change C</dev/sda2> to C</dev/hda2>."
+#. type: textblock
+#: ../cat/virt-ls.pod:413
+msgid "Display time fields as seconds since the Unix epoch."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1353
-msgid "If that named device exists, use it. If not, continue."
+#. type: =item
+#: ../cat/virt-ls.pod:418
+msgid "B<--uids>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1357
-msgid "Replace initial C</dev/sd> string with C</dev/vd>."
+#. type: textblock
+#: ../cat/virt-ls.pod:420
+msgid "Display UID and GID fields."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1359
-msgid "If that named device exists, use it. If not, return an error."
+#. type: textblock
+#: ../cat/virt-ls.pod:445
+msgid "Previous versions of virt-ls allowed you to write either:"
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1363
-msgid "PORTABILITY CONCERNS"
+#. type: verbatim
+#: ../cat/virt-ls.pod:447
+#, no-wrap
+msgid ""
+" virt-ls disk.img [disk.img ...] /dir\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1365
+#. type: verbatim
+#: ../cat/virt-ls.pod:451
+#, 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."
+" virt-ls guestname /dir\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1369
+#. type: textblock
+#: ../cat/virt-ls.pod:497
msgid ""
-"Where possible for maximum future portability programs using libguestfs "
-"should use these future-proof techniques:"
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-"
+"tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
+"L<http://libguestfs.org/>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1376
+#. type: textblock
+#: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374
+#: ../rescue/virt-rescue.pod:302
+msgid "Copyright (C) 2009-2011 Red Hat Inc."
+msgstr ""
+
+#. type: textblock
+#: ../clone/virt-sysprep.pod:5
msgid ""
-"Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
-"device names, and then use those names directly."
+"virt-sysprep - Reset or unconfigure a virtual machine so clones can be made"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1379
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:9
+#, no-wrap
msgid ""
-"Since those device names exist by definition, they will never be translated."
+" virt-sysprep [--options] -d domname\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1384
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:11
+#, no-wrap
msgid ""
-"Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
-"filesystem labels."
+" virt-sysprep [--options] -a disk.img [-a disk.img ...]\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1389
-msgid "INTERNALS"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:15
+msgid ""
+"Virt-sysprep \"resets\" or \"unconfigures\" a virtual machine so that clones "
+"can be made from it. Steps in this process include removing SSH host keys, "
+"removing persistent network MAC configuration, and removing user accounts. "
+"Each step can be enabled or disabled as required."
msgstr ""
-# type: =head2
-#: ../src/guestfs.pod:1391
-msgid "COMMUNICATION PROTOCOL"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:21
+msgid ""
+"Virt-sysprep is a simple shell script, allowing easy inspection or "
+"customization by the system administrator."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1393
+#. type: textblock
+#: ../clone/virt-sysprep.pod:24
msgid ""
-"Don't rely on using this protocol directly. This section documents how it "
-"currently works, but it may change at any time."
+"Virt-sysprep modifies the guest or disk image I<in place>. The guest must "
+"be shut down. If you want to preserve the existing contents of the guest, "
+"you I<must copy or clone the disk first>. See L</COPYING AND CLONING> below."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1396
+#. type: textblock
+#: ../clone/virt-sysprep.pod:29
msgid ""
-"The protocol used to talk between the library and the daemon running inside "
-"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
-"1014, RFC 1832, RFC 4506)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs.pod:1400
-msgid ""
-"The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
-"this file is automatically generated)."
+"You do I<not> need to run virt-sysprep as root. In fact we'd generally "
+"recommend that you don't. The time you might want to run it as root is when "
+"you need root in order to access the disk image, but even in this case it "
+"would be better to change the permissions on the disk image to be writable "
+"as the non-root user running virt-sysprep."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1403
+#. type: textblock
+#: ../clone/virt-sysprep.pod:35
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."
+"\"Sysprep\" stands for \"system preparation\" tool. The name comes from the "
+"Microsoft program C<sysprep.exe> which is used to unconfigure Windows "
+"machines in preparation for cloning them. Having said that, virt-sysprep "
+"does I<not> currently work on Microsoft Windows guests. We plan to support "
+"Windows sysprepping in a future version, and we already have code to do it."
msgstr ""
-# type: =head3
-#: ../src/guestfs.pod:1410
-msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
+#. type: =item
+#: ../clone/virt-sysprep.pod:76
+msgid "B<--enable=...>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1412
-msgid "For ordinary functions, the request message is:"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:78
+msgid ""
+"Choose which sysprep operations to perform. Give a comma-separated list of "
+"operations, for example:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1414
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:81
#, 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"
+" --enable=ssh-hostkeys,udev-persistent-net\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1419
+#. type: textblock
+#: ../clone/virt-sysprep.pod:83
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."
+"would enable ONLY C<ssh-hostkeys> and C<udev-persistent-net> operations."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1425
+#. type: textblock
+#: ../clone/virt-sysprep.pod:85
msgid ""
-"Note also that many functions don't take any arguments, in which case the "
-"C<guestfs_I<foo>_args> is completely omitted."
+"If the I<--enable> option is not given, then we default to trying all "
+"possible sysprep operations. But some sysprep operations are skipped for "
+"some guest types."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1428
+#. type: textblock
+#: ../clone/virt-sysprep.pod:89
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."
+"Use I<--list-operations> to list operations supported by a particular "
+"version of virt-sysprep."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1432
-msgid "The reply message for ordinary functions is:"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:92
+msgid ""
+"See L</OPERATIONS> below for a list and an explanation of each operation."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1434
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:106
#, 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"
+" virt-sysprep --format=raw -a disk.img\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1439
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:110
+#, no-wrap
msgid ""
-"As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
-"functions that return no formal return values."
+" virt-sysprep --format=raw -a disk.img --format -a another.img\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1442
-msgid ""
-"As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
+#. type: =item
+#: ../clone/virt-sysprep.pod:119
+msgid "B<--hostname> newhostname"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1445
+#. type: textblock
+#: ../clone/virt-sysprep.pod:121
msgid ""
-"In the case of an error, a flag is set in the header, and the reply message "
-"is slightly changed:"
+"Change the hostname. See the L</hostname> operation below. If not given, "
+"defaults to C<localhost.localdomain>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1448
-#, no-wrap
-msgid ""
-" total length (header + error,\n"
-" but not including the length word itself)\n"
-" struct guestfs_message_header (encoded as XDR)\n"
-" struct guestfs_message_error (encoded as XDR)\n"
-"\n"
+#. type: =item
+#: ../clone/virt-sysprep.pod:124
+msgid "B<--list-operations>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1453
-msgid ""
-"The C<guestfs_message_error> structure contains the error message as a "
-"string."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:126
+msgid "List the operations supported by the virt-sysprep program."
msgstr ""
-# type: =head3
-#: ../src/guestfs.pod:1456
-msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
+#. type: =item
+#: ../clone/virt-sysprep.pod:128
+msgid "B<--selinux-relabel>"
+msgstr ""
+
+#. type: =item
+#: ../clone/virt-sysprep.pod:130
+msgid "B<--no-selinux-relabel>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1458
+#. type: textblock
+#: ../clone/virt-sysprep.pod:132
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."
+"I<--selinux-relabel> forces SELinux relabelling next time the guest boots. "
+"I<--no-selinux-relabel> disables relabelling."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1462
-#, no-wrap
+#. type: textblock
+#: ../clone/virt-sysprep.pod:135
msgid ""
-" total length (header + arguments,\n"
-" but not including the length word itself,\n"
-" and not including the chunks)\n"
-" struct guestfs_message_header (encoded as XDR)\n"
-" struct guestfs_<foo>_args (encoded as XDR)\n"
-" sequence of chunks for FileIn param #0\n"
-" sequence of chunks for FileIn param #1 etc.\n"
-"\n"
+"The default is to try to detect if SELinux relabelling is required. See L</"
+"SELINUX RELABELLING> below for more details."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1470
-msgid "The \"sequence of chunks\" is:"
+#. type: =head1
+#: ../clone/virt-sysprep.pod:156
+msgid "OPERATIONS"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1472
-#, no-wrap
+#. type: textblock
+#: ../clone/virt-sysprep.pod:158
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"
+"If the I<--enable> option is I<not> given, then I<all sysprep operations are "
+"enabled>, although some are skipped depending on the type of guest."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1480
+#. type: textblock
+#: ../clone/virt-sysprep.pod:162
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."
+"Operations can be individually enabled using the I<--enable> option. Use a "
+"comma-separated list, for example:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1484
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:165
+#, no-wrap
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)."
+" virt-sysprep --enable=ssh-hostkeys,udev-persistent-net [etc..]\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1489
+#. type: textblock
+#: ../clone/virt-sysprep.pod:167
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."
+"To list the operations supported by the current version of virt-sysprep, use "
+"I<--list-operations>."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1495
+#. type: textblock
+#: ../clone/virt-sysprep.pod:170
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."
+"Future versions of virt-sysprep may add more operations. If you are using "
+"virt-sysprep and want predictable behaviour, specify only the operations "
+"that you want to have enabled."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1504
-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."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:174
+msgid "cron-spool"
msgstr ""
-# type: =head3
-#: ../src/guestfs.pod:1510
-msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:176
+msgid "Remove user at-jobs and cron-jobs."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1512
-msgid ""
-"The protocol for FileOut parameters is exactly the same as for FileIn "
-"parameters, but with the roles of daemon and library reversed."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:178
+msgid "dhcp-client-state"
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
+#: ../clone/virt-sysprep.pod:180
+msgid "Remove DHCP client leases."
msgstr ""
-# type: =head3
-#: ../src/guestfs.pod:1523
-msgid "INITIAL MESSAGE"
+#. type: =head2
+#: ../clone/virt-sysprep.pod:182
+msgid "dhcp-server-state"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1525
-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."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:184
+msgid "Remove DHCP server leases."
msgstr ""
-# type: =head3
-#: ../src/guestfs.pod:1529
-msgid "PROGRESS NOTIFICATION MESSAGES"
+#. type: =head2
+#: ../clone/virt-sysprep.pod:186
+msgid "hostname"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1531
+#. type: textblock
+#: ../clone/virt-sysprep.pod:188
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."
+"Changes the hostname of the guest to the value given in the I<--hostname> "
+"parameter."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1535
+#. type: textblock
+#: ../clone/virt-sysprep.pod:191
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."
+"If the I<--hostname> parameter is not given, then the hostname is changed to "
+"C<localhost.localdomain>."
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
+#: ../clone/virt-sysprep.pod:194
+msgid "logfiles"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1543
-msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:196
+msgid "Remove many log files."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1545
-msgid ""
-"All high-level libguestfs actions are synchronous. If you want to use "
-"libguestfs asynchronously then you must create a thread."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:198
+msgid "mail-spool"
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."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:200
+msgid "Remove email from the local mail spool directory."
+msgstr ""
+
+#. type: =head2
+#: ../clone/virt-sysprep.pod:202
+msgid "net-hwaddr"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1552
+#. type: textblock
+#: ../clone/virt-sysprep.pod:204
msgid ""
-"See the graphical program guestfs-browser for one possible architecture for "
-"multithreaded programs using libvirt and libguestfs."
+"Remove HWADDR (hard-coded MAC address) configuration. For Fedora and Red "
+"Hat Enterprise Linux, this is removed from C<ifcfg-*> files."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1555
-msgid "QEMU WRAPPERS"
+#. type: =head2
+#: ../clone/virt-sysprep.pod:207
+msgid "random-seed"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1557
+#. type: textblock
+#: ../clone/virt-sysprep.pod:209
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."
+"Write some random bytes from the host into the random seed file of the guest."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1561
-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."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:212
+msgid "See L</RANDOM SEED> below."
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
+#: ../clone/virt-sysprep.pod:214
+msgid "rhn-systemid"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1569
-#, no-wrap
-msgid ""
-" #!/bin/sh -\n"
-" qemudir=/home/rjones/d/qemu\n"
-" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
-"\n"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:216
+msgid "Remove the RHN system ID."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1573
-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:"
+#. type: =head2
+#: ../clone/virt-sysprep.pod:218
+msgid "smolt-uuid"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1577
-#, no-wrap
-msgid ""
-" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
-"\n"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:220
+msgid "Remove the Smolt hardware UUID."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1579
-msgid ""
-"Note that libguestfs also calls qemu with the -help and -version options in "
-"order to determine features."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:222
+msgid "ssh-hostkeys"
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1582
-msgid "LIBGUESTFS VERSION NUMBERS"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:224
+msgid "Remove the SSH host keys in the guest."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1584
+#. type: textblock
+#: ../clone/virt-sysprep.pod:226
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:"
+"The SSH host keys are regenerated (differently) next time the guest is "
+"booted."
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1589
+#. type: textblock
+#: ../clone/virt-sysprep.pod:229
+msgid ""
+"If, after cloning, the guest gets the same IP address, ssh will give you a "
+"stark warning about the host key changing:"
+msgstr ""
+
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:232
#, no-wrap
msgid ""
-" even numbers for stable: 1.2.x, 1.4.x, ...\n"
-" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
-" |\n"
-" v\n"
-" 1 . 3 . 5\n"
-" ^ ^\n"
-" | |\n"
-" | `-------- sub-version\n"
-" |\n"
-" `------ always '1' because we don't change the ABI\n"
+" @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
+" @ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @\n"
+" @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@\n"
+" IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1600
-msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:237
+msgid "udev-persistent-net"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1602
+#. type: textblock
+#: ../clone/virt-sysprep.pod:239
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."
+"Remove udev persistent net rules which map the guest's existing MAC address "
+"to a fixed ethernet device (eg. eth0)."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1608
-msgid "Our criteria for backporting changes are:"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:242
+msgid ""
+"After a guest is cloned, the MAC address usually changes. Since the old MAC "
+"address occupies the old name (eg. eth0), this means the fresh MAC address "
+"is assigned to a new name (eg. eth1) and this is usually undesirable. "
+"Erasing the udev persistent net rules avoids this."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1614
-msgid ""
-"Documentation changes which don't affect any code are backported unless the "
-"documentation refers to a future feature which is not in stable."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:247
+msgid "utmp"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1620
-msgid ""
-"Bug fixes which are not controversial, fix obvious problems, and have been "
-"well tested are backported."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:249
+msgid "Remove the utmp file."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1625
+#. type: textblock
+#: ../clone/virt-sysprep.pod:251
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."
+"This records who is currently logged in on a machine. In modern Linux "
+"distros it is stored in a ramdisk and hence not part of the virtual "
+"machine's disk, but it was stored on disk in older distros."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1631
-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."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:255
+msgid "yum-uuid"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1637
+#. type: textblock
+#: ../clone/virt-sysprep.pod:257
+msgid "Remove the yum UUID."
+msgstr ""
+
+#. type: textblock
+#: ../clone/virt-sysprep.pod:259
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."
+"Yum creates a fresh UUID the next time it runs when it notices that the "
+"original UUID has been erased."
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"
+#. type: =head1
+#: ../clone/virt-sysprep.pod:262
+msgid "COPYING AND CLONING"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1649 ../fish/guestfish.pod:953
-msgid "LIBGUESTFS_APPEND"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:264
+msgid ""
+"Virt-sysprep can be used as part of a process of cloning guests, or to "
+"prepare a template from which guests can be cloned. There are many "
+"different ways to achieve this using the virt tools, and this section is "
+"just an introduction."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1651 ../fish/guestfish.pod:955
-msgid "Pass additional options to the guest kernel."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:269
+msgid "A virtual machine (when switched off) consists of two parts:"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1653 ../fish/guestfish.pod:957
-msgid "LIBGUESTFS_DEBUG"
+#. type: =item
+#: ../clone/virt-sysprep.pod:273
+msgid "I<configuration>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1655
+#. type: textblock
+#: ../clone/virt-sysprep.pod:275
msgid ""
-"Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
-"effect as calling C<guestfs_set_verbose (g, 1)>."
+"The configuration or description of the guest. eg. The libvirt XML (see "
+"C<virsh dumpxml>), the running configuration of the guest, or another "
+"external format like OVF."
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1658 ../fish/guestfish.pod:962
-msgid "LIBGUESTFS_MEMSIZE"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:279
+msgid "Some configuration items that might need to be changed:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1660 ../fish/guestfish.pod:964
-msgid ""
-"Set the memory allocated to the qemu process, in megabytes. For example:"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:285
+msgid "name"
msgstr ""
-# type: verbatim
-#: ../src/guestfs.pod:1663 ../fish/guestfish.pod:967
-#, no-wrap
-msgid ""
-" LIBGUESTFS_MEMSIZE=700\n"
-"\n"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:289 ../clone/virt-sysprep.pod:316
+msgid "UUID"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1665 ../fish/guestfish.pod:969
-msgid "LIBGUESTFS_PATH"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:293
+msgid "path to block device(s)"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1667
-msgid ""
-"Set the path that libguestfs uses to search for kernel and initrd.img. See "
-"the discussion of paths in section PATH above."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:297
+msgid "network card MAC address"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1670 ../fish/guestfish.pod:974
-msgid "LIBGUESTFS_QEMU"
+#. type: =item
+#: ../clone/virt-sysprep.pod:301
+msgid "I<block device(s)>"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1672 ../fish/guestfish.pod:976
+#. type: textblock
+#: ../clone/virt-sysprep.pod:303
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."
+"One or more hard disk images, themselves containing files, directories, "
+"applications, kernels, configuration, etc."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1676
-msgid "See also L</QEMU WRAPPERS> above."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:306
+msgid "Some things inside the block devices that might need to be changed:"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1678 ../fish/guestfish.pod:980
-msgid "LIBGUESTFS_TRACE"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:312
+msgid "hostname and other net configuration"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1680
-msgid ""
-"Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
-"effect as calling C<guestfs_set_trace (g, 1)>."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:320
+msgid "SSH host keys"
msgstr ""
-# type: =item
-#: ../src/guestfs.pod:1683 ../fish/guestfish.pod:989
-msgid "TMPDIR"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:324
+msgid "Windows unique security ID (SID)"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1685 ../fish/guestfish.pod:991
-msgid "Location of temporary directory, defaults to C</tmp>."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:328
+msgid "Puppet registration"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1687 ../fish/guestfish.pod:993
-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."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:334
+msgid "COPYING THE BLOCK DEVICE"
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
+#: ../clone/virt-sysprep.pod:336
+msgid ""
+"Starting with an original guest, you probably wish to copy the guest block "
+"device and its configuration to make a template. Then once you are happy "
+"with the template, you will want to make many clones from it."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1697
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:341
+#, no-wrap
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/>."
+" virt-sysprep\n"
+" |\n"
+" v\n"
+" original guest --------> template ---------->\n"
+" \\------> cloned\n"
+" \\-----> guests\n"
+" \\---->\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1715
+#. type: textblock
+#: ../clone/virt-sysprep.pod:349
msgid ""
-"Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
-"(8)>, L<disktype(1)>."
+"You can, of course, just copy the block device on the host using L<cp(1)> or "
+"L<dd(1)>."
msgstr ""
-# type: =head1
-#: ../src/guestfs.pod:1722 ../tools/virt-make-fs.pl:541
-#: ../tools/virt-win-reg.pl:476
-msgid "BUGS"
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:352
+#, no-wrap
+msgid ""
+" dd dd\n"
+" original guest --------> template ---------->\n"
+" \\------> cloned\n"
+" \\-----> guests\n"
+" \\---->\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1724
-msgid "To get a list of bugs against libguestfs use this link:"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:358
+msgid "There are some smarter (and faster) ways too:"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1726
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:364
+#, no-wrap
msgid ""
-"L<https://bugzilla.redhat.com/buglist.cgi?"
-"component=libguestfs&product=Virtualization+Tools>"
+" snapshot\n"
+" template ---------->\n"
+" \\------> cloned\n"
+" \\-----> guests\n"
+" \\---->\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1728
-msgid "To report a new bug against libguestfs use this link:"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:370
+msgid ""
+"Use the block device as a backing file and create a snapshot on top for each "
+"guest. The advantage is that you don't need to copy the block device (very "
+"fast) and only changes are stored (less storage required)."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1730
+#. type: textblock
+#: ../clone/virt-sysprep.pod:375
msgid ""
-"L<https://bugzilla.redhat.com/enter_bug.cgi?"
-"component=libguestfs&product=Virtualization+Tools>"
+"Note that writing to the backing file once you have created guests on top of "
+"it is not possible: you will corrupt the guests."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1732
-msgid "When reporting a bug, please check:"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:378
+msgid ""
+"Tools that can do this include: L<qemu-img(1)> (with the I<create -f qcow2 -"
+"o backing_file> option), L<lvcreate(8)> (I<--snapshot> option). Some "
+"filesystems (such as btrfs) and most Network Attached Storage devices can "
+"also create cheap snapshots from files or LUNs."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1738
-msgid "That the bug hasn't been reported already."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:386
+msgid "Get your NAS to snapshot and/or duplicate the LUN."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1742
-msgid "That you are testing a recent version."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:390
+msgid "Prepare your template using L<virt-sparsify(1)>. See below."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1746
-msgid "Describe the bug accurately, and give a way to reproduce it."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:394
+msgid "VIRT-CLONE"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1750
+#. type: textblock
+#: ../clone/virt-sysprep.pod:396
msgid ""
-"Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
-"bug report."
-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"
+"A separate tool, L<virt-clone(1)>, can be used to duplicate the block device "
+"and/or modify the external libvirt configuration of a guest. It will reset "
+"the name, UUID and MAC address of the guest in the libvirt XML."
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>)"
-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: textblock
+#: ../clone/virt-sysprep.pod:401
+msgid ""
+"L<virt-clone(1)> does not use libguestfs and cannot look inside the disk "
+"image. This was the original motivation to write virt-sysprep."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1761 ../fish/guestfish.pod:1073
-msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
+#. type: =head2
+#: ../clone/virt-sysprep.pod:404
+msgid "SPARSIFY"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1764
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:406
+#, no-wrap
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."
+" virt-sparsify\n"
+" original guest --------> template\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1769
+#. type: textblock
+#: ../clone/virt-sysprep.pod:409
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."
+"L<virt-sparsify(1)> can be used to make the cloning template smaller, making "
+"it easier to compress and/or faster to copy."
msgstr ""
-# type: textblock
-#: ../src/guestfs.pod:1774
+#. type: textblock
+#: ../clone/virt-sysprep.pod:412
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"
+"Notice that since virt-sparsify also copies the image, you can use it to "
+"make the initial copy (instead of C<dd>)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1
-msgid "guestfs_add_cdrom"
+#. type: =head2
+#: ../clone/virt-sysprep.pod:415
+msgid "RESIZE"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:417
#, no-wrap
msgid ""
-" int guestfs_add_cdrom (guestfs_h *g,\n"
-"\t\tconst char *filename);\n"
+" virt-resize\n"
+" template ---------->\n"
+" \\------> cloned\n"
+" \\-----> guests\n"
+" \\---->\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."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:423
+msgid ""
+"If you want to give people cloned guests, but let them pick the size of the "
+"guest themselves (eg. depending on how much they are prepared to pay for "
+"disk space), then instead of copying the template, you can run L<virt-resize"
+"(1)>. Virt-resize performs a copy and resize, and thus is ideal for cloning "
+"guests from a template."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:7
-msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
+#. type: =head1
+#: ../clone/virt-sysprep.pod:429 ../src/guestfs.pod:1164
+msgid "SECURITY"
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:"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:431
+msgid ""
+"Although virt-sysprep removes some sensitive information from the guest, it "
+"does not pretend to remove all of it. You should examine the L</OPERATIONS> "
+"above, and the implementation of the operations in the shell script. You "
+"should also examine the guest afterwards."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:16
+#. type: textblock
+#: ../clone/virt-sysprep.pod:436
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."
+"Sensitive files are simply removed. The data they contained may still exist "
+"on the disk, easily recovered with a hex editor or undelete tool. Use "
+"L<virt-sparsify(1)> as one way to remove this content. See also the L<scrub"
+"(1)> command to get rid of deleted content in directory entries and inodes."
+msgstr ""
+
+#. type: =head2
+#: ../clone/virt-sysprep.pod:442
+msgid "RANDOM SEED"
+msgstr ""
+
+#. type: textblock
+#: ../clone/virt-sysprep.pod:444
+msgid "I<(This section applies to Linux guests only)>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:23
+#. type: textblock
+#: ../clone/virt-sysprep.pod:446
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 virt-sysprep C<random-seed> operation writes a few bytes of randomness "
+"from the host into the guest's random seed file."
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."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:449
+msgid ""
+"If this is just done once and the guest is cloned from the same template, "
+"then each guest will start with the same entropy, and things like SSH host "
+"keys and TCP sequence numbers may be predictable."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:31
-msgid "guestfs_add_drive"
+#. type: textblock
+#: ../clone/virt-sysprep.pod:453
+msgid ""
+"Therefore you should arrange to add more randomness I<after> cloning from a "
+"template too, which can be done by just enabling the C<random-seed> "
+"operation:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:33
+#. type: verbatim
+#: ../clone/virt-sysprep.pod:457
#, no-wrap
msgid ""
-" int guestfs_add_drive (guestfs_h *g,\n"
-"\t\tconst char *filename);\n"
+" cp template.img newguest.img\n"
+" virt-sysprep --enable=random-seed -a newguest.img\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:36 ../fish/guestfish-actions.pod:32
-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."
+#. type: =head2
+#: ../clone/virt-sysprep.pod:460
+msgid "SELINUX RELABELLING"
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)."
+#. type: textblock
+#: ../clone/virt-sysprep.pod:462
+msgid "I<(This section applies to Linux guests using SELinux only)>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:47 ../fish/guestfish-actions.pod:43
+#. type: textblock
+#: ../clone/virt-sysprep.pod:464
msgid ""
-"This is equivalent to the qemu parameter C<-drive file=filename,cache=off,"
-"if=...>."
+"If any new files are created by virt-sysprep, then virt-sysprep touches C</."
+"autorelabel> so that these will be correctly labelled by SELinux the next "
+"time the guest is booted. This process interrupts boot and can take some "
+"time."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:50 ../fish/guestfish-actions.pod:46
+#. type: textblock
+#: ../clone/virt-sysprep.pod:469
msgid ""
-"C<cache=off> is omitted in cases where it is not supported by the underlying "
-"filesystem."
+"You can force relabelling for all guests by supplying the I<--selinux-"
+"relabel> option."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:53 ../src/guestfs-actions.pod:82
+#. type: textblock
+#: ../clone/virt-sysprep.pod:472
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>."
+"You can disable relabelling entirely by supplying the I<--no-selinux-"
+"relabel> option."
+msgstr ""
+
+#. type: textblock
+#: ../clone/virt-sysprep.pod:484
+msgid "This program returns 0 on success, or 1 if there was an error."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:58 ../src/guestfs-actions.pod:87
+#. type: textblock
+#: ../clone/virt-sysprep.pod:488
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."
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-clone(1)>, L<virt-rescue(1)>, L<virt-"
+"resize(1)>, L<virt-sparsify(1)>, L<virsh(1)>, L<lvcreate(8)>, L<qemu-img(1)"
+">, L<scrub(1)>, L<http://libguestfs.org/>, L<http://libvirt.org/>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:65
-msgid "guestfs_add_drive_ro"
+#. type: textblock
+#: ../df/virt-df.pod:5
+msgid "virt-df - Display free space on virtual filesystems"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:67
+#. type: verbatim
+#: ../df/virt-df.pod:9
#, no-wrap
msgid ""
-" int guestfs_add_drive_ro (guestfs_h *g,\n"
-"\t\tconst char *filename);\n"
+" virt-df [--options]\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
+#. type: verbatim
+#: ../df/virt-df.pod:11
+#, no-wrap
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."
+" virt-df [--options] -d domname\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:79 ../fish/guestfish-actions.pod:72
+#. type: verbatim
+#: ../df/virt-df.pod:13
+#, no-wrap
msgid ""
-"This is equivalent to the qemu parameter C<-drive file=filename,snapshot=on,"
-"if=...>."
+" virt-df [--options] -a disk.img [-a disk.img ...]\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:94
-msgid "guestfs_add_drive_ro_with_if"
+#. type: verbatim
+#: ../df/virt-df.pod:17
+#, no-wrap
+msgid ""
+" virt-df [--options] domname\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:96
+#. type: verbatim
+#: ../df/virt-df.pod:19
#, no-wrap
msgid ""
-" int guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
-"\t\tconst char *filename,\n"
-"\t\tconst char *iface);\n"
+" virt-df [--options] disk.img [disk.img ...]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:100
+#. type: textblock
+#: ../df/virt-df.pod:23
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."
+"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 size of disk "
+"allocated to a virtual machine, but can look inside disk images to see how "
+"much space is really being used."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:105
-msgid "guestfs_add_drive_with_if"
+#. type: textblock
+#: ../df/virt-df.pod:28
+msgid ""
+"If used without any I<-a> or I<-d> 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: verbatim
-#: ../src/guestfs-actions.pod:107
-#, no-wrap
+#. type: textblock
+#: ../df/virt-df.pod:32
msgid ""
-" int guestfs_add_drive_with_if (guestfs_h *g,\n"
-"\t\tconst char *filename,\n"
-"\t\tconst char *iface);\n"
-"\n"
+"If any I<-a> or I<-d> arguments are specified, 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
-#: ../src/guestfs-actions.pod:111
+#. type: textblock
+#: ../df/virt-df.pod:39
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."
+"Use the I<--csv> option to get a format which can be easily parsed by other "
+"programs. Other options are similar to the standard L<df(1)> command."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:116
-msgid "guestfs_aug_clear"
+#. type: textblock
+#: ../df/virt-df.pod:45
+msgid ""
+"Show disk usage for a single libvirt guest called C<F14x64>. Make the "
+"output human-readable:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:118
+#. type: verbatim
+#: ../df/virt-df.pod:48
#, no-wrap
msgid ""
-" int guestfs_aug_clear (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
+" # virt-df -d F14x64 -h\n"
+" Filesystem Size Used Available Use%\n"
+" F14x64:/dev/sda1 484M 66M 393M 14%\n"
+" F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:121 ../fish/guestfish-actions.pod:103
-msgid ""
-"Set the value associated with C<path> to C<NULL>. This is the same as the "
-"L<augtool(1)> C<clear> command."
+#. type: textblock
+#: ../df/virt-df.pod:53
+msgid "Show disk usage for a disk image file called C<test.img>:"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:126
-msgid "guestfs_aug_close"
+#. type: verbatim
+#: ../df/virt-df.pod:55
+#, no-wrap
+msgid ""
+" $ virt-df -a test1.img\n"
+" Filesystem 1K-blocks Used Available Use%\n"
+" test1.img:/dev/sda1 99099 1551 92432 2%\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:128
+#. type: verbatim
+#: ../df/virt-df.pod:112
#, no-wrap
msgid ""
-" int guestfs_aug_close (guestfs_h *g);\n"
+" virt-df --format=raw -a disk.img\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:130
+#. type: verbatim
+#: ../df/virt-df.pod:116
+#, no-wrap
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."
+" virt-df --format=raw -a disk.img --format -a another.img\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:137
-msgid "guestfs_aug_defnode"
+#. type: textblock
+#: ../df/virt-df.pod:129
+msgid "Print sizes in human-readable format."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:139
-#, no-wrap
-msgid ""
-" struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n"
-"\t\tconst char *name,\n"
-"\t\tconst char *expr,\n"
-"\t\tconst char *val);\n"
-"\n"
+#. type: textblock
+#: ../df/virt-df.pod:131
+msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
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>."
+#. type: =item
+#: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:164
+msgid "B<-i>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:147
-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."
+#. type: =item
+#: ../df/virt-df.pod:135
+msgid "B<--inodes>"
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: textblock
+#: ../df/virt-df.pod:137
+msgid "Print inodes instead of blocks."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:155
+#. type: =item
+#: ../df/virt-df.pod:139
+msgid "B<--one-per-guest>"
+msgstr ""
+
+#. type: textblock
+#: ../df/virt-df.pod:141
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>."
+"Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
+"disks from several guests to a single libguestfs appliance."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:159
-msgid "guestfs_aug_defvar"
+#. type: textblock
+#: ../df/virt-df.pod:144
+msgid "You might use this option in the following circumstances:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:161
-#, no-wrap
+#. type: textblock
+#: ../df/virt-df.pod:150
msgid ""
-" int guestfs_aug_defvar (guestfs_h *g,\n"
-"\t\tconst char *name,\n"
-"\t\tconst char *expr);\n"
-"\n"
+"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
-#: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:134
+#. type: textblock
+#: ../df/virt-df.pod:156
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."
+"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: textblock
-#: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:138
+#. type: textblock
+#: ../df/virt-df.pod:165
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."
+"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
-#: ../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."
+#. type: textblock
+#: ../df/virt-df.pod:169
+msgid ""
+"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: =head2
-#: ../src/guestfs-actions.pod:174
-msgid "guestfs_aug_get"
+#. type: textblock
+#: ../df/virt-df.pod:229
+msgid ""
+"L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<http://"
+"libguestfs.org/>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:176
+#. type: textblock
+#: ../edit/virt-edit.pod:5
+msgid "virt-edit - Edit a file in a virtual machine"
+msgstr ""
+
+#. type: verbatim
+#: ../edit/virt-edit.pod:9
#, no-wrap
msgid ""
-" char *guestfs_aug_get (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
+" virt-edit [--options] -d domname file [file ...]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:145
+#. type: verbatim
+#: ../edit/virt-edit.pod:11
+#, no-wrap
msgid ""
-"Look up the value associated with C<path>. If C<path> matches exactly one "
-"node, the C<value> is returned."
+" virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
+"\n"
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
+#. type: verbatim
+#: ../edit/virt-edit.pod:13
+#, no-wrap
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"
+" virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:187
+#. type: verbatim
+#: ../edit/virt-edit.pod:17
#, no-wrap
msgid ""
-" int guestfs_aug_init (guestfs_h *g,\n"
-"\t\tconst char *root,\n"
-"\t\tint flags);\n"
+" virt-edit domname file\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:191 ../fish/guestfish-actions.pod:152
+#. type: verbatim
+#: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
+#, no-wrap
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."
+" virt-edit disk.img [disk.img ...] file\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:195
-msgid "You must call this before using any other C<guestfs_aug_*> commands."
+#. type: =head1
+#: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23
+#: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15
+#: ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19
+#: ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
+msgid "WARNING"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:198 ../fish/guestfish-actions.pod:159
+#. type: textblock
+#: ../edit/virt-edit.pod:23
msgid ""
-"C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
+"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: textblock
-#: ../src/guestfs-actions.pod:201 ../fish/guestfish-actions.pod:162
+#. type: textblock
+#: ../edit/virt-edit.pod:29
msgid ""
-"The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
-"logical I<or> of the following integers:"
+"C<virt-edit> is a command line tool to edit C<file> where each C<file> "
+"exists in the named virtual machine (or disk image)."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:207 ../fish/guestfish-actions.pod:168
-msgid "C<AUG_SAVE_BACKUP> = 1"
+#. type: textblock
+#: ../edit/virt-edit.pod:32
+msgid ""
+"Multiple filenames can be given, in which case they are each edited in "
+"turn. Each filename must be a full path, starting at the root directory "
+"(starting with '/')."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:209 ../fish/guestfish-actions.pod:170
-msgid "Keep the original file with a C<.augsave> extension."
+#. type: textblock
+#: ../edit/virt-edit.pod:36
+msgid "If you want to just view a file, use L<virt-cat(1)>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:211 ../fish/guestfish-actions.pod:172
-msgid "C<AUG_SAVE_NEWFILE> = 2"
+#. type: textblock
+#: ../edit/virt-edit.pod:38
+msgid ""
+"For more complex cases you should look at the L<guestfish(1)> tool (see L</"
+"USING GUESTFISH> below)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:213 ../fish/guestfish-actions.pod:174
+#. type: textblock
+#: ../edit/virt-edit.pod:41
msgid ""
-"Save changes into a file with extension C<.augnew>, and do not overwrite "
-"original. Overrides C<AUG_SAVE_BACKUP>."
+"C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
+"that and much more."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:216 ../fish/guestfish-actions.pod:177
-msgid "C<AUG_TYPE_CHECK> = 4"
+#. type: textblock
+#: ../edit/virt-edit.pod:46
+msgid "Edit the named files interactively:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:218 ../fish/guestfish-actions.pod:179
-msgid "Typecheck lenses (can be expensive)."
+#. type: verbatim
+#: ../edit/virt-edit.pod:48
+#, no-wrap
+msgid ""
+" virt-edit -d mydomain /boot/grub/grub.conf\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:220 ../fish/guestfish-actions.pod:181
-msgid "C<AUG_NO_STDINC> = 8"
+#. type: verbatim
+#: ../edit/virt-edit.pod:50
+#, no-wrap
+msgid ""
+" virt-edit -d mydomain /etc/passwd\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:222 ../fish/guestfish-actions.pod:183
-msgid "Do not use standard load path for modules."
+#. type: textblock
+#: ../edit/virt-edit.pod:52
+msgid "For Windows guests, some Windows paths are understood:"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:224 ../fish/guestfish-actions.pod:185
-msgid "C<AUG_SAVE_NOOP> = 16"
+#. type: verbatim
+#: ../edit/virt-edit.pod:54
+#, no-wrap
+msgid ""
+" virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
+"\n"
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."
+#. type: textblock
+#: ../edit/virt-edit.pod:56
+msgid ""
+"If Perl is installed, you can also edit files non-interactively (see L</NON-"
+"INTERACTIVE EDITING> below). To change the init default level to 5:"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:228 ../fish/guestfish-actions.pod:189
-msgid "C<AUG_NO_LOAD> = 32"
+#. type: verbatim
+#: ../edit/virt-edit.pod:60
+#, no-wrap
+msgid ""
+" virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:230
-msgid "Do not load the tree in C<guestfs_aug_init>."
+#. type: =item
+#: ../edit/virt-edit.pod:81
+msgid "B<-b> extension"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:234
-msgid "To close the handle, you can call C<guestfs_aug_close>."
+#. type: =item
+#: ../edit/virt-edit.pod:83
+msgid "B<--backup> extension"
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/>."
+#. type: textblock
+#: ../edit/virt-edit.pod:85
+msgid ""
+"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: =head2
-#: ../src/guestfs-actions.pod:240
-msgid "guestfs_aug_insert"
+#. type: textblock
+#: ../edit/virt-edit.pod:88
+msgid ""
+"Usually the first character of C<extension> would be a dot C<.> so you would "
+"write:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:242
+#. type: verbatim
+#: ../edit/virt-edit.pod:91
#, no-wrap
msgid ""
-" int guestfs_aug_insert (guestfs_h *g,\n"
-"\t\tconst char *augpath,\n"
-"\t\tconst char *label,\n"
-"\t\tint before);\n"
+" virt-edit -b .orig [etc]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:247 ../fish/guestfish-actions.pod:203
-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>)."
+#. type: textblock
+#: ../edit/virt-edit.pod:93
+msgid "By default, no backup file is made."
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]>."
+#. type: =item
+#: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181
+#: ../fuse/guestmount.pod:105 ../inspector/virt-inspector.pod:74
+#: ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78
+#: ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
+msgid "B<-c URI>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:257
-msgid "guestfs_aug_load"
+#. type: =item
+#: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183
+#: ../fuse/guestmount.pod:107 ../inspector/virt-inspector.pod:76
+#: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
+#: ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
+msgid "B<--connect URI>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:259
-#, no-wrap
+#. type: textblock
+#: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84
+#: ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134
+#: ../tools/virt-win-reg.pl:135
msgid ""
-" int guestfs_aug_load (guestfs_h *g);\n"
-"\n"
+"If you specify guest block devices directly, then libvirt is not used at all."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:215
-msgid "Load files into the tree."
+#. type: textblock
+#: ../edit/virt-edit.pod:114
+msgid ""
+"When prompting for keys and passphrases, virt-edit 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: 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."
+#. type: =item
+#: ../edit/virt-edit.pod:119
+msgid "B<-e> EXPR"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:268
-msgid "guestfs_aug_ls"
+#. type: =item
+#: ../edit/virt-edit.pod:121
+msgid "B<--expr> EXPR"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:270
-#, no-wrap
+#. type: textblock
+#: ../edit/virt-edit.pod:123
msgid ""
-" char **guestfs_aug_ls (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
-"\n"
+"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
-#: ../src/guestfs-actions.pod:273
+#. type: textblock
+#: ../edit/virt-edit.pod:127
msgid ""
-"This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
-"sorting the resulting nodes into alphabetical order."
-msgstr ""
+"Be careful to properly quote the expression to prevent it from being altered "
+"by the shell."
+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
-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>."
+#. type: textblock
+#: ../edit/virt-edit.pod:130
+msgid "Note that this option is only available when Perl 5 is installed."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:280
-msgid "guestfs_aug_match"
+#. type: =item
+#: ../edit/virt-edit.pod:132
+msgid "B<--format> raw|qcow2|..."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:282
+#. type: verbatim
+#: ../edit/virt-edit.pod:143
#, no-wrap
msgid ""
-" char **guestfs_aug_match (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
+" virt-edit --format=raw -a disk.img file\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:285 ../fish/guestfish-actions.pod:231
+#. type: verbatim
+#: ../edit/virt-edit.pod:147
+#, no-wrap
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."
+" virt-edit --format=raw -a disk.img --format -a another.img file\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:293
-msgid "guestfs_aug_mv"
+#. type: textblock
+#: ../edit/virt-edit.pod:181
+msgid "Previous versions of virt-edit allowed you to write either:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:295
+#. type: verbatim
+#: ../edit/virt-edit.pod:187
#, no-wrap
msgid ""
-" int guestfs_aug_mv (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
+" virt-edit guestname file\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:299 ../fish/guestfish-actions.pod:239
-msgid ""
-"Move the node C<src> to C<dest>. C<src> must match exactly one node. "
-"C<dest> is overwritten if it exists."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:304
-msgid "guestfs_aug_rm"
+#. type: =head1
+#: ../edit/virt-edit.pod:195
+msgid "NON-INTERACTIVE EDITING"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:306
-#, no-wrap
+#. type: textblock
+#: ../edit/virt-edit.pod:197
msgid ""
-" int guestfs_aug_rm (guestfs_h *g,\n"
-"\t\tconst char *augpath);\n"
-"\n"
+"C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
+"administrator can interactively edit the file."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:309 ../fish/guestfish-actions.pod:246
-msgid "Remove C<path> and all of its children."
+#. type: textblock
+#: ../edit/virt-edit.pod:200
+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
-#: ../src/guestfs-actions.pod:311 ../fish/guestfish-actions.pod:248
-msgid "On success this returns the number of entries which were removed."
+#. type: textblock
+#: ../edit/virt-edit.pod:206
+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: =head2
-#: ../src/guestfs-actions.pod:315
-msgid "guestfs_aug_save"
+#. type: textblock
+#: ../edit/virt-edit.pod:210
+msgid ""
+"The second method is to use the I<-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
-#: ../src/guestfs-actions.pod:317
+#. type: verbatim
+#: ../edit/virt-edit.pod:214
#, no-wrap
msgid ""
-" int guestfs_aug_save (guestfs_h *g);\n"
+" virt-edit -d domname filename -e 's/foo/bar/'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:254
-msgid "This writes all pending changes to disk."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:321
+#. type: textblock
+#: ../edit/virt-edit.pod:216
msgid ""
-"The flags which were passed to C<guestfs_aug_init> affect exactly how files "
-"are saved."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:326
-msgid "guestfs_aug_set"
+"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
-#: ../src/guestfs-actions.pod:328
+#. type: verbatim
+#: ../edit/virt-edit.pod:219
#, no-wrap
msgid ""
-" int guestfs_aug_set (guestfs_h *g,\n"
-"\t\tconst char *augpath,\n"
-"\t\tconst char *val);\n"
+" virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:332 ../fish/guestfish-actions.pod:263
-msgid "Set the value associated with C<path> to C<val>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:334
+#. type: textblock
+#: ../edit/virt-edit.pod:221
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."
+"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: =head2
-#: ../src/guestfs-actions.pod:341
-msgid "guestfs_available"
+#. type: textblock
+#: ../edit/virt-edit.pod:226
+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:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:343
+#. type: verbatim
+#: ../edit/virt-edit.pod:229
#, no-wrap
msgid ""
-" int guestfs_available (guestfs_h *g,\n"
-"\t\tchar *const *groups);\n"
+" virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:274
+#. type: textblock
+#: ../edit/virt-edit.pod:231
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."
+"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
-#: ../src/guestfs-actions.pod:350
+#. type: textblock
+#: ../edit/virt-edit.pod:237
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>."
+"The variable C<$lineno> contains the current line number. As is "
+"traditional, the first line in the file is number C<1>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:355 ../fish/guestfish-actions.pod:283
+#. type: textblock
+#: ../edit/virt-edit.pod:240
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."
+"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
-#: ../src/guestfs-actions.pod:362 ../fish/guestfish-actions.pod:290
+#. type: textblock
+#: ../edit/virt-edit.pod:244
msgid ""
-"It fails with an error if one or more of the requested groups is unavailable "
-"in the appliance."
+"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: textblock
-#: ../src/guestfs-actions.pod:365 ../fish/guestfish-actions.pod:293
+#. type: verbatim
+#: ../edit/virt-edit.pod:249
+#, no-wrap
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:>"
+" /some text(\\r?\\n)?$/\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:374
-msgid "You must call C<guestfs_launch> before calling this function."
+#. type: textblock
+#: ../edit/virt-edit.pod:251
+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: textblock
-#: ../src/guestfs-actions.pod:376 ../fish/guestfish-actions.pod:304
+#. type: verbatim
+#: ../edit/virt-edit.pod:255
+#, no-wrap
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."
+" my $m = $_; chomp $m; $m =~ /some text$/\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:310
+#. type: textblock
+#: ../edit/virt-edit.pod:259
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."
+"C<virt-edit> has a limited ability to understand Windows drive letters and "
+"paths (eg. C<E:\\foo\\bar.txt>)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:389 ../fish/guestfish-actions.pod:317
+#. type: textblock
+#: ../edit/virt-edit.pod:278
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 path is resolved case insensitively to locate the file that should be "
+"edited."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:396
+#. type: textblock
+#: ../edit/virt-edit.pod:299
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>."
+"L<guestfish(1)> is a more powerful, lower level tool which you can use when "
+"C<virt-edit> doesn't work."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:405
-msgid "guestfs_available_all_groups"
+#. type: textblock
+#: ../edit/virt-edit.pod:302
+msgid "Using C<virt-edit> is approximately equivalent to doing:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:407
+#. type: verbatim
+#: ../edit/virt-edit.pod:304
#, no-wrap
msgid ""
-" char **guestfs_available_all_groups (guestfs_h *g);\n"
+" guestfish --rw -i -d domname edit /file\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:409
+#. type: textblock
+#: ../edit/virt-edit.pod:306
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."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:415
-msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
+"where C<domname> is the name of the libvirt guest, and C</file> is the full "
+"path to the file."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:421
-msgid "guestfs_base64_in"
+#. type: textblock
+#: ../edit/virt-edit.pod:309
+msgid ""
+"The command above uses libguestfs's guest inspection feature and so does not "
+"work on guests that libguestfs cannot inspect, or on things like arbitrary "
+"disk images that don't contain guests. To edit a file on a disk image "
+"directly, use:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:423
+#. type: verbatim
+#: ../edit/virt-edit.pod:314
#, no-wrap
msgid ""
-" int guestfs_base64_in (guestfs_h *g,\n"
-"\t\tconst char *base64file,\n"
-"\t\tconst char *filename);\n"
+" guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:427 ../fish/guestfish-actions.pod:347
+#. type: textblock
+#: ../edit/virt-edit.pod:316
msgid ""
-"This command uploads base64-encoded data from C<base64file> to C<filename>."
+"where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
+"the disk image to edit, and C</file> is the full path to the file."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:432
-msgid "guestfs_base64_out"
+#. type: textblock
+#: ../edit/virt-edit.pod:320
+msgid ""
+"C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
+"C<write> or C<upload> instead:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:434
+#. type: verbatim
+#: ../edit/virt-edit.pod:323
#, no-wrap
msgid ""
-" int guestfs_base64_out (guestfs_h *g,\n"
-"\t\tconst char *filename,\n"
-"\t\tconst char *base64file);\n"
+" guestfish --rw -i -d domname touch /newfile\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:356
-msgid ""
-"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:443
-msgid "guestfs_blockdev_flushbufs"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:445
+#. type: verbatim
+#: ../edit/virt-edit.pod:325
#, no-wrap
msgid ""
-" int guestfs_blockdev_flushbufs (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" guestfish --rw -i -d domname write /newfile \"new content\"\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:448 ../fish/guestfish-actions.pod:365
+#. type: verbatim
+#: ../edit/virt-edit.pod:327
+#, no-wrap
msgid ""
-"This tells the kernel to flush internal buffers associated with C<device>."
+" guestfish --rw -i -d domname upload localfile /newfile\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."
+#. type: =head1
+#: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1119
+#: ../rescue/virt-rescue.pod:261 ../sparsify/virt-sparsify.pod:232
+#: ../src/guestfs.pod:3209 ../test-tool/libguestfs-test-tool.pod:95
+msgid "ENVIRONMENT VARIABLES"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:455
-msgid "guestfs_blockdev_getbsz"
+#. type: =item
+#: ../edit/virt-edit.pod:333
+msgid "C<EDITOR>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:457
-#, no-wrap
+#. type: textblock
+#: ../edit/virt-edit.pod:335
msgid ""
-" int guestfs_blockdev_getbsz (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+"If set, this string is used as the editor. It may contain arguments, eg. C<"
+"\"emacs -nw\">"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:460 ../fish/guestfish-actions.pod:374
-msgid "This returns the block size of a device."
+#. type: textblock
+#: ../edit/virt-edit.pod:338
+msgid "If not set, C<vi> is used."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:462 ../src/guestfs-actions.pod:544
-#: ../fish/guestfish-actions.pod:376 ../fish/guestfish-actions.pod:439
+#. type: textblock
+#: ../edit/virt-edit.pod:356
msgid ""
-"(Note this is different from both I<size in blocks> and I<filesystem block "
-"size>)."
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
+"tar-in(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: =head2
-#: ../src/guestfs-actions.pod:469
-msgid "guestfs_blockdev_getro"
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:5
+msgid "guestfs-erlang - How to use libguestfs from Erlang"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:471
+#. type: verbatim
+#: ../erlang/examples/guestfs-erlang.pod:9
#, no-wrap
msgid ""
-" int guestfs_blockdev_getro (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" {ok, G} = guestfs:create(),\n"
+" ok = guestfs:add_drive_opts(G, Disk,\n"
+" [{format, \"raw\"}, {readonly, true}]),\n"
+" ok = guestfs:launch(G),\n"
+" [Device] = guestfs:list_devices(G),\n"
+" ok = guestfs:close(G).\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:474 ../fish/guestfish-actions.pod:385
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:18
msgid ""
-"Returns a boolean indicating if the block device is read-only (true if read-"
-"only, false if not)."
+"This manual page documents how to call libguestfs from the Erlang "
+"programming language. This page just documents the differences from the C "
+"API and gives some examples. If you are not familiar with using libguestfs, "
+"you also need to read L<guestfs(3)>."
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: =head2
+#: ../erlang/examples/guestfs-erlang.pod:23
+msgid "OPENING AND CLOSING THE HANDLE"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:481
-msgid "guestfs_blockdev_getsize64"
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:25
+msgid ""
+"The Erlang bindings are implemented using an external program called C<erl-"
+"guestfs>. This program must be on the current PATH, or else you should "
+"specify the full path to the program:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:483
+#. type: verbatim
+#: ../erlang/examples/guestfs-erlang.pod:29
#, no-wrap
msgid ""
-" int64_t guestfs_blockdev_getsize64 (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" {ok, G} = guestfs:create().\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."
+#. type: verbatim
+#: ../erlang/examples/guestfs-erlang.pod:31
+#, no-wrap
+msgid ""
+" {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:488
-msgid "See also C<guestfs_blockdev_getsz>."
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:33
+msgid "C<G> is the libguestfs handle which you should pass to other functions."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:494
-msgid "guestfs_blockdev_getss"
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:36
+msgid "To close the handle:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:496
+#. type: verbatim
+#: ../erlang/examples/guestfs-erlang.pod:38
#, no-wrap
msgid ""
-" int guestfs_blockdev_getss (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" ok = guestfs:close(G).\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."
+#. type: =head2
+#: ../erlang/examples/guestfs-erlang.pod:40
+msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:502
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:42
msgid ""
-"(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
-"that)."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:509
-msgid "guestfs_blockdev_getsz"
+"For functions that take optional arguments, the first arguments are the non-"
+"optional ones. The last argument is a list of tuples supplying the "
+"remaining optional arguments."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:511
+#. type: verbatim
+#: ../erlang/examples/guestfs-erlang.pod:46
#, no-wrap
msgid ""
-" int64_t guestfs_blockdev_getsz (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" ok = guestfs:add_drive_opts(G, Disk,\n"
+" [{format, \"raw\"}, {readonly, true}]).\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:514 ../fish/guestfish-actions.pod:416
-msgid ""
-"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: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>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:525
-msgid "guestfs_blockdev_rereadpt"
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:49
+msgid "If the last argument would be an empty list, you can also omit it:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:527
+#. type: verbatim
+#: ../erlang/examples/guestfs-erlang.pod:51
#, no-wrap
msgid ""
-" int guestfs_blockdev_rereadpt (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" ok = guestfs:add_drive_opts(G, Disk).\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:530 ../fish/guestfish-actions.pod:429
-msgid "Reread the partition table on C<device>."
+#. type: =head2
+#: ../erlang/examples/guestfs-erlang.pod:53
+msgid "RETURN VALUES AND ERRORS"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:536
-msgid "guestfs_blockdev_setbsz"
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:55
+msgid ""
+"On success, most functions return a C<Result> term (which could be a list, "
+"string, tuple etc.). If there is nothing for the function to return, then "
+"the atom C<ok> is returned."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:538
-#, no-wrap
-msgid ""
-" int guestfs_blockdev_setbsz (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint blocksize);\n"
-"\n"
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:59
+msgid "On error, you would see one of the following tuples:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:542 ../fish/guestfish-actions.pod:437
-msgid "This sets the block size of a device."
+#. type: =item
+#: ../erlang/examples/guestfs-erlang.pod:63
+msgid "C<{error, Msg, Errno}>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:551
-msgid "guestfs_blockdev_setro"
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:65
+msgid "This indicates an ordinary error from the function."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:553
-#, no-wrap
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:67
msgid ""
-" int guestfs_blockdev_setro (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+"C<Msg> is the error message (string) and C<Errno> is the Unix error "
+"(integer)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:556 ../fish/guestfish-actions.pod:448
-msgid "Sets the block device named C<device> to read-only."
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:70
+msgid "C<Errno> can be zero. See L<guestfs(3)/guestfs_last_errno>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:562
-msgid "guestfs_blockdev_setrw"
+#. type: =item
+#: ../erlang/examples/guestfs-erlang.pod:72
+msgid "C<{unknown, Function}>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:564
-#, no-wrap
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:74
msgid ""
-" int guestfs_blockdev_setrw (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+"This indicates that the function you called is not known. Generally this "
+"means you are mixing C<erl-guestfs> from another version of libguestfs, "
+"which you should not do."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:456
-msgid "Sets the block device named C<device> to read-write."
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:78
+msgid "C<Function> is the name of the unknown function."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:573
-msgid "guestfs_case_sensitive_path"
+#. type: =item
+#: ../erlang/examples/guestfs-erlang.pod:80
+msgid "C<{unknownarg, Arg}>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:575
-#, no-wrap
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:82
msgid ""
-" char *guestfs_case_sensitive_path (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"This indicates that you called a function with optional arguments, with an "
+"unknown argument name."
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."
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:85
+msgid "C<Arg> is the name of the unknown argument."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:583 ../fish/guestfish-actions.pod:469
-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."
+#. type: =head1
+#: ../erlang/examples/guestfs-erlang.pod:89
+#: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37
+#: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31
+#: ../python/examples/guestfs-python.pod:34
+#: ../ruby/examples/guestfs-ruby.pod:28
+msgid "EXAMPLE 1: CREATE A DISK IMAGE"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:588 ../fish/guestfish-actions.pod:474
-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."
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:91
+#: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39
+#: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33
+#: ../python/examples/guestfs-python.pod:36
+#: ../ruby/examples/guestfs-ruby.pod:30
+msgid "@EXAMPLE1@"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:594 ../fish/guestfish-actions.pod:480
-msgid ""
-"Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
-"#posixfilenames1>"
+#. type: =head1
+#: ../erlang/examples/guestfs-erlang.pod:93
+#: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41
+#: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35
+#: ../python/examples/guestfs-python.pod:38
+#: ../ruby/examples/guestfs-ruby.pod:32
+msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
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: textblock
+#: ../erlang/examples/guestfs-erlang.pod:95
+#: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43
+#: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37
+#: ../python/examples/guestfs-python.pod:40
+#: ../ruby/examples/guestfs-ruby.pod:34
+msgid "@EXAMPLE2@"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:600
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:99
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)."
+"L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
+">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
+"L<guestfs-ruby(3)>, L<http://www.erlang.org/>. L<http://libguestfs.org/>."
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."
+#. type: =head1
+#: ../erlang/examples/guestfs-erlang.pod:110
+#: ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397
+#: ../fish/guestfish.pod:1296 ../fish/virt-copy-in.pod:60
+#: ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58
+#: ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:328
+#: ../inspector/virt-inspector.pod:389 ../java/examples/guestfs-java.pod:58
+#: ../ocaml/examples/guestfs-ocaml.pod:91 ../perl/examples/guestfs-perl.pod:52
+#: ../python/examples/guestfs-python.pod:54
+#: ../ruby/examples/guestfs-ruby.pod:48 ../src/guestfs.pod:3348
+#: ../test-tool/libguestfs-test-tool.pod:106
+msgid "AUTHORS"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:608
-msgid "See also C<guestfs_realpath>."
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:112
+#: ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399
+#: ../fish/guestfish.pod:1298 ../fish/virt-copy-in.pod:62
+#: ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60
+#: ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:330
+#: ../java/examples/guestfs-java.pod:60 ../ocaml/examples/guestfs-ocaml.pod:93
+#: ../perl/examples/guestfs-perl.pod:54
+#: ../python/examples/guestfs-python.pod:56
+#: ../ruby/examples/guestfs-ruby.pod:50 ../src/guestfs.pod:3350
+#: ../test-tool/libguestfs-test-tool.pod:108
+msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:613
-msgid "guestfs_cat"
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:116
+#: ../java/examples/guestfs-java.pod:64 ../perl/examples/guestfs-perl.pod:58
+msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:615
-#, no-wrap
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:118
+#: ../examples/guestfs-examples.pod:53 ../examples/guestfs-recipes.pod:405
+#: ../java/examples/guestfs-java.pod:66 ../ocaml/examples/guestfs-ocaml.pod:99
+#: ../perl/examples/guestfs-perl.pod:60
+#: ../python/examples/guestfs-python.pod:62
+#: ../ruby/examples/guestfs-ruby.pod:56
msgid ""
-" char *guestfs_cat (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"The examples in this manual page may be freely copied, modified and "
+"distributed without any restrictions."
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>."
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:121
+#: ../examples/guestfs-examples.pod:56 ../examples/guestfs-recipes.pod:408
+#: ../java/examples/guestfs-java.pod:69
+#: ../ocaml/examples/guestfs-ocaml.pod:102
+#: ../perl/examples/guestfs-perl.pod:63
+#: ../python/examples/guestfs-python.pod:65
+#: ../ruby/examples/guestfs-ruby.pod:59 ../src/guestfs.pod:3357
+msgid ""
+"This library is free software; you can redistribute it and/or modify it "
+"under the terms of the GNU Lesser General Public License as published by the "
+"Free Software Foundation; either version 2 of the License, or (at your "
+"option) any later version."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:620
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:126
+#: ../examples/guestfs-examples.pod:61 ../examples/guestfs-recipes.pod:413
+#: ../java/examples/guestfs-java.pod:74
+#: ../ocaml/examples/guestfs-ocaml.pod:107
+#: ../perl/examples/guestfs-perl.pod:68
+#: ../python/examples/guestfs-python.pod:70
+#: ../ruby/examples/guestfs-ruby.pod:64 ../src/guestfs.pod:3362
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."
+"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: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
+#. type: textblock
+#: ../erlang/examples/guestfs-erlang.pod:131
+#: ../examples/guestfs-examples.pod:66 ../examples/guestfs-recipes.pod:418
+#: ../java/examples/guestfs-java.pod:79
+#: ../ocaml/examples/guestfs-ocaml.pod:112
+#: ../perl/examples/guestfs-perl.pod:73
+#: ../python/examples/guestfs-python.pod:75
+#: ../ruby/examples/guestfs-ruby.pod:69 ../src/guestfs.pod:3367
msgid ""
-"Because of the message protocol, there is a transfer limit of somewhere "
-"between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
+"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:631
-msgid "guestfs_checksum"
+#. type: textblock
+#: ../examples/guestfs-examples.pod:5
+msgid "guestfs-examples - Examples of using libguestfs from C"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:633
+#. type: verbatim
+#: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
#, no-wrap
msgid ""
-" char *guestfs_checksum (guestfs_h *g,\n"
-"\t\tconst char *csumtype,\n"
-"\t\tconst char *path);\n"
-"\n"
-msgstr ""
+" #include <guestfs.h>\n"
+" \n"
+msgstr "#include <guestfs.h>\n"
-# type: textblock
-#: ../src/guestfs-actions.pod:637 ../fish/guestfish-actions.pod:514
+#. type: verbatim
+#: ../examples/guestfs-examples.pod:11
+#, no-wrap
msgid ""
-"This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
+" guestfs_h *g = guestfs_create ();\n"
+" guestfs_add_drive_ro (g, \"disk.img\");\n"
+" guestfs_launch (g);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:640 ../fish/guestfish-actions.pod:517
+#. type: verbatim
+#: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
+#, no-wrap
msgid ""
-"The type of checksum to compute is given by the C<csumtype> parameter which "
-"must have one of the following values:"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:645 ../fish/guestfish-actions.pod:522
-msgid "C<crc>"
+" cc prog.c -o prog -lguestfs\n"
+"or:\n"
+" cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
+"\n"
msgstr ""
+" cc prog.c -o prog -lguestfs\n"
+"or:\n"
+" cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
+"\n"
-# type: textblock
-#: ../src/guestfs-actions.pod:647 ../fish/guestfish-actions.pod:524
+#. type: textblock
+#: ../examples/guestfs-examples.pod:21
msgid ""
-"Compute the cyclic redundancy check (CRC) specified by POSIX for the "
-"C<cksum> command."
+"This manual page contains examples of calling libguestfs from the C "
+"programming language. If you are not familiar with using libguestfs, you "
+"also need to read L<guestfs(3)>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:650 ../fish/guestfish-actions.pod:527
-msgid "C<md5>"
+#. type: textblock
+#: ../examples/guestfs-examples.pod:35
+msgid ""
+"L<guestfs(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
+">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
+"L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:652 ../fish/guestfish-actions.pod:529
-msgid "Compute the MD5 hash (using the C<md5sum> program)."
+#. type: textblock
+#: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97
+#: ../python/examples/guestfs-python.pod:60
+#: ../ruby/examples/guestfs-ruby.pod:54
+msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:654 ../fish/guestfish-actions.pod:531
-msgid "C<sha1>"
+#. type: =end
+#: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
+msgid "comment"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:656 ../fish/guestfish-actions.pod:533
-msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:5
+msgid ""
+"pod2man and pod2html have differing bugs which makes it hard to write URLs "
+"here. The only way which works for both sorts of output is to just write "
+"the URL directly. Do NOT use L<...> for URLs."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:535
-msgid "C<sha224>"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:9
+msgid ""
+"We break with tradition here and don't use ALL CAPS for the section "
+"headings, as this makes them much easier to read."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:660 ../fish/guestfish-actions.pod:537
-msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:16
+msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:662 ../fish/guestfish-actions.pod:539
-msgid "C<sha256>"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:20
+msgid ""
+"This page contains recipes for and links to things you can do using "
+"libguestfs, L<guestfish(1)> and the virt tools."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:664 ../fish/guestfish-actions.pod:541
-msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:23
+msgid "Audit a virtual machine for setuid files"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:666 ../fish/guestfish-actions.pod:543
-msgid "C<sha384>"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:25
+msgid ""
+"The link below contains a small program which can be used to audit a Linux "
+"virtual machine to see what setuid and setgid files it contains."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:668 ../fish/guestfish-actions.pod:545
-msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:28
+msgid ""
+"https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-"
+"files/#content"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:670 ../fish/guestfish-actions.pod:547
-msgid "C<sha512>"
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:30
+msgid "Change the background image in a Windows XP VM"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:549
-msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:32
+msgid ""
+"The links below explain how to use L<guestfish(1)> to change the background "
+"image for a user of a Windows XP VM. Unfortunately the technique appears to "
+"be substantially different for each version of Windows."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:676 ../fish/guestfish-actions.pod:553
-msgid "The checksum is returned as a printable string."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:37
+msgid ""
+"https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://"
+"lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:678
-msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:40
+msgid "Cloning a virtual machine (Linux)"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:680
-msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:42
+msgid ""
+"The guestfish technique described in the link below works well for most "
+"Linux VMs. Depending on the Linux distro you may need to change the paths "
+"slightly."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:685
-msgid "guestfs_checksum_device"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:46
+msgid ""
+"https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-"
+"vm/#content"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:687
-#, no-wrap
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:48
msgid ""
-" char *guestfs_checksum_device (guestfs_h *g,\n"
-"\t\tconst char *csumtype,\n"
-"\t\tconst char *device);\n"
-"\n"
+"Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
+"discussion."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:691
-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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:51
+msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:698
-msgid "guestfs_checksums_out"
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:53
+msgid "Cloning a virtual machine (Windows)"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:700
-#, no-wrap
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:55
msgid ""
-" int guestfs_checksums_out (guestfs_h *g,\n"
-"\t\tconst char *csumtype,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *sumsfile);\n"
-"\n"
+"It is possible to do a \"sysprep\" using libguestfs alone, although not "
+"straightforward. Currently there is code in the Aeolus Oz project which "
+"does this (using libguestfs). As part of our review of the virt-clone tool, "
+"we may add sysprepping ability."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:705 ../fish/guestfish-actions.pod:571
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:60
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>."
+"https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-"
+"list/2011-May/msg00019.html"
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."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:63
+msgid "Convert a CD-ROM / DVD / ISO to a tarball"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:719
-msgid "guestfs_chmod"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:65
+msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:721
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:67
#, no-wrap
msgid ""
-" int guestfs_chmod (guestfs_h *g,\n"
-"\t\tint mode,\n"
-"\t\tconst char *path);\n"
+" guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:725 ../fish/guestfish-actions.pod:589
-msgid ""
-"Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
-"supported."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:69
+msgid "To export just a subdirectory, eg. C</files>, do:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:728 ../fish/guestfish-actions.pod:592
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:71
+#, no-wrap
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>."
+" guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
+"\n"
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."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:73
+msgid "Create empty disk images"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:736
-msgid "guestfs_chown"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:75
+msgid ""
+"You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
+"The useful guide below explains the options available."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:738
-#, no-wrap
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:78
msgid ""
-" int guestfs_chown (guestfs_h *g,\n"
-"\t\tint owner,\n"
-"\t\tint group,\n"
-"\t\tconst char *path);\n"
-"\n"
+"https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/"
+"#content"
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>."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:80
+msgid "Dump raw filesystem content from inside a disk image or VM"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:2434
-#: ../fish/guestfish-actions.pod:604 ../fish/guestfish-actions.pod:1935
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:82
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)."
+"You can use the L<guestfish(1)> C<download> command to extract the raw "
+"filesystem content from any filesystem in a disk image or a VM (even one "
+"which is encrypted or buried inside an LV):"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:751
-msgid "guestfs_command"
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:86
+#, no-wrap
+msgid ""
+" guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:753
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:88
#, no-wrap
msgid ""
-" char *guestfs_command (guestfs_h *g,\n"
-"\t\tchar *const *arguments);\n"
+" guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:756 ../fish/guestfish-actions.pod:612
-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)."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:90
+msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:761
-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>)."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:92
+msgid "Edit grub configuration in a VM"
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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:94
+msgid "You can use this to:"
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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:100
+msgid "Fix a virtual machine that does not boot."
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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:104
+msgid "Change which kernel is used to boot the VM."
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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:108
+msgid "Change kernel command line options."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:792
-msgid "guestfs_command_lines"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:112
+msgid "Use L<virt-edit(1)> to edit the grub configuration:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:794
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:114
#, no-wrap
msgid ""
-" char **guestfs_command_lines (guestfs_h *g,\n"
-"\t\tchar *const *arguments);\n"
+" virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:797
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:116
msgid ""
-"This is the same as C<guestfs_command>, but splits the result into a list of "
-"lines."
+"or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
+"this:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:800
-msgid "See also: C<guestfs_sh_lines>"
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:119
+#, no-wrap
+msgid ""
+" virt-rescue -d BrokenGuest\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:809
-msgid "guestfs_config"
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:121
+msgid "Export any directory from a VM"
+msgstr ""
+
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:123
+msgid ""
+"To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:811
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:126
#, no-wrap
msgid ""
-" int guestfs_config (guestfs_h *g,\n"
-"\t\tconst char *qemuparam,\n"
-"\t\tconst char *qemuvalue);\n"
+" virt-copy-out -d Guest /home .\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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9
+#: ../fish/guestfish-actions.pod:1450 ../fish/guestfish-actions.pod:1715
+#: ../fish/guestfish-actions.pod:2132 ../src/guestfs-actions.pod:18
+#: ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:2750
+#: ../src/guestfs-actions.pod:3309 ../src/guestfs.pod:1685
+#: ../tools/virt-win-reg.pl:717
+msgid "Notes:"
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)."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:134
+msgid ""
+"The final dot of the command is not a printing error. It means we want to "
+"copy out to the current directory."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:668
-msgid "C<value> can be NULL."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:139
+msgid "This creates a directory called C<home> under the current directory."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:826
-msgid "guestfs_copy_size"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:143
+msgid ""
+"If the guest is a Windows guest then you can use drive letters and "
+"backslashes, but you must prefix the path with C<win:> and quote it to "
+"protect it from the shell, like this:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:828
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:147
#, 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"
+" virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:674
-msgid ""
-"This command copies exactly C<size> bytes from one source device or file "
-"C<src> to another destination device or file C<dest>."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:149
+msgid "To get the output as a compressed tarball, do:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:677
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:151
+#, no-wrap
msgid ""
-"Note this will fail if the source is too short or if the destination is not "
-"large enough."
+" virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
+"\n"
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
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:153
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>."
+"Although it sounds tempting, this is usually not a reliable way to get a "
+"backup from a running guest. See the entry in the FAQ: http://libguestfs."
+"org/FAQ.html#backup"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:846
-msgid "guestfs_cp"
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:157
+msgid "Find out which user is using the most space"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:848
-#, no-wrap
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:159
msgid ""
-" int guestfs_cp (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
-"\n"
+"This simple script examines a Linux guest to find out which user is using "
+"the most space in their home directory:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:852 ../fish/guestfish-actions.pod:684
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:162
+#, no-wrap
msgid ""
-"This copies a file from C<src> to C<dest> where C<dest> is either a "
-"destination filename or destination directory."
+" #!/bin/sh -\n"
+" \n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:857
-msgid "guestfs_cp_a"
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:164 ../fish/guestfish.pod:984
+#, no-wrap
+msgid ""
+" set -e\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:859
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:166
#, no-wrap
msgid ""
-" int guestfs_cp_a (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
-"\n"
+" vm=\"$1\"\n"
+" dir=/home\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:863 ../fish/guestfish-actions.pod:691
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:169
+#, no-wrap
msgid ""
-"This copies a file or directory from C<src> to C<dest> recursively using the "
-"C<cp -a> command."
+" eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
+" \n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:868
-msgid "guestfs_dd"
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:171
+#, no-wrap
+msgid ""
+" for d in $(guestfish --remote ls \"$dir\"); do\n"
+" echo -n \"$dir/$d\"\n"
+" echo -ne '\\t'\n"
+" guestfish --remote du \"$dir/$d\";\n"
+" done | sort -nr -k 2\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:870
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
#, no-wrap
msgid ""
-" int guestfs_dd (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
+" guestfish --remote exit\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:874 ../fish/guestfish-actions.pod:698
-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."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:179
+msgid "Get DHCP address from a VM"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:879
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:181
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>)."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:885
-msgid "guestfs_debug"
+"The link below explains the many different possible techniques for getting "
+"the last assigned DHCP address of a virtual machine."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:887
-#, no-wrap
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:184
msgid ""
-" char *guestfs_debug (guestfs_h *g,\n"
-"\t\tconst char *subcmd,\n"
-"\t\tchar *const *extraargs);\n"
-"\n"
+"https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-"
+"a-virtual-machine-disk-image/#content"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:891
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:186
msgid ""
-"The C<guestfs_debug> command exposes some internals of C<guestfsd> (the "
-"guestfs daemon) that runs inside the qemu subprocess."
+"In the libguestfs source examples directory you will find the latest version "
+"of the C<virt-dhcp-address.c> program."
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."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:189
+msgid "Get the operating system product name string"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:902
-msgid "guestfs_debug_upload"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:191
+msgid "Save the following script into a file called C<product-name.sh>:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:904
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:193
#, 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"
+" #!/bin/sh -\n"
+" set -e\n"
+" eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
+" root=\"$(guestfish --remote inspect-get-roots)\"\n"
+" guestfish --remote inspect-get-product-name \"$root\"\n"
+" guestfish --remote exit\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:909
-msgid ""
-"The C<guestfs_debug_upload> command uploads a file to the libguestfs "
-"appliance."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:200
+msgid "Make the script executable and run it on a named guest:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:726
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:202
+#, no-wrap
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."
+" # product-name.sh RHEL60x64\n"
+" Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:918
-msgid "guestfs_df"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:205
+msgid ""
+"You can also use an XPath query on the L<virt-inspector(1)> XML using the "
+"C<xpath> command line tool or from your favourite programming language:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:920
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:209
#, no-wrap
msgid ""
-" char *guestfs_df (guestfs_h *g);\n"
+" # virt-inspector RHEL60x64 > xml\n"
+" # xpath '//product_name' < xml\n"
+" Found 1 nodes:\n"
+" -- NODE --\n"
+" <product_name>Red Hat Enterprise Linux Server release 6.0 (Santiago)</product_name>\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."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:215
+msgid "Get the default boot kernel for a Linux VM"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:924 ../src/guestfs-actions.pod:938
-#: ../fish/guestfish-actions.pod:738 ../fish/guestfish-actions.pod:749
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:217
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."
+"The link below contains a program to print the default boot kernel for a "
+"Linux VM."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:931
-msgid "guestfs_df_h"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:220
+msgid ""
+"https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-"
+"kernel-for-a-vm/#content"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:933
-#, no-wrap
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:222
msgid ""
-" char *guestfs_df_h (guestfs_h *g);\n"
-"\n"
+"It uses Augeas, and the technique is generally applicable for many different "
+"tasks, such as:"
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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:229
+msgid "listing the user accounts in the guest"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:945
-msgid "guestfs_dmesg"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:233
+msgid "what repositories is it configured to use"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:947
-#, no-wrap
-msgid ""
-" char *guestfs_dmesg (guestfs_h *g);\n"
-"\n"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:237
+msgid "what NTP servers does it connect to"
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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:241
+msgid "what were the boot messages last time it booted"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:953
-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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:245
+msgid "listing who was logged in recently"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:961
-msgid "guestfs_download"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:249
+msgid "http://augeas.net/"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:963
-#, no-wrap
-msgid ""
-" int guestfs_download (guestfs_h *g,\n"
-"\t\tconst char *remotefilename,\n"
-"\t\tconst char *filename);\n"
-"\n"
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:251
+msgid "Install RPMs in a guest"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:967 ../fish/guestfish-actions.pod:770
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:253
msgid ""
-"Download file C<remotefilename> and save it as C<filename> on the local "
-"machine."
+"The link below contains a method to install RPMs in a guest. In fact the "
+"RPMs are just uploaded to the guest along with a \"firstboot\" script that "
+"installs them next time the guest is booted. You could use this technique "
+"to install vital security updates in an offline guest."
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."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:259
+msgid ""
+"https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:972
-msgid "See also C<guestfs_upload>, C<guestfs_cat>."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:261
+msgid "List applications installed in a VM"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:981
-msgid "guestfs_drop_caches"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:263
+msgid "Save the following to a file C<list-apps.sh>:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:983
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:265
#, no-wrap
msgid ""
-" int guestfs_drop_caches (guestfs_h *g,\n"
-"\t\tint whattodrop);\n"
+" #!/bin/sh -\n"
+" set -e\n"
+" eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
+" root=\"$(guestfish --remote inspect-get-roots)\"\n"
+" guestfish --remote inspect-list-applications \"$root\"\n"
+" guestfish --remote exit\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:986 ../fish/guestfish-actions.pod:783
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:272
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>"
+"Make the file executable and then you can run it on any named virtual "
+"machine:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:991 ../fish/guestfish-actions.pod:788
-msgid "Setting C<whattodrop> to 3 should drop everything."
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:275
+#, no-wrap
+msgid ""
+" # list-apps.sh WinGuest\n"
+" [0] = {\n"
+" app_name: Mozilla Firefox (3.6.12)\n"
+" app_display_name: Mozilla Firefox (3.6.12)\n"
+" app_epoch: 0\n"
+" app_version: 3.6.12 (en-GB)\n"
+" app_release:\n"
+" app_install_path: C:\\Program Files\\Mozilla Firefox\n"
+" app_trans_path:\n"
+" app_publisher: Mozilla\n"
+" app_url: http://www.mozilla.com/en-GB/\n"
+" app_source_package:\n"
+" app_summary:\n"
+" app_description: Mozilla Firefox\n"
+" }\n"
+" [1] = {\n"
+" app_name: VLC media player\n"
+" app_display_name: VLC media player 1.1.5\n"
+" app_epoch: 0\n"
+" app_version: 1.1.5\n"
+" app_release:\n"
+" app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
+" app_trans_path:\n"
+" app_publisher: VideoLAN\n"
+" app_url: http://www.videolan.org/\n"
+" app_source_package:\n"
+" app_summary:\n"
+" app_description:\n"
+" }\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:790
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:305
msgid ""
-"This automatically calls L<sync(2)> before the operation, so that the "
-"maximum guest memory is freed."
+"If you want to run the script on disk images (instead of libvirt virtual "
+"machines), change C<-d \"$1\"> to C<-a \"$1\">. See also L<virt-inspector(1)"
+">."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:998
-msgid "guestfs_du"
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:309
+msgid "List files and directories in a VM"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1000
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:311
+msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
+msgstr ""
+
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:313
#, no-wrap
msgid ""
-" int64_t guestfs_du (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1003 ../fish/guestfish-actions.pod:797
-msgid ""
-"This command runs the C<du -s> command to estimate file space usage for "
-"C<path>."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:315
+msgid "List services in a Windows VM"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1006 ../fish/guestfish-actions.pod:800
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:317
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)."
+"The link below contains a script that can be used to list out the services "
+"from a Windows VM, and whether those services run at boot time or are loaded "
+"on demand."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1010 ../fish/guestfish-actions.pod:804
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:321
msgid ""
-"The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
+"https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/"
+"#content"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1015
-msgid "guestfs_e2fsck_f"
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:323
+msgid "Make a disk image sparse"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1017
-#, no-wrap
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:325
msgid ""
-" int guestfs_e2fsck_f (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+"The link below contains some guides for making a disk image sparse (or "
+"reintroducing sparseness)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1020 ../fish/guestfish-actions.pod:811
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:328
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>)."
+"https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
+msgstr ""
+
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:330
+msgid "Monitor disk usage over time"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1024
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:332
msgid ""
-"This command is only needed because of C<guestfs_resize2fs> (q.v.). "
-"Normally you should use C<guestfs_fsck>."
+"You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
+"The link below contains a guide."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1029
-msgid "guestfs_echo_daemon"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:335
+msgid "http://virt-tools.org/learning/advanced-virt-df/"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1031
-#, no-wrap
-msgid ""
-" char *guestfs_echo_daemon (guestfs_h *g,\n"
-"\t\tchar *const *words);\n"
-"\n"
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:337
+msgid "Reading the Windows Event Log from Windows Vista (or later)"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1034 ../fish/guestfish-actions.pod:822
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:339
msgid ""
-"This command concatenates the list of C<words> passed with single spaces "
-"between them and returns the resulting string."
+"L<guestfish(1)> plus the tools described in the link below can be used to "
+"read out the Windows Event Log from any virtual machine running Windows "
+"Vista or a later version."
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: textblock
+#: ../examples/guestfs-recipes.pod:343
+msgid ""
+"https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-"
+"guestfish/#content"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1039
-msgid "See also C<guestfs_ping_daemon>."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:345
+msgid "Remove root password (Linux)"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1044
-msgid "guestfs_egrep"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:347
+msgid ""
+"Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
+"files. One use is to remove the root password from a Linux guest:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1046
+#. type: verbatim
+#: ../examples/guestfs-recipes.pod:350
#, no-wrap
msgid ""
-" char **guestfs_egrep (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1050 ../fish/guestfish-actions.pod:833
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:352
+msgid "Remove Administrator password (Windows)"
+msgstr ""
+
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:354
msgid ""
-"This calls the external C<egrep> program and returns the matching lines."
+"The link below contains one technique for removing the Administrator "
+"password from a Windows VM, or to be more precise, it gives you a command "
+"prompt the next time you log in which you can use to bypass any security:"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1060
-msgid "guestfs_egrepi"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:359
+msgid ""
+"https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-"
+"administrator-password-with-guestfish/"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1062
-#, no-wrap
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:361
+msgid "Unpack a live CD"
+msgstr ""
+
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:363
msgid ""
-" char **guestfs_egrepi (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
-"\n"
+"Linux live CDs often contain multiple layers of disk images wrapped like a "
+"Russian doll. You can use L<guestfish(1)> to look inside these multiple "
+"layers, as outlined in the guide below."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1066 ../fish/guestfish-actions.pod:843
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:367
msgid ""
-"This calls the external C<egrep -i> program and returns the matching lines."
+"https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-"
+"cd/#content"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1076
-msgid "guestfs_equal"
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:369
+msgid "Uploading and downloading files"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1078
-#, no-wrap
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:371
msgid ""
-" int guestfs_equal (guestfs_h *g,\n"
-"\t\tconst char *file1,\n"
-"\t\tconst char *file2);\n"
-"\n"
+"The link below contains general tips on uploading (copying in) and "
+"downloading (copying out) files from VMs."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1082 ../fish/guestfish-actions.pod:853
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:374
msgid ""
-"This compares the two files C<file1> and C<file2> and returns true if their "
-"content is exactly equal, or false otherwise."
+"https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
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."
+#. type: =head1
+#: ../examples/guestfs-recipes.pod:376
+msgid "Use libguestfs tools on VMware ESX guests"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1089
-msgid "guestfs_exists"
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:378
+msgid ""
+"The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
+"tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1091
-#, no-wrap
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:382
msgid ""
-" int guestfs_exists (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-"
+"guests/#content"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1094 ../fish/guestfish-actions.pod:862
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:386
msgid ""
-"This returns C<true> if and only if there is a file, directory (or anything) "
-"with the given C<path> name."
+"L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)"
+">, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-"
+"python(3)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1097
-msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
+#. type: textblock
+#: ../examples/guestfs-recipes.pod:403
+msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1101
-msgid "guestfs_fallocate"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1
+msgid "add-cdrom"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1103
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3
#, no-wrap
msgid ""
-" int guestfs_fallocate (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint len);\n"
+" add-cdrom filename\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1107 ../src/guestfs-actions.pod:1130
-#: ../fish/guestfish-actions.pod:871 ../fish/guestfish-actions.pod:890
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
+msgid "This function adds a virtual CD-ROM disk image to the guest."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
+msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:15
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."
+"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
-#: ../src/guestfs-actions.pod:1111 ../fish/guestfish-actions.pod:875
+#. type: textblock
+#: ../fish/guestfish-actions.pod:22
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."
+"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: textblock
-#: ../src/guestfs-actions.pod:1117 ../fish/guestfish-actions.pod:879
+#. type: textblock
+#: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:214
+#: ../fish/guestfish-actions.pod:228
msgid ""
-"This function is deprecated. In new code, use the C<fallocate64> call "
+"I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
"instead."
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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:217
+#: ../fish/guestfish-actions.pod:231 ../fish/guestfish-actions.pod:941
+#: ../fish/guestfish-actions.pod:976 ../fish/guestfish-actions.pod:1149
+#: ../fish/guestfish-actions.pod:1509 ../fish/guestfish-actions.pod:1523
+#: ../fish/guestfish-actions.pod:3293 ../fish/guestfish-actions.pod:3604
+#: ../fish/guestfish-actions.pod:3652 ../fish/guestfish-actions.pod:4579
+#: ../fish/guestfish-actions.pod:4602 ../fish/guestfish-actions.pod:4624
+#: ../fish/guestfish-actions.pod:4662 ../fish/guestfish-actions.pod:5311
+#: ../fish/guestfish-actions.pod:5417 ../src/guestfs-actions.pod:10
+#: ../src/guestfs-actions.pod:305 ../src/guestfs-actions.pod:326
+#: ../src/guestfs-actions.pod:1572 ../src/guestfs-actions.pod:1629
+#: ../src/guestfs-actions.pod:1912 ../src/guestfs-actions.pod:2411
+#: ../src/guestfs-actions.pod:2432 ../src/guestfs-actions.pod:5077
+#: ../src/guestfs-actions.pod:5599 ../src/guestfs-actions.pod:5699
+#: ../src/guestfs-actions.pod:6999 ../src/guestfs-actions.pod:7043
+#: ../src/guestfs-actions.pod:7077 ../src/guestfs-actions.pod:7140
+#: ../src/guestfs-actions.pod:8072 ../src/guestfs-actions.pod:8181
+#: ../src/guestfs-actions.pod:8364
msgid ""
"Deprecated functions will not be removed from the API, but the fact that "
"they are deprecated indicates that there are problems with correct use of "
"these functions."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1124
-msgid "guestfs_fallocate64"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:35
+msgid "add-domain"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:37
+msgid "domain"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1126
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:39
#, no-wrap
msgid ""
-" int guestfs_fallocate64 (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint64_t len);\n"
+" add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..] [readonlydisk:..]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1134
+#. type: textblock
+#: ../fish/guestfish-actions.pod:41
msgid ""
-"Note that this call allocates disk blocks for the file. To create a sparse "
-"file use C<guestfs_truncate_size> 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
-#: ../src/guestfs-actions.pod:1137
+#. type: textblock
+#: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:65
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."
+"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:1142 ../fish/guestfish-actions.pod:902
+#. type: textblock
+#: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:68
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."
+"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: =head2
-#: ../src/guestfs-actions.pod:1148
-msgid "guestfs_fgrep"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:1150
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:72
msgid ""
-" char **guestfs_fgrep (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tconst char *path);\n"
-"\n"
+"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:1154 ../fish/guestfish-actions.pod:910
+#. type: textblock
+#: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:77
msgid ""
-"This calls the external C<fgrep> program and returns the matching lines."
+"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)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1164
-msgid "guestfs_fgrepi"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:83
+msgid ""
+"The optional C<live> flag controls whether this call will try to connect to "
+"a running virtual machine C<guestfsd> process if it sees a suitable "
+"E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
+"the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
+"DAEMONS> for more information."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1166
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:90
msgid ""
-" char **guestfs_fgrepi (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tconst char *path);\n"
-"\n"
+"If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
+"passed instead of the domain name. The C<dom> string is treated as a UUID "
+"first and looked up, and if that lookup fails then we treat C<dom> as a name "
+"as usual."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:920
+#. type: textblock
+#: ../fish/guestfish-actions.pod:76 ../src/guestfs-actions.pod:95
msgid ""
-"This calls the external C<fgrep -i> program and returns the matching lines."
+"The optional C<readonlydisk> parameter controls what we do for disks which "
+"are marked E<lt>readonly/E<gt> in the libvirt XML. Possible values are:"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1180
-msgid "guestfs_file"
+#. type: =item
+#: ../fish/guestfish-actions.pod:82 ../src/guestfs-actions.pod:101
+msgid "readonlydisk = \"error\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1182
-#, no-wrap
-msgid ""
-" char *guestfs_file (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:84 ../fish/guestfish-actions.pod:95
+#: ../fish/guestfish-actions.pod:106 ../src/guestfs-actions.pod:103
+#: ../src/guestfs-actions.pod:114 ../src/guestfs-actions.pod:125
+msgid "If C<readonly> is false:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1185 ../fish/guestfish-actions.pod:930
+#. type: textblock
+#: ../fish/guestfish-actions.pod:86 ../src/guestfs-actions.pod:105
msgid ""
-"This call uses the standard L<file(1)> command to determine the type or "
-"contents of the file."
+"The whole call is aborted with an error if any disk with the E<lt>readonly/"
+"E<gt> flag is found."
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: textblock
+#: ../fish/guestfish-actions.pod:89 ../fish/guestfish-actions.pod:100
+#: ../fish/guestfish-actions.pod:110 ../src/guestfs-actions.pod:108
+#: ../src/guestfs-actions.pod:119 ../src/guestfs-actions.pod:129
+msgid "If C<readonly> is true:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1191 ../fish/guestfish-actions.pod:936
-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)."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:91 ../fish/guestfish-actions.pod:102
+#: ../fish/guestfish-actions.pod:112 ../src/guestfs-actions.pod:110
+#: ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:131
+msgid "Disks with the E<lt>readonly/E<gt> flag are added read-only."
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
+#: ../fish/guestfish-actions.pod:93 ../src/guestfs-actions.pod:112
+msgid "readonlydisk = \"read\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:945
+#. type: textblock
+#: ../fish/guestfish-actions.pod:97 ../src/guestfs-actions.pod:116
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."
+"Disks with the E<lt>readonly/E<gt> flag are added read-only. Other disks "
+"are added read/write."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1208
-msgid "guestfs_file_architecture"
+#. type: =item
+#: ../fish/guestfish-actions.pod:104 ../src/guestfs-actions.pod:123
+msgid "readonlydisk = \"write\" (default)"
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"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:108 ../src/guestfs-actions.pod:127
+msgid "Disks with the E<lt>readonly/E<gt> flag are added read/write."
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
+#: ../fish/guestfish-actions.pod:114 ../src/guestfs-actions.pod:133
+msgid "readonlydisk = \"ignore\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1216 ../fish/guestfish-actions.pod:957
-msgid "Currently defined architectures are:"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:116 ../src/guestfs-actions.pod:135
+msgid "If C<readonly> is true or false:"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:1220 ../fish/guestfish-actions.pod:961
-msgid "\"i386\""
+#. type: textblock
+#: ../fish/guestfish-actions.pod:118 ../src/guestfs-actions.pod:137
+msgid "Disks with the E<lt>readonly/E<gt> flag are skipped."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1222 ../fish/guestfish-actions.pod:963
+#. type: textblock
+#: ../fish/guestfish-actions.pod:122
msgid ""
-"This string is returned for all 32 bit i386, i486, i586, i686 binaries "
-"irrespective of the precise processor requirements of the binary."
+"The other optional parameters are passed directly through to L</add-drive-"
+"opts>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:1225 ../fish/guestfish-actions.pod:966
-msgid "\"x86_64\""
+#. type: textblock
+#: ../fish/guestfish-actions.pod:125 ../fish/guestfish-actions.pod:194
+#: ../fish/guestfish-actions.pod:624 ../fish/guestfish-actions.pod:835
+#: ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:894
+#: ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:912
+#: ../fish/guestfish-actions.pod:926 ../fish/guestfish-actions.pod:2171
+#: ../fish/guestfish-actions.pod:3342 ../fish/guestfish-actions.pod:3505
+#: ../fish/guestfish-actions.pod:3640
+msgid ""
+"This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1227 ../fish/guestfish-actions.pod:968
-msgid "64 bit x86-64."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:127
+msgid "add-drive"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:1229 ../fish/guestfish-actions.pod:970
-msgid "\"sparc\""
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:129
+#, no-wrap
+msgid ""
+" add-drive filename\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1231 ../fish/guestfish-actions.pod:972
-msgid "32 bit SPARC."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:131
+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: =item
-#: ../src/guestfs-actions.pod:1233 ../fish/guestfish-actions.pod:974
-msgid "\"sparc64\""
+#. type: textblock
+#: ../fish/guestfish-actions.pod:135
+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 L</add-"
+"drive-opts>, and specifying the format."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1235 ../fish/guestfish-actions.pod:976
-msgid "64 bit SPARC V9 and above."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:142
+msgid "add-drive-opts"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:1237 ../fish/guestfish-actions.pod:978
-msgid "\"ia64\""
+#. type: =head2
+#: ../fish/guestfish-actions.pod:144
+msgid "add"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1239 ../fish/guestfish-actions.pod:980
-msgid "Intel Itanium."
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:146
+#, no-wrap
+msgid ""
+" add-drive-opts filename [readonly:..] [format:..] [iface:..] [name:..]\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:1241 ../fish/guestfish-actions.pod:982
-msgid "\"ppc\""
+#. type: textblock
+#: ../fish/guestfish-actions.pod:148 ../src/guestfs-actions.pod:208
+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: textblock
-#: ../src/guestfs-actions.pod:1243 ../fish/guestfish-actions.pod:984
-msgid "32 bit Power PC."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:153 ../src/guestfs-actions.pod:213
+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: =item
-#: ../src/guestfs-actions.pod:1245 ../fish/guestfish-actions.pod:986
-msgid "\"ppc64\""
+#. type: textblock
+#: ../fish/guestfish-actions.pod:159 ../src/guestfs-actions.pod:219
+msgid "This call checks that C<filename> exists."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1247 ../fish/guestfish-actions.pod:988
-msgid "64 bit Power PC."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:161 ../fish/guestfish-actions.pod:3304
+#: ../src/guestfs-actions.pod:221 ../src/guestfs-actions.pod:5114
+msgid "The optional arguments are:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1251 ../fish/guestfish-actions.pod:992
-msgid "Libguestfs may return other architecture strings in future."
+#. type: =item
+#: ../fish/guestfish-actions.pod:165 ../src/guestfs-actions.pod:225
+msgid "C<readonly>"
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:"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:167 ../src/guestfs-actions.pod:227
+msgid ""
+"If true then the image is treated as read-only. Writes are still allowed, "
+"but they are stored in a temporary snapshot overlay which is discarded at "
+"the end. The disk that you add is not modified."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1259 ../fish/guestfish-actions.pod:1000
-msgid "many types of Un*x and Linux binary"
+#. type: =item
+#: ../fish/guestfish-actions.pod:171 ../src/guestfs-actions.pod:231
+msgid "C<format>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1263 ../fish/guestfish-actions.pod:1004
-msgid "many types of Un*x and Linux shared library"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:173
+msgid ""
+"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
-#: ../src/guestfs-actions.pod:1267 ../fish/guestfish-actions.pod:1008
-msgid "Windows Win32 and Win64 binaries"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:177 ../src/guestfs-actions.pod:237
+msgid ""
+"Automatic detection of the format opens you up to a potential security hole "
+"when dealing with untrusted raw-format images. See CVE-2010-3851 and "
+"RHBZ#642934. Specifying the format closes this security hole."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1271 ../fish/guestfish-actions.pod:1012
-msgid "Windows Win32 and Win64 DLLs"
+#. type: =item
+#: ../fish/guestfish-actions.pod:182 ../src/guestfs-actions.pod:242
+msgid "C<iface>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1273 ../fish/guestfish-actions.pod:1014
-msgid "Win32 binaries and DLLs return C<i386>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:184
+msgid ""
+"This rarely-used option lets you emulate the behaviour of the deprecated L</"
+"add-drive-with-if> call (q.v.)"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1275 ../fish/guestfish-actions.pod:1016
-msgid "Win64 binaries and DLLs return C<x86_64>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:187 ../src/guestfs-actions.pod:247
+msgid "C<name>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:1020
-msgid "Linux kernel modules"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:189 ../src/guestfs-actions.pod:249
+msgid ""
+"The name the drive had in the original guest, e.g. /dev/sdb. This is used as "
+"a hint to the guest inspection process if it is available."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1283 ../fish/guestfish-actions.pod:1024
-msgid "Linux new-style initrd images"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:196
+msgid "add-drive-ro"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1287 ../fish/guestfish-actions.pod:1028
-msgid "some non-x86 Linux vmlinuz kernels"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:198
+msgid "add-ro"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:1032
-msgid "What it can't do currently:"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:200
+#, no-wrap
+msgid ""
+" add-drive-ro filename\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:1038
-msgid "static libraries (libfoo.a)"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:202
+msgid ""
+"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
-#: ../src/guestfs-actions.pod:1301 ../fish/guestfish-actions.pod:1042
-msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:207
+msgid "add-drive-ro-with-if"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:1046
-msgid "x86 Linux vmlinuz kernels"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:209
+#, no-wrap
+msgid ""
+" add-drive-ro-with-if filename iface\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1307 ../fish/guestfish-actions.pod:1048
+#. type: textblock
+#: ../fish/guestfish-actions.pod:211
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."
+"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
-#: ../src/guestfs-actions.pod:1317
-msgid "guestfs_filesize"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:221
+msgid "add-drive-with-if"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1319
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:223
#, no-wrap
msgid ""
-" int64_t guestfs_filesize (guestfs_h *g,\n"
-"\t\tconst char *file);\n"
+" add-drive-with-if filename iface\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."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1324
+#. type: textblock
+#: ../fish/guestfish-actions.pod:225
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>."
+"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: =head2
-#: ../src/guestfs-actions.pod:1330
-msgid "guestfs_fill"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:235
+msgid "aug-clear"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1332
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:237
#, no-wrap
msgid ""
-" int guestfs_fill (guestfs_h *g,\n"
-"\t\tint c,\n"
-"\t\tint len,\n"
-"\t\tconst char *path);\n"
+" aug-clear augpath\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:1069
-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]>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1341
+#. type: textblock
+#: ../fish/guestfish-actions.pod:239 ../src/guestfs-actions.pod:343
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>."
+"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:1353
-msgid "guestfs_fill_pattern"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:242
+msgid "aug-close"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1355
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:244
#, no-wrap
msgid ""
-" int guestfs_fill_pattern (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tint len,\n"
-"\t\tconst char *path);\n"
+" aug-close\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1360
+#. type: textblock
+#: ../fish/guestfish-actions.pod:246
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."
+"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
-#: ../src/guestfs-actions.pod:1372
-msgid "guestfs_find"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:251
+msgid "aug-defnode"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1374
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:253
#, no-wrap
msgid ""
-" char **guestfs_find (guestfs_h *g,\n"
-"\t\tconst char *directory);\n"
+" aug-defnode name expr val\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:1091
+#. type: textblock
+#: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:372
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."
+"Defines a variable C<name> whose value is the result of evaluating C<expr>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1382 ../fish/guestfish-actions.pod:1096
+#. type: textblock
+#: ../fish/guestfish-actions.pod:258
msgid ""
-"This returns a list of strings I<without any prefix>. Thus if the directory "
-"structure was:"
+"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: verbatim
-#: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:1099
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:379
msgid ""
-" /tmp/a\n"
-" /tmp/b\n"
-" /tmp/c/d\n"
-"\n"
+"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:1389
-msgid ""
-"then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:266
+msgid "aug-defvar"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1392 ../fish/guestfish-actions.pod:1106
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:268
#, no-wrap
msgid ""
-" a\n"
-" b\n"
-" c\n"
-" c/d\n"
+" aug-defvar name expr\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."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1400 ../fish/guestfish-actions.pod:1114
-msgid "The returned list is sorted."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:270 ../src/guestfs-actions.pod:396
+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:1402
-msgid "See also C<guestfs_find0>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:274 ../src/guestfs-actions.pod:400
+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:1411
-msgid "guestfs_find0"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:277
+msgid "aug-get"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1413
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:279
#, no-wrap
msgid ""
-" int guestfs_find0 (guestfs_h *g,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *files);\n"
+" aug-get augpath\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1417 ../fish/guestfish-actions.pod:1125
+#. type: textblock
+#: ../fish/guestfish-actions.pod:281 ../src/guestfs-actions.pod:413
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>."
+"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:1421
+#. type: =head2
+#: ../fish/guestfish-actions.pod:284
+msgid "aug-init"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:286
+#, no-wrap
msgid ""
-"This command works the same way as C<guestfs_find> with the following "
-"exceptions:"
+" aug-init root flags\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:1136
-msgid "The resulting list is written to an external file."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:288 ../src/guestfs-actions.pod:428
+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
+#: ../fish/guestfish-actions.pod:292
+msgid "You must call this before using any other L</aug-*> commands."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:1140
+#. type: textblock
+#: ../fish/guestfish-actions.pod:295 ../src/guestfs-actions.pod:435
msgid ""
-"Items (filenames) in the result are separated by C<\\0> characters. See "
-"L<find(1)> option I<-print0>."
+"C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:298 ../src/guestfs-actions.pod:438
+msgid ""
+"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: textblock
-#: ../src/guestfs-actions.pod:1442 ../fish/guestfish-actions.pod:1150
-msgid "The result list is not sorted."
+#. type: =item
+#: ../fish/guestfish-actions.pod:304 ../src/guestfs-actions.pod:444
+msgid "C<AUG_SAVE_BACKUP> = 1"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1448
-msgid "guestfs_findfs_label"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:306 ../src/guestfs-actions.pod:446
+msgid "Keep the original file with a C<.augsave> extension."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1450
-#, no-wrap
-msgid ""
-" char *guestfs_findfs_label (guestfs_h *g,\n"
-"\t\tconst char *label);\n"
-"\n"
+#. type: =item
+#: ../fish/guestfish-actions.pod:308 ../src/guestfs-actions.pod:448
+msgid "C<AUG_SAVE_NEWFILE> = 2"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1453 ../fish/guestfish-actions.pod:1160
+#. type: textblock
+#: ../fish/guestfish-actions.pod:310 ../src/guestfs-actions.pod:450
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."
+"Save changes into a file with extension C<.augnew>, and do not overwrite "
+"original. Overrides C<AUG_SAVE_BACKUP>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1457
-msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:313 ../src/guestfs-actions.pod:453
+msgid "C<AUG_TYPE_CHECK> = 4"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1462
-msgid "guestfs_findfs_uuid"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:315 ../src/guestfs-actions.pod:455
+msgid "Typecheck lenses."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1464
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:317
msgid ""
-" char *guestfs_findfs_uuid (guestfs_h *g,\n"
-"\t\tconst char *uuid);\n"
-"\n"
+"This option is only useful when debugging Augeas lenses. Use of this option "
+"may require additional memory for the libguestfs appliance. You may need to "
+"set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1467 ../fish/guestfish-actions.pod:1170
-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."
+#. type: =item
+#: ../fish/guestfish-actions.pod:322 ../src/guestfs-actions.pod:462
+msgid "C<AUG_NO_STDINC> = 8"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1471
-msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:324 ../src/guestfs-actions.pod:464
+msgid "Do not use standard load path for modules."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1476
-msgid "guestfs_fsck"
+#. type: =item
+#: ../fish/guestfish-actions.pod:326 ../src/guestfs-actions.pod:466
+msgid "C<AUG_SAVE_NOOP> = 16"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:328 ../src/guestfs-actions.pod:468
+msgid "Make save a no-op, just record what would have been changed."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:330 ../src/guestfs-actions.pod:470
+msgid "C<AUG_NO_LOAD> = 32"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:332
+msgid "Do not load the tree in L</aug-init>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:336
+msgid "To close the handle, you can call L</aug-close>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:478
+msgid "To find out more about Augeas, see L<http://augeas.net/>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:340
+msgid "aug-insert"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1478
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:342
#, no-wrap
msgid ""
-" int guestfs_fsck (guestfs_h *g,\n"
-"\t\tconst char *fstype,\n"
-"\t\tconst char *device);\n"
+" aug-insert augpath label true|false\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1482 ../fish/guestfish-actions.pod:1180
+#. type: textblock
+#: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:492
msgid ""
-"This runs the filesystem checker (fsck) on C<device> which should have "
-"filesystem type C<fstype>."
+"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:1485 ../fish/guestfish-actions.pod:1183
+#. type: textblock
+#: ../fish/guestfish-actions.pod:348 ../src/guestfs-actions.pod:496
msgid ""
-"The returned integer is the status. See L<fsck(8)> for the list of status "
-"codes from C<fsck>."
+"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: textblock
-#: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:1192
-msgid "Multiple status codes can be summed together."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:352
+msgid "aug-load"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1498 ../fish/guestfish-actions.pod:1196
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:354
+#, no-wrap
msgid ""
-"A non-zero return code can mean \"success\", for example if errors have been "
-"corrected on the filesystem."
+" aug-load\n"
+"\n"
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)."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:356 ../src/guestfs-actions.pod:509
+msgid "Load files into the tree."
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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:358 ../src/guestfs-actions.pod:511
+msgid "See C<aug_load> in the Augeas documentation for the full gory details."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1512
-msgid "guestfs_get_append"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:361
+msgid "aug-ls"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1514
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:363
#, no-wrap
msgid ""
-" const char *guestfs_get_append (guestfs_h *g);\n"
+" aug-ls augpath\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1516 ../fish/guestfish-actions.pod:1212
+#. type: textblock
+#: ../fish/guestfish-actions.pod:365
msgid ""
-"Return the additional kernel options which are added to the guest kernel "
-"command line."
+"This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
+"resulting nodes into alphabetical order."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1519 ../fish/guestfish-actions.pod:1215
-msgid "If C<NULL> then no options are added."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:368
+msgid "aug-match"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1521
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:370
+#, no-wrap
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."
+" aug-match augpath\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1525
-msgid "guestfs_get_autosync"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:372 ../src/guestfs-actions.pod:539
+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."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:376
+msgid "aug-mv"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1527
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:378
#, no-wrap
msgid ""
-" int guestfs_get_autosync (guestfs_h *g);\n"
+" aug-mv src dest\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1529 ../fish/guestfish-actions.pod:1221
-msgid "Get the autosync flag."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:556
+msgid ""
+"Move the node C<src> to C<dest>. C<src> must match exactly one node. "
+"C<dest> is overwritten if it exists."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1533
-msgid "guestfs_get_direct"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:383
+msgid "aug-rm"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1535
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:385
#, no-wrap
msgid ""
-" int guestfs_get_direct (guestfs_h *g);\n"
+" aug-rm augpath\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1227
-msgid "Return the direct appliance mode flag."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:387 ../src/guestfs-actions.pod:569
+msgid "Remove C<path> and all of its children."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1541
-msgid "guestfs_get_e2label"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:389 ../src/guestfs-actions.pod:571
+msgid "On success this returns the number of entries which were removed."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:391
+msgid "aug-save"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1543
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:393
#, no-wrap
msgid ""
-" char *guestfs_get_e2label (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" aug-save\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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:395 ../src/guestfs-actions.pod:582
+msgid "This writes all pending changes to disk."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1236
+#. type: textblock
+#: ../fish/guestfish-actions.pod:397
msgid ""
-"This function is deprecated. In new code, use the C<vfs_label> call instead."
+"The flags which were passed to L</aug-init> affect exactly how files are "
+"saved."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1559
-msgid "guestfs_get_e2uuid"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:400
+msgid "aug-set"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1561
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:402
#, no-wrap
msgid ""
-" char *guestfs_get_e2uuid (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" aug-set augpath val\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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:404 ../src/guestfs-actions.pod:598
+msgid "Set the value associated with C<path> to C<val>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1570 ../fish/guestfish-actions.pod:1250
+#. type: textblock
+#: ../fish/guestfish-actions.pod:406
msgid ""
-"This function is deprecated. In new code, use the C<vfs_uuid> call instead."
+"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
-#: ../src/guestfs-actions.pod:1577
-msgid "guestfs_get_memsize"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:411
+msgid "available"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1579
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:413
#, no-wrap
msgid ""
-" int guestfs_get_memsize (guestfs_h *g);\n"
+" available 'groups ...'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1261
+#. type: textblock
+#: ../fish/guestfish-actions.pod:415 ../src/guestfs-actions.pod:615
msgid ""
-"This gets the memory size in megabytes allocated to the qemu subprocess."
+"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:1584
+#. type: textblock
+#: ../fish/guestfish-actions.pod:419
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."
+"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
-#: ../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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:424 ../src/guestfs-actions.pod:624
msgid ""
-"For more information on the architecture of libguestfs, see L<guestfs(3)>."
+"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:1593
-msgid "guestfs_get_network"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:429 ../src/guestfs-actions.pod:629
+msgid "The command returns no error if I<all> requested groups are available."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1595
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:431 ../src/guestfs-actions.pod:631
msgid ""
-" int guestfs_get_network (guestfs_h *g);\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:1597 ../fish/guestfish-actions.pod:1275
-msgid "This returns the enable network flag."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:434 ../src/guestfs-actions.pod:634
+msgid ""
+"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:1601
-msgid "guestfs_get_path"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:637
+msgid "I<Notes:>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1603
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:443
+msgid "You must call L</launch> before calling this function."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:445 ../src/guestfs-actions.pod:645
msgid ""
-" const char *guestfs_get_path (guestfs_h *g);\n"
-"\n"
+"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: textblock
-#: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1281
-msgid "Return the current search path."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:451 ../src/guestfs-actions.pod:651
+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: textblock
-#: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1283
+#. type: textblock
+#: ../fish/guestfish-actions.pod:458 ../src/guestfs-actions.pod:658
msgid ""
-"This is always non-NULL. If it wasn't set already, then this will return "
-"the default path."
+"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:1610 ../src/guestfs-actions.pod:1633
+#. type: textblock
+#: ../fish/guestfish-actions.pod:465
msgid ""
-"This function returns a string, or NULL on error. The string is owned by "
-"the guest handle and must I<not> be freed."
+"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
-#: ../src/guestfs-actions.pod:1613
-msgid "guestfs_get_pid"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:472
+msgid "available-all-groups"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1615
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:474
#, no-wrap
msgid ""
-" int guestfs_get_pid (guestfs_h *g);\n"
+" available-all-groups\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1290
+#. type: textblock
+#: ../fish/guestfish-actions.pod:476
msgid ""
-"Return the process ID of the qemu subprocess. If there is no qemu "
-"subprocess, then this will return an error."
+"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
-#: ../src/guestfs-actions.pod:1620 ../fish/guestfish-actions.pod:1293
-msgid "This is an internal call used for debugging and testing."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:482
+msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1624
-msgid "guestfs_get_qemu"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:484
+msgid "base64-in"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1626
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:486
#, no-wrap
msgid ""
-" const char *guestfs_get_qemu (guestfs_h *g);\n"
+" base64-in (base64file|-) filename\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1628 ../fish/guestfish-actions.pod:1299
-msgid "Return the current qemu binary."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:488 ../src/guestfs-actions.pod:702
+msgid ""
+"This command uploads base64-encoded data from C<base64file> to C<filename>."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:491 ../fish/guestfish-actions.pod:500
+#: ../fish/guestfish-actions.pod:749 ../fish/guestfish-actions.pod:833
+#: ../fish/guestfish-actions.pod:854 ../fish/guestfish-actions.pod:1025
+#: ../fish/guestfish-actions.pod:1044 ../fish/guestfish-actions.pod:1418
+#: ../fish/guestfish-actions.pod:4882 ../fish/guestfish-actions.pod:4894
+#: ../fish/guestfish-actions.pod:4905 ../fish/guestfish-actions.pod:4916
+#: ../fish/guestfish-actions.pod:4968 ../fish/guestfish-actions.pod:4977
+#: ../fish/guestfish-actions.pod:5031 ../fish/guestfish-actions.pod:5054
+msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1636
-msgid "guestfs_get_recovery_proc"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:493
+msgid "base64-out"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1638
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:495
#, no-wrap
msgid ""
-" int guestfs_get_recovery_proc (guestfs_h *g);\n"
+" base64-out filename (base64file|-)\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1308
-msgid "Return the recovery process enabled flag."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:497 ../src/guestfs-actions.pod:716
+msgid ""
+"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:1644
-msgid "guestfs_get_selinux"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:502
+msgid "blockdev-flushbufs"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1646
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:504
#, no-wrap
msgid ""
-" int guestfs_get_selinux (guestfs_h *g);\n"
+" blockdev-flushbufs device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1648
+#. type: textblock
+#: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:729
msgid ""
-"This returns the current setting of the selinux flag which is passed to the "
-"appliance at boot time. See C<guestfs_set_selinux>."
+"This tells the kernel to flush internal buffers associated with C<device>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1656
-msgid "guestfs_get_state"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:509 ../fish/guestfish-actions.pod:520
+#: ../fish/guestfish-actions.pod:529 ../fish/guestfish-actions.pod:539
+#: ../fish/guestfish-actions.pod:551 ../fish/guestfish-actions.pod:564
+#: ../fish/guestfish-actions.pod:572 ../fish/guestfish-actions.pod:583
+#: ../fish/guestfish-actions.pod:591 ../fish/guestfish-actions.pod:599
+#: ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:749
+#: ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:780
+#: ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:817
+#: ../src/guestfs-actions.pod:831 ../src/guestfs-actions.pod:849
+#: ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:877
+msgid "This uses the L<blockdev(8)> command."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:511
+msgid "blockdev-getbsz"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1658
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:513
#, no-wrap
msgid ""
-" int guestfs_get_state (guestfs_h *g);\n"
+" blockdev-getbsz device\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:515 ../src/guestfs-actions.pod:744
+msgid "This returns the block size of a device."
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)>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:517 ../fish/guestfish-actions.pod:580
+#: ../src/guestfs-actions.pod:746 ../src/guestfs-actions.pod:846
+msgid ""
+"(Note this is different from both I<size in blocks> and I<filesystem block "
+"size>)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1667
-msgid "guestfs_get_trace"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:522
+msgid "blockdev-getro"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1669
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:524
#, no-wrap
msgid ""
-" int guestfs_get_trace (guestfs_h *g);\n"
+" blockdev-getro device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1333
-msgid "Return the command trace flag."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:526 ../src/guestfs-actions.pod:761
+msgid ""
+"Returns a boolean indicating if the block device is read-only (true if read-"
+"only, false if not)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1675
-msgid "guestfs_get_umask"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:531
+msgid "blockdev-getsize64"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1677
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:533
#, no-wrap
msgid ""
-" int guestfs_get_umask (guestfs_h *g);\n"
+" blockdev-getsize64 device\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
-msgid ""
-" int guestfs_get_verbose (guestfs_h *g);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:535 ../src/guestfs-actions.pod:776
+msgid "This returns the size of the device in bytes."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1346
-msgid "This returns the verbose messages flag."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:537
+msgid "See also L</blockdev-getsz>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1692
-msgid "guestfs_getcon"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:541
+msgid "blockdev-getss"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1694
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:543
#, no-wrap
msgid ""
-" char *guestfs_getcon (guestfs_h *g);\n"
+" blockdev-getss device\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:545 ../src/guestfs-actions.pod:792
+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:1698
+#. type: textblock
+#: ../fish/guestfish-actions.pod:548
msgid ""
-"See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
+"(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1704
-msgid "guestfs_getxattrs"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:553
+msgid "blockdev-getsz"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1706
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:555
#, no-wrap
msgid ""
-" struct guestfs_xattr_list *guestfs_getxattrs (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" blockdev-getsz device\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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:557 ../src/guestfs-actions.pod:810
msgid ""
-"At the system call level, this is a combination of the L<listxattr(2)> and "
-"L<getxattr(2)> calls."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:1715
-msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
+"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:1717 ../src/guestfs-actions.pod:2449
-#: ../src/guestfs-actions.pod:2944
+#. type: textblock
+#: ../fish/guestfish-actions.pod:560
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>."
+"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: =head2
-#: ../src/guestfs-actions.pod:1722
-msgid "guestfs_glob_expand"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:566
+msgid "blockdev-rereadpt"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1724
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:568
#, no-wrap
msgid ""
-" char **guestfs_glob_expand (guestfs_h *g,\n"
-"\t\tconst char *pattern);\n"
+" blockdev-rereadpt device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1373
-msgid ""
-"This command searches for all the pathnames matching C<pattern> according to "
-"the wildcard expansion rules used by the shell."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:570 ../src/guestfs-actions.pod:829
+msgid "Reread the partition table on C<device>."
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)."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:574
+msgid "blockdev-setbsz"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1380
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:576
+#, no-wrap
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."
+" blockdev-setbsz device blocksize\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1742
-msgid "guestfs_grep"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:578 ../src/guestfs-actions.pod:844
+msgid "This sets the block size of a device."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:585
+msgid "blockdev-setro"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1744
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:587
#, no-wrap
msgid ""
-" char **guestfs_grep (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" blockdev-setro device\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:861
+msgid "Sets the block device named C<device> to read-only."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1758
-msgid "guestfs_grepi"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:593
+msgid "blockdev-setrw"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1760
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:595
#, no-wrap
msgid ""
-" char **guestfs_grepi (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" blockdev-setrw device\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:597 ../src/guestfs-actions.pod:875
+msgid "Sets the block device named C<device> to read-write."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1774
-msgid "guestfs_grub_install"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:601
+msgid "btrfs-filesystem-resize"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1776
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:603
#, no-wrap
msgid ""
-" int guestfs_grub_install (guestfs_h *g,\n"
-"\t\tconst char *root,\n"
-"\t\tconst char *device);\n"
+" btrfs-filesystem-resize mountpoint [size:..]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1780 ../fish/guestfish-actions.pod:1408
-msgid ""
-"This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
-"the root directory being C<root>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:605 ../src/guestfs-actions.pod:897
+msgid "This command resizes a btrfs filesystem."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1783 ../fish/guestfish-actions.pod:1411
+#. type: textblock
+#: ../fish/guestfish-actions.pod:607 ../src/guestfs-actions.pod:899
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:"
+"Note that unlike other resize calls, the filesystem has to be mounted and "
+"the parameter is the mountpoint not the device (this is a requirement of "
+"btrfs itself)."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1418
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:611 ../fish/guestfish-actions.pod:3615
+#: ../src/guestfs-actions.pod:903 ../src/guestfs-actions.pod:5638
+msgid "The optional parameters are:"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3619
+#: ../src/guestfs-actions.pod:907 ../src/guestfs-actions.pod:5642
+msgid "C<size>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:617 ../src/guestfs-actions.pod:909
msgid ""
-" (hd0) /dev/vda\n"
-"\n"
+"The new size (in bytes) of the filesystem. If omitted, the filesystem is "
+"resized to the maximum size."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:622 ../src/guestfs-actions.pod:914
+msgid "See also L<btrfs(8)>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1796
-msgid "guestfs_head"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:626
+msgid "case-sensitive-path"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1798
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:628
#, no-wrap
msgid ""
-" char **guestfs_head (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" case-sensitive-path path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1426
+#. type: textblock
+#: ../fish/guestfish-actions.pod:630 ../src/guestfs-actions.pod:948
msgid ""
-"This command returns up to the first 10 lines of a file as a list of strings."
+"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: =head2
-#: ../src/guestfs-actions.pod:1811
-msgid "guestfs_head_n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:635 ../src/guestfs-actions.pod:953
+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."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1813
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:640 ../src/guestfs-actions.pod:958
msgid ""
-" char **guestfs_head_n (guestfs_h *g,\n"
-"\t\tint nrlines,\n"
-"\t\tconst char *path);\n"
-"\n"
+"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:1817 ../fish/guestfish-actions.pod:1436
+#. type: textblock
+#: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:964
msgid ""
-"If the parameter C<nrlines> is a positive number, this returns the first "
-"C<nrlines> lines of the file C<path>."
+"Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
+"#posixfilenames1>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1439
+#. type: textblock
+#: ../fish/guestfish-actions.pod:649 ../src/guestfs-actions.pod:967
msgid ""
-"If the parameter C<nrlines> is a negative number, this returns lines from "
-"the file C<path>, excluding the last C<nrlines> lines."
+"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: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: textblock
+#: ../fish/guestfish-actions.pod:652
+msgid ""
+"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: =head2
-#: ../src/guestfs-actions.pod:1832
-msgid "guestfs_hexdump"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:657 ../src/guestfs-actions.pod:975
+msgid "I<Note>: This function does not handle drive names, backslashes etc."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:660
+msgid "See also L</realpath>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:662
+msgid "cat"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1834
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:664
#, no-wrap
msgid ""
-" char *guestfs_hexdump (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" cat path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1451
+#. type: textblock
+#: ../fish/guestfish-actions.pod:666 ../fish/guestfish-actions.pod:4049
+#: ../src/guestfs-actions.pod:991 ../src/guestfs-actions.pod:6299
+msgid "Return the contents of the file named C<path>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:668
msgid ""
-"This runs C<hexdump -C> on the given C<path>. The result is the human-"
-"readable, canonical hex dump of the file."
+"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-actions.pod:673 ../fish/guestfish-actions.pod:808
+#: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:1103
+#: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1180
+#: ../fish/guestfish-actions.pod:1190 ../fish/guestfish-actions.pod:1382
+#: ../fish/guestfish-actions.pod:1695 ../fish/guestfish-actions.pod:1705
+#: ../fish/guestfish-actions.pod:1755 ../fish/guestfish-actions.pod:1770
+#: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1799
+#: ../fish/guestfish-actions.pod:3919 ../fish/guestfish-actions.pod:3934
+#: ../fish/guestfish-actions.pod:4010 ../fish/guestfish-actions.pod:4027
+#: ../fish/guestfish-actions.pod:4042 ../fish/guestfish-actions.pod:4723
+#: ../fish/guestfish-actions.pod:4769 ../fish/guestfish-actions.pod:4854
+#: ../fish/guestfish-actions.pod:4869 ../fish/guestfish-actions.pod:5275
+#: ../fish/guestfish-actions.pod:5287 ../fish/guestfish-actions.pod:5305
+#: ../fish/guestfish-actions.pod:5322 ../fish/guestfish-actions.pod:5332
+#: ../fish/guestfish-actions.pod:5389 ../fish/guestfish-actions.pod:5399
+#: ../fish/guestfish-actions.pod:5428 ../fish/guestfish-actions.pod:5438
+#: ../src/guestfs-actions.pod:1001 ../src/guestfs-actions.pod:1180
+#: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1847
+#: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1969
+#: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2234
+#: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:2735
+#: ../src/guestfs-actions.pod:2800 ../src/guestfs-actions.pod:2824
+#: ../src/guestfs-actions.pod:2841 ../src/guestfs-actions.pod:2870
+#: ../src/guestfs-actions.pod:6081 ../src/guestfs-actions.pod:6107
+#: ../src/guestfs-actions.pod:6238 ../src/guestfs-actions.pod:6264
+#: ../src/guestfs-actions.pod:6288 ../src/guestfs-actions.pod:7255
+#: ../src/guestfs-actions.pod:7310 ../src/guestfs-actions.pod:7456
+#: ../src/guestfs-actions.pod:7480 ../src/guestfs-actions.pod:8145
+#: ../src/guestfs-actions.pod:8165 ../src/guestfs-actions.pod:8198
+#: ../src/guestfs-actions.pod:8217 ../src/guestfs-actions.pod:8236
+#: ../src/guestfs-actions.pod:8330 ../src/guestfs-actions.pod:8349
+#: ../src/guestfs-actions.pod:8395 ../src/guestfs-actions.pod:8414
+msgid ""
+"Because of the message protocol, there is a transfer limit of somewhere "
+"between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1846
-msgid "guestfs_initrd_cat"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:676
+msgid "checksum"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1848
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:678
#, 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"
+" checksum csumtype path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1853 ../fish/guestfish-actions.pod:1461
+#. type: textblock
+#: ../fish/guestfish-actions.pod:680 ../src/guestfs-actions.pod:1013
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."
+"This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1465
+#. type: textblock
+#: ../fish/guestfish-actions.pod:683 ../src/guestfs-actions.pod:1016
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:"
+"The type of checksum to compute is given by the C<csumtype> parameter which "
+"must have one of the following values:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1469
-#, no-wrap
+#. type: =item
+#: ../fish/guestfish-actions.pod:688 ../src/guestfs-actions.pod:1021
+msgid "C<crc>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1023
msgid ""
-" initrd-cat /boot/initrd-<version>.img init\n"
-"\n"
+"Compute the cyclic redundancy check (CRC) specified by POSIX for the "
+"C<cksum> command."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1863
-msgid "See also C<guestfs_initrd_list>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:693 ../src/guestfs-actions.pod:1026
+msgid "C<md5>"
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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:695 ../src/guestfs-actions.pod:1028
+msgid "Compute the MD5 hash (using the C<md5sum> program)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1872
-msgid "guestfs_initrd_list"
+#. type: =item
+#: ../fish/guestfish-actions.pod:697 ../src/guestfs-actions.pod:1030
+msgid "C<sha1>"
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
+#: ../fish/guestfish-actions.pod:699 ../src/guestfs-actions.pod:1032
+msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1480
-msgid "This command lists out files contained in an initrd."
+#. type: =item
+#: ../fish/guestfish-actions.pod:701 ../src/guestfs-actions.pod:1034
+msgid "C<sha224>"
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:703 ../src/guestfs-actions.pod:1036
+msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
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)."
+#. type: =item
+#: ../fish/guestfish-actions.pod:705 ../src/guestfs-actions.pod:1038
+msgid "C<sha256>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1891
-msgid "guestfs_inotify_add_watch"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1040
+msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
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: =item
+#: ../fish/guestfish-actions.pod:709 ../src/guestfs-actions.pod:1042
+msgid "C<sha384>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1897 ../fish/guestfish-actions.pod:1494
-msgid "Watch C<path> for the events listed in C<mask>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:711 ../src/guestfs-actions.pod:1044
+msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
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)."
+#. type: =item
+#: ../fish/guestfish-actions.pod:713 ../src/guestfs-actions.pod:1046
+msgid "C<sha512>"
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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:715 ../src/guestfs-actions.pod:1048
+msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1909
-msgid "guestfs_inotify_close"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:719 ../src/guestfs-actions.pod:1052
+msgid "The checksum is returned as a printable string."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1911
-#, no-wrap
-msgid ""
-" int guestfs_inotify_close (guestfs_h *g);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:721
+msgid "To get the checksum for a device, use L</checksum-device>."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:723
+msgid "To get the checksums for many files, use L</checksums-out>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:1919
-msgid "guestfs_inotify_files"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:725
+msgid "checksum-device"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1921
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:727
#, no-wrap
msgid ""
-" char **guestfs_inotify_files (guestfs_h *g);\n"
+" checksum-device csumtype device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1923
+#. type: textblock
+#: ../fish/guestfish-actions.pod:729
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."
+"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: =head2
-#: ../src/guestfs-actions.pod:1931
-msgid "guestfs_inotify_init"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:733
+msgid "checksums-out"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1933
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:735
#, no-wrap
msgid ""
-" int guestfs_inotify_init (guestfs_h *g,\n"
-"\t\tint maxevents);\n"
+" checksums-out csumtype directory (sumsfile|-)\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1936 ../fish/guestfish-actions.pod:1524
+#. type: textblock
+#: ../fish/guestfish-actions.pod:737 ../src/guestfs-actions.pod:1087
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."
+"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:1940
+#. type: textblock
+#: ../fish/guestfish-actions.pod:741 ../src/guestfs-actions.pod:1091
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>)."
+"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:1950
-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>."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:751
+msgid "chmod"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1956
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:753
+#, no-wrap
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."
+" chmod mode path\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1963
+#. type: textblock
+#: ../fish/guestfish-actions.pod:755 ../src/guestfs-actions.pod:1110
msgid ""
-"The handle should be closed after use by calling C<guestfs_inotify_close>. "
-"This also removes any watches automatically."
+"Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
+"supported."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1967 ../fish/guestfish-actions.pod:1555
+#. type: textblock
+#: ../fish/guestfish-actions.pod:758 ../src/guestfs-actions.pod:1113
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."
+"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: =head2
-#: ../src/guestfs-actions.pod:1974
-msgid "guestfs_inotify_read"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:762 ../fish/guestfish-actions.pod:3268
+#: ../fish/guestfish-actions.pod:3407 ../fish/guestfish-actions.pod:3417
+#: ../fish/guestfish-actions.pod:3427 ../src/guestfs-actions.pod:1117
+#: ../src/guestfs-actions.pod:5045 ../src/guestfs-actions.pod:5254
+#: ../src/guestfs-actions.pod:5273 ../src/guestfs-actions.pod:5292
+msgid "The mode actually set is affected by the umask."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1976
+#. type: =head2
+#: ../fish/guestfish-actions.pod:764
+msgid "chown"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:766
#, no-wrap
msgid ""
-" struct guestfs_inotify_event_list *guestfs_inotify_read (guestfs_h *g);\n"
+" chown owner group path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1978 ../fish/guestfish-actions.pod:1564
+#. type: textblock
+#: ../fish/guestfish-actions.pod:768 ../src/guestfs-actions.pod:1131
+msgid "Change the file owner to C<owner> and group to C<group>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:770 ../fish/guestfish-actions.pod:2703
+#: ../src/guestfs-actions.pod:1133 ../src/guestfs-actions.pod:4116
msgid ""
-"Return the complete queue of events that have happened since the previous "
-"read call."
+"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: textblock
-#: ../src/guestfs-actions.pod:1981 ../fish/guestfish-actions.pod:1567
-msgid "If no events have happened, this returns an empty list."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:774
+msgid "command"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1569
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:776
+#, no-wrap
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."
+" command 'arguments ...'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:778 ../src/guestfs-actions.pod:1147
+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:1989
+#. type: textblock
+#: ../fish/guestfish-actions.pod:783
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>."
+"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
-#: ../src/guestfs-actions.pod:1994
-msgid "guestfs_inotify_rm_watch"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:790 ../src/guestfs-actions.pod:1159
+msgid "The return value is anything printed to I<stdout> by the command."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:1996
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:793 ../src/guestfs-actions.pod:1162
msgid ""
-" int guestfs_inotify_rm_watch (guestfs_h *g,\n"
-"\t\tint wd);\n"
-"\n"
+"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:1999
+#. type: textblock
+#: ../fish/guestfish-actions.pod:797 ../src/guestfs-actions.pod:1166
msgid ""
-"Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
+"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: =head2
-#: ../src/guestfs-actions.pod:2004
-msgid "guestfs_inspect_get_arch"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:802 ../src/guestfs-actions.pod:1171
+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."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2006
+#. type: =head2
+#: ../fish/guestfish-actions.pod:811
+msgid "command-lines"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:813
#, no-wrap
msgid ""
-" char *guestfs_inspect_get_arch (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" command-lines 'arguments ...'\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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:815
msgid ""
-"This function should only be called with a root device string as returned by "
-"C<guestfs_inspect_os>."
+"This is the same as L</command>, but splits the result into a list of lines."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:818
+msgid "See also: L</sh-lines>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2012
+#. type: =head2
+#: ../fish/guestfish-actions.pod:823
+msgid "compress-device-out"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:825
+#, no-wrap
msgid ""
-"This returns the architecture of the inspected operating system. The "
-"possible return values are listed under C<guestfs_file_architecture>."
+" compress-device-out ctype device (zdevice|-) [level:..]\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1593
+#. type: textblock
+#: ../fish/guestfish-actions.pod:827 ../src/guestfs-actions.pod:1221
msgid ""
-"If the architecture could not be determined, then the string C<unknown> is "
-"returned."
+"This command compresses C<device> and writes it out to the local file "
+"C<zdevice>."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:830
+msgid ""
+"The C<ctype> and optional C<level> parameters have the same meaning as in L</"
+"compress-out>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2024
-msgid "guestfs_inspect_get_distro"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:837
+msgid "compress-out"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2026
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:839
#, no-wrap
msgid ""
-" char *guestfs_inspect_get_distro (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" compress-out ctype file (zfile|-) [level:..]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2032 ../fish/guestfish-actions.pod:1605
+#. type: textblock
+#: ../fish/guestfish-actions.pod:841 ../src/guestfs-actions.pod:1273
msgid ""
-"This returns the distro (distribution) of the inspected operating system."
+"This command compresses C<file> and writes it out to the local file C<zfile>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1608
-msgid "Currently defined distros are:"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:844 ../src/guestfs-actions.pod:1276
+msgid ""
+"The compression program used is controlled by the C<ctype> parameter. "
+"Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>. "
+"Some compression types may not be supported by particular builds of "
+"libguestfs, in which case you will get an error containing the substring "
+"\"not supported\"."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:2039 ../fish/guestfish-actions.pod:1612
-msgid "\"debian\""
+#. type: textblock
+#: ../fish/guestfish-actions.pod:850 ../src/guestfs-actions.pod:1282
+msgid ""
+"The optional C<level> parameter controls compression level. The meaning and "
+"default for this parameter depends on the compression program being used."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2041 ../fish/guestfish-actions.pod:1614
-msgid "Debian or a Debian-derived distro such as Ubuntu."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:858
+msgid "config"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:2043 ../fish/guestfish-actions.pod:1616
-msgid "\"fedora\""
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:860
+#, no-wrap
+msgid ""
+" config qemuparam qemuvalue\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2045 ../fish/guestfish-actions.pod:1618
-msgid "Fedora."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:862 ../src/guestfs-actions.pod:1323
+msgid ""
+"This can be used to add arbitrary qemu command line parameters of the form "
+"I<-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: =item
-#: ../src/guestfs-actions.pod:2047 ../fish/guestfish-actions.pod:1620
-msgid "\"redhat-based\""
+#. type: textblock
+#: ../fish/guestfish-actions.pod:867 ../src/guestfs-actions.pod:1328
+msgid "The first character of C<param> string must be a C<-> (dash)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2049 ../fish/guestfish-actions.pod:1622
-msgid "Some Red Hat-derived distro."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:869 ../src/guestfs-actions.pod:1330
+msgid "C<value> can be NULL."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:2051 ../fish/guestfish-actions.pod:1624
-msgid "\"rhel\""
+#. type: =head2
+#: ../fish/guestfish-actions.pod:871
+msgid "copy-device-to-device"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1626
-msgid "Red Hat Enterprise Linux and some derivatives."
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:873
+#, no-wrap
+msgid ""
+" copy-device-to-device src dest [srcoffset:..] [destoffset:..] [size:..]\n"
+"\n"
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
+#: ../fish/guestfish-actions.pod:875
+msgid ""
+"The four calls L</copy-device-to-device>, L</copy-device-to-file>, L</copy-"
+"file-to-device>, and L</copy-file-to-file> let you copy from a source "
+"(device|file) to a destination (device|file)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2057 ../fish/guestfish-actions.pod:1630
+#. type: textblock
+#: ../fish/guestfish-actions.pod:882 ../src/guestfs-actions.pod:1360
msgid ""
-"Windows does not have distributions. This string is returned if the OS type "
-"is Windows."
+"Partial copies can be made since you can specify optionally the source "
+"offset, destination offset and size to copy. These values are all specified "
+"in bytes. If not given, the offsets both default to zero, and the size "
+"defaults to copying as much as possible until we hit the end of the source."
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
+#: ../fish/guestfish-actions.pod:888 ../src/guestfs-actions.pod:1366
+msgid ""
+"The source and destination may be the same object. However overlapping "
+"regions may not be copied correctly."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2062 ../fish/guestfish-actions.pod:1635
-msgid "The distro could not be determined."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:891 ../src/guestfs-actions.pod:1369
+msgid ""
+"If the destination is a file, it is created if required. If the destination "
+"file is not large enough, it is extended."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:896
+msgid "copy-device-to-file"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2217
-#: ../fish/guestfish-actions.pod:1639 ../fish/guestfish-actions.pod:1764
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:898
+#, no-wrap
msgid ""
-"Future versions of libguestfs may return other strings here. The caller "
-"should be prepared to handle any string."
+" copy-device-to-file src dest [srcoffset:..] [destoffset:..] [size:..]\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2074
-msgid "guestfs_inspect_get_filesystems"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:900 ../fish/guestfish-actions.pod:909
+#: ../fish/guestfish-actions.pod:918
+msgid "See L</copy-device-to-device> for a general overview of this call."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:905
+msgid "copy-file-to-device"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2076
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:907
#, no-wrap
msgid ""
-" char **guestfs_inspect_get_filesystems (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" copy-file-to-device src dest [srcoffset:..] [destoffset:..] [size:..]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2082 ../fish/guestfish-actions.pod:1651
-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."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:914
+msgid "copy-file-to-file"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2087 ../fish/guestfish-actions.pod:1656
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:916
+#, no-wrap
msgid ""
-"In the case of a multi-boot virtual machine, it is possible for a filesystem "
-"to be shared between operating systems."
+" copy-file-to-file src dest [srcoffset:..] [destoffset:..] [size:..]\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2090
+#. type: textblock
+#: ../fish/guestfish-actions.pod:921
msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also "
-"C<guestfs_inspect_get_mountpoints>."
+"This is B<not> the function you want for copying files. This is for copying "
+"blocks within existing files. See L</cp>, L</cp-a> and L</mv> for general "
+"file copying and moving functions."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2097
-msgid "guestfs_inspect_get_major_version"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:928
+msgid "copy-size"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2099
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:930
#, no-wrap
msgid ""
-" int guestfs_inspect_get_major_version (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" copy-size src dest size\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2105 ../fish/guestfish-actions.pod:1669
+#. type: textblock
+#: ../fish/guestfish-actions.pod:932 ../src/guestfs-actions.pod:1576
msgid ""
-"This returns the major version number of the inspected operating system."
+"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:2108 ../fish/guestfish-actions.pod:1672
+#. type: textblock
+#: ../fish/guestfish-actions.pod:935 ../src/guestfs-actions.pod:1579
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."
+"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: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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:973
+msgid ""
+"I<This function is deprecated.> In new code, use the L</"
+"copy_device_to_device> call instead."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2121
-msgid "guestfs_inspect_get_minor_version"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:945
+msgid "cp"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2123
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:947
#, no-wrap
msgid ""
-" int guestfs_inspect_get_minor_version (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" cp src dest\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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:949 ../src/guestfs-actions.pod:1598
msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also "
-"C<guestfs_inspect_get_major_version>."
+"This copies 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:2139
-msgid "guestfs_inspect_get_mountpoints"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:952
+msgid "cp-a"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2141
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:954
#, no-wrap
msgid ""
-" char **guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" cp-a src dest\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1705
+#. type: textblock
+#: ../fish/guestfish-actions.pod:956 ../src/guestfs-actions.pod:1612
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>."
+"This copies a file or directory from C<src> to C<dest> recursively using the "
+"C<cp -a> command."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1710
-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>)."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:959
+msgid "dd"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2157 ../fish/guestfish-actions.pod:1715
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:961
+#, no-wrap
msgid ""
-"Non-mounted devices such as swap devices are I<not> returned in this list."
+" dd src dest\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2160
+#. type: textblock
+#: ../fish/guestfish-actions.pod:963 ../src/guestfs-actions.pod:1633
msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also "
-"C<guestfs_inspect_get_filesystems>."
+"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:2163 ../src/guestfs-actions.pod:3380
-#: ../src/guestfs-actions.pod:4902
+#. type: textblock
+#: ../fish/guestfish-actions.pod:968
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>."
+"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-device-to-device>)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2169
-msgid "guestfs_inspect_get_product_name"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:980
+msgid "df"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2171
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:982
#, no-wrap
msgid ""
-" char *guestfs_inspect_get_product_name (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" df\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2177 ../fish/guestfish-actions.pod:1728
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1652
+msgid "This command runs the C<df> command to report disk space used."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2182 ../fish/guestfish-actions.pod:1733
+#. type: textblock
+#: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:997
msgid ""
-"If the product name could not be determined, then the string C<unknown> is "
-"returned."
+"This command is mostly useful for interactive sessions. It is I<not> "
+"intended that you try to parse the output string. Use L</statvfs> from "
+"programs."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2190
-msgid "guestfs_inspect_get_type"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:990
+msgid "df-h"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2192
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:992
#, no-wrap
msgid ""
-" char *guestfs_inspect_get_type (guestfs_h *g,\n"
-"\t\tconst char *root);\n"
+" df-h\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2198 ../fish/guestfish-actions.pod:1745
+#. type: textblock
+#: ../fish/guestfish-actions.pod:994 ../src/guestfs-actions.pod:1668
msgid ""
-"This returns the type of the inspected operating system. Currently defined "
-"types are:"
+"This command runs the C<df -h> command to report disk space used in human-"
+"readable format."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:2203 ../fish/guestfish-actions.pod:1750
-msgid "\"linux\""
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1001
+msgid "dmesg"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2205 ../fish/guestfish-actions.pod:1752
-msgid "Any Linux-based operating system."
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1003
+#, no-wrap
+msgid ""
+" dmesg\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1756
-msgid "Any Microsoft Windows operating system."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1005 ../src/guestfs-actions.pod:1685
+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:2213 ../fish/guestfish-actions.pod:1760
-msgid "The operating system type could not be determined."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1009
+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
-#: ../src/guestfs-actions.pod:2225
-msgid "guestfs_inspect_os"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1014
+msgid "download"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2227
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1016
#, no-wrap
msgid ""
-" char **guestfs_inspect_os (guestfs_h *g);\n"
+" download remotefilename (filename|-)\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1773
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1018 ../fish/guestfish-actions.pod:1031
+#: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1731
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."
+"Download file C<remotefilename> and save it as C<filename> on the local "
+"machine."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1021 ../fish/guestfish-actions.pod:5027
+#: ../src/guestfs-actions.pod:1709 ../src/guestfs-actions.pod:7715
+msgid "C<filename> can also be a named pipe."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1023
+msgid "See also L</upload>, L</cat>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1027
+msgid "download-offset"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2242
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1029
+#, 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."
+" download-offset remotefilename (filename|-) offset size\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2247
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1034 ../src/guestfs-actions.pod:1734
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."
+"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:2253 ../fish/guestfish-actions.pod:1797
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1037
msgid ""
-"This function cannot decrypt encrypted disks. The caller must do that first "
-"(supplying the necessary keys) if the disk is encrypted."
+"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: =head2
-#: ../src/guestfs-actions.pod:2263
-msgid "guestfs_is_blockdev"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1042
+msgid "See also L</download>, L</pread>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1046
+msgid "drop-caches"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2265
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1048
#, no-wrap
msgid ""
-" int guestfs_is_blockdev (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" drop-caches whattodrop\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2268 ../fish/guestfish-actions.pod:1807
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1050 ../src/guestfs-actions.pod:1759
msgid ""
-"This returns C<true> if and only if there is a block device with the given "
-"C<path> name."
+"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: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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1055 ../src/guestfs-actions.pod:1764
+msgid "Setting C<whattodrop> to 3 should drop everything."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2275
-msgid "guestfs_is_busy"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1057 ../src/guestfs-actions.pod:1766
+msgid ""
+"This automatically calls L<sync(2)> before the operation, so that the "
+"maximum guest memory is freed."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2277
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1060
+msgid "du"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1062
#, no-wrap
msgid ""
-" int guestfs_is_busy (guestfs_h *g);\n"
+" du path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2279 ../fish/guestfish-actions.pod:1816
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1779
msgid ""
-"This returns true iff this handle is busy processing a command (in the "
-"C<BUSY> state)."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2286
-msgid "guestfs_is_chardev"
+"This command runs the C<du -s> command to estimate file space usage for "
+"C<path>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2288
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1782
msgid ""
-" int guestfs_is_chardev (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"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:2291 ../fish/guestfish-actions.pod:1825
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1071 ../src/guestfs-actions.pod:1786
msgid ""
-"This returns C<true> if and only if there is a character device with the "
-"given C<path> name."
+"The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2298
-msgid "guestfs_is_config"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1074
+msgid "e2fsck-f"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2300
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1076
#, no-wrap
msgid ""
-" int guestfs_is_config (guestfs_h *g);\n"
+" e2fsck-f device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2302 ../fish/guestfish-actions.pod:1834
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1804
msgid ""
-"This returns true iff this handle is being configured (in the C<CONFIG> "
-"state)."
+"This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
+"on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
+"clean (I<-f>)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2309
-msgid "guestfs_is_dir"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1082
+msgid ""
+"This command is only needed because of L</resize2fs> (q.v.). Normally you "
+"should use L</fsck>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2311
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1085
+msgid "echo-daemon"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1087
#, no-wrap
msgid ""
-" int guestfs_is_dir (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" echo-daemon 'words ...'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1843
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1089 ../src/guestfs-actions.pod:1821
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."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2322
-msgid "guestfs_is_fifo"
+"This command concatenates the list of C<words> passed with single spaces "
+"between them and returns the resulting string."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2324
-#, no-wrap
-msgid ""
-" int guestfs_is_fifo (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1824
+msgid "You can use this command to test the connection through to the daemon."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1094
+msgid "See also L</ping-daemon>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2334
-msgid "guestfs_is_file"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1096
+msgid "egrep"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2336
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1098
#, no-wrap
msgid ""
-" int guestfs_is_file (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" egrep regex path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2339 ../fish/guestfish-actions.pod:1862
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1840
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 calls the external C<egrep> program and returns the matching lines."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2347
-msgid "guestfs_is_launching"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1106
+msgid "egrepi"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2349
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1108
#, no-wrap
msgid ""
-" int guestfs_is_launching (guestfs_h *g);\n"
+" egrepi regex path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2351 ../fish/guestfish-actions.pod:1872
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1859
msgid ""
-"This returns true iff this handle is launching the subprocess (in the "
-"C<LAUNCHING> state)."
+"This calls the external C<egrep -i> program and returns the matching lines."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2358
-msgid "guestfs_is_lv"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1116
+msgid "equal"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2360
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1118
#, no-wrap
msgid ""
-" int guestfs_is_lv (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" equal file1 file2\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2363 ../fish/guestfish-actions.pod:1881
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1878
msgid ""
-"This command tests whether C<device> is a logical volume, and returns true "
-"iff this is the case."
+"This compares the two files C<file1> and C<file2> and returns true if their "
+"content is exactly equal, or false otherwise."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2368
-msgid "guestfs_is_ready"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1123 ../src/guestfs-actions.pod:1881
+msgid "The external L<cmp(1)> program is used for the comparison."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2370
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1125
+msgid "exists"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1127
#, no-wrap
msgid ""
-" int guestfs_is_ready (guestfs_h *g);\n"
+" exists path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1888
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1893
msgid ""
-"This returns true iff this handle is ready to accept commands (in the "
-"C<READY> state)."
+"This returns C<true> if and only if there is a file, directory (or anything) "
+"with the given C<path> name."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2379
-msgid "guestfs_is_socket"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1132
+msgid "See also L</is-file>, L</is-dir>, L</stat>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2381
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1134
+msgid "fallocate"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1136
#, no-wrap
msgid ""
-" int guestfs_is_socket (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" fallocate path len\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1897
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1138 ../fish/guestfish-actions.pod:1157
+#: ../src/guestfs-actions.pod:1916 ../src/guestfs-actions.pod:1935
msgid ""
-"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:2391
-msgid "guestfs_is_symlink"
+"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: verbatim
-#: ../src/guestfs-actions.pod:2393
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1142 ../src/guestfs-actions.pod:1920
msgid ""
-" int guestfs_is_symlink (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"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:2396 ../fish/guestfish-actions.pod:1906
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1146
msgid ""
-"This returns C<true> if and only if there is a symbolic link with the given "
-"C<path> name."
+"I<This function is deprecated.> In new code, use the L</fallocate64> call "
+"instead."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2403
-msgid "guestfs_kill_subprocess"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1153
+msgid "fallocate64"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2405
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1155
#, no-wrap
msgid ""
-" int guestfs_kill_subprocess (guestfs_h *g);\n"
+" fallocate64 path len\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."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2411
-msgid "guestfs_launch"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:2413
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1161
msgid ""
-" int guestfs_launch (guestfs_h *g);\n"
-"\n"
+"Note that this call allocates disk blocks for the file. To create a sparse "
+"file use L</truncate-size> instead."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1921
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1164
msgid ""
-"Internally libguestfs is implemented by running a virtual machine using "
-"L<qemu(1)>."
+"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: textblock
-#: ../src/guestfs-actions.pod:2418 ../fish/guestfish-actions.pod:1924
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1169 ../src/guestfs-actions.pod:1947
msgid ""
-"You should call this after configuring the handle (eg. adding drives) but "
-"before performing any actions."
+"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:2423
-msgid "guestfs_lchown"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1173
+msgid "fgrep"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2425
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1175
#, no-wrap
msgid ""
-" int guestfs_lchown (guestfs_h *g,\n"
-"\t\tint owner,\n"
-"\t\tint group,\n"
-"\t\tconst char *path);\n"
+" fgrep pattern path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2430
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1177 ../src/guestfs-actions.pod:1962
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 calls the external C<fgrep> program and returns the matching lines."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2440
-msgid "guestfs_lgetxattrs"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1183
+msgid "fgrepi"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2442
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1185
#, no-wrap
msgid ""
-" struct guestfs_xattr_list *guestfs_lgetxattrs (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" fgrepi pattern path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2445
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1187 ../src/guestfs-actions.pod:1981
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."
+"This calls the external C<fgrep -i> program and returns the matching lines."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2454
-msgid "guestfs_list_devices"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1193
+msgid "file"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2456
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1195
#, no-wrap
msgid ""
-" char **guestfs_list_devices (guestfs_h *g);\n"
+" file 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>"
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2466
-msgid "guestfs_list_partitions"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1999
+msgid ""
+"This call uses the standard L<file(1)> command to determine the type or "
+"contents of the file."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2468
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:2002
msgid ""
-" char **guestfs_list_partitions (guestfs_h *g);\n"
-"\n"
+"This call will also transparently look inside various types of compressed "
+"file."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1959
-msgid "List all the partitions detected on all block devices."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1203 ../src/guestfs-actions.pod:2005
+msgid ""
+"The exact command which runs is C<file -zb path>. Note in particular that "
+"the filename is not prepended to the output (the I<-b> option)."
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>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1207 ../src/guestfs-actions.pod:2009
+msgid ""
+"The output depends on the output of the underlying L<file(1)> command and it "
+"can change in future in ways beyond our control. In other words, the output "
+"is not guaranteed by the ABI."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2474
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1211
msgid ""
-"This does not return logical volumes. For that you will need to call "
-"C<guestfs_lvs>."
+"See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
+"(etc), L</is-zero>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2481
-msgid "guestfs_ll"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1214
+msgid "file-architecture"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2483
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1216
#, no-wrap
msgid ""
-" char *guestfs_ll (guestfs_h *g,\n"
-"\t\tconst char *directory);\n"
+" file-architecture filename\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1970
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1218 ../src/guestfs-actions.pod:2027
msgid ""
-"List the files in C<directory> (relative to the root directory, there is no "
-"cwd) in the format of 'ls -la'."
+"This detects the architecture of the binary C<filename>, and returns it if "
+"known."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1973
-msgid ""
-"This command is mostly useful for interactive sessions. It is I<not> "
-"intended that you try to parse the output string."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1221 ../src/guestfs-actions.pod:2030
+msgid "Currently defined architectures are:"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2495
-msgid "guestfs_ln"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1225 ../src/guestfs-actions.pod:2034
+msgid "\"i386\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2497
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1227 ../src/guestfs-actions.pod:2036
msgid ""
-" int guestfs_ln (guestfs_h *g,\n"
-"\t\tconst char *target,\n"
-"\t\tconst char *linkname);\n"
-"\n"
+"This string is returned for all 32 bit i386, i486, i586, i686 binaries "
+"irrespective of the precise processor requirements of the binary."
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."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1230 ../src/guestfs-actions.pod:2039
+msgid "\"x86_64\""
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2505
-msgid "guestfs_ln_f"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1232 ../src/guestfs-actions.pod:2041
+msgid "64 bit x86-64."
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"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1234 ../src/guestfs-actions.pod:2043
+msgid "\"sparc\""
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1236 ../src/guestfs-actions.pod:2045
+msgid "32 bit SPARC."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2516
-msgid "guestfs_ln_s"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1238 ../src/guestfs-actions.pod:2047
+msgid "\"sparc64\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2518
-#, no-wrap
-msgid ""
-" int guestfs_ln_s (guestfs_h *g,\n"
-"\t\tconst char *target,\n"
-"\t\tconst char *linkname);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1240 ../src/guestfs-actions.pod:2049
+msgid "64 bit SPARC V9 and above."
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."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:2051
+msgid "\"ia64\""
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2526
-msgid "guestfs_ln_sf"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1244 ../src/guestfs-actions.pod:2053
+msgid "Intel Itanium."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2528
-#, no-wrap
-msgid ""
-" int guestfs_ln_sf (guestfs_h *g,\n"
-"\t\tconst char *target,\n"
-"\t\tconst char *linkname);\n"
-"\n"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:2055
+msgid "\"ppc\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1999
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1248 ../src/guestfs-actions.pod:2057
+msgid "32 bit Power PC."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2537
-msgid "guestfs_lremovexattr"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1250 ../src/guestfs-actions.pod:2059
+msgid "\"ppc64\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2539
-#, no-wrap
-msgid ""
-" int guestfs_lremovexattr (guestfs_h *g,\n"
-"\t\tconst char *xattr,\n"
-"\t\tconst char *path);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1252 ../src/guestfs-actions.pod:2061
+msgid "64 bit Power PC."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:2065
+msgid "Libguestfs may return other architecture strings in future."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2549
-msgid "guestfs_ls"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1258 ../src/guestfs-actions.pod:2067
+msgid "The function works on at least the following types of files:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2551
-#, no-wrap
-msgid ""
-" char **guestfs_ls (guestfs_h *g,\n"
-"\t\tconst char *directory);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1264 ../src/guestfs-actions.pod:2073
+msgid "many types of Un*x and Linux binary"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:2014
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1268 ../src/guestfs-actions.pod:2077
+msgid "many types of Un*x and Linux shared library"
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1272 ../src/guestfs-actions.pod:2081
+msgid "Windows Win32 and Win64 binaries"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2565
-msgid "guestfs_lsetxattr"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:2085
+msgid "Windows Win32 and Win64 DLLs"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2567
-#, 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"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1278 ../src/guestfs-actions.pod:2087
+msgid "Win32 binaries and DLLs return C<i386>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2573
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1280 ../src/guestfs-actions.pod:2089
+msgid "Win64 binaries and DLLs return C<x86_64>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2579
-msgid "guestfs_lstat"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1284 ../src/guestfs-actions.pod:2093
+msgid "Linux kernel modules"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2581
-#, no-wrap
-msgid ""
-" struct guestfs_stat *guestfs_lstat (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1288 ../src/guestfs-actions.pod:2097
+msgid "Linux new-style initrd images"
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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1292 ../src/guestfs-actions.pod:2101
+msgid "some non-x86 Linux vmlinuz kernels"
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1296 ../src/guestfs-actions.pod:2105
+msgid "What it can't do currently:"
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:2111
+msgid "static libraries (libfoo.a)"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2592 ../src/guestfs-actions.pod:4571
-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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1306 ../src/guestfs-actions.pod:2115
+msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2596
-msgid "guestfs_lstatlist"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1310 ../src/guestfs-actions.pod:2119
+msgid "x86 Linux vmlinuz kernels"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2598
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:2121
msgid ""
-" struct guestfs_stat_list *guestfs_lstatlist (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tchar *const *names);\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: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."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1319
+msgid "filesize"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2606 ../fish/guestfish-actions.pod:2049
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1321
+#, no-wrap
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>."
+" filesize file\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2611
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1323 ../src/guestfs-actions.pod:2139
+msgid "This command returns the size of C<file> in bytes."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2619
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1325
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>."
+"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
-#: ../src/guestfs-actions.pod:2624
-msgid "guestfs_luks_add_key"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1329
+msgid "fill"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2626
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1331
#, 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"
+" fill c len path\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."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2637
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:2157
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."
+"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: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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1337
msgid ""
-"This function takes a key or passphrase parameter which could contain "
-"sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
-"information."
+"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
-#: ../src/guestfs-actions.pod:2647
-msgid "guestfs_luks_close"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1342
+msgid "fill-pattern"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2649
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1344
#, no-wrap
msgid ""
-" int guestfs_luks_close (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" fill-pattern pattern len path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2652
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1346
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 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
-#: ../src/guestfs-actions.pod:2660
-msgid "guestfs_luks_format"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1351
+msgid "find"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2662
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1353
#, 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"
+" find directory\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2667 ../fish/guestfish-actions.pod:2092
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1355 ../src/guestfs-actions.pod:2203
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)."
+"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: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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1360 ../src/guestfs-actions.pod:2208
msgid ""
-"B<This command is dangerous. Without careful use you can easily destroy all "
-"your data>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2681
-msgid "guestfs_luks_format_cipher"
+"This returns a list of strings I<without any prefix>. Thus if the directory "
+"structure was:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2683
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1363 ../src/guestfs-actions.pod:2211
#, 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"
+" /tmp/a\n"
+" /tmp/b\n"
+" /tmp/c/d\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2689
-msgid ""
-"This command is the same as C<guestfs_luks_format> but it also allows you to "
-"set the C<cipher> used."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2701
-msgid "guestfs_luks_kill_slot"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1367
+msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2703
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1370 ../src/guestfs-actions.pod:2218
#, no-wrap
msgid ""
-" int guestfs_luks_kill_slot (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *key,\n"
-"\t\tint keyslot);\n"
+" a\n"
+" b\n"
+" c\n"
+" c/d\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:2120
-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: =head2
-#: ../src/guestfs-actions.pod:2718
-msgid "guestfs_luks_open"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1375 ../src/guestfs-actions.pod:2223
+msgid "If C<directory> is not a directory, then this command returns an error."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2720
-#, 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"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1378 ../src/guestfs-actions.pod:2226
+msgid "The returned list is sorted."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2725 ../fish/guestfish-actions.pod:2131
-msgid ""
-"This command opens a block device which has been encrypted according to the "
-"Linux Unified Key Setup (LUKS) standard."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1380
+msgid "See also L</find0>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2728 ../fish/guestfish-actions.pod:2134
-msgid "C<device> is the encrypted block device or partition."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1385
+msgid "find0"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:2136
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1387
+#, no-wrap
msgid ""
-"The caller must supply one of the keys associated with the LUKS block "
-"device, in the C<key> parameter."
+" find0 directory (files|-)\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2733 ../fish/guestfish-actions.pod:2139
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1389 ../src/guestfs-actions.pod:2246
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."
+"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:2737
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1393
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 command works the same way as L</find> with the following exceptions:"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2747
-msgid "guestfs_luks_open_ro"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1400 ../src/guestfs-actions.pod:2257
+msgid "The resulting list is written to an external file."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2749
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1404 ../src/guestfs-actions.pod:2261
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"
-"\n"
+"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:2754
-msgid ""
-"This is the same as C<guestfs_luks_open> except that a read-only mapping is "
-"created."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1409 ../src/guestfs-actions.pod:2266
+msgid "This command is not limited in the number of names that it can return."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2763
-msgid "guestfs_lvcreate"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1414 ../src/guestfs-actions.pod:2271
+msgid "The result list is not sorted."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1420
+msgid "findfs-label"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2765
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1422
#, no-wrap
msgid ""
-" int guestfs_lvcreate (guestfs_h *g,\n"
-"\t\tconst char *logvol,\n"
-"\t\tconst char *volgroup,\n"
-"\t\tint mbytes);\n"
+" findfs-label label\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2770 ../fish/guestfish-actions.pod:2164
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1424 ../src/guestfs-actions.pod:2285
msgid ""
-"This creates an LVM logical volume called C<logvol> on the volume group "
-"C<volgroup>, with C<size> megabytes."
+"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: =head2
-#: ../src/guestfs-actions.pod:2775
-msgid "guestfs_lvm_clear_filter"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1428
+msgid "To find the label of a filesystem, use L</vfs-label>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1430
+msgid "findfs-uuid"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2777
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1432
#, no-wrap
msgid ""
-" int guestfs_lvm_clear_filter (guestfs_h *g);\n"
+" findfs-uuid uuid\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2779
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1434 ../src/guestfs-actions.pod:2302
msgid ""
-"This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
-"see every block device."
+"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: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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1438
+msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2787
-msgid "guestfs_lvm_remove_all"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1440
+msgid "fsck"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2789
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1442
#, no-wrap
msgid ""
-" int guestfs_lvm_remove_all (guestfs_h *g);\n"
+" fsck fstype device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:2181
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2320
msgid ""
-"This command removes all LVM logical volumes, volume groups and physical "
-"volumes."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:2799
-msgid "guestfs_lvm_set_filter"
+"This runs the filesystem checker (fsck) on C<device> which should have "
+"filesystem type C<fstype>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2801
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1447 ../src/guestfs-actions.pod:2323
msgid ""
-" int guestfs_lvm_set_filter (guestfs_h *g,\n"
-"\t\tchar *const *devices);\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: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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1456 ../src/guestfs-actions.pod:2332
+msgid "Multiple status codes can be summed together."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:2195
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1460 ../src/guestfs-actions.pod:2336
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."
+"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:2821 ../fish/guestfish-actions.pod:2208
-msgid "You can filter whole block devices or individual partitions."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1465 ../src/guestfs-actions.pod:2341
+msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2823 ../fish/guestfish-actions.pod:2210
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1470 ../src/guestfs-actions.pod:2346
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."
+"This command is entirely equivalent to running C<fsck -a -t fstype device>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2829
-msgid "guestfs_lvremove"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1472
+msgid "get-append"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2831
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1474
#, no-wrap
msgid ""
-" int guestfs_lvremove (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" get-append\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2834 ../fish/guestfish-actions.pod:2218
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1476 ../src/guestfs-actions.pod:2357
msgid ""
-"Remove an LVM logical volume C<device>, where C<device> is the path to the "
-"LV, such as C</dev/VG/LV>."
+"Return the additional kernel options which are added to the guest kernel "
+"command line."
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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1479 ../src/guestfs-actions.pod:2360
+msgid "If C<NULL> then no options are added."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2842
-msgid "guestfs_lvrename"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1481
+msgid "get-attach-method"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2844
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1483
#, no-wrap
msgid ""
-" int guestfs_lvrename (guestfs_h *g,\n"
-"\t\tconst char *logvol,\n"
-"\t\tconst char *newlogvol);\n"
+" get-attach-method\n"
"\n"
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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1485
+msgid "Return the current attach method. See L</set-attach-method>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2852
-msgid "guestfs_lvresize"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1487
+msgid "get-autosync"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2854
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1489
#, no-wrap
msgid ""
-" int guestfs_lvresize (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint mbytes);\n"
+" get-autosync\n"
"\n"
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1491 ../src/guestfs-actions.pod:2385
+msgid "Get the autosync flag."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2864
-msgid "guestfs_lvresize_free"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1493
+msgid "get-direct"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2866
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1495
#, no-wrap
msgid ""
-" int guestfs_lvresize_free (guestfs_h *g,\n"
-"\t\tconst char *lv,\n"
-"\t\tint percent);\n"
+" get-direct\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:2242
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1497 ../src/guestfs-actions.pod:2396
+msgid "Return the direct appliance mode flag."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2878
-msgid "guestfs_lvs"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1499
+msgid "get-e2label"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2880
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1501
#, no-wrap
msgid ""
-" char **guestfs_lvs (guestfs_h *g);\n"
+" get-e2label device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:2252
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1503 ../src/guestfs-actions.pod:2415
msgid ""
-"List all the logical volumes detected. This is the equivalent of the L<lvs"
-"(8)> command."
+"This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2885 ../fish/guestfish-actions.pod:2255
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1506
msgid ""
-"This returns a list of the logical volume device names (eg. C</dev/"
-"VolGroup00/LogVol00>)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:2888
-msgid "See also C<guestfs_lvs_full>."
+"I<This function is deprecated.> In new code, use the L</vfs_label> call "
+"instead."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2894
-msgid "guestfs_lvs_full"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1513
+msgid "get-e2uuid"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2896
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1515
#, no-wrap
msgid ""
-" struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *g);\n"
+" get-e2uuid device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:2264
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2436
msgid ""
-"List all the logical volumes detected. This is the equivalent of the L<lvs"
-"(8)> command. The \"full\" version includes all fields."
+"This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2901
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1520
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>."
+"I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
+"instead."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2906
-msgid "guestfs_lvuuid"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1527
+msgid "get-memsize"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2908
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1529
#, no-wrap
msgid ""
-" char *guestfs_lvuuid (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" get-memsize\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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1531 ../src/guestfs-actions.pod:2449
+msgid ""
+"This gets the memory size in megabytes allocated to the qemu subprocess."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2916
-msgid "guestfs_lxattrlist"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1534
+msgid ""
+"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: verbatim
-#: ../src/guestfs-actions.pod:2918
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1538 ../fish/guestfish-actions.pod:1595
+#: ../fish/guestfish-actions.pod:4375 ../fish/guestfish-actions.pod:4477
+#: ../src/guestfs-actions.pod:2456 ../src/guestfs-actions.pod:2548
+#: ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:6886
msgid ""
-" struct guestfs_xattr_list *guestfs_lxattrlist (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tchar *const *names);\n"
-"\n"
+"For more information on the architecture of libguestfs, see L<guestfs(3)>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2277
-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."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1541
+msgid "get-network"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2926 ../fish/guestfish-actions.pod:2281
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1543
+#, no-wrap
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."
+" get-network\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2936
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1545 ../src/guestfs-actions.pod:2468
+msgid "This returns the enable network flag."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2949
-msgid "guestfs_mkdir"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1547
+msgid "get-path"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2951
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1549
#, no-wrap
msgid ""
-" int guestfs_mkdir (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" get-path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2303
-msgid "Create a directory named C<path>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2479
+msgid "Return the current search path."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2958
-msgid "guestfs_mkdir_mode"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1553 ../src/guestfs-actions.pod:2481
+msgid ""
+"This is always non-NULL. If it wasn't set already, then this will return "
+"the default path."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2960
-#, no-wrap
-msgid ""
-" int guestfs_mkdir_mode (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint mode);\n"
-"\n"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1556
+msgid "get-pgroup"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2964 ../fish/guestfish-actions.pod:2309
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1558
+#, no-wrap
msgid ""
-"This command creates a directory, setting the initial permissions of the "
-"directory to C<mode>."
+" get-pgroup\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2312
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2494
+msgid "This returns the process group flag."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2971
-msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1562
+msgid "get-pid"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2975
-msgid "guestfs_mkdir_p"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1564
+msgid "pid"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2977
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1566
#, no-wrap
msgid ""
-" int guestfs_mkdir_p (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" get-pid\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2980 ../fish/guestfish-actions.pod:2322
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1568 ../src/guestfs-actions.pod:2505
msgid ""
-"Create a directory named C<path>, creating any parent directories as "
-"necessary. This is like the C<mkdir -p> shell command."
+"Return the process ID of the qemu subprocess. If there is no qemu "
+"subprocess, then this will return an error."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:2985
-msgid "guestfs_mkdtemp"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2508
+msgid "This is an internal call used for debugging and testing."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1573
+msgid "get-qemu"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:2987
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1575
#, no-wrap
msgid ""
-" char *guestfs_mkdtemp (guestfs_h *g,\n"
-"\t\tconst char *template);\n"
+" get-qemu\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2990 ../fish/guestfish-actions.pod:2329
-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\"."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1577 ../src/guestfs-actions.pod:2519
+msgid "Return the current qemu binary."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2334
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2521
msgid ""
-"For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
-"being suitable for Windows filesystems."
-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."
+"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:3001 ../fish/guestfish-actions.pod:2340
-msgid "The temporary directory is created with mode 0700 and is owned by root."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1582
+msgid "get-recovery-proc"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2343
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1584
+#, no-wrap
msgid ""
-"The caller is responsible for deleting the temporary directory and its "
-"contents after use."
+" get-recovery-proc\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2346
-msgid "See also: L<mkdtemp(3)>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1586 ../src/guestfs-actions.pod:2534
+msgid "Return the recovery process enabled flag."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3012
-msgid "guestfs_mke2fs_J"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1588
+msgid "get-selinux"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3014
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1590
#, 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"
+" get-selinux\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2352
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1592
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 current setting of the selinux flag which is passed to the "
+"appliance at boot time. See L</set-selinux>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3024 ../fish/guestfish-actions.pod:2356
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1598
+msgid "get-smp"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1600
#, no-wrap
msgid ""
-" mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
+" get-smp\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3026
-msgid "See also C<guestfs_mke2journal>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1602 ../src/guestfs-actions.pod:2560
+msgid "This returns the number of virtual CPUs assigned to the appliance."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3030
-msgid "guestfs_mke2fs_JL"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1604
+msgid "get-state"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3032
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1606
#, 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"
+" get-state\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2364
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1608 ../src/guestfs-actions.pod:2571
msgid ""
-"This creates an ext2/3/4 filesystem on C<device> with an external journal on "
-"the journal labeled C<label>."
+"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:3041
-msgid "See also C<guestfs_mke2journal_L>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1611 ../fish/guestfish-actions.pod:2570
+#: ../fish/guestfish-actions.pod:2588 ../fish/guestfish-actions.pod:2626
+#: ../fish/guestfish-actions.pod:2642 ../src/guestfs-actions.pod:2574
+#: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3922
+#: ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:4010
+msgid "For more information on states, see L<guestfs(3)>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3045
-msgid "guestfs_mke2fs_JU"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1613
+msgid "get-trace"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3047
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1615
#, no-wrap
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"
+" get-trace\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3053 ../fish/guestfish-actions.pod:2373
-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:3056
-msgid "See also C<guestfs_mke2journal_U>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1617 ../src/guestfs-actions.pod:2585
+msgid "Return the command trace flag."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3060
-msgid "guestfs_mke2journal"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1619
+msgid "get-umask"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3062
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1621
#, no-wrap
msgid ""
-" int guestfs_mke2journal (guestfs_h *g,\n"
-"\t\tint blocksize,\n"
-"\t\tconst char *device);\n"
+" get-umask\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2382
-msgid ""
-"This creates an ext2 external journal on C<device>. It is equivalent to the "
-"command:"
-msgstr ""
-
-# type: verbatim
-#: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2385
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1623
msgid ""
-" mke2fs -O journal_dev -b blocksize device\n"
-"\n"
+"Return the current umask. By default the umask is C<022> unless it has been "
+"set by calling L</umask>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3073
-msgid "guestfs_mke2journal_L"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1626
+msgid "get-verbose"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3075
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1628
#, 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"
+" get-verbose\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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1630 ../src/guestfs-actions.pod:2608
+msgid "This returns the verbose messages flag."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3084
-msgid "guestfs_mke2journal_U"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1632
+msgid "getcon"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3086
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1634
#, 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"
+" getcon\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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2619
+msgid "This gets the SELinux security context of the daemon."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3095
-msgid "guestfs_mkfifo"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1638
+msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1641
+msgid "getxattr"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3097
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1643
#, no-wrap
msgid ""
-" int guestfs_mkfifo (guestfs_h *g,\n"
-"\t\tint mode,\n"
-"\t\tconst char *path);\n"
+" getxattr path name\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3101
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1645
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>."
+"Get a single extended attribute from file C<path> named C<name>. This call "
+"follows symlinks. If you want to lookup an extended attribute for the "
+"symlink itself, use L</lgetxattr>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3109
-msgid "guestfs_mkfs"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1649 ../fish/guestfish-actions.pod:2715
+msgid ""
+"Normally it is better to get all extended attributes from a file in one go "
+"by calling L</getxattrs>. However some Linux filesystem implementations are "
+"buggy and do not provide a way to list out attributes. For these "
+"filesystems (notably ntfs-3g) you have to know the names of the extended "
+"attributes you want in advance and call this function."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3111
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1656 ../fish/guestfish-actions.pod:2722
+#: ../src/guestfs-actions.pod:2648 ../src/guestfs-actions.pod:4143
msgid ""
-" int guestfs_mkfs (guestfs_h *g,\n"
-"\t\tconst char *fstype,\n"
-"\t\tconst char *device);\n"
-"\n"
+"Extended attribute values are blobs of binary data. If there is no extended "
+"attribute named C<name>, this returns an error."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3115 ../fish/guestfish-actions.pod:2413
-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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1659
+msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3121
-msgid "guestfs_mkfs_b"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1661
+msgid "getxattrs"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3123
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1663
#, 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"
+" getxattrs path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3128
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1665 ../src/guestfs-actions.pod:2665
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."
+"This call lists the extended attributes of the file or directory C<path>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3133 ../fish/guestfish-actions.pod:2426
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1668 ../src/guestfs-actions.pod:2668
msgid ""
-"For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
-"cluster size."
+"At the system call level, this is a combination of the L<listxattr(2)> and "
+"L<getxattr(2)> calls."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3138
-msgid "guestfs_mkmountpoint"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1671
+msgid "See also: L</lgetxattrs>, L<attr(5)>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1673
+msgid "glob-expand"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3140
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1675
#, no-wrap
msgid ""
-" int guestfs_mkmountpoint (guestfs_h *g,\n"
-"\t\tconst char *exemptpath);\n"
+" glob-expand pattern\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3143
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1677 ../src/guestfs-actions.pod:2685
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 command searches for all the pathnames matching C<pattern> according to "
+"the wildcard expansion rules used by the shell."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3147 ../fish/guestfish-actions.pod:2437
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1681 ../src/guestfs-actions.pod:2689
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."
+"If no paths match, then this returns an empty list (note: not an error)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2441
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1684 ../src/guestfs-actions.pod:2692
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:"
+"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: =head2
+#: ../fish/guestfish-actions.pod:1688
+msgid "grep"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:2446
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1690
#, 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"
+" grep regex path\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1692 ../src/guestfs-actions.pod:2709
+msgid "This calls the external C<grep> program and returns the matching lines."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3169
-msgid "guestfs_mknod"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1698
+msgid "grepi"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3171
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1700
#, 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"
+" grepi regex path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3177 ../fish/guestfish-actions.pod:2461
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1702 ../src/guestfs-actions.pod:2728
msgid ""
-"This call creates block or character special devices, or named pipes (FIFOs)."
+"This calls the external C<grep -i> program and returns the matching lines."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2464
-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."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1708
+msgid "grub-install"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3185
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1710
+#, no-wrap
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."
+" grub-install root device\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3197
-msgid "guestfs_mknod_b"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1712 ../src/guestfs-actions.pod:2747
+msgid ""
+"This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
+"with the root directory being C<root>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3199
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1721 ../src/guestfs-actions.pod:2756
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"
-"\n"
+"There is currently no way in the API to install grub2, which is used by most "
+"modern Linux guests. It is possible to run the grub2 command from the "
+"guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3205
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1728 ../src/guestfs-actions.pod:2763
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 uses C<grub-install> from the host. Unfortunately grub is not always "
+"compatible with itself, so this only works in rather narrow circumstances. "
+"Careful testing with each guest version is advisable."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3213
-msgid "guestfs_mknod_c"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1735 ../src/guestfs-actions.pod:2770
+msgid ""
+"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:3215
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2777
#, 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"
+" (hd0) /dev/vda\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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1744 ../src/guestfs-actions.pod:2779
+msgid "replacing C</dev/vda> with the name of the installation device."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3229
-msgid "guestfs_mkswap"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1748
+msgid "head"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3231
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1750
#, no-wrap
msgid ""
-" int guestfs_mkswap (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" head path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2503
-msgid "Create a swap partition on C<device>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2793
+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:3238
-msgid "guestfs_mkswap_L"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1758
+msgid "head-n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3240
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1760
#, no-wrap
msgid ""
-" int guestfs_mkswap_L (guestfs_h *g,\n"
-"\t\tconst char *label,\n"
-"\t\tconst char *device);\n"
+" head-n nrlines 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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2812
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."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:3252
-msgid "guestfs_mkswap_U"
+"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:3254
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1765 ../src/guestfs-actions.pod:2815
msgid ""
-" int guestfs_mkswap_U (guestfs_h *g,\n"
-"\t\tconst char *uuid,\n"
-"\t\tconst char *device);\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:3258 ../fish/guestfish-actions.pod:2519
-msgid "Create a swap partition on C<device> with UUID C<uuid>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1768 ../fish/guestfish-actions.pod:4867
+#: ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:7474
+msgid "If the parameter C<nrlines> is zero, this returns an empty list."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3262
-msgid "guestfs_mkswap_file"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1773
+msgid "hexdump"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3264
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1775
#, no-wrap
msgid ""
-" int guestfs_mkswap_file (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" hexdump path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2525
-msgid "Create a swap file."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3269
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1777 ../src/guestfs-actions.pod:2835
msgid ""
-"This command just writes a swap file signature to an existing file. To "
-"create the file itself, use something like C<guestfs_fallocate>."
+"This runs C<hexdump -C> on the given C<path>. The result is the human-"
+"readable, canonical hex dump of the file."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3274
-msgid "guestfs_modprobe"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1783
+msgid "initrd-cat"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3276
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1785
#, no-wrap
msgid ""
-" int guestfs_modprobe (guestfs_h *g,\n"
-"\t\tconst char *modulename);\n"
+" initrd-cat initrdpath filename\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2534
-msgid "This loads a kernel module in the appliance."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3281 ../fish/guestfish-actions.pod:2536
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1787 ../src/guestfs-actions.pod:2854
msgid ""
-"The kernel module must have been whitelisted when libguestfs was built (see "
-"C<appliance/kmod.whitelist.in> in the source)."
+"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:3286
-msgid "guestfs_mount"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1791 ../src/guestfs-actions.pod:2858
+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:3288
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1795 ../src/guestfs-actions.pod:2862
#, no-wrap
msgid ""
-" int guestfs_mount (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *mountpoint);\n"
+" initrd-cat /boot/initrd-<version>.img init\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3292 ../fish/guestfish-actions.pod:2543
-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."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:3298 ../fish/guestfish-actions.pod:2549
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1797
+msgid "See also L</initrd-list>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2554
-msgid ""
-"The mounted filesystem is writable, if we have sufficient permissions on the "
-"underlying device."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1802
+msgid "initrd-list"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3306
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1804
+#, no-wrap
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)."
+" initrd-list path\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3318
-msgid "guestfs_mount_loop"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1806 ../src/guestfs-actions.pod:2881
+msgid "This command lists out files contained in an initrd."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3320
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2883
msgid ""
-" int guestfs_mount_loop (guestfs_h *g,\n"
-"\t\tconst char *file,\n"
-"\t\tconst char *mountpoint);\n"
-"\n"
+"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:3324 ../fish/guestfish-actions.pod:2571
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1812 ../src/guestfs-actions.pod:2887
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>."
+"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:3330
-msgid "guestfs_mount_options"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1816
+msgid "inotify-add-watch"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3332
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1818
#, 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"
+" inotify-add-watch path mask\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3337
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1820 ../src/guestfs-actions.pod:2904
+msgid "Watch C<path> for the events listed in C<mask>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2906
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."
+"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:3341 ../fish/guestfish-actions.pod:2583
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1826 ../src/guestfs-actions.pod:2910
msgid ""
-"If the C<options> parameter is an empty string, then no options are passed "
-"(all options default to whatever the filesystem uses)."
+"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:3347
-msgid "guestfs_mount_ro"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1830
+msgid "inotify-close"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3349
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1832
#, no-wrap
msgid ""
-" int guestfs_mount_ro (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *mountpoint);\n"
+" inotify-close\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3353
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1834 ../src/guestfs-actions.pod:2923
msgid ""
-"This is the same as the C<guestfs_mount> command, but it mounts the "
-"filesystem with the read-only (I<-o ro>) flag."
+"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:3358
-msgid "guestfs_mount_vfs"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1838
+msgid "inotify-files"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3360
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1840
#, 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"
+" inotify-files\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3366
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1842
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 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
-#: ../src/guestfs-actions.pod:3372
-msgid "guestfs_mountpoints"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1846
+msgid "inotify-init"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3374
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1848
#, no-wrap
msgid ""
-" char **guestfs_mountpoints (guestfs_h *g);\n"
+" inotify-init maxevents\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3376
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1850 ../src/guestfs-actions.pod:2952
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."
+"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:3386
-msgid "guestfs_mounts"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1854
+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
-#: ../src/guestfs-actions.pod:3388
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1864
msgid ""
-" char **guestfs_mounts (guestfs_h *g);\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
-#: ../src/guestfs-actions.pod:3390 ../fish/guestfish-actions.pod:2614
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1870
msgid ""
-"This returns the list of currently mounted filesystems. It returns the list "
-"of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
+"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
-#: ../src/guestfs-actions.pod:3393 ../fish/guestfish-actions.pod:2617
-msgid "Some internal mounts are not shown."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1877
+msgid ""
+"The handle should be closed after use by calling L</inotify-close>. This "
+"also removes any watches automatically."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3395
-msgid "See also: C<guestfs_mountpoints>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2983
+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:3401
-msgid "guestfs_mv"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1886
+msgid "inotify-read"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3403
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1888
#, no-wrap
msgid ""
-" int guestfs_mv (guestfs_h *g,\n"
-"\t\tconst char *src,\n"
-"\t\tconst char *dest);\n"
+" inotify-read\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3407 ../fish/guestfish-actions.pod:2625
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1890 ../src/guestfs-actions.pod:2997
msgid ""
-"This moves a file from C<src> to C<dest> where C<dest> is either a "
-"destination filename or destination directory."
+"Return the complete queue of events that have happened since the previous "
+"read call."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3412
-msgid "guestfs_ntfs_3g_probe"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1893 ../src/guestfs-actions.pod:3000
+msgid "If no events have happened, this returns an empty list."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3414
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1895 ../src/guestfs-actions.pod:3002
msgid ""
-" int guestfs_ntfs_3g_probe (guestfs_h *g,\n"
-"\t\tint rw,\n"
-"\t\tconst char *device);\n"
-"\n"
+"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: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)."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1901
+msgid "inotify-rm-watch"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3422 ../fish/guestfish-actions.pod:2636
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1903
+#, no-wrap
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."
+" inotify-rm-watch wd\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3426 ../fish/guestfish-actions.pod:2640
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1905
+msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3432
-msgid "guestfs_ntfsresize"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1908
+msgid "inspect-get-arch"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3434
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1910
#, no-wrap
msgid ""
-" int guestfs_ntfsresize (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" inspect-get-arch root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3437 ../fish/guestfish-actions.pod:2648
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1912
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:3443
-msgid "guestfs_ntfsresize_size"
+"This returns the architecture of the inspected operating system. The "
+"possible return values are listed under L</file-architecture>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3445
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1916 ../src/guestfs-actions.pod:3037
msgid ""
-" int guestfs_ntfsresize_size (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint64_t size);\n"
-"\n"
+"If the architecture could not be determined, then the string C<unknown> is "
+"returned."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1919 ../fish/guestfish-actions.pod:2014
+#: ../fish/guestfish-actions.pod:2093 ../fish/guestfish-actions.pod:2105
+#: ../fish/guestfish-actions.pod:2189 ../fish/guestfish-actions.pod:2251
+#: ../fish/guestfish-actions.pod:2272 ../fish/guestfish-actions.pod:2286
+#: ../fish/guestfish-actions.pod:2326 ../fish/guestfish-actions.pod:2362
+#: ../fish/guestfish-actions.pod:2375 ../fish/guestfish-actions.pod:2388
+#: ../fish/guestfish-actions.pod:2398 ../fish/guestfish-actions.pod:2408
+#: ../fish/guestfish-actions.pod:2420 ../fish/guestfish-actions.pod:2516
+#: ../fish/guestfish-actions.pod:2550 ../src/guestfs-actions.pod:3040
+#: ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3246
+#: ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3396
+#: ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3508
+#: ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3582
+#: ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3646
+#: ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3683
+#: ../src/guestfs-actions.pod:3699 ../src/guestfs-actions.pod:3717
+#: ../src/guestfs-actions.pod:3819 ../src/guestfs-actions.pod:3860
+msgid "Please read L<guestfs(3)/INSPECTION> for more details."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3454
-msgid "guestfs_part_add"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:1921
+msgid "inspect-get-distro"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3456
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:1923
#, 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"
+" inspect-get-distro root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3462
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1925 ../src/guestfs-actions.pod:3053
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 returns the distro (distribution) of the inspected operating system."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1928 ../src/guestfs-actions.pod:3056
+msgid "Currently defined distros are:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3470 ../fish/guestfish-actions.pod:2671
-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)."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1932 ../src/guestfs-actions.pod:3060
+msgid "\"archlinux\""
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1934 ../src/guestfs-actions.pod:3062
+msgid "Arch Linux."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3479
-msgid "guestfs_part_del"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1936 ../src/guestfs-actions.pod:3064
+msgid "\"centos\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3481
-#, no-wrap
-msgid ""
-" int guestfs_part_del (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1938 ../src/guestfs-actions.pod:3066
+msgid "CentOS."
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>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:3068
+msgid "\"debian\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3487 ../fish/guestfish-actions.pod:2684
-msgid ""
-"Note that in the case of MBR partitioning, deleting an extended partition "
-"also deletes any logical partitions it contains."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1942 ../src/guestfs-actions.pod:3070
+msgid "Debian."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3493
-msgid "guestfs_part_disk"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1944 ../src/guestfs-actions.pod:3072
+msgid "\"fedora\""
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"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:3074
+msgid "Fedora."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3499
-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."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1948 ../src/guestfs-actions.pod:3076
+msgid "\"gentoo\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3503
-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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1950 ../src/guestfs-actions.pod:3078
+msgid "Gentoo."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3511
-msgid "guestfs_part_get_bootable"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1952 ../src/guestfs-actions.pod:3080
+msgid "\"linuxmint\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3513
-#, no-wrap
-msgid ""
-" int guestfs_part_get_bootable (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:3082
+msgid "Linux Mint."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3517 ../fish/guestfish-actions.pod:2706
-msgid ""
-"This command returns true if the partition C<partnum> on C<device> has the "
-"bootable flag set."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1956 ../src/guestfs-actions.pod:3084
+msgid "\"mageia\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3520
-msgid "See also C<guestfs_part_set_bootable>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1958 ../src/guestfs-actions.pod:3086
+msgid "Mageia."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3524
-msgid "guestfs_part_get_mbr_id"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1960 ../src/guestfs-actions.pod:3088
+msgid "\"mandriva\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3526
-#, no-wrap
-msgid ""
-" int guestfs_part_get_mbr_id (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1962 ../src/guestfs-actions.pod:3090
+msgid "Mandriva."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3530 ../fish/guestfish-actions.pod:2715
-msgid ""
-"Returns the MBR type byte (also known as the ID byte) from the numbered "
-"partition C<partnum>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1964 ../src/guestfs-actions.pod:3092
+msgid "\"meego\""
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>)."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1966 ../src/guestfs-actions.pod:3094
+msgid "MeeGo."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3539
-msgid "guestfs_part_get_parttype"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:3096
+msgid "\"opensuse\""
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3541
-#, no-wrap
-msgid ""
-" char *guestfs_part_get_parttype (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1970 ../src/guestfs-actions.pod:3098
+msgid "OpenSUSE."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3544 ../fish/guestfish-actions.pod:2726
-msgid ""
-"This command examines the partition table on C<device> and returns the "
-"partition table type (format) being used."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1972 ../src/guestfs-actions.pod:3100
+msgid "\"pardus\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3547
-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:3555
-msgid "guestfs_part_init"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1974 ../src/guestfs-actions.pod:3102
+msgid "Pardus."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3557
-#, no-wrap
-msgid ""
-" int guestfs_part_init (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *parttype);\n"
-"\n"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1976 ../src/guestfs-actions.pod:3104
+msgid "\"redhat-based\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3561 ../fish/guestfish-actions.pod:2738
-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)."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1978 ../src/guestfs-actions.pod:3106
+msgid "Some Red Hat-derived distro."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3565
-msgid ""
-"Initially there are no partitions. Following this, you should call "
-"C<guestfs_part_add> for each partition required."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:3108
+msgid "\"rhel\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3568 ../fish/guestfish-actions.pod:2745
-msgid "Possible values for C<parttype> are:"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:3110
+msgid "Red Hat Enterprise Linux."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3572 ../fish/guestfish-actions.pod:2749
-msgid "B<efi> | B<gpt>"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1984 ../src/guestfs-actions.pod:3112
+msgid "\"scientificlinux\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3574 ../fish/guestfish-actions.pod:2751
-msgid "Intel EFI / GPT partition table."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1986 ../src/guestfs-actions.pod:3114
+msgid "Scientific Linux."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2753
-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."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1988 ../src/guestfs-actions.pod:3116
+msgid "\"slackware\""
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3580 ../fish/guestfish-actions.pod:2757
-msgid "B<mbr> | B<msdos>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1990 ../src/guestfs-actions.pod:3118
+msgid "Slackware."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3582 ../fish/guestfish-actions.pod:2759
-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>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:1992 ../src/guestfs-actions.pod:3120
+msgid "\"ttylinux\""
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:"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1994 ../src/guestfs-actions.pod:3122
+msgid "ttylinux."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3594 ../fish/guestfish-actions.pod:2771
-msgid "B<aix>"
+#. type: =item
+#: ../fish/guestfish-actions.pod:1996 ../src/guestfs-actions.pod:3124
+msgid "\"ubuntu\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3596 ../fish/guestfish-actions.pod:2773
-msgid "AIX disk labels."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:1998 ../src/guestfs-actions.pod:3126
+msgid "Ubuntu."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3598 ../fish/guestfish-actions.pod:2775
-msgid "B<amiga> | B<rdb>"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2000 ../fish/guestfish-actions.pod:2084
+#: ../fish/guestfish-actions.pod:2353 ../src/guestfs-actions.pod:3128
+#: ../src/guestfs-actions.pod:3237 ../src/guestfs-actions.pod:3617
+msgid "\"unknown\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3600 ../fish/guestfish-actions.pod:2777
-msgid "Amiga \"Rigid Disk Block\" format."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2002 ../src/guestfs-actions.pod:3130
+msgid "The distro could not be determined."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3602 ../fish/guestfish-actions.pod:2779
-msgid "B<bsd>"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2004 ../fish/guestfish-actions.pod:2341
+#: ../src/guestfs-actions.pod:3132 ../src/guestfs-actions.pod:3605
+msgid "\"windows\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3604 ../fish/guestfish-actions.pod:2781
-msgid "BSD disk labels."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2006 ../src/guestfs-actions.pod:3134
+msgid ""
+"Windows does not have distributions. This string is returned if the OS type "
+"is Windows."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3606 ../fish/guestfish-actions.pod:2783
-msgid "B<dasd>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2090
+#: ../fish/guestfish-actions.pod:2359 ../src/guestfs-actions.pod:3139
+#: ../src/guestfs-actions.pod:3243 ../src/guestfs-actions.pod:3623
+msgid ""
+"Future versions of libguestfs may return other strings here. The caller "
+"should be prepared to handle any string."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2785
-msgid "DASD, used on IBM mainframes."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2016
+msgid "inspect-get-drive-mappings"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2787
-msgid "B<dvh>"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2018
+#, no-wrap
+msgid ""
+" inspect-get-drive-mappings root\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3612 ../fish/guestfish-actions.pod:2789
-msgid "MIPS/SGI volumes."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2020 ../src/guestfs-actions.pod:3155
+msgid ""
+"This call is useful for Windows which uses a primitive system of assigning "
+"drive letters (like \"C:\") to partitions. This inspection API examines the "
+"Windows Registry to find out how disks/partitions are mapped to drive "
+"letters, and returns a hash table as in the example below:"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3614 ../fish/guestfish-actions.pod:2791
-msgid "B<mac>"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2026 ../src/guestfs-actions.pod:3161
+#, no-wrap
+msgid ""
+" C => /dev/vda2\n"
+" E => /dev/vdb1\n"
+" F => /dev/vdc1\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3616 ../fish/guestfish-actions.pod:2793
-msgid "Old Mac partition format. Modern Macs use C<gpt>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2030 ../src/guestfs-actions.pod:3165
+msgid ""
+"Note that keys are drive letters. For Windows, the key is case insensitive "
+"and just contains the drive letter, without the customary colon separator "
+"character."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3618 ../fish/guestfish-actions.pod:2795
-msgid "B<pc98>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2034 ../src/guestfs-actions.pod:3169
+msgid ""
+"In future we may support other operating systems that also used drive "
+"letters, but the keys for those might not be case insensitive and might be "
+"longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
+"C<h1> etc."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2797
-msgid "NEC PC-98 format, common in Japan apparently."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2039 ../src/guestfs-actions.pod:3174
+msgid ""
+"For Windows guests, currently only hard drive mappings are returned. "
+"Removable disks (eg. DVD-ROMs) are ignored."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3622 ../fish/guestfish-actions.pod:2799
-msgid "B<sun>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2042 ../src/guestfs-actions.pod:3177
+msgid ""
+"For guests that do not use drive mappings, or if the drive mappings could "
+"not be determined, this returns an empty hash table."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3624 ../fish/guestfish-actions.pod:2801
-msgid "Sun disk labels."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2045
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
+"get-mountpoints>, L</inspect-get-filesystems>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3630
-msgid "guestfs_part_list"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2049
+msgid "inspect-get-filesystems"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3632
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2051
#, no-wrap
msgid ""
-" struct guestfs_partition_list *guestfs_part_list (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" inspect-get-filesystems root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3635 ../fish/guestfish-actions.pod:2809
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2053 ../src/guestfs-actions.pod:3198
msgid ""
-"This command parses the partition table on C<device> and returns the list of "
-"partitions found."
+"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:3638 ../fish/guestfish-actions.pod:2812
-msgid "The fields in the returned structure are:"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2058 ../src/guestfs-actions.pod:3203
+msgid ""
+"In the case of a multi-boot virtual machine, it is possible for a filesystem "
+"to be shared between operating systems."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3642 ../fish/guestfish-actions.pod:2816
-msgid "B<part_num>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2061
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
+"get-mountpoints>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3644 ../fish/guestfish-actions.pod:2818
-msgid "Partition number, counting from 1."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2064
+msgid "inspect-get-format"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3646 ../fish/guestfish-actions.pod:2820
-msgid "B<part_start>"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2066
+#, no-wrap
+msgid ""
+" inspect-get-format root\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3648
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3221
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 returns the format of the inspected operating system. You can use it "
+"to detect install images, live CDs and similar."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3651 ../fish/guestfish-actions.pod:2825
-msgid "B<part_end>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2071 ../src/guestfs-actions.pod:3224
+msgid "Currently defined formats are:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2827
-msgid "End of the partition in bytes."
+#. type: =item
+#: ../fish/guestfish-actions.pod:2075 ../src/guestfs-actions.pod:3228
+msgid "\"installed\""
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3655 ../fish/guestfish-actions.pod:2829
-msgid "B<part_size>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2077 ../src/guestfs-actions.pod:3230
+msgid "This is an installed operating system."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2831
-msgid "Size of the partition in bytes."
+#. type: =item
+#: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3232
+msgid "\"installer\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3661
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2081 ../src/guestfs-actions.pod:3234
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>."
+"The disk image being inspected is not an installed operating system, but a "
+"I<bootable> install disk, live CD, or similar."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3666
-msgid "guestfs_part_set_bootable"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2086 ../src/guestfs-actions.pod:3239
+msgid "The format of this disk image is not known."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2095
+msgid "inspect-get-hostname"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3668
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2097
#, 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"
+" inspect-get-hostname root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2839
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2099 ../src/guestfs-actions.pod:3259
msgid ""
-"This sets the bootable flag on partition numbered C<partnum> on device "
-"C<device>. Note that partitions are numbered from 1."
+"This function returns the hostname of the operating system as found by "
+"inspection of the guest's configuration files."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3676 ../fish/guestfish-actions.pod:2842
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2102 ../src/guestfs-actions.pod:3262
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."
+"If the hostname could not be determined, then the string C<unknown> is "
+"returned."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3682
-msgid "guestfs_part_set_mbr_id"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2107
+msgid "inspect-get-icon"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3684
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2109
#, 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"
+" inspect-get-icon root [favicon:..] [highquality:..]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2850
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2111 ../src/guestfs-actions.pod:3288
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."
+"This function returns an icon corresponding to the inspected operating "
+"system. The icon is returned as a buffer containing a PNG image (re-encoded "
+"to PNG if necessary)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3701
-msgid "guestfs_part_set_name"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2115 ../src/guestfs-actions.pod:3292
+msgid ""
+"If it was not possible to get an icon this function returns a zero-length "
+"(non-NULL) buffer. I<Callers must check for this case>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3703
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2118 ../src/guestfs-actions.pod:3295
msgid ""
-" int guestfs_part_set_name (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint partnum,\n"
-"\t\tconst char *name);\n"
-"\n"
+"Libguestfs will start by looking for a file called C</etc/favicon.png> or "
+"C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
+"this file will be returned. You can disable favicons by passing the "
+"optional C<favicon> boolean as false (default is true)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3708 ../fish/guestfish-actions.pod:2864
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2124 ../src/guestfs-actions.pod:3301
msgid ""
-"This sets the partition name on partition numbered C<partnum> on device "
-"C<device>. Note that partitions are numbered from 1."
+"If finding the favicon fails, then we look in other places in the guest for "
+"a suitable icon."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3711 ../fish/guestfish-actions.pod:2867
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2127 ../src/guestfs-actions.pod:3304
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."
+"If the optional C<highquality> boolean is true then only high quality icons "
+"are returned, which means only icons of high resolution with an alpha "
+"channel. The default (false) is to return any icon we can, even if it is of "
+"substandard quality."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3716
-msgid "guestfs_ping_daemon"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3315
+msgid ""
+"Unlike most other inspection API calls, the guest's disks must be mounted up "
+"before you call this, since it needs to read information from the guest "
+"filesystem during the call."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3718
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3321
msgid ""
-" int guestfs_ping_daemon (guestfs_h *g);\n"
-"\n"
+"B<Security:> The icon data comes from the untrusted guest, and should be "
+"treated with caution. PNG files have been known to contain exploits. "
+"Ensure that libpng (or other relevant libraries) are fully up to date before "
+"trying to process or display the icon."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3720 ../fish/guestfish-actions.pod:2874
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3329
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."
+"The PNG image returned can be any size. It might not be square. Libguestfs "
+"tries to return the largest, highest quality icon available. The "
+"application must scale the icon to the required size."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3727
-msgid "guestfs_pread"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2159 ../src/guestfs-actions.pod:3336
+msgid ""
+"Extracting icons from Windows guests requires the external C<wrestool> "
+"program from the C<icoutils> package, and several programs (C<bmptopnm>, "
+"C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
+"installed separately."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2166 ../src/guestfs-actions.pod:3343
+msgid ""
+"Operating system icons are usually trademarks. Seek legal advice before "
+"using trademarks in applications."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2173
+msgid "inspect-get-major-version"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3729
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2175
#, 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"
+" inspect-get-major-version root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3735 ../fish/guestfish-actions.pod:2883
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2177 ../src/guestfs-actions.pod:3384
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>."
+"This returns the major version number of the inspected operating system."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2886
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2180 ../src/guestfs-actions.pod:3387
msgid ""
-"This may read fewer bytes than requested. For further details see the "
-"L<pread(2)> system call."
+"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:3741
-msgid "See also C<guestfs_pwrite>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2187 ../fish/guestfish-actions.pod:2198
+#: ../src/guestfs-actions.pod:3394 ../src/guestfs-actions.pod:3411
+msgid "If the version could not be determined, then C<0> is returned."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3750
-msgid "guestfs_pvcreate"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2191
+msgid "inspect-get-minor-version"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3752
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2193
#, no-wrap
msgid ""
-" int guestfs_pvcreate (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" inspect-get-minor-version root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3755 ../fish/guestfish-actions.pod:2898
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2195 ../src/guestfs-actions.pod:3408
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>."
+"This returns the minor version number of the inspected operating system."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3761
-msgid "guestfs_pvremove"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2200
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
+"get-major-version>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2203
+msgid "inspect-get-mountpoints"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3763
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2205
#, no-wrap
msgid ""
-" int guestfs_pvremove (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" inspect-get-mountpoints root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3766 ../fish/guestfish-actions.pod:2906
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3426
msgid ""
-"This wipes a physical volume C<device> so that LVM will no longer recognise "
-"it."
+"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>. I<In particular note> that this may return filesystems which are "
+"non-existent or not mountable and callers should be prepared to handle or "
+"ignore failures if they try to mount them."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2909
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2216 ../src/guestfs-actions.pod:3435
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."
+"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: =head2
-#: ../src/guestfs-actions.pod:3775
-msgid "guestfs_pvresize"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2221 ../src/guestfs-actions.pod:3440
+msgid ""
+"Non-mounted devices such as swap devices are I<not> returned in this list."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3777
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2224
msgid ""
-" int guestfs_pvresize (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+"For operating systems like Windows which still use drive letters, this call "
+"will only return an entry for the first drive \"mounted on\" C</>. For "
+"information about the mapping of drive letters to partitions, see L</inspect-"
+"get-drive-mappings>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3780 ../fish/guestfish-actions.pod:2917
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2230
msgid ""
-"This resizes (expands or shrinks) an existing LVM physical volume to match "
-"the new size of the underlying device."
+"Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
+"get-filesystems>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3785
-msgid "guestfs_pvresize_size"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2233
+msgid "inspect-get-package-format"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3787
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2235
#, no-wrap
msgid ""
-" int guestfs_pvresize_size (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint64_t size);\n"
+" inspect-get-package-format root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3791
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2237
msgid ""
-"This command is the same as C<guestfs_pvresize> except that it allows you to "
-"specify the new size (in bytes) explicitly."
+"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
-#: ../src/guestfs-actions.pod:3796
-msgid "guestfs_pvs"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2243 ../src/guestfs-actions.pod:3472
+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
+#: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3476
+msgid ""
+"Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, "
+"C<pkgsrc>. Future versions of libguestfs may return other strings."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2253
+msgid "inspect-get-package-management"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3798
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2255
#, no-wrap
msgid ""
-" char **guestfs_pvs (guestfs_h *g);\n"
+" inspect-get-package-management root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3800 ../fish/guestfish-actions.pod:2931
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2257
msgid ""
-"List all the physical volumes detected. This is the equivalent of the L<pvs"
-"(8)> command."
+"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: textblock
-#: ../src/guestfs-actions.pod:3803 ../fish/guestfish-actions.pod:2934
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2263 ../src/guestfs-actions.pod:3499
msgid ""
-"This returns a list of just the device names that contain PVs (eg. C</dev/"
-"sda2>)."
+"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:3806
-msgid "See also C<guestfs_pvs_full>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3503
+msgid ""
+"Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
+"derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>. Future "
+"versions of libguestfs may return other strings."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3812
-msgid "guestfs_pvs_full"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2274
+msgid "inspect-get-product-name"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3814
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2276
#, no-wrap
msgid ""
-" struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *g);\n"
+" inspect-get-product-name root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3816 ../fish/guestfish-actions.pod:2943
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3521
msgid ""
-"List all the physical volumes detected. This is the equivalent of the L<pvs"
-"(8)> command. The \"full\" version includes all fields."
+"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:3819
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2283 ../src/guestfs-actions.pod:3526
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>."
+"If the product name could not be determined, then the string C<unknown> is "
+"returned."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3824
-msgid "guestfs_pvuuid"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2288
+msgid "inspect-get-product-variant"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3826
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2290
#, no-wrap
msgid ""
-" char *guestfs_pvuuid (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" inspect-get-product-variant root\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>."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:3834
-msgid "guestfs_pwrite"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2292 ../src/guestfs-actions.pod:3542
+msgid "This returns the product variant of the inspected operating system."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3836
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2295 ../src/guestfs-actions.pod:3545
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"
+"For Windows guests, this returns the contents of the Registry key C<HKLM"
+"\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
+"is usually a string such as C<Client> or C<Server> (other values are "
+"possible). This can be used to distinguish consumer and enterprise versions "
+"of Windows that have the same version number (for example, Windows 7 and "
+"Windows 2008 Server are both version 6.1, but the former is C<Client> and "
+"the latter is C<Server>)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3842 ../fish/guestfish-actions.pod:2956
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2304 ../src/guestfs-actions.pod:3554
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>."
+"For enterprise Linux guests, in future we intend this to return the product "
+"variant such as C<Desktop>, C<Server> and so on. But this is not "
+"implemented at present."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3845 ../fish/guestfish-actions.pod:2959
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3558
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."
+"If the product variant could not be determined, then the string C<unknown> "
+"is returned."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3851
-msgid "See also C<guestfs_pread>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2311
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
+"get-product-name>, L</inspect-get-major-version>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3858
-msgid "guestfs_read_file"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2315
+msgid "inspect-get-roots"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3860
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2317
#, no-wrap
msgid ""
-" char *guestfs_read_file (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tsize_t *size_r);\n"
+" inspect-get-roots\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2319
+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: textblock
-#: ../src/guestfs-actions.pod:3867
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2323
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."
+"This returns an empty list if either no root devices were found or the "
+"caller has not called L</inspect-os>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3879
-msgid "guestfs_read_lines"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2328
+msgid "inspect-get-type"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3881
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2330
#, no-wrap
msgid ""
-" char **guestfs_read_lines (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" inspect-get-type root\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2991
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3596
msgid ""
-"The file contents are returned as a list of lines. Trailing C<LF> and "
-"C<CRLF> character sequences are I<not> returned."
+"This returns the type of the inspected operating system. Currently defined "
+"types are:"
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."
+#. type: =item
+#: ../fish/guestfish-actions.pod:2337 ../src/guestfs-actions.pod:3601
+msgid "\"linux\""
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3898
-msgid "guestfs_readdir"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2339 ../src/guestfs-actions.pod:3603
+msgid "Any Linux-based operating system."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3900
-#, no-wrap
-msgid ""
-" struct guestfs_dirent_list *guestfs_readdir (guestfs_h *g,\n"
-"\t\tconst char *dir);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3607
+msgid "Any Microsoft Windows operating system."
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>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3609
+msgid "\"freebsd\""
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3611
+msgid "FreeBSD."
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:"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:3014
-msgid "'b'"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3613
+msgid "\"netbsd\""
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3916 ../fish/guestfish-actions.pod:3016
-msgid "Block special"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2351 ../src/guestfs-actions.pod:3615
+msgid "NetBSD."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3918 ../fish/guestfish-actions.pod:3018
-msgid "'c'"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3619
+msgid "The operating system type could not be determined."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3920 ../fish/guestfish-actions.pod:3020
-msgid "Char special"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2364
+msgid "inspect-get-windows-current-control-set"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:3022
-msgid "'d'"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2366
+#, no-wrap
+msgid ""
+" inspect-get-windows-current-control-set root\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3924 ../fish/guestfish-actions.pod:3024
-msgid "Directory"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3639
+msgid ""
+"This returns the Windows CurrentControlSet of the inspected guest. The "
+"CurrentControlSet is a registry key name such as C<ControlSet001>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:3026
-msgid "'f'"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2371 ../src/guestfs-actions.pod:3642
+msgid ""
+"This call assumes that the guest is Windows and that the Registry could be "
+"examined by inspection. If this is not the case then an error is returned."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3928 ../fish/guestfish-actions.pod:3028
-msgid "FIFO (named pipe)"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2377
+msgid "inspect-get-windows-systemroot"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3930 ../fish/guestfish-actions.pod:3030
-msgid "'l'"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2379
+#, no-wrap
+msgid ""
+" inspect-get-windows-systemroot root\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3932 ../fish/guestfish-actions.pod:3032
-msgid "Symbolic link"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2381 ../src/guestfs-actions.pod:3659
+msgid ""
+"This returns the Windows systemroot of the inspected guest. The systemroot "
+"is a directory path such as C</WINDOWS>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3934 ../fish/guestfish-actions.pod:3034
-msgid "'r'"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2384 ../src/guestfs-actions.pod:3662
+msgid ""
+"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:3936 ../fish/guestfish-actions.pod:3036
-msgid "Regular file"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2390
+msgid "inspect-is-live"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:3038
-msgid "'s'"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2392
+#, no-wrap
+msgid ""
+" inspect-is-live root\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3940 ../fish/guestfish-actions.pod:3040
-msgid "Socket"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2394
+msgid ""
+"If L</inspect-get-format> returns C<installer> (this is an install disk), "
+"then this returns true if a live image was detected on the disk."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3942 ../fish/guestfish-actions.pod:3042
-msgid "'u'"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2400
+msgid "inspect-is-multipart"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:3044
-msgid "Unknown file type"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2402
+#, no-wrap
+msgid ""
+" inspect-is-multipart root\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:3946 ../fish/guestfish-actions.pod:3046
-msgid "'?'"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2404
+msgid ""
+"If L</inspect-get-format> returns C<installer> (this is an install disk), "
+"then this returns true if the disk is part of a set."
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: =head2
+#: ../fish/guestfish-actions.pod:2410
+msgid "inspect-is-netinst"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3953
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2412
+#, no-wrap
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>."
+" inspect-is-netinst root\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3957
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2414
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>."
+"If L</inspect-get-format> returns C<installer> (this is an install disk), "
+"then this returns true if the disk is a network installer, ie. not a self-"
+"contained install CD but one which is likely to require network access to "
+"complete the install."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:3962
-msgid "guestfs_readlink"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2422
+msgid "inspect-list-applications"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3964
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2424
#, no-wrap
msgid ""
-" char *guestfs_readlink (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" inspect-list-applications root\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."
-msgstr ""
-
-# type: =head2
-#: ../src/guestfs-actions.pod:3972
-msgid "guestfs_readlinklist"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2426 ../src/guestfs-actions.pod:3729
+msgid "Return the list of applications installed in the operating system."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:3974
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2428
msgid ""
-" char **guestfs_readlinklist (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tchar *const *names);\n"
-"\n"
+"I<Note:> This call works differently from other parts of the inspection "
+"API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
+"then mount up the disks, before calling this. Listing applications is a "
+"significantly more difficult operation which requires access to the full "
+"filesystem. Also note that unlike the other L</inspect-get-*> calls which "
+"are just returning data cached in the libguestfs handle, this call actually "
+"reads parts of the mounted filesystems during the call."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3978 ../fish/guestfish-actions.pod:3067
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2438 ../src/guestfs-actions.pod:3741
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."
+"This returns an empty list if the inspection code was not able to determine "
+"the list of applications."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3982 ../fish/guestfish-actions.pod:3071
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2441 ../src/guestfs-actions.pod:3744
+msgid "The application structure contains the following fields:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3986 ../fish/guestfish-actions.pod:3075
-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)."
+#. type: =item
+#: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3748
+msgid "C<app_name>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:3082
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2447 ../src/guestfs-actions.pod:3750
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."
+"The name of the application. For Red Hat-derived and Debian-derived Linux "
+"guests, this is the package name."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4004
-msgid "guestfs_realpath"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2450 ../src/guestfs-actions.pod:3753
+msgid "C<app_display_name>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4006
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2452 ../src/guestfs-actions.pod:3755
msgid ""
-" char *guestfs_realpath (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"The display name of the application, sometimes localized to the install "
+"language of the guest operating system."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4009 ../fish/guestfish-actions.pod:3093
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2455 ../src/guestfs-actions.pod:3758
msgid ""
-"Return the canonicalized absolute pathname of C<path>. The returned path "
-"has no C<.>, C<..> or symbolic link path elements."
+"If unavailable this is returned as an empty string C<\"\">. Callers needing "
+"to display something can use C<app_name> instead."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4015
-msgid "guestfs_removexattr"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3761
+msgid "C<app_epoch>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4017
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2460 ../src/guestfs-actions.pod:3763
msgid ""
-" int guestfs_removexattr (guestfs_h *g,\n"
-"\t\tconst char *xattr,\n"
-"\t\tconst char *path);\n"
-"\n"
+"For package managers which use epochs, this contains the epoch of the "
+"package (an integer). If unavailable, this is returned as C<0>."
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>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3766
+msgid "C<app_version>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4024
-msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2465 ../src/guestfs-actions.pod:3768
+msgid ""
+"The version string of the application or package. If unavailable this is "
+"returned as an empty string C<\"\">."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4028
-msgid "guestfs_resize2fs"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2468 ../src/guestfs-actions.pod:3771
+msgid "C<app_release>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4030
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3773
msgid ""
-" int guestfs_resize2fs (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+"The release string of the application or package, for package managers that "
+"use this. If unavailable this is returned as an empty string C<\"\">."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4033 ../fish/guestfish-actions.pod:3109
-msgid ""
-"This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
-"underlying device."
+#. type: =item
+#: ../fish/guestfish-actions.pod:2474 ../src/guestfs-actions.pod:3777
+msgid "C<app_install_path>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4036
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2476 ../src/guestfs-actions.pod:3779
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."
+"The installation path of the application (on operating systems such as "
+"Windows which use installation paths). This path is in the format used by "
+"the guest operating system, it is not a libguestfs path."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4044
-msgid "guestfs_resize2fs_size"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2481 ../src/guestfs-actions.pod:3784
+msgid "If unavailable this is returned as an empty string C<\"\">."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4046
-#, no-wrap
-msgid ""
-" int guestfs_resize2fs_size (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tint64_t size);\n"
-"\n"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2483 ../src/guestfs-actions.pod:3786
+msgid "C<app_trans_path>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4050
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2485 ../src/guestfs-actions.pod:3788
msgid ""
-"This command is the same as C<guestfs_resize2fs> except that it allows you "
-"to specify the new size (in bytes) explicitly."
+"The install path translated into a libguestfs path. If unavailable this is "
+"returned as an empty string C<\"\">."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4055
-msgid "guestfs_rm"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2488 ../src/guestfs-actions.pod:3791
+msgid "C<app_publisher>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4057
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2490 ../src/guestfs-actions.pod:3793
msgid ""
-" int guestfs_rm (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"The name of the publisher of the application, for package managers that use "
+"this. If unavailable this is returned as an empty string C<\"\">."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4060 ../fish/guestfish-actions.pod:3129
-msgid "Remove the single file C<path>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:2494 ../src/guestfs-actions.pod:3797
+msgid "C<app_url>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4064
-msgid "guestfs_rm_rf"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3799
+msgid ""
+"The URL (eg. upstream URL) of the application. If unavailable this is "
+"returned as an empty string C<\"\">."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4066
-#, no-wrap
-msgid ""
-" int guestfs_rm_rf (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2499 ../src/guestfs-actions.pod:3802
+msgid "C<app_source_package>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:3135
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2501 ../src/guestfs-actions.pod:3804
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."
+"For packaging systems which support this, the name of the source package. "
+"If unavailable this is returned as an empty string C<\"\">."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4075
-msgid "guestfs_rmdir"
+#. type: =item
+#: ../fish/guestfish-actions.pod:2504 ../src/guestfs-actions.pod:3807
+msgid "C<app_summary>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4077
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2506 ../src/guestfs-actions.pod:3809
msgid ""
-" int guestfs_rmdir (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"A short (usually one line) description of the application or package. If "
+"unavailable this is returned as an empty string C<\"\">."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4080 ../fish/guestfish-actions.pod:3143
-msgid "Remove the single directory C<path>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:2509 ../src/guestfs-actions.pod:3812
+msgid "C<app_description>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4084
-msgid "guestfs_rmmountpoint"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2511 ../src/guestfs-actions.pod:3814
+msgid ""
+"A longer description of the application or package. If unavailable this is "
+"returned as an empty string C<\"\">."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4086
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2518
+msgid "inspect-os"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2520
#, no-wrap
msgid ""
-" int guestfs_rmmountpoint (guestfs_h *g,\n"
-"\t\tconst char *exemptpath);\n"
+" inspect-os\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4089
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2522 ../src/guestfs-actions.pod:3832
msgid ""
-"This calls removes a mountpoint that was previously created with "
-"C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
+"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: =head2
-#: ../src/guestfs-actions.pod:4095
-msgid "guestfs_scrub_device"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2526 ../src/guestfs-actions.pod:3836
+msgid "The list returned is empty if no operating systems were found."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4097
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2528 ../src/guestfs-actions.pod:3838
msgid ""
-" int guestfs_scrub_device (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+"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: textblock
-#: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:3157
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2535
msgid ""
-"This command writes patterns over C<device> to make data retrieval more "
-"difficult."
+"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: 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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2540
msgid ""
-"It is an interface to the L<scrub(1)> program. See that manual page for "
-"more details."
+"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: =head2
-#: ../src/guestfs-actions.pod:4111
-msgid "guestfs_scrub_file"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2546 ../src/guestfs-actions.pod:3856
+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
+#: ../fish/guestfish-actions.pod:2552 ../fish/guestfish-actions.pod:2750
+#: ../fish/guestfish-actions.pod:2809
+msgid "See also L</list-filesystems>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2554
+msgid "is-blockdev"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4113
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2556
#, no-wrap
msgid ""
-" int guestfs_scrub_file (guestfs_h *g,\n"
-"\t\tconst char *file);\n"
+" is-blockdev path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:3170
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2558 ../src/guestfs-actions.pod:3876
msgid ""
-"This command writes patterns over a file to make data retrieval more "
-"difficult."
+"This returns C<true> if and only if there is a block device with the given "
+"C<path> name."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:3173
-msgid "The file is I<removed> after scrubbing."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2561 ../fish/guestfish-actions.pod:2579
+#: ../fish/guestfish-actions.pod:2598 ../fish/guestfish-actions.pod:2607
+#: ../fish/guestfish-actions.pod:2617 ../fish/guestfish-actions.pod:2651
+#: ../fish/guestfish-actions.pod:2660
+msgid "See also L</stat>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4126
-msgid "guestfs_scrub_freespace"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2563
+msgid "is-busy"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4128
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2565
#, no-wrap
msgid ""
-" int guestfs_scrub_freespace (guestfs_h *g,\n"
-"\t\tconst char *dir);\n"
+" is-busy\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4131
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2567 ../src/guestfs-actions.pod:3890
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 returns true iff this handle is busy processing a command (in the "
+"C<BUSY> state)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4142
-msgid "guestfs_set_append"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2572
+msgid "is-chardev"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4144
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2574
#, no-wrap
msgid ""
-" int guestfs_set_append (guestfs_h *g,\n"
-"\t\tconst char *append);\n"
+" is-chardev path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4147 ../fish/guestfish-actions.pod:3195
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2576 ../src/guestfs-actions.pod:3905
msgid ""
-"This function is used to add additional options to the guest kernel command "
-"line."
+"This returns C<true> if and only if there is a character device with the "
+"given C<path> name."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2581
+msgid "is-config"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:3198
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2583
+#, no-wrap
msgid ""
-"The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
-"environment variable."
+" is-config\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4153 ../fish/guestfish-actions.pod:3201
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2585 ../src/guestfs-actions.pod:3919
msgid ""
-"Setting C<append> to C<NULL> means I<no> additional options are passed "
-"(libguestfs always adds a few of its own)."
+"This returns true iff this handle is being configured (in the C<CONFIG> "
+"state)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4158
-msgid "guestfs_set_autosync"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2590
+msgid "is-dir"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4160
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2592
#, no-wrap
msgid ""
-" int guestfs_set_autosync (guestfs_h *g,\n"
-"\t\tint autosync);\n"
+" is-dir path\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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2594 ../src/guestfs-actions.pod:3934
msgid ""
-"This is disabled by default (except in guestfish where it is enabled by "
-"default)."
+"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:4173
-msgid "guestfs_set_direct"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2600
+msgid "is-fifo"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4175
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2602
#, no-wrap
msgid ""
-" int guestfs_set_direct (guestfs_h *g,\n"
-"\t\tint direct);\n"
+" is-fifo path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:3220
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2604 ../src/guestfs-actions.pod:3950
msgid ""
-"If the direct appliance mode flag is enabled, then stdin and stdout are "
-"passed directly through to the appliance once it is launched."
+"This returns C<true> if and only if there is a FIFO (named pipe) with the "
+"given C<path> name."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4182
-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."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2609
+msgid "is-file"
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."
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2611
+#, no-wrap
+msgid ""
+" is-file path\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4189 ../fish/guestfish-actions.pod:3231
-msgid "The default is disabled."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2613 ../src/guestfs-actions.pod:3965
+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."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4193
-msgid "guestfs_set_e2label"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2619
+msgid "is-launching"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4195
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2621
#, no-wrap
msgid ""
-" int guestfs_set_e2label (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *label);\n"
+" is-launching\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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2623 ../src/guestfs-actions.pod:3980
msgid ""
-"You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
-"the existing label on a filesystem."
+"This returns true iff this handle is launching the subprocess (in the "
+"C<LAUNCHING> state)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4208
-msgid "guestfs_set_e2uuid"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2628
+msgid "is-lv"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4210
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2630
#, no-wrap
msgid ""
-" int guestfs_set_e2uuid (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tconst char *uuid);\n"
+" is-lv device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:3248
-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."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4219
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2632 ../src/guestfs-actions.pod:3995
msgid ""
-"You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
-"the existing UUID of a filesystem."
+"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:4224
-msgid "guestfs_set_memsize"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2635
+msgid "is-ready"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4226
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2637
#, no-wrap
msgid ""
-" int guestfs_set_memsize (guestfs_h *g,\n"
-"\t\tint memsize);\n"
+" is-ready\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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2639 ../src/guestfs-actions.pod:4007
msgid ""
-"You can also change this by setting the environment variable "
-"C<LIBGUESTFS_MEMSIZE> before the handle is created."
+"This returns true iff this handle is ready to accept commands (in the "
+"C<READY> state)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4242
-msgid "guestfs_set_network"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2644
+msgid "is-socket"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4244
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2646
#, no-wrap
msgid ""
-" int guestfs_set_network (guestfs_h *g,\n"
-"\t\tint network);\n"
+" is-socket path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4247 ../fish/guestfish-actions.pod:3275
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2648 ../src/guestfs-actions.pod:4022
msgid ""
-"If C<network> is true, then the network is enabled in the libguestfs "
-"appliance. The default is false."
+"This returns C<true> if and only if there is a Unix domain socket with the "
+"given C<path> name."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2653
+msgid "is-symlink"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4250 ../fish/guestfish-actions.pod:3278
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2655
+#, no-wrap
msgid ""
-"This affects whether commands are able to access the network (see L<guestfs"
-"(3)/RUNNING COMMANDS>)."
+" is-symlink path\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4253
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2657 ../src/guestfs-actions.pod:4037
msgid ""
-"You must call this before calling C<guestfs_launch>, otherwise it has no "
-"effect."
+"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:4258
-msgid "guestfs_set_path"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2662
+msgid "is-zero"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4260
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2664
#, no-wrap
msgid ""
-" int guestfs_set_path (guestfs_h *g,\n"
-"\t\tconst char *searchpath);\n"
+" is-zero path\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."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:3290
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2666 ../src/guestfs-actions.pod:4052
msgid ""
-"The default is C<$libdir/guestfs> unless overridden by setting "
-"C<LIBGUESTFS_PATH> environment variable."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:3293
-msgid "Setting C<path> to C<NULL> restores the default path."
+"This returns true iff the file exists and the file is empty or it contains "
+"all zero bytes."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4272
-msgid "guestfs_set_qemu"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2669
+msgid "is-zero-device"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4274
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2671
#, no-wrap
msgid ""
-" int guestfs_set_qemu (guestfs_h *g,\n"
-"\t\tconst char *qemu);\n"
+" is-zero-device device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4277 ../fish/guestfish-actions.pod:3299
-msgid "Set the qemu binary that we will use."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2673 ../src/guestfs-actions.pod:4065
+msgid "This returns true iff the device exists and contains all zero bytes."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2675 ../src/guestfs-actions.pod:4067
+msgid "Note that for large devices this can take a long time to run."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2677
+msgid "kill-subprocess"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:3304
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2679
+#, no-wrap
msgid ""
-"You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
-"variable."
+" kill-subprocess\n"
+"\n"
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:4078
+msgid "This kills the qemu subprocess. You should never need to call this."
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."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2683
+msgid "launch"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4297
-msgid "guestfs_set_recovery_proc"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2685
+msgid "run"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4299
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2687
#, no-wrap
msgid ""
-" int guestfs_set_recovery_proc (guestfs_h *g,\n"
-"\t\tint recoveryproc);\n"
+" launch\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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2689 ../src/guestfs-actions.pod:4089
msgid ""
-"This only has any effect if called before C<guestfs_launch>, and the default "
-"is true."
+"Internally libguestfs is implemented by running a virtual machine using "
+"L<qemu(1)>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4310 ../fish/guestfish-actions.pod:3329
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2692 ../src/guestfs-actions.pod:4092
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."
+"You should call this after configuring the handle (eg. adding drives) but "
+"before performing any actions."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4318
-msgid "guestfs_set_selinux"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2695
+msgid "lchown"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4320
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2697
#, no-wrap
msgid ""
-" int guestfs_set_selinux (guestfs_h *g,\n"
-"\t\tint selinux);\n"
+" lchown owner group path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:3339
-msgid ""
-"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:4326 ../fish/guestfish-actions.pod:3342
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2699
msgid ""
-"Note that if SELinux is enabled, it is always in Permissive mode "
-"(C<enforcing=0>)."
+"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
-#: ../src/guestfs-actions.pod:4334
-msgid "guestfs_set_trace"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2707
+msgid "lgetxattr"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4336
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2709
#, no-wrap
msgid ""
-" int guestfs_set_trace (guestfs_h *g,\n"
-"\t\tint trace);\n"
+" lgetxattr path name\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4339 ../fish/guestfish-actions.pod:3352
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2711 ../src/guestfs-actions.pod:4132
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."
+"Get a single extended attribute from file C<path> named C<name>. If C<path> "
+"is a symlink, then this call returns an extended attribute from the symlink."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2725
+msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4346 ../fish/guestfish-actions.pod:3359
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2727
+msgid "lgetxattrs"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2729
+#, no-wrap
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."
+" lgetxattrs path\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4350 ../fish/guestfish-actions.pod:3363
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2731
msgid ""
-"Command traces are disabled unless the environment variable "
-"C<LIBGUESTFS_TRACE> is defined and set to C<1>."
+"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
-#: ../src/guestfs-actions.pod:4355
-msgid "guestfs_set_verbose"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2735
+msgid "list-9p"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4357
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2737
#, no-wrap
msgid ""
-" int guestfs_set_verbose (guestfs_h *g,\n"
-"\t\tint verbose);\n"
+" list-9p\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>)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4362 ../fish/guestfish-actions.pod:3372
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2739 ../src/guestfs-actions.pod:4175
msgid ""
-"Verbose messages are disabled unless the environment variable "
-"C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
+"List all 9p filesystems attached to the guest. A list of mount tags is "
+"returned."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4367
-msgid "guestfs_setcon"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2742
+msgid "list-devices"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4369
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2744
#, no-wrap
msgid ""
-" int guestfs_setcon (guestfs_h *g,\n"
-"\t\tconst char *context);\n"
+" list-devices\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4372 ../fish/guestfish-actions.pod:3379
-msgid ""
-"This sets the SELinux security context of the daemon to the string "
-"C<context>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2746 ../src/guestfs-actions.pod:4189
+msgid "List all the block devices."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4375 ../fish/guestfish-actions.pod:3382
-msgid "See the documentation about SELINUX in L<guestfs(3)>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2748 ../src/guestfs-actions.pod:4191
+msgid "The full block device names are returned, eg. C</dev/sda>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4379
-msgid "guestfs_setxattr"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2752
+msgid "list-dm-devices"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4381
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2754
#, 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"
+" list-dm-devices\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4387 ../fish/guestfish-actions.pod:3388
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2756 ../src/guestfs-actions.pod:4206
+msgid "List all device mapper devices."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2758
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."
+"The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
+"previous call to L</luks-open>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4391
-msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2761
+msgid ""
+"Device mapper devices which correspond to logical volumes are I<not> "
+"returned in this list. Call L</lvs> if you want to list logical volumes."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4395
-msgid "guestfs_sfdisk"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2765
+msgid "list-filesystems"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4397
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2767
#, no-wrap
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"
+" list-filesystems\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4404 ../fish/guestfish-actions.pod:3398
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2769 ../src/guestfs-actions.pod:4226
msgid ""
-"This is a direct interface to the L<sfdisk(8)> program for creating "
-"partitions on block devices."
+"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:4407 ../fish/guestfish-actions.pod:3401
-msgid "C<device> should be a block device, for example C</dev/sda>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4230
+msgid ""
+"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: textblock
-#: ../src/guestfs-actions.pod:4409 ../fish/guestfish-actions.pod:3403
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2777 ../src/guestfs-actions.pod:4234
+#, no-wrap
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."
+" \"/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:4417 ../fish/guestfish-actions.pod:3411
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2782 ../src/guestfs-actions.pod:4239
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 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:4420 ../fish/guestfish-actions.pod:3414
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2786
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)."
+"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: textblock
-#: ../src/guestfs-actions.pod:4424
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2790
msgid ""
-"See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
+"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
-#: ../src/guestfs-actions.pod:4432
-msgid "guestfs_sfdiskM"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2798
+msgid "list-partitions"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4434
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2800
#, no-wrap
msgid ""
-" int guestfs_sfdiskM (guestfs_h *g,\n"
-"\t\tconst char *device,\n"
-"\t\tchar *const *lines);\n"
+" list-partitions\n"
"\n"
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2802 ../src/guestfs-actions.pod:4268
+msgid "List all the partitions detected on all block devices."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2804 ../src/guestfs-actions.pod:4270
+msgid "The full partition device names are returned, eg. C</dev/sda1>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4444
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2806
msgid ""
-"See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
-"C<guestfs_part_disk>"
+"This does not return logical volumes. For that you will need to call L</"
+"lvs>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4452
-msgid "guestfs_sfdisk_N"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2811
+msgid "ll"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4454
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2813
#, 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"
+" ll directory\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:3444
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2815 ../src/guestfs-actions.pod:4289
msgid ""
-"This runs L<sfdisk(8)> option to modify just the single partition C<n> "
-"(note: C<n> counts from 1)."
+"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:4465
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2818 ../src/guestfs-actions.pod:4292
msgid ""
-"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:4468
-msgid "See also: C<guestfs_part_add>"
+"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:4475
-msgid "guestfs_sfdisk_disk_geometry"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2821
+msgid "ln"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4477
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2823
#, no-wrap
msgid ""
-" char *guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" ln target linkname\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4480
-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: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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2825 ../src/guestfs-actions.pod:4307
+msgid "This command creates a hard link using the C<ln> command."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4491
-msgid "guestfs_sfdisk_kernel_geometry"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2827
+msgid "ln-f"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4493
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2829
#, no-wrap
msgid ""
-" char *guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" ln-f target linkname\n"
"\n"
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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2831 ../src/guestfs-actions.pod:4320
+msgid ""
+"This command creates a hard link using the C<ln -f> command. The I<-f> "
+"option removes the link (C<linkname>) if it exists already."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4504
-msgid "guestfs_sfdisk_l"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2834
+msgid "ln-s"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4506
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2836
#, no-wrap
msgid ""
-" char *guestfs_sfdisk_l (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" ln-s target linkname\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4509 ../fish/guestfish-actions.pod:3480
-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."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4513
-msgid "See also: C<guestfs_part_list>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2838 ../src/guestfs-actions.pod:4334
+msgid "This command creates a symbolic link using the C<ln -s> command."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4518
-msgid "guestfs_sh"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2840
+msgid "ln-sf"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4520
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2842
#, no-wrap
msgid ""
-" char *guestfs_sh (guestfs_h *g,\n"
-"\t\tconst char *command);\n"
+" ln-sf target linkname\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4523 ../fish/guestfish-actions.pod:3490
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2844 ../src/guestfs-actions.pod:4347
msgid ""
-"This call runs a command from the guest filesystem via the guest's C</bin/"
-"sh>."
+"This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
+"option removes the link (C<linkname>) if it exists already."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4526
-msgid "This is like C<guestfs_command>, but passes the command to:"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2847
+msgid "lremovexattr"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4528 ../fish/guestfish-actions.pod:3495
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2849
#, no-wrap
msgid ""
-" /bin/sh -c \"command\"\n"
+" lremovexattr xattr path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4530 ../fish/guestfish-actions.pod:3497
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2851
msgid ""
-"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:4534
-msgid "All the provisos about C<guestfs_command> apply to this call."
+"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: =head2
-#: ../src/guestfs-actions.pod:4539
-msgid "guestfs_sh_lines"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2855
+msgid "ls"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4541
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2857
#, no-wrap
msgid ""
-" char **guestfs_sh_lines (guestfs_h *g,\n"
-"\t\tconst char *command);\n"
+" ls directory\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4544
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2859 ../src/guestfs-actions.pod:4375
msgid ""
-"This is the same as C<guestfs_sh>, but splits the result into a list of "
-"lines."
+"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:4547
-msgid "See also: C<guestfs_command_lines>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2863
+msgid ""
+"This command is mostly useful for interactive sessions. Programs should "
+"probably use L</readdir> instead."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4553
-msgid "guestfs_sleep"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2866
+msgid "lsetxattr"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4555
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2868
#, no-wrap
msgid ""
-" int guestfs_sleep (guestfs_h *g,\n"
-"\t\tint secs);\n"
+" lsetxattr xattr val vallen path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4558 ../fish/guestfish-actions.pod:3516
-msgid "Sleep for C<secs> seconds."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2870
+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
-#: ../src/guestfs-actions.pod:4562 ../src/guestfs-structs.pod:109
-msgid "guestfs_stat"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2874
+msgid "lstat"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4564
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2876
#, no-wrap
msgid ""
-" struct guestfs_stat *guestfs_stat (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" lstat path\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2878 ../fish/guestfish-actions.pod:4702
+#: ../src/guestfs-actions.pod:4411 ../src/guestfs-actions.pod:7214
+msgid "Returns file information for the given C<path>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4575 ../src/guestfs-structs.pod:135
-msgid "guestfs_statvfs"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2880
+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: verbatim
-#: ../src/guestfs-actions.pod:4577
-#, no-wrap
-msgid ""
-" struct guestfs_statvfs *guestfs_statvfs (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2884 ../src/guestfs-actions.pod:4417
+msgid "This is the same as the C<lstat(2)> system call."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3530
-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:4584 ../fish/guestfish-actions.pod:3534
-msgid "This is the same as the C<statvfs(2)> system call."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2886
+msgid "lstatlist"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4586
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2888
+#, no-wrap
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>."
+" lstatlist path 'names ...'\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4590
-msgid "guestfs_strings"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2890
+msgid ""
+"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: verbatim
-#: ../src/guestfs-actions.pod:4592
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2894 ../src/guestfs-actions.pod:4436
msgid ""
-" char **guestfs_strings (guestfs_h *g,\n"
-"\t\tconst char *path);\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:4595 ../fish/guestfish-actions.pod:3540
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2899
msgid ""
-"This runs the L<strings(1)> command on a file and returns the list of "
-"printable strings found."
+"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
-#: ../src/guestfs-actions.pod:4605
-msgid "guestfs_strings_e"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2907
+msgid "luks-add-key"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4607
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2909
#, no-wrap
msgid ""
-" char **guestfs_strings_e (guestfs_h *g,\n"
-"\t\tconst char *encoding,\n"
-"\t\tconst char *path);\n"
+" luks-add-key device keyslot\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4611
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2911 ../src/guestfs-actions.pod:4464
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-actions.pod:4615 ../fish/guestfish-actions.pod:3554
-msgid "Allowed encodings are:"
-msgstr ""
-
-# type: =item
-#: ../src/guestfs-actions.pod:4619 ../fish/guestfish-actions.pod:3558
-msgid "s"
+"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:4621
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2916
msgid ""
-"Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
-"ISO-8859-X (this is what C<guestfs_strings> uses)."
+"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: =item
-#: ../src/guestfs-actions.pod:4624 ../fish/guestfish-actions.pod:3563
-msgid "S"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2920 ../fish/guestfish-actions.pod:2942
+#: ../fish/guestfish-actions.pod:2955 ../fish/guestfish-actions.pod:2969
+#: ../fish/guestfish-actions.pod:2995 ../fish/guestfish-actions.pod:3005
+msgid ""
+"This command has one or more key or passphrase parameters. Guestfish will "
+"prompt for these separately."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4626 ../fish/guestfish-actions.pod:3565
-msgid "Single 8-bit-byte characters."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2923
+msgid "luks-close"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:4628 ../fish/guestfish-actions.pod:3567
-msgid "b"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2925
+#, no-wrap
+msgid ""
+" luks-close device\n"
+"\n"
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2927
+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: =item
-#: ../src/guestfs-actions.pod:4633 ../fish/guestfish-actions.pod:3572
-msgid "l (lower case letter L)"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2933
+msgid "luks-format"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4635 ../fish/guestfish-actions.pod:3574
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2935
+#, no-wrap
msgid ""
-"16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
-"examining binaries in Windows guests."
+" luks-format device keyslot\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:4638 ../fish/guestfish-actions.pod:3577
-msgid "B"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2937 ../src/guestfs-actions.pod:4505
+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:4640 ../fish/guestfish-actions.pod:3579
-msgid "32-bit big endian such as UCS-4BE."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2945 ../fish/guestfish-actions.pod:2958
+#: ../fish/guestfish-actions.pod:3045 ../fish/guestfish-actions.pod:3696
+#: ../fish/guestfish-actions.pod:4236 ../fish/guestfish-actions.pod:4573
+#: ../fish/guestfish-actions.pod:4596 ../fish/guestfish-actions.pod:4618
+#: ../fish/guestfish-actions.pod:5364 ../src/guestfs-actions.pod:4512
+#: ../src/guestfs-actions.pod:4535 ../src/guestfs-actions.pod:4678
+#: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:6577
+#: ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7058
+#: ../src/guestfs-actions.pod:7091 ../src/guestfs-actions.pod:8290
+msgid ""
+"B<This command is dangerous. Without careful use you can easily destroy all "
+"your data>."
msgstr ""
-# type: =item
-#: ../src/guestfs-actions.pod:4642 ../fish/guestfish-actions.pod:3581
-msgid "L"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2948
+msgid "luks-format-cipher"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3583
-msgid "32-bit little endian such as UCS-4LE."
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2950
+#, no-wrap
+msgid ""
+" luks-format-cipher device keyslot cipher\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3587
-msgid "The returned strings are transcoded to UTF-8."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2952
+msgid ""
+"This command is the same as L</luks-format> but it also allows you to set "
+"the C<cipher> used."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4657
-msgid "guestfs_swapoff_device"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2961
+msgid "luks-kill-slot"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4659
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2963
#, no-wrap
msgid ""
-" int guestfs_swapoff_device (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" luks-kill-slot device keyslot\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4662
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2965 ../src/guestfs-actions.pod:4552
msgid ""
-"This command disables the libguestfs appliance swap device or partition "
-"named C<device>. See C<guestfs_swapon_device>."
+"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: =head2
-#: ../src/guestfs-actions.pod:4668
-msgid "guestfs_swapoff_file"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2972
+msgid "luks-open"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4670
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:2974
#, no-wrap
msgid ""
-" int guestfs_swapoff_file (guestfs_h *g,\n"
-"\t\tconst char *file);\n"
+" luks-open device mapname\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2976 ../src/guestfs-actions.pod:4572
+msgid ""
+"This command opens a block device which has been encrypted according to the "
+"Linux Unified Key Setup (LUKS) standard."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4677
-msgid "guestfs_swapoff_label"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2979 ../src/guestfs-actions.pod:4575
+msgid "C<device> is the encrypted block device or partition."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4679
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2981 ../src/guestfs-actions.pod:4577
msgid ""
-" int guestfs_swapoff_label (guestfs_h *g,\n"
-"\t\tconst char *label);\n"
-"\n"
+"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:4682 ../fish/guestfish-actions.pod:3610
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2984 ../src/guestfs-actions.pod:4580
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 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: verbatim
-#: ../src/guestfs-actions.pod:4689
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2988
msgid ""
-" int guestfs_swapoff_uuid (guestfs_h *g,\n"
-"\t\tconst char *uuid);\n"
-"\n"
+"If this block device contains LVM volume groups, then calling L</vgscan> "
+"followed by L</vg-activate-all> will make them visible."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:2992
+msgid "Use L</list-dm-devices> to list all device mapper devices."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4697
-msgid "guestfs_swapon_device"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:2998
+msgid "luks-open-ro"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4699
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3000
#, no-wrap
msgid ""
-" int guestfs_swapon_device (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" luks-open-ro device mapname\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4702
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3002
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>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4707 ../fish/guestfish-actions.pod:3629
-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."
+"This is the same as L</luks-open> except that a read-only mapping is created."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4716
-msgid "guestfs_swapon_file"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3008
+msgid "lvcreate"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4718
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3010
#, no-wrap
msgid ""
-" int guestfs_swapon_file (guestfs_h *g,\n"
-"\t\tconst char *file);\n"
+" lvcreate logvol volgroup mbytes\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4721
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3012 ../src/guestfs-actions.pod:4626
msgid ""
-"This command enables swap to a file. See C<guestfs_swapon_device> for other "
-"notes."
+"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:4726
-msgid "guestfs_swapon_label"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3015
+msgid "lvm-canonical-lv-name"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4728
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3017
#, no-wrap
msgid ""
-" int guestfs_swapon_label (guestfs_h *g,\n"
-"\t\tconst char *label);\n"
+" lvm-canonical-lv-name lvname\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4731
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3019 ../src/guestfs-actions.pod:4639
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"
+"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: verbatim
-#: ../src/guestfs-actions.pod:4738
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3023 ../src/guestfs-actions.pod:4643
msgid ""
-" int guestfs_swapon_uuid (guestfs_h *g,\n"
-"\t\tconst char *uuid);\n"
-"\n"
+"This command returns an error if the C<lvname> parameter does not refer to a "
+"logical volume."
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3026
+msgid "See also L</is-lv>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4746
-msgid "guestfs_sync"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3028
+msgid "lvm-clear-filter"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4748
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3030
#, no-wrap
msgid ""
-" int guestfs_sync (guestfs_h *g);\n"
+" lvm-clear-filter\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3661
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3032
msgid ""
-"This syncs the disk, so that any writes are flushed through to the "
-"underlying disk image."
+"This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
+"block device."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3664
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3035 ../fish/guestfish-actions.pod:3066
+#: ../src/guestfs-actions.pod:4661 ../src/guestfs-actions.pod:4703
msgid ""
-"You should always call this if you have modified a disk image, before "
-"closing the handle."
+"This command also clears the LVM cache and performs a volume group scan."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4758
-msgid "guestfs_tail"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3038
+msgid "lvm-remove-all"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4760
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3040
#, no-wrap
msgid ""
-" char **guestfs_tail (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" lvm-remove-all\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4763 ../fish/guestfish-actions.pod:3671
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3042 ../src/guestfs-actions.pod:4673
msgid ""
-"This command returns up to the last 10 lines of a file as a list of strings."
+"This command removes all LVM logical volumes, volume groups and physical "
+"volumes."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4773
-msgid "guestfs_tail_n"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3048
+msgid "lvm-set-filter"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4775
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3050
#, no-wrap
msgid ""
-" char **guestfs_tail_n (guestfs_h *g,\n"
-"\t\tint nrlines,\n"
-"\t\tconst char *path);\n"
+" lvm-set-filter 'devices ...'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4779 ../fish/guestfish-actions.pod:3681
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3052 ../src/guestfs-actions.pod:4689
msgid ""
-"If the parameter C<nrlines> is a positive number, this returns the last "
-"C<nrlines> lines of the file C<path>."
+"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: textblock
-#: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3684
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3056 ../src/guestfs-actions.pod:4693
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."
+"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: =head2
-#: ../src/guestfs-actions.pod:4794
-msgid "guestfs_tar_in"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3069 ../src/guestfs-actions.pod:4706
+msgid "You can filter whole block devices or individual partitions."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4796
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3071 ../src/guestfs-actions.pod:4708
+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."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3075
+msgid "lvremove"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3077
#, no-wrap
msgid ""
-" int guestfs_tar_in (guestfs_h *g,\n"
-"\t\tconst char *tarfile,\n"
-"\t\tconst char *directory);\n"
+" lvremove device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4800 ../fish/guestfish-actions.pod:3696
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3079 ../src/guestfs-actions.pod:4722
msgid ""
-"This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
-"tar file) into C<directory>."
+"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:4803
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3082 ../src/guestfs-actions.pod:4725
msgid ""
-"To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
+"You can also remove all LVs in a volume group by specifying the VG name, C</"
+"dev/VG>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4808
-msgid "guestfs_tar_out"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3085
+msgid "lvrename"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4810
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3087
#, no-wrap
msgid ""
-" int guestfs_tar_out (guestfs_h *g,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *tarfile);\n"
+" lvrename logvol newlogvol\n"
"\n"
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>."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:4817
-msgid ""
-"To download a compressed tarball, use C<guestfs_tgz_out> or "
-"C<guestfs_txz_out>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3089 ../src/guestfs-actions.pod:4739
+msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4822
-msgid "guestfs_tgz_in"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3091
+msgid "lvresize"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4824
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3093
#, no-wrap
msgid ""
-" int guestfs_tgz_in (guestfs_h *g,\n"
-"\t\tconst char *tarball,\n"
-"\t\tconst char *directory);\n"
+" lvresize device mbytes\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3720
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3095 ../src/guestfs-actions.pod:4752
msgid ""
-"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:4831
-msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
+"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:4835
-msgid "guestfs_tgz_out"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3099
+msgid "lvresize-free"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4837
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3101
#, no-wrap
msgid ""
-" int guestfs_tgz_out (guestfs_h *g,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *tarball);\n"
+" lvresize-free lv percent\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4841 ../fish/guestfish-actions.pod:3731
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3103 ../src/guestfs-actions.pod:4767
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>."
+"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: =head2
-#: ../src/guestfs-actions.pod:4848
-msgid "guestfs_touch"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3109
+msgid "lvs"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4850
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3111
#, no-wrap
msgid ""
-" int guestfs_touch (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" lvs\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4853 ../fish/guestfish-actions.pod:3742
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3113 ../src/guestfs-actions.pod:4782
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 ""
+"List all the logical volumes detected. This is the equivalent of the L<lvs"
+"(8)> command."
+msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3746
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4785
msgid ""
-"This command only works on regular files, and will fail on other file types "
-"such as directories, symbolic links, block special etc."
+"This returns a list of the logical volume device names (eg. C</dev/"
+"VolGroup00/LogVol00>)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4862
-msgid "guestfs_truncate"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3119
+msgid "See also L</lvs-full>, L</list-filesystems>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4864
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3121
+msgid "lvs-full"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3123
#, no-wrap
msgid ""
-" int guestfs_truncate (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" lvs-full\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4867 ../fish/guestfish-actions.pod:3753
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3125 ../src/guestfs-actions.pod:4801
msgid ""
-"This command truncates C<path> to a zero-length file. The file must exist "
-"already."
+"List all the logical volumes detected. This is the equivalent of the L<lvs"
+"(8)> command. The \"full\" version includes all fields."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4872
-msgid "guestfs_truncate_size"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3128
+msgid "lvuuid"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4874
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3130
#, no-wrap
msgid ""
-" int guestfs_truncate_size (guestfs_h *g,\n"
-"\t\tconst char *path,\n"
-"\t\tint64_t size);\n"
+" lvuuid device\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."
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3132 ../src/guestfs-actions.pod:4816
+msgid "This command returns the UUID of the LVM LV C<device>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4889
-msgid "guestfs_tune2fs_l"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3134
+msgid "lxattrlist"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4891
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3136
#, no-wrap
msgid ""
-" char **guestfs_tune2fs_l (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" lxattrlist path 'names ...'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4894 ../fish/guestfish-actions.pod:3773
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3138 ../src/guestfs-actions.pod:4830
msgid ""
-"This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
-"C<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:4897 ../fish/guestfish-actions.pod:3776
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3142 ../src/guestfs-actions.pod:4834
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."
+"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: =head2
-#: ../src/guestfs-actions.pod:4908
-msgid "guestfs_txz_in"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3152
+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:3160
+msgid "mkdir"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4910
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3162
#, no-wrap
msgid ""
-" int guestfs_txz_in (guestfs_h *g,\n"
-"\t\tconst char *tarball,\n"
-"\t\tconst char *directory);\n"
+" mkdir path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4914 ../fish/guestfish-actions.pod:3785
-msgid ""
-"This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
-"tar file) into C<directory>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3164 ../src/guestfs-actions.pod:4864
+msgid "Create a directory named C<path>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4919
-msgid "guestfs_txz_out"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3166
+msgid "mkdir-mode"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4921
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3168
#, no-wrap
msgid ""
-" int guestfs_txz_out (guestfs_h *g,\n"
-"\t\tconst char *directory,\n"
-"\t\tconst char *tarball);\n"
+" mkdir-mode path mode\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4925 ../fish/guestfish-actions.pod:3794
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3170 ../src/guestfs-actions.pod:4877
msgid ""
-"This command packs the contents of C<directory> and downloads it to local "
-"file C<tarball> (as an xz compressed tar archive)."
+"This command creates a directory, setting the initial permissions of the "
+"directory to C<mode>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4930
-msgid "guestfs_umask"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3173 ../src/guestfs-actions.pod:4880
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3177
+msgid "See also L</mkdir>, L</umask>"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3179
+msgid "mkdir-p"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4932
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3181
#, no-wrap
msgid ""
-" int guestfs_umask (guestfs_h *g,\n"
-"\t\tint mask);\n"
+" mkdir-p path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4935 ../fish/guestfish-actions.pod:3803
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3183 ../src/guestfs-actions.pod:4896
msgid ""
-"This function sets the mask used for creating new files and device nodes to "
-"C<mask & 0777>."
+"Create a directory named C<path>, creating any parent directories as "
+"necessary. This is like the C<mkdir -p> shell command."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3186
+msgid "mkdtemp"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4938 ../fish/guestfish-actions.pod:3806
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3188
+#, no-wrap
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\"."
+" mkdtemp template\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4943 ../fish/guestfish-actions.pod:3811
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3190 ../src/guestfs-actions.pod:4909
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>."
+"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: textblock
-#: ../src/guestfs-actions.pod:4947
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3195 ../src/guestfs-actions.pod:4914
msgid ""
-"See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
-"C<guestfs_mkdir>."
+"For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
+"being suitable for Windows filesystems."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4950 ../fish/guestfish-actions.pod:3818
-msgid "This call returns the previous umask."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3198 ../src/guestfs-actions.pod:4917
+msgid "The name of the temporary directory that was created is returned."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4954
-msgid "guestfs_umount"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3201 ../src/guestfs-actions.pod:4920
+msgid "The temporary directory is created with mode 0700 and is owned by root."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4956
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3204 ../src/guestfs-actions.pod:4923
msgid ""
-" int guestfs_umount (guestfs_h *g,\n"
-"\t\tconst char *pathordevice);\n"
-"\n"
+"The caller is responsible for deleting the temporary directory and its "
+"contents after use."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4959 ../fish/guestfish-actions.pod:3824
-msgid ""
-"This unmounts the given filesystem. The filesystem may be specified either "
-"by its mountpoint (path) or the device which contains the filesystem."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3207 ../src/guestfs-actions.pod:4926
+msgid "See also: L<mkdtemp(3)>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4965
-msgid "guestfs_umount_all"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3209
+msgid "mke2fs-J"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4967
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3211
#, no-wrap
msgid ""
-" int guestfs_umount_all (guestfs_h *g);\n"
+" mke2fs-J fstype blocksize device journal\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3832
-msgid "This unmounts all mounted filesystems."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3213 ../src/guestfs-actions.pod:4942
+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:4971 ../fish/guestfish-actions.pod:3834
-msgid "Some internal mounts are not unmounted by this call."
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3217 ../src/guestfs-actions.pod:4946
+#, no-wrap
+msgid ""
+" mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4975
-msgid "guestfs_upload"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3219
+msgid "See also L</mke2journal>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3221
+msgid "mke2fs-JL"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4977
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3223
#, no-wrap
msgid ""
-" int guestfs_upload (guestfs_h *g,\n"
-"\t\tconst char *filename,\n"
-"\t\tconst char *remotefilename);\n"
+" mke2fs-JL fstype blocksize device label\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3225 ../src/guestfs-actions.pod:4963
+msgid ""
+"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:4986
-msgid "See also C<guestfs_download>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3228
+msgid "See also L</mke2journal-L>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:4990
-msgid "guestfs_utimens"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3230
+msgid "mke2fs-JU"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:4992
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3232
#, 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"
+" mke2fs-JU fstype blocksize device uuid\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3234 ../src/guestfs-actions.pod:4981
+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:5002 ../fish/guestfish-actions.pod:3856
-msgid ""
-"C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
-"from the epoch."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3237
+msgid "See also L</mke2journal-U>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5005 ../fish/guestfish-actions.pod:3859
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3239
+msgid "mke2journal"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3241
+#, no-wrap
msgid ""
-"C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
-"nanoseconds from the epoch."
+" mke2journal blocksize device\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5008 ../fish/guestfish-actions.pod:3862
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3243 ../src/guestfs-actions.pod:4997
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)."
+"This creates an ext2 external journal on C<device>. It is equivalent to the "
+"command:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5012 ../fish/guestfish-actions.pod:3866
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3246 ../src/guestfs-actions.pod:5000
+#, no-wrap
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)."
+" mke2fs -O journal_dev -b blocksize device\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5018 ../src/guestfs-structs.pod:175
-msgid "guestfs_version"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3248
+msgid "mke2journal-L"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5020
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3250
#, no-wrap
msgid ""
-" struct guestfs_version *guestfs_version (guestfs_h *g);\n"
+" mke2journal-L blocksize label device\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3252 ../src/guestfs-actions.pod:5014
+msgid "This creates an ext2 external journal on C<device> with label C<label>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3877
-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."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3254
+msgid "mke2journal-U"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5030 ../fish/guestfish-actions.pod:3882
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3256
+#, no-wrap
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)."
+" mke2journal-U blocksize uuid device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3258 ../src/guestfs-actions.pod:5028
+msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5036 ../fish/guestfish-actions.pod:3888
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3260
+msgid "mkfifo"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3262
+#, 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."
+" mkfifo mode path\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5042 ../fish/guestfish-actions.pod:3894
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3264
msgid ""
-"To construct the original version string: C<$major.$minor.$release$extra>"
+"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: textblock
-#: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3897
-msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3270
+msgid "mkfs"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5047
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3272
+#, no-wrap
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."
+" mkfs fstype device\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5053
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3274 ../src/guestfs-actions.pod:5058
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>."
+"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: =head2
-#: ../src/guestfs-actions.pod:5057
-msgid "guestfs_vfs_label"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3278
+msgid "mkfs-b"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5059
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3280
#, no-wrap
msgid ""
-" char *guestfs_vfs_label (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" mkfs-b fstype blocksize device\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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3282
+msgid ""
+"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: textblock
-#: ../src/guestfs-actions.pod:5065 ../fish/guestfish-actions.pod:3912
-msgid "If the filesystem is unlabeled, this returns the empty string."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3287 ../fish/guestfish-actions.pod:3314
+#: ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5124
+msgid ""
+"For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
+"cluster size."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5067
-msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3290
+msgid ""
+"I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
+"instead."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5072
-msgid "guestfs_vfs_type"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3297
+msgid "mkfs-opts"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5074
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3299
#, no-wrap
msgid ""
-" char *guestfs_vfs_type (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3920
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3301 ../src/guestfs-actions.pod:5111
msgid ""
-"This command gets the filesystem type corresponding to the filesystem on "
-"C<device>."
+"This function creates a filesystem on C<device>. The filesystem type is "
+"C<fstype>, for example C<ext3>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5080 ../fish/guestfish-actions.pod:3923
-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>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:5118
+msgid "C<blocksize>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5088
-msgid "guestfs_vfs_uuid"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3310 ../src/guestfs-actions.pod:5120
+msgid ""
+"The filesystem block size. Supported block sizes depend on the filesystem "
+"type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
+"filesystems."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5090
-#, no-wrap
-msgid ""
-" char *guestfs_vfs_uuid (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3317 ../src/guestfs-actions.pod:5127
+msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
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>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:3319 ../src/guestfs-actions.pod:5129
+msgid "C<features>"
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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3321 ../src/guestfs-actions.pod:5131
+msgid "This passes the I<-O> parameter to the external mkfs program."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5098
-msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3323 ../src/guestfs-actions.pod:5133
+msgid ""
+"For certain filesystem types, this allows extra filesystem features to be "
+"selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5103
-msgid "guestfs_vg_activate"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3327 ../src/guestfs-actions.pod:5137
+msgid ""
+"You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
+"type."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5105
-#, no-wrap
-msgid ""
-" int guestfs_vg_activate (guestfs_h *g,\n"
-"\t\tint activate,\n"
-"\t\tchar *const *volgroups);\n"
-"\n"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3330 ../src/guestfs-actions.pod:5140
+msgid "C<inode>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3943
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3332 ../src/guestfs-actions.pod:5142
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."
+"This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
+"sets the inode size (only for ext2/3/4 filesystems at present)."
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...>"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3335 ../src/guestfs-actions.pod:5145
+msgid "C<sectorsize>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3951
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3337 ../src/guestfs-actions.pod:5147
msgid ""
-"Note that if C<volgroups> is an empty list then B<all> volume groups are "
-"activated or deactivated."
+"This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
+"sets sector size for ufs filesystem."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5122
-msgid "guestfs_vg_activate_all"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3344
+msgid "mkmountpoint"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5124
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3346
#, no-wrap
msgid ""
-" int guestfs_vg_activate_all (guestfs_h *g,\n"
-"\t\tint activate);\n"
+" mkmountpoint exemptpath\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3958
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3348
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."
+"L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
+"to create extra mountpoints before mounting the first filesystem."
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>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3352 ../src/guestfs-actions.pod:5190
+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: =head2
-#: ../src/guestfs-actions.pod:5137
-msgid "guestfs_vgcreate"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3356 ../src/guestfs-actions.pod:5194
+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:5139
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5199
#, no-wrap
msgid ""
-" int guestfs_vgcreate (guestfs_h *g,\n"
-"\t\tconst char *volgroup,\n"
-"\t\tchar *const *physvols);\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: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"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3370 ../src/guestfs-actions.pod:5208
+msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5150
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3372
msgid ""
-" char **guestfs_vglvuuids (guestfs_h *g,\n"
-"\t\tconst char *vgname);\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
-#: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3977
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3376
msgid ""
-"Given a VG called C<vgname>, this returns the UUIDs of all the logical "
-"volumes created in this volume group."
+"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
-#: ../src/guestfs-actions.pod:5156
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3381 ../src/guestfs-actions.pod:5219
msgid ""
-"You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
-"associate logical volumes and volume groups."
+"For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5159
-msgid "See also C<guestfs_vgpvuuids>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3383
+msgid ""
+"Autosync [see L</set-autosync>, this is set by default on handles] can cause "
+"L</umount-all> to be called when the handle is closed which can also trigger "
+"these issues."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5165
-msgid "guestfs_vgpvuuids"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3387
+msgid "mknod"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5167
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3389
#, no-wrap
msgid ""
-" char **guestfs_vgpvuuids (guestfs_h *g,\n"
-"\t\tconst char *vgname);\n"
+" mknod mode devmajor devminor path\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5170 ../fish/guestfish-actions.pod:3989
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3391 ../src/guestfs-actions.pod:5238
msgid ""
-"Given a VG called C<vgname>, this returns the UUIDs of all the physical "
-"volumes that this volume group resides on."
+"This call creates block or character special devices, or named pipes (FIFOs)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5173
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3394 ../src/guestfs-actions.pod:5241
msgid ""
-"You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
-"associate physical volumes and volume groups."
+"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:5176
-msgid "See also C<guestfs_vglvuuids>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3399
+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 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
-#: ../src/guestfs-actions.pod:5182
-msgid "guestfs_vgremove"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3409
+msgid "mknod-b"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5184
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3411
#, no-wrap
msgid ""
-" int guestfs_vgremove (guestfs_h *g,\n"
-"\t\tconst char *vgname);\n"
+" mknod-b mode devmajor devminor path\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
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3413
msgid ""
-"This also forcibly removes all logical volumes in the volume group (if any)."
+"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
-#: ../src/guestfs-actions.pod:5194
-msgid "guestfs_vgrename"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3419
+msgid "mknod-c"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5196
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3421
#, no-wrap
msgid ""
-" int guestfs_vgrename (guestfs_h *g,\n"
-"\t\tconst char *volgroup,\n"
-"\t\tconst char *newvolgroup);\n"
+" mknod-c mode devmajor devminor path\n"
"\n"
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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3423
+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 L</mknod>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5204
-msgid "guestfs_vgs"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3429
+msgid "mkswap"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5206
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3431
#, no-wrap
msgid ""
-" char **guestfs_vgs (guestfs_h *g);\n"
+" mkswap device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:4016
-msgid ""
-"List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
-"> command."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:4019
-msgid ""
-"This returns a list of just the volume group names that were detected (eg. "
-"C<VolGroup00>)."
-msgstr ""
-
-# type: textblock
-#: ../src/guestfs-actions.pod:5214
-msgid "See also C<guestfs_vgs_full>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3433 ../src/guestfs-actions.pod:5304
+msgid "Create a swap partition on C<device>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5220
-msgid "guestfs_vgs_full"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3435
+msgid "mkswap-L"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5222
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3437
#, no-wrap
msgid ""
-" struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *g);\n"
+" mkswap-L label device\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3439 ../src/guestfs-actions.pod:5317
+msgid "Create a swap partition on C<device> with label C<label>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5227
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3441 ../src/guestfs-actions.pod:5319
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>."
+"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:5232
-msgid "guestfs_vgscan"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3445
+msgid "mkswap-U"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5234
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3447
#, no-wrap
msgid ""
-" int guestfs_vgscan (guestfs_h *g);\n"
+" mkswap-U uuid device\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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3449 ../src/guestfs-actions.pod:5334
+msgid "Create a swap partition on C<device> with UUID C<uuid>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5241
-msgid "guestfs_vguuid"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3451
+msgid "mkswap-file"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5243
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3453
#, no-wrap
msgid ""
-" char *guestfs_vguuid (guestfs_h *g,\n"
-"\t\tconst char *vgname);\n"
+" mkswap-file path\n"
"\n"
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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3455 ../src/guestfs-actions.pod:5346
+msgid "Create a swap file."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5251
-msgid "guestfs_wait_ready"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3457
+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:3460
+msgid "modprobe"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5253
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3462
#, no-wrap
msgid ""
-" int guestfs_wait_ready (guestfs_h *g);\n"
+" modprobe modulename\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
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3464 ../src/guestfs-actions.pod:5361
+msgid "This loads a kernel module in the appliance."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5262
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3466 ../src/guestfs-actions.pod:5363
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."
+"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:5268
-msgid "guestfs_wc_c"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3469
+msgid "mount"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5270
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3471
#, no-wrap
msgid ""
-" int guestfs_wc_c (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" mount device mountpoint\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:4048
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3473 ../src/guestfs-actions.pod:5377
msgid ""
-"This command counts the characters in a file, using the C<wc -c> external "
-"command."
+"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: =head2
-#: ../src/guestfs-actions.pod:5278
-msgid "guestfs_wc_l"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3479 ../src/guestfs-actions.pod:5383
+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: verbatim
-#: ../src/guestfs-actions.pod:5280
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3484 ../src/guestfs-actions.pod:5388
msgid ""
-" int guestfs_wc_l (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
-"\n"
+"The mounted filesystem is writable, if we have sufficient permissions on the "
+"underlying device."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:4055
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3487
msgid ""
-"This command counts the lines in a file, using the C<wc -l> external command."
+"Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
+"and C<noatime>. The C<sync> option greatly slowed writes and caused many "
+"problems for users. If your program might need to work with older versions "
+"of libguestfs, use L</mount-options> instead (using an empty string for the "
+"first parameter if you don't want any options)."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5288
-msgid "guestfs_wc_w"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3494
+msgid "mount-9p"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5290
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3496
#, no-wrap
msgid ""
-" int guestfs_wc_w (guestfs_h *g,\n"
-"\t\tconst char *path);\n"
+" mount-9p mounttag mountpoint [options:..]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5293 ../fish/guestfish-actions.pod:4062
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3498 ../src/guestfs-actions.pod:5417
msgid ""
-"This command counts the words in a file, using the C<wc -w> external command."
+"Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
+"C<mountpoint>."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5298
-msgid "guestfs_write"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3501 ../src/guestfs-actions.pod:5420
+msgid ""
+"If required, C<trans=virtio> will be automatically added to the options. "
+"Any other options required can be passed in the optional C<options> "
+"parameter."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5300
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3507
+msgid "mount-loop"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3509
#, 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"
+" mount-loop file mountpoint\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5305 ../fish/guestfish-actions.pod:4069
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3511 ../src/guestfs-actions.pod:5459
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 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:5313
-msgid "guestfs_write_file"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3515
+msgid "mount-options"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5315
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3517
#, 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"
+" mount-options options device mountpoint\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:4079
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3519
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>."
+"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: textblock
-#: ../src/guestfs-actions.pod:5324 ../fish/guestfish-actions.pod:4083
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3523 ../src/guestfs-actions.pod:5479
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)."
+"If the C<options> parameter is an empty string, then no options are passed "
+"(all options default to whatever the filesystem uses)."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3527
+msgid "mount-ro"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5328 ../fish/guestfish-actions.pod:4087
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3529
+#, no-wrap
msgid ""
-"I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
-"I<not> work, even if the length is specified."
+" mount-ro device mountpoint\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5336 ../fish/guestfish-actions.pod:4093
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3531
msgid ""
-"This function is deprecated. In new code, use the C<write> call instead."
+"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
-#: ../src/guestfs-actions.pod:5343
-msgid "guestfs_zegrep"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3534
+msgid "mount-vfs"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5345
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3536
#, no-wrap
msgid ""
-" char **guestfs_zegrep (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" mount-vfs options vfstype device mountpoint\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5349 ../fish/guestfish-actions.pod:4104
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3538
msgid ""
-"This calls the external C<zegrep> program and returns the matching lines."
+"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
-#: ../src/guestfs-actions.pod:5359
-msgid "guestfs_zegrepi"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3542
+msgid "mountpoints"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5361
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3544
#, no-wrap
msgid ""
-" char **guestfs_zegrepi (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" mountpoints\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:4114
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3546
msgid ""
-"This calls the external C<zegrep -i> program and returns the matching lines."
+"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
-#: ../src/guestfs-actions.pod:5375
-msgid "guestfs_zero"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3550
+msgid "mounts"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5377
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3552
#, no-wrap
msgid ""
-" int guestfs_zero (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" mounts\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>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3554 ../src/guestfs-actions.pod:5540
+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:5382 ../fish/guestfish-actions.pod:4126
-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."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3557 ../src/guestfs-actions.pod:5543
+msgid "Some internal mounts are not shown."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5386
-msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3559
+msgid "See also: L</mountpoints>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5395
-msgid "guestfs_zero_device"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3561
+msgid "mv"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5397
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3563
#, no-wrap
msgid ""
-" int guestfs_zero_device (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" mv src dest\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5400
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3565 ../src/guestfs-actions.pod:5560
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 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:5414
-msgid "guestfs_zerofree"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3568
+msgid "ntfs-3g-probe"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5416
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3570
#, no-wrap
msgid ""
-" int guestfs_zerofree (guestfs_h *g,\n"
-"\t\tconst char *device);\n"
+" ntfs-3g-probe true|false device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5419 ../fish/guestfish-actions.pod:4147
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3572 ../src/guestfs-actions.pod:5574
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."
+"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:5424 ../fish/guestfish-actions.pod:4152
-msgid "You should B<not> run this program if the filesystem is mounted."
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3576 ../src/guestfs-actions.pod:5578
+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."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:4155
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3580 ../src/guestfs-actions.pod:5582
msgid ""
-"It is possible that using this program can damage the filesystem or data on "
-"the filesystem."
+"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: =head2
-#: ../src/guestfs-actions.pod:5432
-msgid "guestfs_zfgrep"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3584
+msgid "ntfsresize"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5434
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3586
#, no-wrap
msgid ""
-" char **guestfs_zfgrep (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tconst char *path);\n"
+" ntfsresize device\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:4162
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3588 ../fish/guestfish-actions.pod:3612
+#: ../src/guestfs-actions.pod:5603 ../src/guestfs-actions.pod:5635
msgid ""
-"This calls the external C<zfgrep> program and returns the matching lines."
+"This command resizes an NTFS filesystem, expanding or shrinking it to the "
+"size of the underlying device."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5448
-msgid "guestfs_zfgrepi"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3591 ../src/guestfs-actions.pod:5606
+msgid ""
+"I<Note:> After the resize operation, the filesystem is marked as requiring a "
+"consistency check (for safety). You have to boot into Windows to perform "
+"this check and clear this condition. Furthermore, ntfsresize refuses to "
+"resize filesystems which have been marked in this way. So in effect it is "
+"not possible to call ntfsresize multiple times on a single filesystem "
+"without booting into Windows between each resize."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5450
-#, no-wrap
-msgid ""
-" char **guestfs_zfgrepi (guestfs_h *g,\n"
-"\t\tconst char *pattern,\n"
-"\t\tconst char *path);\n"
-"\n"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3599 ../fish/guestfish-actions.pod:3638
+#: ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:5661
+msgid "See also L<ntfsresize(8)>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5454 ../fish/guestfish-actions.pod:4172
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3601 ../fish/guestfish-actions.pod:3649
msgid ""
-"This calls the external C<zfgrep -i> program and returns the matching lines."
+"I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
+"call instead."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5464
-msgid "guestfs_zfile"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3608
+msgid "ntfsresize-opts"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5466
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3610
#, no-wrap
msgid ""
-" char *guestfs_zfile (guestfs_h *g,\n"
-"\t\tconst char *meth,\n"
-"\t\tconst char *path);\n"
+" ntfsresize-opts device [size:..] [force:..]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5470 ../fish/guestfish-actions.pod:4182
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3621 ../src/guestfs-actions.pod:5644
msgid ""
-"This command runs C<file> after first decompressing C<path> using C<method>."
+"The new size (in bytes) of the filesystem. If omitted, the filesystem is "
+"resized to fit the container (eg. partition)."
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>."
+#. type: =item
+#: ../fish/guestfish-actions.pod:3624 ../src/guestfs-actions.pod:5647
+msgid "C<force>"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5475
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3626 ../src/guestfs-actions.pod:5649
msgid ""
-"Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
-"files."
+"If this option is true, then force the resize of the filesystem even if the "
+"filesystem is marked as requiring a consistency check."
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:4190
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3629
msgid ""
-"This function is deprecated. In new code, use the C<file> call instead."
+"After the resize operation, the filesystem is always marked as requiring a "
+"consistency check (for safety). You have to boot into Windows to perform "
+"this check and clear this condition. If you I<don't> set the C<force> "
+"option then it is not possible to call L</ntfsresize-opts> multiple times on "
+"a single filesystem without booting into Windows between each resize."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5488
-msgid "guestfs_zgrep"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3642
+msgid "ntfsresize-size"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5490
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3644
#, no-wrap
msgid ""
-" char **guestfs_zgrep (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" ntfsresize-size device size\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:4201
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3646
msgid ""
-"This calls the external C<zgrep> program and returns the matching lines."
+"This command is the same as L</ntfsresize> except that it allows you to "
+"specify the new size (in bytes) explicitly."
msgstr ""
-# type: =head2
-#: ../src/guestfs-actions.pod:5504
-msgid "guestfs_zgrepi"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3656
+msgid "part-add"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-actions.pod:5506
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3658
#, no-wrap
msgid ""
-" char **guestfs_zgrepi (guestfs_h *g,\n"
-"\t\tconst char *regex,\n"
-"\t\tconst char *path);\n"
+" part-add device prlogex startsect endsect\n"
"\n"
msgstr ""
-# type: textblock
-#: ../src/guestfs-actions.pod:5510 ../fish/guestfish-actions.pod:4211
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3660
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>"
+"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
-#: ../src/guestfs-availability.pod:5
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3663 ../src/guestfs-actions.pod:5722
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>"
+"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: =item
-#: ../src/guestfs-availability.pod:21
-msgid "B<inotify>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3668 ../src/guestfs-actions.pod:5727
+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)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:23
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3672
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>"
+"Creating a partition which covers the whole disk is not so easy. Use L</"
+"part-disk> to do that."
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:31
-msgid "B<linuxfsuuid>"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3675
+msgid "part-del"
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:33
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3677
+#, no-wrap
msgid ""
-"The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
-"guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
+" part-del device partnum\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:40
-msgid "B<linuxmodules>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3679 ../src/guestfs-actions.pod:5745
+msgid "This command deletes the partition numbered C<partnum> on C<device>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:42
-msgid "The following functions: L</guestfs_modprobe>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3681 ../src/guestfs-actions.pod:5747
+msgid ""
+"Note that in the case of MBR partitioning, deleting an extended partition "
+"also deletes any logical partitions it contains."
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:45
-msgid "B<linuxxattrs>"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3685
+msgid "part-disk"
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:47
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3687
+#, no-wrap
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>"
+" part-disk device parttype\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:56
-msgid "B<luks>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3689
+msgid ""
+"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
-#: ../src/guestfs-availability.pod:58
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3693
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>"
+"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: =item
-#: ../src/guestfs-availability.pod:67
-msgid "B<lvm2>"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3699
+msgid "part-get-bootable"
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:69
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3701
+#, no-wrap
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>"
+" part-get-bootable device partnum\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:92
-msgid "B<mknod>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3703 ../src/guestfs-actions.pod:5783
+msgid ""
+"This command returns true if the partition C<partnum> on C<device> has the "
+"bootable flag set."
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>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3706
+msgid "See also L</part-set-bootable>."
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:100
-msgid "B<ntfs3g>"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3708
+msgid "part-get-mbr-id"
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:102
-msgid "The following functions: L</guestfs_ntfs_3g_probe>"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3710
+#, no-wrap
+msgid ""
+" part-get-mbr-id device partnum\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:105
-msgid "B<ntfsprogs>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3712 ../src/guestfs-actions.pod:5799
+msgid ""
+"Returns the MBR type byte (also known as the ID byte) from the numbered "
+"partition C<partnum>."
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:107
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3715 ../fish/guestfish-actions.pod:3859
msgid ""
-"The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
+"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: =item
-#: ../src/guestfs-availability.pod:111
-msgid "B<realpath>"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3719
+msgid "part-get-parttype"
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:113
-msgid "The following functions: L</guestfs_realpath>"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3721
+#, no-wrap
+msgid ""
+" part-get-parttype device\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:116
-msgid "B<scrub>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3723 ../src/guestfs-actions.pod:5816
+msgid ""
+"This command examines the partition table on C<device> and returns the "
+"partition table type (format) being used."
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:118
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3726
msgid ""
-"The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
-"guestfs_scrub_freespace>"
+"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: =item
-#: ../src/guestfs-availability.pod:123
-msgid "B<selinux>"
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3731
+msgid "part-init"
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:125
-msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3733
+#, no-wrap
+msgid ""
+" part-init device parttype\n"
+"\n"
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:129
-msgid "B<xz>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3735 ../src/guestfs-actions.pod:5836
+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)."
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:131
-msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3739
+msgid ""
+"Initially there are no partitions. Following this, you should call L</part-"
+"add> for each partition required."
msgstr ""
-# type: =item
-#: ../src/guestfs-availability.pod:135
-msgid "B<zerofree>"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3742 ../src/guestfs-actions.pod:5843
+msgid "Possible values for C<parttype> are:"
msgstr ""
-# type: textblock
-#: ../src/guestfs-availability.pod:137
-msgid "The following functions: L</guestfs_zerofree>"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3746 ../src/guestfs-actions.pod:5847
+msgid "B<efi>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:1
-msgid "guestfs_int_bool"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3748 ../src/guestfs-actions.pod:5849
+msgid "B<gpt>"
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"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3750 ../src/guestfs-actions.pod:5851
+msgid "Intel EFI / GPT partition table."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:8
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3752 ../src/guestfs-actions.pod:5853
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 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: 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"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3756 ../src/guestfs-actions.pod:5857
+msgid "B<mbr>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:16
-msgid "guestfs_lvm_pv"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3758 ../src/guestfs-actions.pod:5859
+msgid "B<msdos>"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:18
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3760 ../src/guestfs-actions.pod:5861
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"
+"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: verbatim
-#: ../src/guestfs-structs.pod:36
-#, no-wrap
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3767 ../src/guestfs-actions.pod:5868
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"
+"Other partition table types that may work but are not supported include:"
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"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3772 ../src/guestfs-actions.pod:5873
+msgid "B<aix>"
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:44
-msgid "guestfs_lvm_vg"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3774 ../src/guestfs-actions.pod:5875
+msgid "AIX disk labels."
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"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3776 ../src/guestfs-actions.pod:5877
+msgid "B<amiga>"
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"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3778 ../src/guestfs-actions.pod:5879
+msgid "B<rdb>"
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"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3780 ../src/guestfs-actions.pod:5881
+msgid "Amiga \"Rigid Disk Block\" format."
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:77
-msgid "guestfs_lvm_lv"
+#. type: =item
+#: ../fish/guestfish-actions.pod:3782 ../src/guestfs-actions.pod:5883
+msgid "B<bsd>"
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"
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3784 ../src/guestfs-actions.pod:5885
+msgid "BSD disk labels."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5887
+msgid "B<dasd>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3788 ../src/guestfs-actions.pod:5889
+msgid "DASD, used on IBM mainframes."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:3790 ../src/guestfs-actions.pod:5891
+msgid "B<dvh>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5893
+msgid "MIPS/SGI volumes."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:3794 ../src/guestfs-actions.pod:5895
+msgid "B<mac>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3796 ../src/guestfs-actions.pod:5897
+msgid "Old Mac partition format. Modern Macs use C<gpt>."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:3798 ../src/guestfs-actions.pod:5899
+msgid "B<pc98>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3800 ../src/guestfs-actions.pod:5901
+msgid "NEC PC-98 format, common in Japan apparently."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:3802 ../src/guestfs-actions.pod:5903
+msgid "B<sun>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3804 ../src/guestfs-actions.pod:5905
+msgid "Sun disk labels."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3808
+msgid "part-list"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3810
+#, no-wrap
+msgid ""
+" part-list device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3812 ../src/guestfs-actions.pod:5919
+msgid ""
+"This command parses the partition table on C<device> and returns the list of "
+"partitions found."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3815 ../src/guestfs-actions.pod:5922
+msgid "The fields in the returned structure are:"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:3819 ../src/guestfs-actions.pod:5926
+msgid "B<part_num>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3821 ../src/guestfs-actions.pod:5928
+msgid "Partition number, counting from 1."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:3823 ../src/guestfs-actions.pod:5930
+msgid "B<part_start>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3825
+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: =item
+#: ../fish/guestfish-actions.pod:3828 ../src/guestfs-actions.pod:5935
+msgid "B<part_end>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3830 ../src/guestfs-actions.pod:5937
+msgid "End of the partition in bytes."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:3832 ../src/guestfs-actions.pod:5939
+msgid "B<part_size>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3834 ../src/guestfs-actions.pod:5941
+msgid "Size of the partition in bytes."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3838
+msgid "part-set-bootable"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3840
+#, no-wrap
+msgid ""
+" part-set-bootable device partnum true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3842 ../src/guestfs-actions.pod:5959
+msgid ""
+"This sets the bootable flag on partition numbered C<partnum> on device "
+"C<device>. Note that partitions are numbered from 1."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3845 ../src/guestfs-actions.pod:5962
+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
+#: ../fish/guestfish-actions.pod:3849
+msgid "part-set-mbr-id"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3851
+#, no-wrap
+msgid ""
+" part-set-mbr-id device partnum idbyte\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3853 ../src/guestfs-actions.pod:5978
+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."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3863
+msgid "part-set-name"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3865
+#, no-wrap
+msgid ""
+" part-set-name device partnum name\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3867 ../src/guestfs-actions.pod:6000
+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
+#: ../fish/guestfish-actions.pod:3870 ../src/guestfs-actions.pod:6003
+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
+#: ../fish/guestfish-actions.pod:3873
+msgid "part-to-dev"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3875
+#, no-wrap
+msgid ""
+" part-to-dev partition\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3877 ../src/guestfs-actions.pod:6016
+msgid ""
+"This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
+"partition number, returning the device name (eg. \"/dev/sdb\")."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3881 ../fish/guestfish-actions.pod:3893
+msgid ""
+"The named partition must exist, for example as a string returned from L</"
+"list-partitions>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3884
+msgid "See also L</part-to-partnum>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3886
+msgid "part-to-partnum"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3888
+#, no-wrap
+msgid ""
+" part-to-partnum partition\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3890 ../src/guestfs-actions.pod:6036
+msgid ""
+"This function takes a partition name (eg. \"/dev/sdb1\") and returns the "
+"partition number (eg. C<1>)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3896
+msgid "See also L</part-to-dev>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3898
+msgid "ping-daemon"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3900
+#, no-wrap
+msgid ""
+" ping-daemon\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3902 ../src/guestfs-actions.pod:6051
+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
+#: ../fish/guestfish-actions.pod:3907
+msgid "pread"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3909
+#, no-wrap
+msgid ""
+" pread path count offset\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3911 ../src/guestfs-actions.pod:6069
+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
+#: ../fish/guestfish-actions.pod:3914 ../fish/guestfish-actions.pod:3929
+#: ../src/guestfs-actions.pod:6072 ../src/guestfs-actions.pod:6098
+msgid ""
+"This may read fewer bytes than requested. For further details see the "
+"L<pread(2)> system call."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3917
+msgid "See also L</pwrite>, L</pread-device>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3922
+msgid "pread-device"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3924
+#, no-wrap
+msgid ""
+" pread-device device count offset\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3926 ../src/guestfs-actions.pod:6095
+msgid ""
+"This command lets you read part of a file. It reads C<count> bytes of "
+"C<device>, starting at C<offset>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3932
+msgid "See also L</pread>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3937
+msgid "pvcreate"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3939
+#, no-wrap
+msgid ""
+" pvcreate device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3941 ../src/guestfs-actions.pod:6118
+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>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3945
+msgid "pvremove"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3947
+#, no-wrap
+msgid ""
+" pvremove device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3949 ../src/guestfs-actions.pod:6132
+msgid ""
+"This wipes a physical volume C<device> so that LVM will no longer recognise "
+"it."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3952 ../src/guestfs-actions.pod:6135
+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: =head2
+#: ../fish/guestfish-actions.pod:3956
+msgid "pvresize"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3958
+#, no-wrap
+msgid ""
+" pvresize device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3960 ../src/guestfs-actions.pod:6149
+msgid ""
+"This resizes (expands or shrinks) an existing LVM physical volume to match "
+"the new size of the underlying device."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3963
+msgid "pvresize-size"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3965
+#, no-wrap
+msgid ""
+" pvresize-size device size\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3967
+msgid ""
+"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:3970
+msgid "pvs"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3972
+#, no-wrap
+msgid ""
+" pvs\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3974 ../src/guestfs-actions.pod:6175
+msgid ""
+"List all the physical volumes detected. This is the equivalent of the L<pvs"
+"(8)> command."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3977 ../src/guestfs-actions.pod:6178
+msgid ""
+"This returns a list of just the device names that contain PVs (eg. C</dev/"
+"sda2>)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3980
+msgid "See also L</pvs-full>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3982
+msgid "pvs-full"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3984
+#, no-wrap
+msgid ""
+" pvs-full\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3986 ../src/guestfs-actions.pod:6194
+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: =head2
+#: ../fish/guestfish-actions.pod:3989
+msgid "pvuuid"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3991
+#, no-wrap
+msgid ""
+" pvuuid device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3993 ../src/guestfs-actions.pod:6209
+msgid "This command returns the UUID of the LVM PV C<device>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:3995
+msgid "pwrite"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:3997
+#, no-wrap
+msgid ""
+" pwrite path content offset\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:3999 ../src/guestfs-actions.pod:6225
+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>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4002 ../src/guestfs-actions.pod:6228
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4008
+msgid "See also L</pread>, L</pwrite-device>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4013
+msgid "pwrite-device"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4015
+#, no-wrap
+msgid ""
+" pwrite-device device content offset\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4017 ../src/guestfs-actions.pod:6252
+msgid ""
+"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
+#: ../fish/guestfish-actions.pod:4020 ../src/guestfs-actions.pod:6255
+msgid ""
+"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: textblock
+#: ../fish/guestfish-actions.pod:4025
+msgid "See also L</pwrite>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4030
+msgid "read-file"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4032
+#, no-wrap
+msgid ""
+" read-file path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4034 ../src/guestfs-actions.pod:6276
+msgid "This calls returns the contents of the file C<path> as a buffer."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4037
+msgid ""
+"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:4045
+msgid "read-lines"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4047
+#, no-wrap
+msgid ""
+" read-lines path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4051 ../src/guestfs-actions.pod:6301
+msgid ""
+"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
+#: ../fish/guestfish-actions.pod:4054
+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 L</read-file> function which has a more complex "
+"interface."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4059
+msgid "readdir"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4061
+#, no-wrap
+msgid ""
+" readdir dir\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4063 ../src/guestfs-actions.pod:6321
+msgid "This returns the list of directory entries in directory C<dir>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4065 ../src/guestfs-actions.pod:6323
+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: textblock
+#: ../fish/guestfish-actions.pod:4069 ../src/guestfs-actions.pod:6327
+msgid ""
+"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
+#: ../fish/guestfish-actions.pod:4074 ../src/guestfs-actions.pod:6332
+msgid "'b'"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4076 ../src/guestfs-actions.pod:6334
+msgid "Block special"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6336
+msgid "'c'"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6338
+msgid "Char special"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4082 ../src/guestfs-actions.pod:6340
+msgid "'d'"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4084 ../src/guestfs-actions.pod:6342
+msgid "Directory"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4086 ../src/guestfs-actions.pod:6344
+msgid "'f'"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6346
+msgid "FIFO (named pipe)"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6348
+msgid "'l'"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6350
+msgid "Symbolic link"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4094 ../src/guestfs-actions.pod:6352
+msgid "'r'"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4096 ../src/guestfs-actions.pod:6354
+msgid "Regular file"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4098 ../src/guestfs-actions.pod:6356
+msgid "'s'"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4100 ../src/guestfs-actions.pod:6358
+msgid "Socket"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4102 ../src/guestfs-actions.pod:6360
+msgid "'u'"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6362
+msgid "Unknown file type"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4106 ../src/guestfs-actions.pod:6364
+msgid "'?'"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4108 ../src/guestfs-actions.pod:6366
+msgid ""
+"The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4113
+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:4117
+msgid "readlink"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4119
+#, no-wrap
+msgid ""
+" readlink path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4121 ../src/guestfs-actions.pod:6387
+msgid "This command reads the target of a symbolic link."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4123
+msgid "readlinklist"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4125
+#, no-wrap
+msgid ""
+" readlinklist path 'names ...'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4127 ../src/guestfs-actions.pod:6401
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4131 ../src/guestfs-actions.pod:6405
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4135 ../src/guestfs-actions.pod:6409
+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
+#: ../fish/guestfish-actions.pod:4142 ../src/guestfs-actions.pod:6416
+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
+#: ../fish/guestfish-actions.pod:4149
+msgid "realpath"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4151
+#, no-wrap
+msgid ""
+" realpath path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4153 ../src/guestfs-actions.pod:6435
+msgid ""
+"Return the canonicalized absolute pathname of C<path>. The returned path "
+"has no C<.>, C<..> or symbolic link path elements."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4156
+msgid "removexattr"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4158
+#, no-wrap
+msgid ""
+" removexattr xattr path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4160 ../src/guestfs-actions.pod:6450
+msgid ""
+"This call removes the extended attribute named C<xattr> of the file C<path>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4163
+msgid "See also: L</lremovexattr>, L<attr(5)>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4165
+msgid "resize2fs"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4167
+#, no-wrap
+msgid ""
+" resize2fs device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4169 ../src/guestfs-actions.pod:6465
+msgid ""
+"This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
+"underlying device."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4172
+msgid ""
+"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:4178
+msgid "resize2fs-M"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4180
+#, no-wrap
+msgid ""
+" resize2fs-M device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4182
+msgid ""
+"This command is the same as L</resize2fs>, but the filesystem is resized to "
+"its minimum size. This works like the I<-M> option to the C<resize2fs> "
+"command."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4186
+msgid ""
+"To get the resulting size of the filesystem you should call L</tune2fs-l> "
+"and read the C<Block size> and C<Block count> values. These two numbers, "
+"multiplied together, give the resulting size of the minimal filesystem in "
+"bytes."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4191
+msgid "resize2fs-size"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4193
+#, no-wrap
+msgid ""
+" resize2fs-size device size\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4195
+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:4198
+msgid "rm"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4200
+#, no-wrap
+msgid ""
+" rm path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4202 ../src/guestfs-actions.pod:6517
+msgid "Remove the single file C<path>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4204
+msgid "rm-rf"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4206
+#, no-wrap
+msgid ""
+" rm-rf path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4208 ../src/guestfs-actions.pod:6529
+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."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4212
+msgid "rmdir"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4214
+#, no-wrap
+msgid ""
+" rmdir path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4216 ../src/guestfs-actions.pod:6543
+msgid "Remove the single directory C<path>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4218
+msgid "rmmountpoint"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4220
+#, no-wrap
+msgid ""
+" rmmountpoint exemptpath\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4222
+msgid ""
+"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:4226
+msgid "scrub-device"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4228
+#, no-wrap
+msgid ""
+" scrub-device device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4230 ../src/guestfs-actions.pod:6569
+msgid ""
+"This command writes patterns over C<device> to make data retrieval more "
+"difficult."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4233 ../fish/guestfish-actions.pod:4248
+#: ../fish/guestfish-actions.pod:4261 ../src/guestfs-actions.pod:6572
+#: ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6612
+msgid ""
+"It is an interface to the L<scrub(1)> program. See that manual page for "
+"more details."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4239
+msgid "scrub-file"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4241
+#, no-wrap
+msgid ""
+" scrub-file file\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4243 ../src/guestfs-actions.pod:6588
+msgid ""
+"This command writes patterns over a file to make data retrieval more "
+"difficult."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4246 ../src/guestfs-actions.pod:6591
+msgid "The file is I<removed> after scrubbing."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4251
+msgid "scrub-freespace"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4253
+#, no-wrap
+msgid ""
+" scrub-freespace dir\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4255
+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 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:4264
+msgid "set-append"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4266
+msgid "append"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4268
+#, no-wrap
+msgid ""
+" set-append append\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4270 ../src/guestfs-actions.pod:6625
+msgid ""
+"This function is used to add additional options to the guest kernel command "
+"line."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4273 ../src/guestfs-actions.pod:6628
+msgid ""
+"The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
+"environment variable."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4276 ../src/guestfs-actions.pod:6631
+msgid ""
+"Setting C<append> to C<NULL> means I<no> additional options are passed "
+"(libguestfs always adds a few of its own)."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4279
+msgid "set-attach-method"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4281
+msgid "attach-method"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4283
+#, no-wrap
+msgid ""
+" set-attach-method attachmethod\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4285 ../src/guestfs-actions.pod:6644
+msgid ""
+"Set the method that libguestfs uses to connect to the back end guestfsd "
+"daemon. Possible methods are:"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4290 ../src/guestfs-actions.pod:6649
+#: ../src/guestfs.pod:2916
+msgid "C<appliance>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4292 ../src/guestfs-actions.pod:6651
+msgid ""
+"Launch an appliance and connect to it. This is the ordinary method and the "
+"default."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4295 ../src/guestfs-actions.pod:6654
+msgid "C<unix:I<path>>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4297 ../src/guestfs-actions.pod:6656
+msgid "Connect to the Unix domain socket I<path>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4299 ../src/guestfs-actions.pod:6658
+msgid ""
+"This method lets you connect to an existing daemon or (using virtio-serial) "
+"to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
+"RUNNING DAEMONS>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4305
+msgid "set-autosync"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4307
+msgid "autosync"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4309
+#, no-wrap
+msgid ""
+" set-autosync true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4311 ../src/guestfs-actions.pod:6674
+msgid ""
+"If C<autosync> is true, this enables autosync. Libguestfs will make a best "
+"effort attempt to make filesystems consistent and synchronized when the "
+"handle is closed (also if the program exits without closing handles)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4316 ../src/guestfs-actions.pod:6679
+msgid ""
+"This is enabled by default (since libguestfs 1.5.24, previously it was "
+"disabled by default)."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4319
+msgid "set-direct"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4321
+msgid "direct"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4323
+#, no-wrap
+msgid ""
+" set-direct true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4325 ../src/guestfs-actions.pod:6692
+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
+#: ../fish/guestfish-actions.pod:4329
+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: textblock
+#: ../fish/guestfish-actions.pod:4333 ../src/guestfs-actions.pod:6700
+msgid "You probably don't want to use this unless you know what you are doing."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4336 ../src/guestfs-actions.pod:6703
+msgid "The default is disabled."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4338
+msgid "set-e2label"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4340
+#, no-wrap
+msgid ""
+" set-e2label device label\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4342 ../src/guestfs-actions.pod:6716
+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
+#: ../fish/guestfish-actions.pod:4346
+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:4349
+msgid "set-e2uuid"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4351
+#, no-wrap
+msgid ""
+" set-e2uuid device uuid\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4353 ../src/guestfs-actions.pod:6734
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4358
+msgid ""
+"You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
+"UUID of a filesystem."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4361
+msgid "set-memsize"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4363
+msgid "memsize"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4365
+#, no-wrap
+msgid ""
+" set-memsize memsize\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4367
+msgid ""
+"This sets the memory size in megabytes allocated to the qemu subprocess. "
+"This only has any effect if called before L</launch>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4371 ../src/guestfs-actions.pod:6756
+msgid ""
+"You can also change this by setting the environment variable "
+"C<LIBGUESTFS_MEMSIZE> before the handle is created."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4378
+msgid "set-network"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4380
+msgid "network"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4382
+#, no-wrap
+msgid ""
+" set-network true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4384 ../src/guestfs-actions.pod:6773
+msgid ""
+"If C<network> is true, then the network is enabled in the libguestfs "
+"appliance. The default is false."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4387 ../src/guestfs-actions.pod:6776
+msgid ""
+"This affects whether commands are able to access the network (see L<guestfs"
+"(3)/RUNNING COMMANDS>)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4390
+msgid ""
+"You must call this before calling L</launch>, otherwise it has no effect."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4393
+msgid "set-path"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4397
+#, no-wrap
+msgid ""
+" set-path searchpath\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4399 ../src/guestfs-actions.pod:6792
+msgid "Set the path that libguestfs searches for kernel and initrd.img."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4401 ../src/guestfs-actions.pod:6794
+msgid ""
+"The default is C<$libdir/guestfs> unless overridden by setting "
+"C<LIBGUESTFS_PATH> environment variable."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4404 ../src/guestfs-actions.pod:6797
+msgid "Setting C<path> to C<NULL> restores the default path."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4406
+msgid "set-pgroup"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4408
+msgid "pgroup"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4410
+#, no-wrap
+msgid ""
+" set-pgroup true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4412 ../src/guestfs-actions.pod:6809
+msgid ""
+"If C<pgroup> is true, child processes are placed into their own process "
+"group."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4415 ../src/guestfs-actions.pod:6812
+msgid ""
+"The practical upshot of this is that signals like C<SIGINT> (from users "
+"pressing C<^C>) won't be received by the child process."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4418 ../src/guestfs-actions.pod:6815
+msgid ""
+"The default for this flag is false, because usually you want C<^C> to kill "
+"the subprocess."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4421
+msgid "set-qemu"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4423
+msgid "qemu"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4425
+#, no-wrap
+msgid ""
+" set-qemu qemu\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4427 ../src/guestfs-actions.pod:6828
+msgid "Set the qemu binary that we will use."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4429 ../src/guestfs-actions.pod:6830
+msgid ""
+"The default is chosen when the library was compiled by the configure script."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4432 ../src/guestfs-actions.pod:6833
+msgid ""
+"You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
+"variable."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4435 ../src/guestfs-actions.pod:6836
+msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4437 ../src/guestfs-actions.pod:6838
+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
+#: ../fish/guestfish-actions.pod:4445
+msgid "set-recovery-proc"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4447
+msgid "recovery-proc"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4449
+#, no-wrap
+msgid ""
+" set-recovery-proc true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4451
+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:4456
+msgid ""
+"This only has any effect if called before L</launch>, and the default is "
+"true."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4459 ../src/guestfs-actions.pod:6864
+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
+#: ../fish/guestfish-actions.pod:4465
+msgid "set-selinux"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4467
+msgid "selinux"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4469
+#, no-wrap
+msgid ""
+" set-selinux true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4471 ../src/guestfs-actions.pod:6880
+msgid ""
+"This sets the selinux flag that is passed to the appliance at boot time. "
+"The default is C<selinux=0> (disabled)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4474 ../src/guestfs-actions.pod:6883
+msgid ""
+"Note that if SELinux is enabled, it is always in Permissive mode "
+"(C<enforcing=0>)."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4480
+msgid "set-smp"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4482
+msgid "smp"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4484
+#, no-wrap
+msgid ""
+" set-smp smp\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4486 ../src/guestfs-actions.pod:6899
+msgid ""
+"Change the number of virtual CPUs assigned to the appliance. The default is "
+"C<1>. Increasing this may improve performance, though often it has no "
+"effect."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4490
+msgid "This function must be called before L</launch>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4492
+msgid "set-trace"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4494
+msgid "trace"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4496
+#, no-wrap
+msgid ""
+" set-trace true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4498 ../src/guestfs-actions.pod:6915
+msgid ""
+"If the command trace flag is set to 1, then libguestfs calls, parameters and "
+"return values are traced."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4501 ../src/guestfs-actions.pod:6918
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4505 ../src/guestfs-actions.pod:6922
+msgid ""
+"Command traces are disabled unless the environment variable "
+"C<LIBGUESTFS_TRACE> is defined and set to C<1>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4508
+msgid ""
+"Trace messages are normally sent to C<stderr>, unless you register a "
+"callback to send them somewhere else (see L</set-event-callback>)."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4512
+msgid "set-verbose"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4514
+msgid "verbose"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4516
+#, no-wrap
+msgid ""
+" set-verbose true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4518 ../src/guestfs-actions.pod:6939
+msgid "If C<verbose> is true, this turns on verbose messages."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4520 ../src/guestfs-actions.pod:6941
+msgid ""
+"Verbose messages are disabled unless the environment variable "
+"C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4523
+msgid ""
+"Verbose messages are normally sent to C<stderr>, unless you register a "
+"callback to send them somewhere else (see L</set-event-callback>)."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4527
+msgid "setcon"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4529
+#, no-wrap
+msgid ""
+" setcon context\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4531 ../src/guestfs-actions.pod:6958
+msgid ""
+"This sets the SELinux security context of the daemon to the string "
+"C<context>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4534 ../src/guestfs-actions.pod:6961
+msgid "See the documentation about SELINUX in L<guestfs(3)>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4536
+msgid "setxattr"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4538
+#, no-wrap
+msgid ""
+" setxattr xattr val vallen path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:6976
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4544
+msgid "See also: L</lsetxattr>, L<attr(5)>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4546
+msgid "sfdisk"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4548
+#, no-wrap
+msgid ""
+" sfdisk device cyls heads sectors 'lines ...'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4550 ../src/guestfs-actions.pod:7003
+msgid ""
+"This is a direct interface to the L<sfdisk(8)> program for creating "
+"partitions on block devices."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4553 ../src/guestfs-actions.pod:7006
+msgid "C<device> should be a block device, for example C</dev/sda>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4555 ../src/guestfs-actions.pod:7008
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4563 ../src/guestfs-actions.pod:7016
+msgid ""
+"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: textblock
+#: ../fish/guestfish-actions.pod:4566 ../src/guestfs-actions.pod:7019
+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)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4570
+msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4576 ../fish/guestfish-actions.pod:4599
+#: ../fish/guestfish-actions.pod:4621
+msgid ""
+"I<This function is deprecated.> In new code, use the L</part_add> call "
+"instead."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4583
+msgid "sfdiskM"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4585
+#, no-wrap
+msgid ""
+" sfdiskM device 'lines ...'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4587
+msgid ""
+"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:4593
+msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4606
+msgid "sfdisk-N"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4608
+#, no-wrap
+msgid ""
+" sfdisk-N device partnum cyls heads sectors line\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4610 ../src/guestfs-actions.pod:7081
+msgid ""
+"This runs L<sfdisk(8)> option to modify just the single partition C<n> "
+"(note: C<n> counts from 1)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4613
+msgid ""
+"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:4616
+msgid "See also: L</part-add>"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4628
+msgid "sfdisk-disk-geometry"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4630
+#, no-wrap
+msgid ""
+" sfdisk-disk-geometry device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4632
+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: textblock
+#: ../fish/guestfish-actions.pod:4637 ../fish/guestfish-actions.pod:4646
+#: ../src/guestfs-actions.pod:7107 ../src/guestfs-actions.pod:7123
+msgid "The result is in human-readable format, and not designed to be parsed."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4640
+msgid "sfdisk-kernel-geometry"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4642
+#, no-wrap
+msgid ""
+" sfdisk-kernel-geometry device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4644 ../src/guestfs-actions.pod:7121
+msgid "This displays the kernel's idea of the geometry of C<device>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4649
+msgid "sfdisk-l"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4651
+#, no-wrap
+msgid ""
+" sfdisk-l device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4653 ../src/guestfs-actions.pod:7144
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4657
+msgid "See also: L</part-list>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4659
+msgid ""
+"I<This function is deprecated.> In new code, use the L</part_list> call "
+"instead."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4666
+msgid "sh"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4668
+#, no-wrap
+msgid ""
+" sh command\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4670 ../src/guestfs-actions.pod:7161
+msgid ""
+"This call runs a command from the guest filesystem via the guest's C</bin/"
+"sh>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4673
+msgid "This is like L</command>, but passes the command to:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4675 ../src/guestfs-actions.pod:7166
+#, no-wrap
+msgid ""
+" /bin/sh -c \"command\"\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4677 ../src/guestfs-actions.pod:7168
+msgid ""
+"Depending on the guest's shell, this usually results in wildcards being "
+"expanded, shell expressions being interpolated and so on."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4681
+msgid "All the provisos about L</command> apply to this call."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4683
+msgid "sh-lines"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4685
+#, no-wrap
+msgid ""
+" sh-lines command\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4687
+msgid "This is the same as L</sh>, but splits the result into a list of lines."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4690
+msgid "See also: L</command-lines>"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4692
+msgid "sleep"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4694
+#, no-wrap
+msgid ""
+" sleep secs\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4696 ../src/guestfs-actions.pod:7202
+msgid "Sleep for C<secs> seconds."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4698
+msgid "stat"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4700
+#, no-wrap
+msgid ""
+" stat path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4704 ../src/guestfs-actions.pod:7216
+msgid "This is the same as the C<stat(2)> system call."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4706
+msgid "statvfs"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4708
+#, no-wrap
+msgid ""
+" statvfs path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4710 ../src/guestfs-actions.pod:7230
+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
+#: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7234
+msgid "This is the same as the C<statvfs(2)> system call."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4716
+msgid "strings"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4718
+#, no-wrap
+msgid ""
+" strings path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4720 ../src/guestfs-actions.pod:7248
+msgid ""
+"This runs the L<strings(1)> command on a file and returns the list of "
+"printable strings found."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4726
+msgid "strings-e"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4728
+#, no-wrap
+msgid ""
+" strings-e encoding path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4730
+msgid ""
+"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:4734 ../src/guestfs-actions.pod:7271
+msgid "Allowed encodings are:"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4738 ../src/guestfs-actions.pod:7275
+msgid "s"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4740
+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: =item
+#: ../fish/guestfish-actions.pod:4743 ../src/guestfs-actions.pod:7280
+msgid "S"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4745 ../src/guestfs-actions.pod:7282
+msgid "Single 8-bit-byte characters."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4747 ../src/guestfs-actions.pod:7284
+msgid "b"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4749 ../src/guestfs-actions.pod:7286
+msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4752 ../src/guestfs-actions.pod:7289
+msgid "l (lower case letter L)"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4754 ../src/guestfs-actions.pod:7291
+msgid ""
+"16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
+"examining binaries in Windows guests."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4757 ../src/guestfs-actions.pod:7294
+msgid "B"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4759 ../src/guestfs-actions.pod:7296
+msgid "32-bit big endian such as UCS-4BE."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish-actions.pod:4761 ../src/guestfs-actions.pod:7298
+msgid "L"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4763 ../src/guestfs-actions.pod:7300
+msgid "32-bit little endian such as UCS-4LE."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4767 ../src/guestfs-actions.pod:7304
+msgid "The returned strings are transcoded to UTF-8."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4772
+msgid "swapoff-device"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4774
+#, no-wrap
+msgid ""
+" swapoff-device device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4776
+msgid ""
+"This command disables the libguestfs appliance swap device or partition "
+"named C<device>. See L</swapon-device>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4780
+msgid "swapoff-file"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4782
+#, no-wrap
+msgid ""
+" swapoff-file file\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4784 ../src/guestfs-actions.pod:7335
+msgid "This command disables the libguestfs appliance swap on file."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4786
+msgid "swapoff-label"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4788
+#, no-wrap
+msgid ""
+" swapoff-label label\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4790 ../src/guestfs-actions.pod:7347
+msgid ""
+"This command disables the libguestfs appliance swap on labeled swap "
+"partition."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4793
+msgid "swapoff-uuid"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4795
+#, no-wrap
+msgid ""
+" swapoff-uuid uuid\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4797 ../src/guestfs-actions.pod:7360
+msgid ""
+"This command disables the libguestfs appliance swap partition with the given "
+"UUID."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4800
+msgid "swapon-device"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4802
+#, no-wrap
+msgid ""
+" swapon-device device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4804
+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 L</command> or L</sh>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4809 ../src/guestfs-actions.pod:7378
+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
+#: ../fish/guestfish-actions.pod:4816
+msgid "swapon-file"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4818
+#, no-wrap
+msgid ""
+" swapon-file file\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4820
+msgid ""
+"This command enables swap to a file. See L</swapon-device> for other notes."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4823
+msgid "swapon-label"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4825
+#, no-wrap
+msgid ""
+" swapon-label label\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4827
+msgid ""
+"This command enables swap to a labeled swap partition. See L</swapon-"
+"device> for other notes."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4830
+msgid "swapon-uuid"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4832
+#, no-wrap
+msgid ""
+" swapon-uuid uuid\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4834
+msgid ""
+"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:4837
+msgid "sync"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4839
+#, no-wrap
+msgid ""
+" sync\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4841 ../src/guestfs-actions.pod:7433
+msgid ""
+"This syncs the disk, so that any writes are flushed through to the "
+"underlying disk image."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4844 ../src/guestfs-actions.pod:7436
+msgid ""
+"You should always call this if you have modified a disk image, before "
+"closing the handle."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4847
+msgid "tail"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4849
+#, no-wrap
+msgid ""
+" tail path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4851 ../src/guestfs-actions.pod:7449
+msgid ""
+"This command returns up to the last 10 lines of a file as a list of strings."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4857
+msgid "tail-n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4859
+#, no-wrap
+msgid ""
+" tail-n nrlines path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4861 ../src/guestfs-actions.pod:7468
+msgid ""
+"If the parameter C<nrlines> is a positive number, this returns the last "
+"C<nrlines> lines of the file C<path>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4864 ../src/guestfs-actions.pod:7471
+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
+#: ../fish/guestfish-actions.pod:4872
+msgid "tar-in"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4874
+#, no-wrap
+msgid ""
+" tar-in (tarfile|-) directory\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7492
+msgid ""
+"This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
+"tar file) into C<directory>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4879
+msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4884
+msgid "tar-out"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4886
+#, no-wrap
+msgid ""
+" tar-out directory (tarfile|-)\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4888 ../src/guestfs-actions.pod:7509
+msgid ""
+"This command packs the contents of C<directory> and downloads it to local "
+"file C<tarfile>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4891
+msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4896
+msgid "tgz-in"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4898
+#, no-wrap
+msgid ""
+" tgz-in (tarball|-) directory\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4900 ../src/guestfs-actions.pod:7526
+msgid ""
+"This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
+"tar file) into C<directory>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4903
+msgid "To upload an uncompressed tarball, use L</tar-in>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4907
+msgid "tgz-out"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4909
+#, no-wrap
+msgid ""
+" tgz-out directory (tarball|-)\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4911 ../src/guestfs-actions.pod:7542
+msgid ""
+"This command packs the contents of C<directory> and downloads it to local "
+"file C<tarball>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4914
+msgid "To download an uncompressed tarball, use L</tar-out>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4918
+msgid "touch"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4920
+#, no-wrap
+msgid ""
+" touch path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4922 ../src/guestfs-actions.pod:7557
+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
+#: ../fish/guestfish-actions.pod:4926 ../src/guestfs-actions.pod:7561
+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
+#: ../fish/guestfish-actions.pod:4929
+msgid "truncate"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4931
+#, no-wrap
+msgid ""
+" truncate path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4933 ../src/guestfs-actions.pod:7574
+msgid ""
+"This command truncates C<path> to a zero-length file. The file must exist "
+"already."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4936
+msgid "truncate-size"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4938
+#, no-wrap
+msgid ""
+" truncate-size path size\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4940 ../src/guestfs-actions.pod:7588
+msgid ""
+"This command truncates C<path> to size C<size> bytes. The file must exist "
+"already."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4943
+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 L</fallocate64> instead."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4949
+msgid "tune2fs-l"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4951
+#, no-wrap
+msgid ""
+" tune2fs-l device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4953 ../src/guestfs-actions.pod:7607
+msgid ""
+"This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
+"C<device>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4956 ../src/guestfs-actions.pod:7610
+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
+#: ../fish/guestfish-actions.pod:4961
+msgid "txz-in"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4963
+#, no-wrap
+msgid ""
+" txz-in (tarball|-) directory\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4965 ../src/guestfs-actions.pod:7630
+msgid ""
+"This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
+"tar file) into C<directory>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:4970
+msgid "txz-out"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4972
+#, no-wrap
+msgid ""
+" txz-out directory (tarball|-)\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4974 ../src/guestfs-actions.pod:7644
+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
+#: ../fish/guestfish-actions.pod:4979
+msgid "umask"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:4981
+#, no-wrap
+msgid ""
+" umask mask\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4983 ../src/guestfs-actions.pod:7657
+msgid ""
+"This function sets the mask used for creating new files and device nodes to "
+"C<mask & 0777>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4986 ../src/guestfs-actions.pod:7660
+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
+#: ../fish/guestfish-actions.pod:4991 ../src/guestfs-actions.pod:7665
+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
+#: ../fish/guestfish-actions.pod:4995
+msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:4998 ../src/guestfs-actions.pod:7672
+msgid "This call returns the previous umask."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5000
+msgid "umount"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5002
+msgid "unmount"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5004
+#, no-wrap
+msgid ""
+" umount pathordevice\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5006 ../src/guestfs-actions.pod:7684
+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
+#: ../fish/guestfish-actions.pod:5010
+msgid "umount-all"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5012
+msgid "unmount-all"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5014
+#, no-wrap
+msgid ""
+" umount-all\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5016 ../src/guestfs-actions.pod:7697
+msgid "This unmounts all mounted filesystems."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5018 ../src/guestfs-actions.pod:7699
+msgid "Some internal mounts are not unmounted by this call."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5020
+msgid "upload"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5022
+#, no-wrap
+msgid ""
+" upload (filename|-) remotefilename\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5024 ../fish/guestfish-actions.pod:5037
+#: ../src/guestfs-actions.pod:7712 ../src/guestfs-actions.pod:7736
+msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5029
+msgid "See also L</download>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5033
+msgid "upload-offset"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5035
+#, no-wrap
+msgid ""
+" upload-offset (filename|-) remotefilename offset\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5040 ../src/guestfs-actions.pod:7739
+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
+#: ../fish/guestfish-actions.pod:5047
+msgid ""
+"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:5052
+msgid "See also L</upload>, L</pwrite>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5056
+msgid "utimens"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5058
+#, no-wrap
+msgid ""
+" utimens path atsecs atnsecs mtsecs mtnsecs\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5060 ../src/guestfs-actions.pod:7772
+msgid "This command sets the timestamps of a file with nanosecond precision."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5063 ../src/guestfs-actions.pod:7775
+msgid ""
+"C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
+"from the epoch."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5066 ../src/guestfs-actions.pod:7778
+msgid ""
+"C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
+"nanoseconds from the epoch."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5069 ../src/guestfs-actions.pod:7781
+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
+#: ../fish/guestfish-actions.pod:5073 ../src/guestfs-actions.pod:7785
+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
+#: ../fish/guestfish-actions.pod:5077
+msgid "version"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5079
+#, no-wrap
+msgid ""
+" version\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5081 ../src/guestfs-actions.pod:7798
+msgid ""
+"Return the libguestfs version number that the program is linked against."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5084 ../src/guestfs-actions.pod:7801
+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
+#: ../fish/guestfish-actions.pod:5089 ../src/guestfs-actions.pod:7806
+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
+#: ../fish/guestfish-actions.pod:5095 ../src/guestfs-actions.pod:7812
+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
+#: ../fish/guestfish-actions.pod:5101 ../src/guestfs-actions.pod:7818
+msgid ""
+"To construct the original version string: C<$major.$minor.$release$extra>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5104 ../src/guestfs-actions.pod:7821
+msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5106
+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:5112
+msgid "vfs-label"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5114
+#, no-wrap
+msgid ""
+" vfs-label device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5116 ../src/guestfs-actions.pod:7841
+msgid "This returns the filesystem label of the filesystem on C<device>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5119 ../src/guestfs-actions.pod:7844
+msgid "If the filesystem is unlabeled, this returns the empty string."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5121
+msgid "To find a filesystem from the label, use L</findfs-label>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5123
+msgid "vfs-type"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5125
+#, no-wrap
+msgid ""
+" vfs-type device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5127 ../src/guestfs-actions.pod:7859
+msgid ""
+"This command gets the filesystem type corresponding to the filesystem on "
+"C<device>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5130 ../src/guestfs-actions.pod:7862
+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
+#: ../fish/guestfish-actions.pod:5135
+msgid "vfs-uuid"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5137
+#, no-wrap
+msgid ""
+" vfs-uuid device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5139 ../src/guestfs-actions.pod:7878
+msgid "This returns the filesystem UUID of the filesystem on C<device>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5142 ../src/guestfs-actions.pod:7881
+msgid "If the filesystem does not have a UUID, this returns the empty string."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5144
+msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5146
+msgid "vg-activate"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5148
+#, no-wrap
+msgid ""
+" vg-activate true|false 'volgroups ...'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5150 ../src/guestfs-actions.pod:7897
+msgid ""
+"This command activates or (if C<activate> is false) deactivates all logical "
+"volumes in the listed volume groups C<volgroups>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5153 ../src/guestfs-actions.pod:7900
+msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5155 ../src/guestfs-actions.pod:7902
+msgid ""
+"Note that if C<volgroups> is an empty list then B<all> volume groups are "
+"activated or deactivated."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5158
+msgid "vg-activate-all"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5160
+#, no-wrap
+msgid ""
+" vg-activate-all true|false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5162 ../src/guestfs-actions.pod:7915
+msgid ""
+"This command activates or (if C<activate> is false) deactivates all logical "
+"volumes in all volume groups."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5165 ../src/guestfs-actions.pod:7918
+msgid "This command is the same as running C<vgchange -a y|n>"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5167
+msgid "vgcreate"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5169
+#, no-wrap
+msgid ""
+" vgcreate volgroup 'physvols ...'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5171 ../src/guestfs-actions.pod:7931
+msgid ""
+"This creates an LVM volume group called C<volgroup> from the non-empty list "
+"of physical volumes C<physvols>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5174
+msgid "vglvuuids"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5176
+#, no-wrap
+msgid ""
+" vglvuuids vgname\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5178 ../src/guestfs-actions.pod:7944
+msgid ""
+"Given a VG called C<vgname>, this returns the UUIDs of all the logical "
+"volumes created in this volume group."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5181
+msgid ""
+"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:5184
+msgid "See also L</vgpvuuids>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5186
+msgid "vgpvuuids"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5188
+#, no-wrap
+msgid ""
+" vgpvuuids vgname\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5190 ../src/guestfs-actions.pod:7964
+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
+#: ../fish/guestfish-actions.pod:5193
+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:5196
+msgid "See also L</vglvuuids>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5198
+msgid "vgremove"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5200
+#, no-wrap
+msgid ""
+" vgremove vgname\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5202 ../src/guestfs-actions.pod:7984
+msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5204 ../src/guestfs-actions.pod:7986
+msgid ""
+"This also forcibly removes all logical volumes in the volume group (if any)."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5207
+msgid "vgrename"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5209
+#, no-wrap
+msgid ""
+" vgrename volgroup newvolgroup\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5211 ../src/guestfs-actions.pod:8000
+msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5213
+msgid "vgs"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5215
+#, no-wrap
+msgid ""
+" vgs\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5217 ../src/guestfs-actions.pod:8011
+msgid ""
+"List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
+"> command."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5220 ../src/guestfs-actions.pod:8014
+msgid ""
+"This returns a list of just the volume group names that were detected (eg. "
+"C<VolGroup00>)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5223
+msgid "See also L</vgs-full>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5225
+msgid "vgs-full"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5227
+#, no-wrap
+msgid ""
+" vgs-full\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5229 ../src/guestfs-actions.pod:8030
+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: =head2
+#: ../fish/guestfish-actions.pod:5232
+msgid "vgscan"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5234
+#, no-wrap
+msgid ""
+" vgscan\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5236 ../src/guestfs-actions.pod:8044
+msgid ""
+"This rescans all block devices and rebuilds the list of LVM physical "
+"volumes, volume groups and logical volumes."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5239
+msgid "vguuid"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5241
+#, no-wrap
+msgid ""
+" vguuid vgname\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5243 ../src/guestfs-actions.pod:8057
+msgid "This command returns the UUID of the LVM VG named C<vgname>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5245
+msgid "wc-c"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5247
+#, no-wrap
+msgid ""
+" wc-c path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5249 ../src/guestfs-actions.pod:8097
+msgid ""
+"This command counts the characters in a file, using the C<wc -c> external "
+"command."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5252
+msgid "wc-l"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5254
+#, no-wrap
+msgid ""
+" wc-l path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5256 ../src/guestfs-actions.pod:8110
+msgid ""
+"This command counts the lines in a file, using the C<wc -l> external command."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5259
+msgid "wc-w"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5261
+#, no-wrap
+msgid ""
+" wc-w path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5263 ../src/guestfs-actions.pod:8123
+msgid ""
+"This command counts the words in a file, using the C<wc -w> external command."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5266
+msgid "write"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5268
+#, no-wrap
+msgid ""
+" write path content\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5270 ../src/guestfs-actions.pod:8138
+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: textblock
+#: ../fish/guestfish-actions.pod:5273
+msgid "See also L</write-append>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5278
+msgid "write-append"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5280
+#, no-wrap
+msgid ""
+" write-append path content\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5282 ../src/guestfs-actions.pod:8158
+msgid ""
+"This call appends C<content> to the end of file C<path>. If C<path> does "
+"not exist, then a new file is created."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5285
+msgid "See also L</write>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5290
+msgid "write-file"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5292
+#, no-wrap
+msgid ""
+" write-file path content size\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5294 ../src/guestfs-actions.pod:8185
+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
+#: ../fish/guestfish-actions.pod:5298 ../src/guestfs-actions.pod:8189
+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
+#: ../fish/guestfish-actions.pod:5302 ../src/guestfs-actions.pod:8193
+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
+#: ../fish/guestfish-actions.pod:5308
+msgid ""
+"I<This function is deprecated.> In new code, use the L</write> call instead."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5315
+msgid "zegrep"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5317
+#, no-wrap
+msgid ""
+" zegrep regex path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5319 ../src/guestfs-actions.pod:8210
+msgid ""
+"This calls the external C<zegrep> program and returns the matching lines."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5325
+msgid "zegrepi"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5327
+#, no-wrap
+msgid ""
+" zegrepi regex path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5329 ../src/guestfs-actions.pod:8229
+msgid ""
+"This calls the external C<zegrep -i> program and returns the matching lines."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5335
+msgid "zero"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5337
+#, no-wrap
+msgid ""
+" zero device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5339 ../src/guestfs-actions.pod:8247
+msgid "This command writes zeroes over the first few blocks of C<device>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5341 ../src/guestfs-actions.pod:8249
+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
+#: ../fish/guestfish-actions.pod:5345 ../fish/guestfish-actions.pod:5360
+#: ../src/guestfs-actions.pod:8253 ../src/guestfs-actions.pod:8279
+msgid ""
+"If blocks are already zero, then this command avoids writing zeroes. This "
+"prevents the underlying device from becoming non-sparse or growing "
+"unnecessarily."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5349
+msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5352
+msgid "zero-device"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5354
+#, no-wrap
+msgid ""
+" zero-device device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5356
+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:5367
+msgid "zerofree"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5369
+#, no-wrap
+msgid ""
+" zerofree device\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5371 ../src/guestfs-actions.pod:8301
+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
+#: ../fish/guestfish-actions.pod:5376 ../src/guestfs-actions.pod:8306
+msgid "You should B<not> run this program if the filesystem is mounted."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5379 ../src/guestfs-actions.pod:8309
+msgid ""
+"It is possible that using this program can damage the filesystem or data on "
+"the filesystem."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5382
+msgid "zfgrep"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5384
+#, no-wrap
+msgid ""
+" zfgrep pattern path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5386 ../src/guestfs-actions.pod:8323
+msgid ""
+"This calls the external C<zfgrep> program and returns the matching lines."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5392
+msgid "zfgrepi"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5394
+#, no-wrap
+msgid ""
+" zfgrepi pattern path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5396 ../src/guestfs-actions.pod:8342
+msgid ""
+"This calls the external C<zfgrep -i> program and returns the matching lines."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5402
+msgid "zfile"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5404
+#, no-wrap
+msgid ""
+" zfile meth path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5406 ../src/guestfs-actions.pod:8368
+msgid ""
+"This command runs C<file> after first decompressing C<path> using C<method>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5409 ../src/guestfs-actions.pod:8371
+msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5411
+msgid ""
+"Since 1.0.63, use L</file> instead which can now process compressed files."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5414
+msgid ""
+"I<This function is deprecated.> In new code, use the L</file> call instead."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5421
+msgid "zgrep"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5423
+#, no-wrap
+msgid ""
+" zgrep regex path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5425 ../src/guestfs-actions.pod:8388
+msgid ""
+"This calls the external C<zgrep> program and returns the matching lines."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-actions.pod:5431
+msgid "zgrepi"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-actions.pod:5433
+#, no-wrap
+msgid ""
+" zgrepi regex path\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-actions.pod:5435 ../src/guestfs-actions.pod:8407
+msgid ""
+"This calls the external C<zgrep -i> program and returns the matching lines."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:1
+msgid "alloc"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:3
+msgid "allocate"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:5
+#, no-wrap
+msgid ""
+" alloc filename size\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../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: textblock
+#: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
+msgid "For more advanced image creation, see L<qemu-img(1)> utility."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
+msgid "Size can be specified using standard suffixes, eg. C<1M>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:14
+msgid ""
+"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-commands.pod:17
+msgid "copy-in"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:19
+#, no-wrap
+msgid ""
+" copy-in local [local ...] /remotedir\n"
+"\n"
+msgstr ""
+
+#. 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: textblock
+#: ../fish/guestfish-commands.pod:26
+msgid ""
+"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-commands.pod:30
+msgid "copy-out"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:32
+#, no-wrap
+msgid ""
+" copy-out remote [remote ...] localdir\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:34
+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."
+msgstr ""
+
+#. type: textblock
+#: ../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-commands.pod:44
+#, no-wrap
+msgid ""
+" copy-out /home .\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:46
+msgid ""
+"Wildcards cannot be used in the ordinary command, but you can use them with "
+"the help of L</glob> like this:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:49
+#, no-wrap
+msgid ""
+" glob copy-out /home/* .\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:51
+msgid "display"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:53
+#, no-wrap
+msgid ""
+" display filename\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:55
+msgid ""
+"Use C<display> (a graphical display program) to display an image file. It "
+"downloads the file, and runs C<display> on it."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:58
+msgid ""
+"To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
+"environment variable. For example to use the GNOME display program:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:61
+#, no-wrap
+msgid ""
+" export GUESTFISH_DISPLAY_IMAGE=eog\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:63
+msgid "See also L<display(1)>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:65
+msgid "echo"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:67
+#, no-wrap
+msgid ""
+" echo [params ...]\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:69
+msgid "This echos the parameters to the terminal."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:71
+msgid "edit"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:73
+msgid "vi"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:75
+msgid "emacs"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:77
+#, no-wrap
+msgid ""
+" edit filename\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:79
+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:82
+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-commands.pod:86
+msgid "glob"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:88
+#, no-wrap
+msgid ""
+" glob command args...\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:90
+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:93
+msgid "See L</WILDCARDS AND GLOBBING>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:95
+msgid "hexedit"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:97
+#, no-wrap
+msgid ""
+" hexedit <filename|device>\n"
+" hexedit <filename|device> <max>\n"
+" hexedit <filename|device> <start> <max>\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:101
+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:104
+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:111
+msgid "For example to edit the first few sectors of a disk you might do:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:114
+#, no-wrap
+msgid ""
+" hexedit /dev/sda 1M\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:116
+msgid ""
+"which would allow you to edit anywhere within the first megabyte of the disk."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:119
+msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:121
+#, no-wrap
+msgid ""
+" hexedit /dev/sda1 0x400 0x400\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:123
+msgid "(assuming the superblock is in the standard location)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:125
+msgid ""
+"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:129
+msgid "See also L</hexdump>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:131
+msgid "lcd"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:133
+#, no-wrap
+msgid ""
+" lcd directory\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:135
+msgid ""
+"Change the local directory, ie. the current directory of guestfish itself."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:138
+msgid "Note that C<!cd> won't do what you might expect."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:140
+msgid "man"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:142
+msgid "manual"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:144
+#, no-wrap
+msgid ""
+" man\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:146
+msgid "Opens the manual page for guestfish."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:148
+msgid "more"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:150
+msgid "less"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:152
+#, no-wrap
+msgid ""
+" more filename\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:154
+#, no-wrap
+msgid ""
+" less filename\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:156
+msgid "This is used to view a file."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:158
+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-commands.pod:161
+msgid "reopen"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:163
+#, no-wrap
+msgid ""
+" reopen\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:165
+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."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:169
+msgid "setenv"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:171
+#, no-wrap
+msgid ""
+" setenv VAR value\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:173
+msgid "Set the environment variable C<VAR> to the string C<value>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:175
+msgid ""
+"To print the value of an environment variable use a shell command such as:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:178
+#, no-wrap
+msgid ""
+" !echo $VAR\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:180
+msgid "sparse"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:182
+#, no-wrap
+msgid ""
+" sparse filename size\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:184
+msgid ""
+"This creates an empty sparse file of the given size, and then adds so it can "
+"be further examined."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:187
+msgid ""
+"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-commands.pod:197
+msgid "supported"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:199
+#, no-wrap
+msgid ""
+" supported\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:201
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:205
+msgid "See also L<guestfs(3)/AVAILABILITY>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:207
+msgid "time"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:209
+#, no-wrap
+msgid ""
+" time command args...\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:211
+msgid ""
+"Run the command as usual, but print the elapsed time afterwards. This can "
+"be useful for benchmarking operations."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish-commands.pod:214
+msgid "unsetenv"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish-commands.pod:216
+#, no-wrap
+msgid ""
+" unsetenv VAR\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish-commands.pod:218
+msgid "Remove C<VAR> from the environment."
+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: 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: =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 ../fish/virt-copy-in.pod:31
+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 ../src/guestfs.pod:2243
+#, 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:1042
+#, 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: textblock
+#: ../fish/guestfish.pod:154
+msgid "Displays general help on options."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:158
+msgid "B<--cmd-help>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:160
+msgid "Lists all available guestfish commands."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:162
+msgid "B<-h cmd>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:164
+msgid "B<--cmd-help cmd>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:166
+msgid "Displays detailed help on a single command C<cmd>."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:96
+msgid "B<-a image>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:98
+msgid "B<--add image>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:172
+msgid "Add a block device or virtual machine image to the shell."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:177
+msgid ""
+"Using this flag is mostly equivalent to using the C<add> command, with "
+"C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
+"the I<--format=...> flag was given."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:109
+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:189
+msgid "B<--csh>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:191
+msgid ""
+"If using the I<--listen> option and a csh-like shell, use this option. See "
+"section L</REMOTE CONTROL AND CSH> below."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:113
+msgid "B<-d libvirt-domain>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:115
+msgid "B<--domain libvirt-domain>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:117
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:121
+msgid "Domain UUIDs can be used instead of names."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:204
+msgid ""
+"Using this flag is mostly equivalent to using the C<add-domain> command, "
+"with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
+"if the I<--format:...> flag was given."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:208
+msgid "B<-D>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:210
+msgid "B<--no-dest-paths>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:212
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:137
+msgid ""
+"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: =item
+#: ../fish/guestfish.pod:224
+msgid "B<-f file>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:226
+msgid "B<--file file>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:228
+msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:231
+#, no-wrap
+msgid ""
+" #!/usr/bin/guestfish -f\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:244
+#, no-wrap
+msgid ""
+" guestfish --format=raw -a disk.img\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:248
+#, no-wrap
+msgid ""
+" guestfish --format=raw -a disk.img --format -a another.img\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:253
+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</add-drive-opts>."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:166
+msgid "B<--inspector>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:168
+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:266
+msgid "Typical usage is either:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:268
+#, no-wrap
+msgid ""
+" guestfish -d myguest -i\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:270
+msgid "(for an inactive libvirt domain called I<myguest>), or:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:272
+#, no-wrap
+msgid ""
+" guestfish --ro -d myguest -i\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:274
+msgid "(for active domains, readonly), or specify the block device directly:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:276
+#, no-wrap
+msgid ""
+" guestfish --rw -a /dev/Guests/MyGuest -i\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:278
+msgid ""
+"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:281
+#, no-wrap
+msgid ""
+" guestfish [--ro] -i disk.img\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:283
+#, no-wrap
+msgid ""
+" guestfish [--ro] -i libvirt-domain\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:285
+msgid ""
+"Using this flag is mostly equivalent to using the C<inspect-os> command and "
+"then using other commands to mount the filesystems that were found."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:294
+msgid "B<--listen>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:296
+msgid ""
+"Fork into the background and listen for remote commands. See section L</"
+"REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:177
+msgid "B<--live>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:179
+msgid ""
+"Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
+"ATTACHING TO RUNNING DAEMONS>)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:182
+msgid "B<-m dev[:mountpoint[:options]]>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
+msgid "B<--mount dev[:mountpoint[:options]]>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:308
+msgid "Mount the named partition or logical volume on the given mountpoint."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:310
+msgid "If the mountpoint is omitted, it defaults to C</>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:312
+msgid "You have to mount something on C</> before most commands will work."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:314
+msgid ""
+"If any I<-m> or I<--mount> options are given, the guest is automatically "
+"launched."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:317
+msgid ""
+"If you don't know what filesystems a disk image contains, you can either run "
+"guestfish without this option, then list the partitions, filesystems and LVs "
+"available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
+"commands), or you can use the L<virt-filesystems(1)> program."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:192
+msgid ""
+"The third (and rarely used) part of the mount parameter is the list of mount "
+"options used to mount the underlying filesystem. If this is not given, then "
+"the mount options are either the empty string or C<ro> (the latter if the "
+"I<--ro> flag is used). By specifying the mount options, you override this "
+"default choice. Probably the only time you would use this is to enable ACLs "
+"and/or extended attributes if the filesystem can support them:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:200
+#, no-wrap
+msgid ""
+" -m /dev/sda1:/:acl,user_xattr\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:333
+msgid "Using this flag is equivalent to using the C<mount-options> command."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:202
+#: ../resize/virt-resize.pod:435
+msgid "B<-n>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:204
+msgid "B<--no-sync>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:339
+msgid ""
+"Disable autosync. This is enabled by default. See the discussion of "
+"autosync in the L<guestfs(3)> manpage."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:342
+msgid "B<-N type>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:344
+msgid "B<--new type>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:346
+msgid "B<-N help>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:348
+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."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:353
+msgid "B<--progress-bars>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:355
+msgid "Enable progress bars, even when guestfish is used non-interactively."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:357
+msgid ""
+"Progress bars are enabled by default when guestfish is used as an "
+"interactive shell."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:360
+msgid "B<--no-progress-bars>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:362
+msgid "Disable progress bars."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:364
+msgid "B<--remote[=pid]>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:366
+msgid ""
+"Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
+"CONTROL GUESTFISH OVER A SOCKET> below."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:248
+#: ../rescue/virt-rescue.pod:161
+msgid "B<-r>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:250
+#: ../rescue/virt-rescue.pod:163
+msgid "B<--ro>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:373
+msgid ""
+"This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
+"mounts are done read-only."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:380
+msgid ""
+"Note that prepared disk images created with I<-N> are not affected by this "
+"option. Also commands like C<add> are not affected - you have to specify "
+"the C<readonly:true> option explicitly if you need it."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:384
+msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:262
+#: ../rescue/virt-rescue.pod:173
+msgid "B<--selinux>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:388
+msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:394
+msgid ""
+"Enable very verbose messages. This is particularly useful if you find a bug."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:401
+msgid "Display the guestfish / libguestfs version number and exit."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:278
+#: ../rescue/virt-rescue.pod:194
+msgid "B<-w>"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:280
+#: ../rescue/virt-rescue.pod:196
+msgid "B<--rw>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:282
+msgid ""
+"This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
+"mounts are done read-write."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:410
+msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:414
+msgid "Echo each command before executing it."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:418
+msgid "COMMANDS ON COMMAND LINE"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:420
+msgid ""
+"Any additional (non-option) arguments are treated as commands to execute."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:423
+msgid ""
+"Commands to execute should be separated by a colon (C<:>), where the colon "
+"is a separate parameter. Thus:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:426
+#, no-wrap
+msgid ""
+" guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:428
+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:432
+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:437
+msgid "USING launch (OR run)"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:439
+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:447
+msgid "add or -a/--add"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:451
+msgid "launch (aka run)"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:455
+msgid "mount or -m/--mount"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:459
+msgid "any other commands"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:463
+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:466
+msgid ""
+"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: =head1
+#: ../fish/guestfish.pod:471
+msgid "OPENING DISKS FOR READ AND WRITE"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:473
+msgid ""
+"The guestfish, L<guestmount(1)> and L<virt-rescue(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: textblock
+#: ../fish/guestfish.pod:478
+msgid ""
+"In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue 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:482
+msgid ""
+"This matters: If you accidentally open a live VM disk image writable then "
+"you will cause irreversible disk corruption."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:485
+msgid ""
+"In a future libguestfs 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>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
+"configuration file C</etc/libguestfs-tools.conf> in order to get write "
+"access for disk images specified by those other command line options."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:492
+msgid ""
+"This version of guestfish, guestmount and virt-rescue 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 you need write access, "
+"and prepare your scripts for the day when this option will be required for "
+"write access."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:498
+msgid ""
+"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: =head1
+#: ../fish/guestfish.pod:501
+msgid "QUOTING"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:503
+msgid ""
+"You can quote ordinary parameters using either single or double quotes. For "
+"example:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:506
+#, no-wrap
+msgid ""
+" add \"file with a space.img\"\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:508
+#, no-wrap
+msgid ""
+" rm '/file name'\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:510
+#, no-wrap
+msgid ""
+" rm '/\"'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:512
+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:517
+#, no-wrap
+msgid ""
+" vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
+" command \"/bin/echo 'foo bar'\"\n"
+" command \"/bin/echo \\'foo\\'\"\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:521
+msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:523
+msgid ""
+"In double-quoted arguments (only) use backslash to insert special characters:"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:528
+msgid "C<\\a>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:530
+msgid "Alert (bell) character."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:532
+msgid "C<\\b>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:534
+msgid "Backspace character."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:536
+msgid "C<\\f>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:538
+msgid "Form feed character."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:540
+msgid "C<\\n>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:542
+msgid "Newline character."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:544
+msgid "C<\\r>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:546
+msgid "Carriage return character."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:548
+msgid "C<\\t>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:550
+msgid "Horizontal tab character."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:552
+msgid "C<\\v>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:554
+msgid "Vertical tab character."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:556
+msgid "C<\\\">"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:558
+msgid "A literal double quote character."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:560
+msgid "C<\\ooo>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:562
+msgid ""
+"A character with octal value I<ooo>. There must be precisely 3 octal digits "
+"(unlike C)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:565
+msgid "C<\\xhh>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:567
+msgid ""
+"A character with hex value I<hh>. There must be precisely 2 hex digits."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:570
+msgid ""
+"In the current implementation C<\\000> and C<\\x00> cannot be used in "
+"strings."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:573
+msgid "C<\\\\>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:575
+msgid "A literal backslash character."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:579
+msgid "OPTIONAL ARGUMENTS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:581
+msgid ""
+"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:585
+#, no-wrap
+msgid ""
+" add-drive-opts filename\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:587
+#, no-wrap
+msgid ""
+" add-drive-opts filename readonly:true\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:589
+#, no-wrap
+msgid ""
+" add-drive-opts filename format:qcow2 readonly:false\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:591
+msgid ""
+"Each optional argument can appear at most once. All optional arguments must "
+"appear after the required ones."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:594
+msgid "NUMBERS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:596
+msgid ""
+"This section applies to all commands which can take integers as parameters."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:599
+msgid "SIZE SUFFIX"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:601
+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: =item
+#: ../fish/guestfish.pod:607
+msgid "B<k> or B<K> or B<KiB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:609
+msgid "The size in kilobytes (multiplied by 1024)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:611
+msgid "B<KB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:613
+msgid "The size in SI 1000 byte units."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:615
+msgid "B<M> or B<MiB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:617
+msgid "The size in megabytes (multiplied by 1048576)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:619
+msgid "B<MB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:621
+msgid "The size in SI 1000000 byte units."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:623
+msgid "B<G> or B<GiB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:625
+msgid "The size in gigabytes (multiplied by 2**30)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:627
+msgid "B<GB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:629
+msgid "The size in SI 10**9 byte units."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:631
+msgid "B<T> or B<TiB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:633
+msgid "The size in terabytes (multiplied by 2**40)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:635
+msgid "B<TB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:637
+msgid "The size in SI 10**12 byte units."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:639
+msgid "B<P> or B<PiB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:641
+msgid "The size in petabytes (multiplied by 2**50)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:643
+msgid "B<PB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:645
+msgid "The size in SI 10**15 byte units."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:647
+msgid "B<E> or B<EiB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:649
+msgid "The size in exabytes (multiplied by 2**60)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:651
+msgid "B<EB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:653
+msgid "The size in SI 10**18 byte units."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:655
+msgid "B<Z> or B<ZiB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:657
+msgid "The size in zettabytes (multiplied by 2**70)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:659
+msgid "B<ZB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:661
+msgid "The size in SI 10**21 byte units."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:663
+msgid "B<Y> or B<YiB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:665
+msgid "The size in yottabytes (multiplied by 2**80)."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:667
+msgid "B<YB>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:669
+msgid "The size in SI 10**24 byte units."
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:675
+#, no-wrap
+msgid ""
+" truncate-size /file 1G\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:677
+msgid "would truncate the file to 1 gigabyte."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:679
+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."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:683
+msgid "OCTAL AND HEXADECIMAL NUMBERS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:685
+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: verbatim
+#: ../fish/guestfish.pod:688
+#, 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:692
+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: verbatim
+#: ../fish/guestfish.pod:696
+#, no-wrap
+msgid ""
+" chmod 0777 /public # OK\n"
+" chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:699
+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>)."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:703
+msgid "WILDCARDS AND GLOBBING"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:705
+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:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:709
+#, no-wrap
+msgid ""
+" rm-rf /home/*\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:711
+msgid ""
+"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:714
+msgid "To perform wildcard expansion, use the C<glob> command."
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:716
+#, no-wrap
+msgid ""
+" glob rm-rf /home/*\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:718
+msgid ""
+"runs C<rm-rf> on each path that matches (ie. potentially running the command "
+"many times), equivalent to:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:721
+#, no-wrap
+msgid ""
+" rm-rf /home/jim\n"
+" rm-rf /home/joe\n"
+" rm-rf /home/mary\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:725
+msgid "C<glob> only works on simple guest paths and not on device names."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:727
+msgid ""
+"If you have several parameters, each containing a wildcard, then glob will "
+"perform a Cartesian product."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:730
+msgid "COMMENTS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:732
+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:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:736
+#, 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:740
+msgid "Blank lines are also ignored."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:742
+msgid "RUNNING COMMANDS LOCALLY"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:744
+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: verbatim
+#: ../fish/guestfish.pod:748
+#, no-wrap
+msgid ""
+" !mkdir local\n"
+" tgz-out /remote local/remote-data.tar.gz\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:751
+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:755
+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: =head2
+#: ../fish/guestfish.pod:758
+msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:760
+msgid ""
+"If a line starts with I<E<lt>!> then the shell command is executed (as for "
+"I<!>), but subsequently any output (stdout) of the shell command is parsed "
+"and executed as guestfish commands."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:764
+msgid ""
+"Thus you can use shell script to construct arbitrary guestfish commands "
+"which are then parsed by guestfish."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:767
+msgid ""
+"For example it is tedious to create a sequence of files (eg. C</foo.1> "
+"through C</foo.100>) using guestfish commands alone. However this is simple "
+"if we use a shell script to create the guestfish commands for us:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:772
+#, no-wrap
+msgid ""
+" <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:774
+msgid "or with names like C</foo.001>:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:776
+#, no-wrap
+msgid ""
+" <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:778
+msgid ""
+"When using guestfish interactively it can be helpful to just run the shell "
+"script first (ie. remove the initial C<E<lt>> character so it is just an "
+"ordinary I<!> local command), see what guestfish commands it would run, and "
+"when you are happy with those prepend the C<E<lt>> character to run the "
+"guestfish commands for real."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:784
+msgid "PIPES"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:786
+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: verbatim
+#: ../fish/guestfish.pod:790
+#, no-wrap
+msgid ""
+" cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:792
+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: verbatim
+#: ../fish/guestfish.pod:797
+#, 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:801
+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: textblock
+#: ../fish/guestfish.pod:806
+msgid ""
+"To use a literal argument which begins with a pipe symbol, you have to quote "
+"it, eg:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:809
+#, no-wrap
+msgid ""
+" echo \"|\"\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:811
+msgid "HOME DIRECTORIES"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:813
+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: textblock
+#: ../fish/guestfish.pod:817
+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:820
+msgid ""
+"To use a literal argument which begins with a tilde, you have to quote it, "
+"eg:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:823
+#, no-wrap
+msgid ""
+" echo \"~\"\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:825 ../src/guestfs.pod:534
+msgid "ENCRYPTED DISKS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:827
+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: textblock
+#: ../fish/guestfish.pod:832
+msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:834
+#, no-wrap
+msgid ""
+" ><fs> vfs-type /dev/sda2\n"
+" crypto_LUKS\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:837
+msgid ""
+"Then open those devices using L</luks-open>. This creates a device-mapper "
+"device called C</dev/mapper/luksdev>."
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:840
+#, 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:843
+msgid ""
+"Finally you have to tell LVM to scan for volume groups on the newly created "
+"mapper device:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:846
+#, no-wrap
+msgid ""
+" vgscan\n"
+" vg-activate-all true\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:849
+msgid "The logical volume(s) can now be mounted in the usual way."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:851
+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: verbatim
+#: ../fish/guestfish.pod:855
+#, no-wrap
+msgid ""
+" vg-activate false /dev/VG\n"
+" luks-close /dev/mapper/luksdev\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:860
+msgid ""
+"If a path is prefixed with C<win:> then you can use Windows-style drive "
+"letters and paths (with some limitations). The following commands are "
+"equivalent:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:864
+#, no-wrap
+msgid ""
+" file /WINDOWS/system32/config/system.LOG\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:866
+#, no-wrap
+msgid ""
+" file win:\\windows\\system32\\config\\system.log\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:868
+#, no-wrap
+msgid ""
+" file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:870
+msgid ""
+"The parameter is rewritten \"behind the scenes\" by looking up the position "
+"where the drive is mounted, prepending that to the path, changing all "
+"backslash characters to forward slash, then resolving the result using L</"
+"case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
+"the parameter might be rewritten like this:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:876
+#, no-wrap
+msgid ""
+" win:e:\\foo\\bar => /e/FOO/bar\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:878
+msgid "This only works in argument positions that expect a path."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:880
+msgid "UPLOADING AND DOWNLOADING FILES"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:882
+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:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:886
+#, no-wrap
+msgid ""
+" upload - /foo\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:888
+msgid ""
+"reads stdin and creates from that a file C</foo> in the disk image, and:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:891
+#, no-wrap
+msgid ""
+" tar-out /etc - | tar tf -\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:893
+msgid ""
+"writes the tarball to stdout and then pipes that into the external \"tar\" "
+"command (see L</PIPES>)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:896
+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:900
+#, no-wrap
+msgid ""
+" 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:906
+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)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:910
+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:913
+msgid "EXIT ON ERROR BEHAVIOUR"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:915
+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)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:920
+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."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:924
+msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:926
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:931
+msgid "Start a guestfish server process using:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:933
+#, no-wrap
+msgid ""
+" eval \"`guestfish --listen`\"\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:935
+msgid "and then send it commands by doing:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:937
+#, no-wrap
+msgid ""
+" guestfish --remote cmd [...]\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:939
+msgid "To cause the server to exit, send it the exit command:"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:943
+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>."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:947
+msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:949
+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:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:953
+#, 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"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:961
+msgid "REMOTE CONTROL AND CSH"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:963
+msgid ""
+"When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
+"option:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:966
+#, no-wrap
+msgid ""
+" eval \"`guestfish --listen --csh`\"\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:968
+msgid "REMOTE CONTROL DETAILS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:970
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:974
+msgid "Guestfish client and server versions must match exactly."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:976
+msgid "USING REMOTE CONTROL ROBUSTLY FROM SHELL SCRIPTS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:978
+msgid ""
+"From Bash, you can use the following code which creates a guestfish "
+"instance, correctly quotes the command line, handles failure to start, and "
+"cleans up guestfish when the script exits:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:982 ../src/guestfs.pod:980
+#, no-wrap
+msgid ""
+" #!/bin/bash -\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:986
+#, no-wrap
+msgid ""
+" guestfish[0]=\"guestfish\"\n"
+" guestfish[1]=\"--listen\"\n"
+" guestfish[2]=\"--ro\"\n"
+" guestfish[3]=\"-a\"\n"
+" guestfish[4]=\"disk.img\"\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:992
+#, no-wrap
+msgid ""
+" GUESTFISH_PID=\n"
+" eval $(\"${guestfish[@]}\")\n"
+" if [ -z \"$GUESTFISH_PID\" ]; then\n"
+" echo \"error: guestfish didn't start up, see error messages above\"\n"
+" exit 1\n"
+" fi\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:999
+#, no-wrap
+msgid ""
+" cleanup_guestfish ()\n"
+" {\n"
+" guestfish --remote -- exit >/dev/null 2>&1 ||:\n"
+" }\n"
+" trap cleanup_guestfish EXIT ERR\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1005
+#, no-wrap
+msgid ""
+" guestfish --remote -- run\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1007
+#, no-wrap
+msgid ""
+" # ...\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:1009
+msgid "REMOTE CONTROL RUN COMMAND HANGING"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1011
+msgid ""
+"Using the C<run> (or C<launch>) command remotely in a command substitution "
+"context hangs, ie. don't do (note the backquotes):"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1014
+#, no-wrap
+msgid ""
+" a=`guestfish --remote run`\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1016
+msgid ""
+"Since the C<run> command produces no output on stdout, this is not useful "
+"anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
+"cgi?id=592910>."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:1020
+msgid "PREPARED DISK IMAGES"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1022
+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>)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1028
+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>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1032
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1040
+msgid "To list the available types and any extra parameters they take, run:"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1044
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1048
+msgid ""
+"If any I<-N> or I<--new> options are given, the guest is automatically "
+"launched."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1053
+msgid "Create a 100MB disk with an ext4-formatted partition:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1055
+#, no-wrap
+msgid ""
+" guestfish -N fs:ext4\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1057
+msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1059
+#, no-wrap
+msgid ""
+" guestfish -N fs:vfat:32M -m /dev/sda1\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1061
+msgid "Create a blank 200MB disk:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1063
+#, no-wrap
+msgid ""
+" guestfish -N disk:200M\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:1065
+msgid "PROGRESS BARS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1067
+msgid ""
+"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:1071
+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:1075
+#, no-wrap
+msgid ""
+" ><fs> copy-size /large-file /another-file 2048M\n"
+" / 10% [#####-----------------------------------------] 00:30\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1078
+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."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1085
+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>."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:1090
+msgid "GUESTFISH COMMANDS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1092
+msgid ""
+"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:1095
+msgid "help"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1097
+#, no-wrap
+msgid ""
+" help\n"
+" help cmd\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1100
+msgid "Without any parameter, this provides general help."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1102
+msgid "With a C<cmd> parameter, this displays detailed help for that command."
+msgstr ""
+
+#. type: =head2
+#: ../fish/guestfish.pod:1104
+msgid "quit | exit"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1106
+msgid "This exits guestfish. You can also use C<^D> key."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1108
+msgid "@FISH_COMMANDS@"
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:1110
+msgid "COMMANDS"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1112 ../src/guestfs.pod:1520
+msgid "@ACTIONS@"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1116
+msgid ""
+"guestfish returns 0 if the commands completed without error, or 1 if there "
+"was an error."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1123
+msgid "EDITOR"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1125
+msgid ""
+"The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
+"C<vi>."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1128 ../src/guestfs.pod:3213
+msgid "FEBOOTSTRAP_KERNEL"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1130 ../src/guestfs.pod:3215
+msgid "FEBOOTSTRAP_MODULES"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1132 ../src/guestfs.pod:3217
+msgid ""
+"These two environment variables allow the kernel that libguestfs uses in the "
+"appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
+"most recent host kernel is chosen. For more information about kernel "
+"selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
+"available in febootstrap E<ge> 3.8."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1138
+msgid "GUESTFISH_DISPLAY_IMAGE"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1140
+msgid ""
+"The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
+"If not set, it uses L<display(1)>."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1143
+msgid "GUESTFISH_PID"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1145
+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:1149
+msgid "HEXEDITOR"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1151
+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: =item
+#: ../fish/guestfish.pod:1155
+msgid "HOME"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1157
+msgid ""
+"If compiled with GNU readline support, various files in the home directory "
+"can be used. See L</FILES>."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1160 ../src/guestfs.pod:3223
+msgid "LIBGUESTFS_APPEND"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1162 ../src/guestfs.pod:3225
+msgid "Pass additional options to the guest kernel."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1164 ../src/guestfs.pod:3227
+msgid "LIBGUESTFS_DEBUG"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1166
+msgid ""
+"Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
+"effect as using the B<-v> option."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1169 ../src/guestfs.pod:3232
+msgid "LIBGUESTFS_MEMSIZE"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1171 ../src/guestfs.pod:3234
+msgid ""
+"Set the memory allocated to the qemu process, in megabytes. For example:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1174 ../src/guestfs.pod:3237
+#, no-wrap
+msgid ""
+" LIBGUESTFS_MEMSIZE=700\n"
+"\n"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1176 ../src/guestfs.pod:3239
+msgid "LIBGUESTFS_PATH"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1178
+msgid ""
+"Set the path that guestfish uses to search for kernel and initrd.img. See "
+"the discussion of paths in L<guestfs(3)>."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1181 ../src/guestfs.pod:3244
+msgid "LIBGUESTFS_QEMU"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1183 ../src/guestfs.pod:3246
+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: =item
+#: ../fish/guestfish.pod:1187 ../src/guestfs.pod:3252
+msgid "LIBGUESTFS_TRACE"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1189
+msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1191
+msgid "PAGER"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1193
+msgid ""
+"The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
+"C<more>."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1196 ../sparsify/virt-sparsify.pod:236
+#: ../src/guestfs.pod:3257
+msgid "TMPDIR"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1198 ../src/guestfs.pod:3259
+msgid ""
+"Location of temporary directory, defaults to C</tmp> except for the cached "
+"supermin appliance which defaults to C</var/tmp>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1201 ../src/guestfs.pod:3262
+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</var/tmp> is not large enough."
+msgstr ""
+
+#. type: =head1
+#: ../fish/guestfish.pod:1209 ../fuse/guestmount.pod:297
+#: ../rescue/virt-rescue.pod:273
+msgid "FILES"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1213 ../fuse/guestmount.pod:301
+#: ../rescue/virt-rescue.pod:277
+msgid "$HOME/.libguestfs-tools.rc"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1215 ../fuse/guestmount.pod:303
+#: ../rescue/virt-rescue.pod:279
+msgid "/etc/libguestfs-tools.conf"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1217 ../fuse/guestmount.pod:305
+#: ../rescue/virt-rescue.pod:281
+msgid ""
+"This configuration file controls the default read-only or read-write mode "
+"(I<--ro> or I<--rw>)."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1220
+msgid "See L</OPENING DISKS FOR READ AND WRITE>."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1222
+msgid "$HOME/.guestfish"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1224
+msgid ""
+"If compiled with GNU readline support, then the command history is saved in "
+"this file."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1227
+msgid "$HOME/.inputrc"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1229
+msgid "/etc/inputrc"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1231
+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>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1235
+msgid "To write rules which only apply to guestfish, use:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1237
+#, no-wrap
+msgid ""
+" $if guestfish\n"
+" ...\n"
+" $endif\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1241
+msgid ""
+"Variables that you can set in inputrc that change the behaviour of guestfish "
+"in useful ways include:"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1246
+msgid "completion-ignore-case (default: on)"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1248
+msgid ""
+"By default, guestfish will ignore case when tab-completing paths on the "
+"disk. Use:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/guestfish.pod:1251
+#, no-wrap
+msgid ""
+" set completion-ignore-case off\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1253
+msgid "to make guestfish case sensitive."
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1257
+msgid "test1.img"
+msgstr ""
+
+#. type: =item
+#: ../fish/guestfish.pod:1259
+msgid "test2.img (etc)"
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1261
+msgid ""
+"When using the I<-N> or I<--new> option, the prepared disk or filesystem "
+"will be created in the file C<test1.img> in the current directory. The "
+"second use of I<-N> will use C<test2.img> and so on. Any existing file with "
+"the same name will be overwritten."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1270
+msgid ""
+"L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-alignment-scan(1)>, L<virt-"
+"cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit"
+"(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems"
+"(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
+"rescue(1)>, L<virt-resize(1)>, L<virt-sparsify(1)>, L<virt-sysprep(1)>, "
+"L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, "
+"L<display(1)>, L<hexedit(1)>, L<febootstrap-supermin-helper(8)>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/guestfish.pod:1302 ../src/guestfs.pod:3354
+#: ../test-tool/libguestfs-test-tool.pod:112
+msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-in.pod:5
+msgid ""
+"virt-copy-in - Copy files and directories into a virtual machine disk image."
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-copy-in.pod:9
+#, no-wrap
+msgid ""
+" virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-copy-in.pod:11
+#, no-wrap
+msgid ""
+" virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-in.pod:15
+msgid ""
+"Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
+"causing disk corruption. The virtual machine must be shut down before you "
+"use this command."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-in.pod:21
+msgid ""
+"C<virt-copy-in> copies files and directories from the local disk into a "
+"virtual machine disk image or named libvirt domain."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-in.pod:24
+msgid ""
+"You can give one of more filenames and directories on the command line. "
+"Directories are copied in recursively. The final parameter must be the "
+"destination directory in the disk image which must be an absolute path "
+"starting with a C</> character."
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-copy-in.pod:33
+#, no-wrap
+msgid ""
+" virt-copy-in -d MyGuest resolv.conf /etc\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
+msgid "Upload a home directory to a guest:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-copy-in.pod:37
+#, no-wrap
+msgid ""
+" virt-copy-in -d MyGuest skel /home\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
+#: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
+msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-in.pod:41
+msgid ""
+"This command is just a simple shell script wrapper around the L<guestfish(1)"
+"> C<copy-in> command. For anything more complex than a trivial copy, you "
+"are probably better off using guestfish directly."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
+#: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
+msgid ""
+"Since the shell script just passes options straight to guestfish, read "
+"L<guestfish(1)> to see the full list of options."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-in.pod:52
+msgid ""
+"L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
+"L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
+#: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
+msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-out.pod:5
+msgid ""
+"virt-copy-out - Copy files and directories out of a virtual machine disk "
+"image."
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-copy-out.pod:9
+#, no-wrap
+msgid ""
+" virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-copy-out.pod:11
+#, no-wrap
+msgid ""
+" virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-out.pod:15
+msgid ""
+"C<virt-copy-out> copies files and directories out of a virtual machine disk "
+"image or named libvirt domain."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-out.pod:18
+msgid ""
+"You can give one of more filenames and directories on the command line. "
+"Directories are copied out recursively."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-out.pod:23
+msgid "Download the home directories from a virtual machine:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-copy-out.pod:25
+#, no-wrap
+msgid ""
+" mkdir homes\n"
+" virt-copy-out -d MyGuest /home homes\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-out.pod:30
+msgid ""
+"This command is just a simple shell script wrapper around the L<guestfish(1)"
+"> C<copy-out> command. For anything more complex than a trivial copy, you "
+"are probably better off using guestfish directly."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-copy-out.pod:41
+msgid ""
+"L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
+"tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-in.pod:5
+msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-tar-in.pod:9
+#, no-wrap
+msgid ""
+" virt-tar-in -a disk.img data.tar /destination\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-tar-in.pod:11
+#, no-wrap
+msgid ""
+" virt-tar-in -d domain data.tar /destination\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-tar-in.pod:13
+#, no-wrap
+msgid ""
+" zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-in.pod:17
+msgid ""
+"Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
+"causing disk corruption. The virtual machine must be shut down before you "
+"use this command."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-in.pod:23
+msgid ""
+"C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
+"image or named libvirt domain."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-in.pod:26
+msgid ""
+"The first parameter is the tar file. Use C<-> to read the tar file from "
+"standard input. The second parameter is the absolute target directory to "
+"unpack into."
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-tar-in.pod:34
+#, no-wrap
+msgid ""
+" virt-tar-in -d MyGuest homes.tar /home\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-in.pod:38
+msgid ""
+"This command is just a simple shell script wrapper around the L<guestfish(1)"
+"> C<tar-in> command. For anything more complex than a trivial copy, you are "
+"probably better off using guestfish directly."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-in.pod:49
+msgid ""
+"L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
+"L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
+"org/>."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-out.pod:5
+msgid ""
+"virt-tar-out - Pack a virtual machine disk image directory into a tarball."
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-tar-out.pod:9
+#, no-wrap
+msgid ""
+" virt-tar-out -a disk.img /dir files.tar\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-tar-out.pod:11
+#, no-wrap
+msgid ""
+" virt-tar-out -d domain /dir files.tar\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-tar-out.pod:13
+#, no-wrap
+msgid ""
+" virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-out.pod:17
+msgid ""
+"C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-out.pod:20
+msgid ""
+"The first parameter is the absolute path of the virtual machine directory. "
+"The second parameter is the tar file to write. Use C<-> to write to "
+"standard output."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-out.pod:26
+msgid "Download the home directories from a guest:"
+msgstr ""
+
+#. type: verbatim
+#: ../fish/virt-tar-out.pod:28
+#, no-wrap
+msgid ""
+" virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-out.pod:32
+msgid ""
+"This command is just a simple shell script wrapper around the L<guestfish(1)"
+"> C<tar-out> command. For anything more complex than a trivial copy, you "
+"are probably better off using guestfish directly."
+msgstr ""
+
+#. type: textblock
+#: ../fish/virt-tar-out.pod:43
+msgid ""
+"L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
+"L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:5
+msgid ""
+"guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
+msgstr ""
+
+#. type: verbatim
+#: ../fuse/guestmount.pod:9
+#, no-wrap
+msgid ""
+" guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
+"\n"
+msgstr ""
+
+#. 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: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 "
+"filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
+"a mountable device."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:27
+msgid ""
+"Along with other options, you have to give at least one device (I<-a> "
+"option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
+"option) or use the I<-i> inspection option or the I<--live> 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: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 "
+"make certain global configuration changes to C</etc/fuse.conf>. To unmount "
+"the filesystem, use the C<fusermount -u> command."
+msgstr ""
+
+#. type: textblock
+#: ../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:44
+#, no-wrap
+msgid ""
+" guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../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:49
+#, no-wrap
+msgid ""
+" guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:51
+msgid "To get libguestfs to detect guest mountpoints for you:"
+msgstr ""
+
+#. type: verbatim
+#: ../fuse/guestmount.pod:53
+#, no-wrap
+msgid ""
+" guestmount -a guest.img -i --ro /mnt\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:55
+msgid "For a libvirt guest called \"Guest\" you could do:"
+msgstr ""
+
+#. type: verbatim
+#: ../fuse/guestmount.pod:57
+#, no-wrap
+msgid ""
+" guestmount -d Guest -i --ro /mnt\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:59
+msgid ""
+"If you don't know what filesystems are contained in a guest or disk image, "
+"use L<virt-filesystems(1)> first:"
+msgstr ""
+
+#. type: verbatim
+#: ../fuse/guestmount.pod:62
+#, no-wrap
+msgid ""
+" virt-filesystems MyGuest\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:64
+msgid ""
+"If you want to trace the libguestfs calls but without excessive debugging "
+"information, we recommend:"
+msgstr ""
+
+#. type: verbatim
+#: ../fuse/guestmount.pod:67
+#, no-wrap
+msgid ""
+" guestmount [...] --trace /mnt\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:69
+msgid "If you want to debug the program, we recommend:"
+msgstr ""
+
+#. type: verbatim
+#: ../fuse/guestmount.pod:71
+#, no-wrap
+msgid ""
+" guestmount [...] --trace --verbose /mnt\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68
+#: ../resize/virt-resize.pod:621
+msgid "NOTES"
+msgstr ""
+
+#. type: =head2
+#: ../fuse/guestmount.pod:75
+msgid "Other users cannot see the filesystem by default"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:77
+msgid ""
+"If you mount a filesystem as one user (eg. root), then other users will not "
+"be able to see it by default. The fix is to add the FUSE C<allow_other> "
+"option when mounting:"
+msgstr ""
+
+#. type: verbatim
+#: ../fuse/guestmount.pod:81
+#, no-wrap
+msgid ""
+" sudo guestmount [...] -o allow_other /mnt\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../fuse/guestmount.pod:83
+msgid "Enabling FUSE"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:85
+msgid ""
+"On some distros, you may need to add yourself to a special group (eg. "
+"C<fuse>) before you can use any FUSE filesystem. This is necessary on "
+"Debian and derivatives."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:89
+msgid ""
+"On other distros, no special group is required. It is not necessary on "
+"Fedora or Red Hat Enterprise Linux."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:100
+msgid "Add a block device or virtual machine image."
+msgstr ""
+
+#. type: =item
+#: ../fuse/guestmount.pod:123
+msgid "B<--dir-cache-timeout N>"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:125
+msgid ""
+"Set the readdir cache timeout to I<N> seconds, the default being 60 "
+"seconds. The readdir cache [actually, there are several semi-independent "
+"caches] is populated after a readdir(2) call with the stat and extended "
+"attributes of the files in the directory, in anticipation that they will be "
+"requested soon after."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:131
+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:151
+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:156
+msgid "B<--fuse-help>"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:158
+msgid "Display help on special FUSE options (see I<-o> below)."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:162
+msgid "Display brief help and exit."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:186
+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:189
+msgid ""
+"If the mountpoint is omitted, it defaults to C</>. You have to mount "
+"something on C</>."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:206
+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 "
+"disk. See the discussion of autosync in the L<guestfs(3)> manpage."
+msgstr ""
+
+#. type: =item
+#: ../fuse/guestmount.pod:211
+msgid "B<-o option>"
+msgstr ""
+
+#. type: =item
+#: ../fuse/guestmount.pod:213
+msgid "B<--option option>"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:215
+msgid "Pass extra options to FUSE."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:217
+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 "
+"of them are a good idea."
+msgstr ""
+
+#. type: verbatim
+#: ../fuse/guestmount.pod:221
+#, no-wrap
+msgid ""
+" guestmount --fuse-help\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:223
+msgid "Some potentially useful FUSE options:"
+msgstr ""
+
+#. type: =item
+#: ../fuse/guestmount.pod:227
+msgid "B<-o allow_other>"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:229
+msgid "Allow other users to see the filesystem."
+msgstr ""
+
+#. type: =item
+#: ../fuse/guestmount.pod:231
+msgid "B<-o attr_timeout=N>"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:233
+msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
+msgstr ""
+
+#. type: =item
+#: ../fuse/guestmount.pod:235
+msgid "B<-o kernel_cache>"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:237
+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 "
+"afford the extra memory usage."
+msgstr ""
+
+#. type: =item
+#: ../fuse/guestmount.pod:241
+msgid "B<-o uid=N> B<-o gid=N>"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:243
+msgid ""
+"Use these options to map all UIDs and GIDs inside the guest filesystem to "
+"the chosen values."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:252
+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:255
+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 "
+"strong risk of disk corruption in the guest. We try to prevent this from "
+"happening, but it is not always possible."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:260 ../rescue/virt-rescue.pod:171
+msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:264
+msgid "Enable SELinux support for the guest."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:270
+msgid "Enable verbose messages from underlying libguestfs."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:276
+msgid "Display the program version and exit."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:285 ../fuse/guestmount.pod:308
+#: ../rescue/virt-rescue.pod:201 ../rescue/virt-rescue.pod:284
+msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
+msgstr ""
+
+#. type: =item
+#: ../fuse/guestmount.pod:289
+msgid "B<--trace>"
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:291
+msgid "Trace libguestfs calls and entry into each FUSE function."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:293
+msgid "This also stops the daemon from forking into the background."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:319
+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/>, L<http://fuse.sf."
+"net/>."
+msgstr ""
+
+#. type: textblock
+#: ../fuse/guestmount.pod:334
+msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:5
+msgid ""
+"virt-inspector - Display operating system version and other information "
+"about a virtual machine"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:9
+#, no-wrap
+msgid ""
+" virt-inspector [--options] -d domname\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:11
+#, no-wrap
+msgid ""
+" virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:15
+#, no-wrap
+msgid ""
+" virt-inspector domname\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
+#, no-wrap
+msgid ""
+" virt-inspector disk.img [disk.img ...]\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:21
+msgid ""
+"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.pod:25
+msgid "Virt-inspector produces XML output for feeding into other programs."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:27
+msgid ""
+"In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
+"the libvirt domain (see: C<virsh list --all>)."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:30
+msgid ""
+"You can also run virt-inspector directly on disk images from a single "
+"virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
+"has several block devices, in which case you should list several I<-a> "
+"options one after another, with the first corresponding to the guest's C</"
+"dev/sda>, the second to the guest's C</dev/sdb> and so on."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:37
+msgid ""
+"You can also run virt-inspector on install disks, live CDs, bootable USB "
+"keys and similar."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:40
+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 "
+"times (for example, from a shell script for-loop)."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:45
+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.pod:48
+msgid ""
+"All of the information available from virt-inspector is also available "
+"through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
+"The same information can also be fetched using guestfish or via libguestfs "
+"bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
+"WITH OTHER PROGRAMMING LANGUAGES>)."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:81
+msgid ""
+"Libvirt is only used if you specify a C<domname> on the command line. If "
+"you specify guest block devices directly (I<-a>), then libvirt is not used "
+"at all."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:94
+msgid ""
+"When prompting for keys and passphrases, virt-inspector 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: textblock
+#: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93
+#: ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143
+#: ../tools/virt-win-reg.pl:144
+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.pod:107 ../tools/virt-list-filesystems.pl:97
+#: ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147
+#: ../tools/virt-win-reg.pl:148
+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.pod:111 ../resize/virt-resize.pod:391
+#: ../resize/virt-resize.pod:483 ../sparsify/virt-sparsify.pod:132
+#: ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102
+#: ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
+msgid ""
+"If working with untrusted raw-format guest disk images, you should ensure "
+"the format is always specified."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:139
+msgid "Previous versions of virt-inspector allowed you to write either:"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:145
+#, no-wrap
+msgid ""
+" virt-inspector guestname\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../inspector/virt-inspector.pod:153
+msgid "XML FORMAT"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:155
+msgid ""
+"The virt-inspector XML is described precisely in a RELAX NG schema file "
+"C<virt-inspector.rng> which is supplied with libguestfs. This section is "
+"just an overview."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:159
+msgid ""
+"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: =head2
+#: ../inspector/virt-inspector.pod:164
+msgid "E<lt>operatingsystemE<gt>"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:166
+msgid ""
+"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.pod:170
+#, no-wrap
+msgid ""
+" <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"
+" <product_variant>Client</product_variant>\n"
+" <major_version>6</major_version>\n"
+" <minor_version>1</minor_version>\n"
+" <windows_systemroot>/Windows</windows_systemroot>\n"
+" <format>installed</format>\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:183
+msgid ""
+"In brief, E<lt>nameE<gt> is the class of operating system (something like "
+"C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
+"but many other distros are recognized) and E<lt>archE<gt> is the guest "
+"architecture. The other fields are fairly self-explanatory, but because "
+"these fields are taken directly from the libguestfs inspection API you can "
+"find precise information from L<guestfs(3)/INSPECTION>."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:191
+msgid ""
+"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.pod:195
+msgid "E<lt>mountpointsE<gt>"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:197
+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: verbatim
+#: ../inspector/virt-inspector.pod:201
+#, 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.pod:209
+msgid ""
+"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.pod:214
+msgid "E<lt>filesystemsE<gt>"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:216
+msgid ""
+"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 with this OS and other OSes)."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:222
+msgid "You might see something like this:"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:224
+#, no-wrap
+msgid ""
+" <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.pod:234
+msgid ""
+"The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
+"the label, and the UUID."
+msgstr ""
+
+#. type: =head2
+#: ../inspector/virt-inspector.pod:237
+msgid "E<lt>applicationsE<gt>"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:239
+msgid ""
+"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."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:243
+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.pod:246
+msgid ""
+"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.pod:249
+msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:252
+#, no-wrap
+msgid ""
+" <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.pod:262
+msgid ""
+"The version and release fields may not be available for some types guests. "
+"Other fields are possible, see L<guestfs(3)/"
+"guestfs_inspect_list_applications>."
+msgstr ""
+
+#. type: =head2
+#: ../inspector/virt-inspector.pod:266
+msgid "E<lt>drive_mappingsE<gt>"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:268
+msgid ""
+"For operating systems like Windows which use drive letters, virt-inspector "
+"is able to find out how drive letters map to filesystems."
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:272
+#, no-wrap
+msgid ""
+" <operatingsystems>\n"
+" <operatingsystem>\n"
+" ...\n"
+" <drive_mappings>\n"
+" <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
+" <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
+" </drive_mappings>\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:280
+msgid ""
+"In the example above, drive C maps to the filesystem on the second partition "
+"on the first disk, and drive E maps to the filesystem on the first partition "
+"on the second disk."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:284
+msgid ""
+"Note that this only covers permanent local filesystem mappings, not things "
+"like network shares. Furthermore NTFS volume mount points may not be listed "
+"here."
+msgstr ""
+
+#. type: =head2
+#: ../inspector/virt-inspector.pod:288
+msgid "E<lt>iconE<gt>"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:290
+msgid ""
+"Virt-inspector is sometimes able to extract an icon or logo for the guest. "
+"The icon is returned as base64-encoded PNG data. Note that the icon can be "
+"very large and high quality."
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:294
+#, no-wrap
+msgid ""
+" <operatingsystems>\n"
+" <operatingsystem>\n"
+" ...\n"
+" <icon>\n"
+" iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
+" [... many lines of base64 data ...]\n"
+" </icon>\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:302
+msgid ""
+"To display the icon, you have to extract it and convert the base64 data back "
+"to a binary file. Use an XPath query or simply an editor to extract the "
+"data, then use the coreutils L<base64(1)> program to do the conversion back "
+"to a PNG file:"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:307
+#, no-wrap
+msgid ""
+" base64 -i -d < icon.data > icon.png\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../inspector/virt-inspector.pod:309
+msgid "INSPECTING INSTALL DISKS, LIVE CDs"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:311
+msgid ""
+"Virt-inspector can detect some operating system installers on install disks, "
+"live CDs, bootable USB keys and more."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:314
+msgid ""
+"In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
+"fields may be present to indicate a live CD, network installer, or one part "
+"of a multipart CD. For example:"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:318
+#, no-wrap
+msgid ""
+" <operatingsystems>\n"
+" <operatingsystem>\n"
+" <root>/dev/sda</root>\n"
+" <name>linux</name>\n"
+" <arch>i386</arch>\n"
+" <distro>ubuntu</distro>\n"
+" <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
+" <major_version>10</major_version>\n"
+" <minor_version>10</minor_version>\n"
+" <format>installer</format>\n"
+" <live/>\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../inspector/virt-inspector.pod:330
+msgid "USING XPATH"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:332
+msgid ""
+"You can use the XPath query language to select parts of the XML. We "
+"recommend using C<xmlstarlet> to perform XPath queries from the command line."
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:338
+#, no-wrap
+msgid ""
+" $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
+" <filesystems>\n"
+" <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
+" <type>ext4</type>\n"
+" [...]\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:344
+#, no-wrap
+msgid ""
+" $ virt-inspector -d Guest | \\\n"
+" xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
+" ext4\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:348
+#, no-wrap
+msgid ""
+" $ virt-inspector -d Guest | \\\n"
+" xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
+" [displays the guest icon, if there is one]\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../inspector/virt-inspector.pod:359
+msgid "OLD VERSIONS OF VIRT-INSPECTOR"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:361
+msgid ""
+"Early versions of libguestfs shipped with a different virt-inspector program "
+"written in Perl (the current version is written in C). The XML output of "
+"the Perl virt-inspector was different and it could also output in other "
+"formats like text."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:366
+msgid ""
+"The old virt-inspector is no longer supported or shipped with libguestfs."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:369
+msgid ""
+"To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
+"versions of virt-inspector with different names:"
+msgstr ""
+
+#. type: verbatim
+#: ../inspector/virt-inspector.pod:372
+#, no-wrap
+msgid ""
+" virt-inspector Old Perl version.\n"
+" virt-inspector2 New C version.\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:382
+msgid ""
+"L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
+">, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../inspector/virt-inspector.pod:399
+msgid "Matthew Booth L<mbooth@redhat.com>"
+msgstr ""
+
+#. type: textblock
+#: ../java/examples/guestfs-java.pod:5
+msgid "guestfs-java - How to use libguestfs from Java"
+msgstr ""
+
+#. type: verbatim
+#: ../java/examples/guestfs-java.pod:9
+#, no-wrap
+msgid ""
+" import com.redhat.et.libguestfs.*;\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../java/examples/guestfs-java.pod:11
+#, no-wrap
+msgid ""
+" GuestFS g = new GuestFS ();\n"
+" g.add_drive_opts (\"disk.img\", null);\n"
+" g.launch ();\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../java/examples/guestfs-java.pod:17
+msgid ""
+"This manual page documents how to call libguestfs from the Java programming "
+"language. This page just documents the differences from the C API and gives "
+"some examples. If you are not familiar with using libguestfs, you also need "
+"to read L<guestfs(3)>."
+msgstr ""
+
+#. type: =head2
+#: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
+msgid "CLOSING THE HANDLE"
+msgstr ""
+
+#. type: textblock
+#: ../java/examples/guestfs-java.pod:24
+msgid ""
+"The handle is closed when it is reaped by the garbage collector. Because "
+"libguestfs handles include a lot of state, it is also possible to close (and "
+"hence free) them explicitly by calling the C<close> method."
+msgstr ""
+
+#. type: =head2
+#: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60
+#: ../python/examples/guestfs-python.pod:21
+#: ../ruby/examples/guestfs-ruby.pod:22
+msgid "EXCEPTIONS"
+msgstr ""
+
+#. type: textblock
+#: ../java/examples/guestfs-java.pod:31
+msgid ""
+"Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
+"exception. This has a single parameter which is the error message (a "
+"C<String>)."
+msgstr ""
+
+#. type: textblock
+#: ../java/examples/guestfs-java.pod:35
+msgid "Calling any method on a closed handle raises the same exception."
+msgstr ""
+
+#. type: textblock
+#: ../java/examples/guestfs-java.pod:47
+msgid ""
+"L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-ocaml"
+"(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
+"L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:5
+msgid "guestfs-ocaml - How to use libguestfs from OCaml"
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:9
+msgid "Module style:"
+msgstr ""
+
+#. type: verbatim
+#: ../ocaml/examples/guestfs-ocaml.pod:11
+#, no-wrap
+msgid ""
+" let g = Guestfs.create () in\n"
+" Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
+" Guestfs.launch g;\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:15
+msgid "Object-oriented style:"
+msgstr ""
+
+#. type: verbatim
+#: ../ocaml/examples/guestfs-ocaml.pod:17
+#, no-wrap
+msgid ""
+" let g = new Guestfs.guestfs () in\n"
+" g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
+" g#launch ();\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../ocaml/examples/guestfs-ocaml.pod:21
+#, no-wrap
+msgid ""
+" ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
+"or:\n"
+" ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:27
+msgid ""
+"This manual page documents how to call libguestfs from the OCaml programming "
+"language. This page just documents the differences from the C API and gives "
+"some examples. If you are not familiar with using libguestfs, you also need "
+"to read L<guestfs(3)>."
+msgstr ""
+
+#. type: =head2
+#: ../ocaml/examples/guestfs-ocaml.pod:32
+msgid "PROGRAMMING STYLES"
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:34
+msgid ""
+"There are two different programming styles supported by the OCaml bindings. "
+"You can use a module style, with each C function mapped to an OCaml function:"
+msgstr ""
+
+#. type: verbatim
+#: ../ocaml/examples/guestfs-ocaml.pod:38
+#, no-wrap
+msgid ""
+" int guestfs_set_verbose (guestfs_h *g, int flag);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:40
+msgid "becomes:"
+msgstr ""
+
+#. type: verbatim
+#: ../ocaml/examples/guestfs-ocaml.pod:42
+#, no-wrap
+msgid ""
+" val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:44
+msgid ""
+"Alternately you can use an object-oriented style, calling methods on the "
+"class C<Guestfs.guestfs>:"
+msgstr ""
+
+#. type: verbatim
+#: ../ocaml/examples/guestfs-ocaml.pod:47
+#, no-wrap
+msgid ""
+" method set_verbose : bool -> unit\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:49
+msgid ""
+"The object-oriented style is usually briefer, and the minor performance "
+"penalty isn't noticable in the general overhead of performing libguestfs "
+"functions."
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:55
+msgid ""
+"The handle is closed when it is reaped by the garbage collector. Because "
+"libguestfs handles include a lot of state, it is also possible to close (and "
+"hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
+"method."
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:62
+msgid ""
+"Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
+"exception. This has a single parameter which is the error message (a "
+"string)."
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:66
+msgid ""
+"Calling any function/method on a closed handle raises C<Guestfs."
+"Handle_closed>. The single parameter is the name of the function that you "
+"called."
+msgstr ""
+
+#. type: textblock
+#: ../ocaml/examples/guestfs-ocaml.pod:80
+msgid ""
+"L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
+"(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
+"L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
+msgstr ""
+
+#. type: textblock
+#: ../perl/examples/guestfs-perl.pod:5
+msgid "guestfs-perl - How to use libguestfs from Perl"
+msgstr ""
+
+#. type: verbatim
+#: ../perl/examples/guestfs-perl.pod:9
+#, no-wrap
+msgid ""
+" use Sys::Guestfs;\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../perl/examples/guestfs-perl.pod:11
+#, no-wrap
+msgid ""
+" my $h = Sys::Guestfs->new ();\n"
+" $h->add_drive_opts ('guest.img', format => 'raw');\n"
+" $h->launch ();\n"
+" $h->mount_options ('', '/dev/sda1', '/');\n"
+" $h->touch ('/hello');\n"
+" $h->sync ();\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../perl/examples/guestfs-perl.pod:20
+msgid ""
+"This manual page documents how to call libguestfs from the Perl programming "
+"language. This page just documents the differences from the C API and gives "
+"some examples. If you are not familiar with using libguestfs, you also need "
+"to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
+msgstr ""
+
+#. type: =head2
+#: ../perl/examples/guestfs-perl.pod:26
+msgid "ERRORS"
+msgstr ""
+
+#. type: textblock
+#: ../perl/examples/guestfs-perl.pod:28
+msgid ""
+"Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
+">)."
+msgstr ""
+
+#. type: textblock
+#: ../perl/examples/guestfs-perl.pod:41
+msgid ""
+"L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang"
+"(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
+"L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../python/examples/guestfs-python.pod:5
+msgid "guestfs-python - How to use libguestfs from Python"
+msgstr ""
+
+#. type: verbatim
+#: ../python/examples/guestfs-python.pod:9
+#, no-wrap
+msgid ""
+" import guestfs\n"
+" g = guestfs.GuestFS ()\n"
+" g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
+" g.launch\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../python/examples/guestfs-python.pod:16
+msgid ""
+"This manual page documents how to call libguestfs from the Python "
+"programming language. This page just documents the differences from the C "
+"API and gives some examples. If you are not familiar with using libguestfs, "
+"you also need to read L<guestfs(3)>."
+msgstr ""
+
+#. type: textblock
+#: ../python/examples/guestfs-python.pod:23
+msgid ""
+"Errors from libguestfs functions are mapped into C<RuntimeException> with a "
+"single string argument which is the error message."
+msgstr ""
+
+#. type: =head2
+#: ../python/examples/guestfs-python.pod:26
+msgid "MORE DOCUMENTATION"
+msgstr ""
+
+#. type: textblock
+#: ../python/examples/guestfs-python.pod:28
+msgid "Type:"
+msgstr ""
+
+#. type: verbatim
+#: ../python/examples/guestfs-python.pod:30
+#, no-wrap
+msgid ""
+" $ python\n"
+" >>> import guestfs\n"
+" >>> help (guestfs)\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../python/examples/guestfs-python.pod:44
+msgid ""
+"L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
+"(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, "
+"L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:5
+msgid "virt-rescue - Run a rescue shell on a virtual machine"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:9
+#, no-wrap
+msgid ""
+" virt-rescue [--options] -d domname\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:11
+#, no-wrap
+msgid ""
+" virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:15
+#, no-wrap
+msgid ""
+" virt-rescue [--options] domname\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:17
+#, no-wrap
+msgid ""
+" virt-rescue [--options] disk.img [disk.img ...]\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:21
+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."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:25
+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."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:31
+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
+#: ../rescue/virt-rescue.pod:36
+msgid ""
+"You can run virt-rescue on any virtual machine known to libvirt, or directly "
+"on disk image(s):"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:39
+#, no-wrap
+msgid ""
+" virt-rescue -d GuestName\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:41
+#, no-wrap
+msgid ""
+" virt-rescue --ro -a /path/to/disk.img\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:43
+#, no-wrap
+msgid ""
+" virt-rescue -a /dev/sdc\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:45
+msgid "For live VMs you I<must> use the --ro option."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:47
+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."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:54
+msgid ""
+"In the example below, we list logical volumes, then choose one to mount "
+"under C</sysroot>:"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:57
+#, 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
+#: ../rescue/virt-rescue.pod:64
+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: textblock
+#: ../rescue/virt-rescue.pod:70
+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."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:76
+msgid ""
+"Virt-rescue does not require root. You only need to run it as root if you "
+"need root to open the disk image."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:79
+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
+#: ../rescue/virt-rescue.pod:103
+msgid "B<--append kernelopts>"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:105
+msgid "Pass additional options to the rescue kernel."
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:135
+#, no-wrap
+msgid ""
+" virt-rescue --format=raw -a disk.img\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:139
+#, no-wrap
+msgid ""
+" virt-rescue --format=raw -a disk.img --format -a another.img\n"
+"\n"
+msgstr ""
+
+#. type: =item
+#: ../rescue/virt-rescue.pod:148
+msgid "B<-m MB>"
+msgstr ""
+
+#. type: =item
+#: ../rescue/virt-rescue.pod:150
+msgid "B<--memsize MB>"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:152
+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."
+msgstr ""
+
+#. type: =item
+#: ../rescue/virt-rescue.pod:157
+msgid "B<--network>"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:159
+msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:165
+msgid "Open the image read-only."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:175
+msgid ""
+"Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
+"SELINUX> before using this option."
+msgstr ""
+
+#. type: =item
+#: ../rescue/virt-rescue.pod:178
+msgid "B<--smp> N"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:180
+msgid "Enable N E<ge> 2 virtual CPUs in the rescue appliance."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:198
+msgid ""
+"This changes the I<-a> and I<-d> options so that disks are added and mounts "
+"are done read-write."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:211
+msgid "Previous versions of virt-rescue allowed you to write either:"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:213
+#, no-wrap
+msgid ""
+" virt-rescue disk.img [disk.img ...]\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:217
+#, no-wrap
+msgid ""
+" virt-rescue guestname\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../rescue/virt-rescue.pod:225
+msgid "NETWORK"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:227
+msgid ""
+"Adding the I<--network> option enables QEMU user networking in the rescue "
+"appliance. There are some differences between user networking and ordinary "
+"networking:"
+msgstr ""
+
+#. type: =item
+#: ../rescue/virt-rescue.pod:233
+msgid "ping does not work"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:235
+msgid ""
+"Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
+"send the ping packets, and because virt-rescue must be able to run as non-"
+"root, QEMU user networking is not able to emulate the L<ping(8)> command. "
+"The ping command will appear to resolve addresses but will not be able to "
+"send or receive any packets. This does not mean that the network is not "
+"working."
+msgstr ""
+
+#. type: =item
+#: ../rescue/virt-rescue.pod:242
+msgid "cannot receive connections"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:244
+msgid "QEMU user networking cannot receive incoming connections."
+msgstr ""
+
+#. type: =item
+#: ../rescue/virt-rescue.pod:246
+msgid "making TCP connections"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:248
+msgid ""
+"The virt-rescue appliance needs to be small and so does not include many "
+"network tools. In particular there is no L<telnet(1)> command. You can "
+"make TCP connections from the shell using the magical C</dev/tcp/"
+"E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
+msgstr ""
+
+#. type: verbatim
+#: ../rescue/virt-rescue.pod:253
+#, no-wrap
+msgid ""
+" exec 3<>/dev/tcp/redhat.com/80\n"
+" echo \"GET /\" >&3\n"
+" cat <&3\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:257
+msgid "See L<bash(1)> for more details."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:263
+msgid ""
+"Several environment variables affect virt-rescue. See L<guestfs(3)/"
+"ENVIRONMENT VARIABLES> for the complete list."
+msgstr ""
+
+#. type: textblock
+#: ../rescue/virt-rescue.pod:290
+msgid ""
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<http://"
+"libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:5
+msgid "virt-resize - Resize a virtual machine disk"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:9
+#, no-wrap
+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"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:15
+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."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:19
+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."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:23
+msgid ""
+"If you are not familiar with the associated tools: L<virt-filesystems(1)> "
+"and L<virt-df(1)>, we recommend you go and read those manual pages first."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:597
+#: ../sparsify/virt-sparsify.pod:203 ../src/guestfs.pod:484
+#: ../src/guestfs.pod:1302 ../src/guestfs.pod:1441 ../src/guestfs.pod:2690
+msgid "1."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:33
+msgid ""
+"Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
+"fill the extra 5GB of space."
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:36
+#, no-wrap
+msgid ""
+" virt-filesystems --long -h --all -a olddisk\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:38
+#, no-wrap
+msgid ""
+" truncate -r olddisk newdisk\n"
+" truncate -s +5G newdisk\n"
" \n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:101
+#. type: verbatim
+#: ../resize/virt-resize.pod:41
+#, no-wrap
+msgid ""
+" # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
+" virt-resize --expand /dev/sda2 olddisk newdisk\n"
+"\n"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:604
+#: ../sparsify/virt-sparsify.pod:210 ../src/guestfs.pod:490
+#: ../src/guestfs.pod:1306 ../src/guestfs.pod:1445 ../src/guestfs.pod:2715
+msgid "2."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:46
+msgid ""
+"As above, but make the /boot partition 200MB bigger, while giving the "
+"remaining space to /dev/sda2:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:49
+#, no-wrap
+msgid ""
+" virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
+" olddisk newdisk\n"
+"\n"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:610
+#: ../sparsify/virt-sparsify.pod:216 ../src/guestfs.pod:501
+#: ../src/guestfs.pod:1451
+msgid "3."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:54
+msgid ""
+"As in the first example, but expand a logical volume as the final step. "
+"This is what you would typically use for Linux guests that use LVM:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:58
+#, no-wrap
+msgid ""
+" virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
+" olddisk newdisk\n"
+"\n"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:61
+msgid "4."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:63
+msgid ""
+"As in the first example, but the output format will be qcow2 instead of a "
+"raw disk:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:66
+#, no-wrap
+msgid ""
+" qemu-img create -f qcow2 newdisk.qcow2 15G\n"
+" virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
+"\n"
+msgstr ""
+
+#. type: =head1
+#: ../resize/virt-resize.pod:71
+msgid "DETAILED USAGE"
+msgstr ""
+
+#. type: =head2
+#: ../resize/virt-resize.pod:73
+msgid "EXPANDING A VIRTUAL MACHINE DISK"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:77
+msgid "1. Shut down the virtual machine"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:79
+msgid "2. Locate input disk image"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:81
+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:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:85
+#, 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
+#: ../resize/virt-resize.pod:90
+msgid "3. Look at current sizing"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:92
+msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:95
+#, no-wrap
+msgid ""
+" # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
+" Name Type Size Parent\n"
+" /dev/sda1 partition 101M /dev/sda\n"
+" /dev/sda2 partition 7.9G /dev/sda\n"
+" /dev/sda device 8.0G -\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:101
+msgid ""
+"(This example is a virtual machine with an 8 GB disk which we would like to "
+"expand up to 10 GB)."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:104
+msgid "4. Create output disk"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:106
+msgid ""
+"Virt-resize cannot do in-place disk modifications. You have to have space "
+"to store the resized output disk."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:109
+msgid ""
+"To store the resized disk image in a file, create a file of a suitable size:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:112
+#, no-wrap
+msgid ""
+" # rm -f outdisk\n"
+" # truncate -s 10G outdisk\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:115
+msgid "Or use L<lvcreate(1)> to create a logical volume:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:117
+#, no-wrap
+msgid ""
+" # lvcreate -L 10G -n lv_name vg_name\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:119
+msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:121
+#, no-wrap
+msgid ""
+" # virsh pool-list\n"
+" # virsh vol-create-as poolname newvol 10G\n"
+"\n"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:124
+msgid "5. Resize"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:126
+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: verbatim
+#: ../resize/virt-resize.pod:130
+#, no-wrap
+msgid ""
+" # virt-resize indisk outdisk\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:132
+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: textblock
+#: ../resize/virt-resize.pod:138
+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: textblock
+#: ../resize/virt-resize.pod:142
+msgid ""
+"L</--expand> is the most useful option. It expands the named partition "
+"within the disk to fill any extra space:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:145
+#, no-wrap
+msgid ""
+" # virt-resize --expand /dev/sda2 indisk outdisk\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:147
+msgid ""
+"(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
+#: ../resize/virt-resize.pod:150
+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:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:154
+#, no-wrap
+msgid ""
+" # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
+" indisk outdisk\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:157
+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)>, L<ntfsresize(8)> "
+"or L<btrfs(8)>. However virt-resize does not know how to resize some "
+"filesystems, so you would have to online resize them after booting the guest."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:164
+msgid "Other options are covered below."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:166
+msgid "6. Test"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:168
+msgid "Thoroughly test the new disk image I<before> discarding the old one."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:170
+msgid "If you are using libvirt, edit the XML to point at the new disk:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:172
+#, no-wrap
+msgid ""
+" # virsh edit guestname\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:174
+msgid ""
+"Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
+"html#elementsDisks>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:177
+msgid "Then start up the domain with the new, resized disk:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:179
+#, no-wrap
+msgid ""
+" # virsh start guestname\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:181
+msgid ""
+"and check that it still works. See also the L</NOTES> section below for "
+"additional information."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:184
+msgid "7. Resize LVs etc inside the guest"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:186
+msgid "(This can also be done offline using L<guestfish(1)>)"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:188
+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
+#: ../resize/virt-resize.pod:195
+msgid "SHRINKING A VIRTUAL MACHINE DISK"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:197
+msgid ""
+"Shrinking is somewhat more complex than expanding, and only an overview is "
+"given here."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:200
+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."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:205
+msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:207
+msgid ""
+"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
+#: ../resize/virt-resize.pod:210
+msgid ""
+"Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
+msgstr ""
+
+#. type: =head2
+#: ../resize/virt-resize.pod:213
+msgid "IGNORING OR DELETING PARTITIONS"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:215
+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."
+msgstr ""
+
+#. type: =head2
+#: ../resize/virt-resize.pod:222
+msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:224
+msgid ""
+"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
+#: ../resize/virt-resize.pod:230
+#, no-wrap
+msgid ""
+" qemu-img create [-c] -f qcow2 outdisk [size]\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:232
+msgid "instead of the truncate command (use I<-c> for a compressed disk)."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:234
+msgid "Similarly, to get non-sparse raw output use:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:236
+#, no-wrap
+msgid ""
+" fallocate -l size outdisk\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:238
+msgid ""
+"(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: =head2
+#: ../resize/virt-resize.pod:241
+msgid "LOGICAL PARTITIONS"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:243
+msgid ""
+"Logical partitions (a.k.a. C</dev/sda5+> on disks using DOS partition "
+"tables) cannot be resized."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:246
+msgid ""
+"To understand what is going on, firstly one of the four partitions C</dev/"
+"sda1-4> will have MBR partition type C<05> or C<0f>. This is called the "
+"B<extended partition>. Use L<virt-filesystems(1)> to see the MBR partition "
+"type."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:251
+msgid "Logical partitions live inside the extended partition."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:253
+msgid ""
+"The extended partition can be expanded, but not shrunk (unless you force it, "
+"which is not advisable). When the extended partition is copied across, all "
+"the logical partitions contained inside are copied over implicitly. Virt-"
+"resize does not look inside the extended partition, so it copies the logical "
+"partitions blindly."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:259
+msgid ""
+"You cannot specify a logical partition (C</dev/sda5+>) at all on the command "
+"line. Doing so will give an error."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:268 ../sparsify/virt-sparsify.pod:105
+msgid "Display help."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:270
+msgid "B<--align-first auto>"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:272
+msgid "B<--align-first never>"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:274
+msgid "B<--align-first always>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:276
+msgid ""
+"Align the first partition for improved performance (see also the I<--"
+"alignment> option)."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:279
+msgid ""
+"The default is I<--align-first auto> which only aligns the first partition "
+"if it is safe to do so. That is, only when we know how to fix the "
+"bootloader automatically, and at the moment that can only be done for "
+"Windows guests."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:284
+msgid ""
+"I<--align-first never> means we never move the first partition. This is the "
+"safest option. Try this if the guest does not boot after resizing."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:288
+msgid ""
+"I<--align-first always> means we always align the first partition (if it "
+"needs to be aligned). For some guests this will break the bootloader, "
+"making the guest unbootable."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:292
+msgid "B<--alignment N>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:294
+msgid ""
+"Set the alignment of partitions to C<N> sectors. The default in virt-resize "
+"E<lt> 1.13.19 was 64 sectors, and after that is 128 sectors."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:298
+msgid ""
+"Assuming 512 byte sector size inside the guest, here are some suitable "
+"values for this:"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:303
+msgid "I<--alignment 1> (512 bytes)"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:305
+msgid ""
+"The partitions would be packed together as closely as possible, but would be "
+"completely unaligned. In some cases this can cause very poor performance. "
+"See L<virt-alignment-scan(1)> for further details."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:309
+msgid "I<--alignment 8> (4K)"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:311
+msgid ""
+"This would be the minimum acceptable alignment for reasonable performance on "
+"modern hosts."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:314
+msgid "I<--alignment 128> (64K)"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:316
+msgid ""
+"This alignment provides good performance when the host is using high end "
+"network storage."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:319
+msgid "I<--alignment 2048> (1M)"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:321
+msgid ""
+"This is the standard alignment used by all newly installed guests since "
+"around 2008."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:326
+msgid "B<-d>"
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:328 ../tools/virt-make-fs.pl:177
+#: ../tools/virt-win-reg.pl:120
+msgid "B<--debug>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:330 ../tools/virt-win-reg.pl:122
+msgid "Enable debugging messages."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:332
+msgid "B<--delete part>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:334
+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: textblock
+#: ../resize/virt-resize.pod:338
+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: textblock
+#: ../resize/virt-resize.pod:343 ../resize/virt-resize.pod:404
+#: ../resize/virt-resize.pod:531 ../sparsify/virt-sparsify.pod:145
+msgid "You can give this option multiple times."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:345
+msgid "B<--expand part>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:347
+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)."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:350
+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
+#: ../resize/virt-resize.pod:355
+msgid "Currently virt-resize can resize:"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:361
+msgid "ext2, ext3 and ext4 filesystems."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:365
+msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:367
+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."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:374
+msgid ""
+"LVM PVs (physical volumes). virt-resize does not usually resize anything "
+"inside the PV, but see the I<--LV-expand> option. The user could also "
+"resize LVs as desired after boot."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:380
+msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:384 ../resize/virt-resize.pod:559
+msgid "Note that you cannot use I<--expand> and I<--shrink> together."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:386 ../sparsify/virt-sparsify.pod:125
+#: ../tools/virt-list-filesystems.pl:91 ../tools/virt-list-partitions.pl:92
+#: ../tools/virt-tar.pl:141 ../tools/virt-win-reg.pl:142
+msgid "B<--format> raw"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:388 ../sparsify/virt-sparsify.pod:129
+msgid ""
+"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
+#: ../resize/virt-resize.pod:394
+msgid ""
+"Note that this option I<does not> affect the output format. See L</QCOW2 "
+"AND NON-SPARSE RAW FORMATS>."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:397
+msgid "B<--ignore part>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:399
+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)."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:406
+msgid "B<--LV-expand logvol>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:408
+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:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:413
+#, no-wrap
+msgid ""
+" virt-resize indisk outdisk \\\n"
+" --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:416
+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
+#: ../resize/virt-resize.pod:419
+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 I<--no-expand-content>."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:423
+msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:425
+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."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:429 ../sparsify/virt-sparsify.pod:147
+msgid "B<--machine-readable>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:431 ../sparsify/virt-sparsify.pod:149
+msgid ""
+"This option is used to make the output more machine friendly when being "
+"parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:437
+msgid "B<--dryrun>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:439
+msgid "Print a summary of what would be done, but don't do anything."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:441
+msgid "B<--no-copy-boot-loader>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:443
+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."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:448
+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: =item
+#: ../resize/virt-resize.pod:451
+msgid "B<--no-extra-partition>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:453
+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: textblock
+#: ../resize/virt-resize.pod:459
+msgid ""
+"Note that if the surplus space is smaller than 10 MB, no extra partition "
+"will be created."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:462
+msgid "B<--no-expand-content>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:464
+msgid ""
+"By default, virt-resize will try to expand the direct contents of "
+"partitions, if it knows how (see I<--expand> option above)."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:467
+msgid ""
+"If you give the I<--no-expand-content> option then virt-resize will not "
+"attempt this."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:470
+msgid "B<--ntfsresize-force>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:472
+msgid ""
+"Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
+"the NTFS disk is marked as needing a consistency check. You have to use "
+"this option if you want to resize a Windows guest multiple times without "
+"booting into Windows between each resize."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:478
+msgid "B<--output-format> raw"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:480
+msgid ""
+"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
+#: ../resize/virt-resize.pod:486
+msgid ""
+"Note that this option I<does not create> the output format. This option "
+"just tells libguestfs what it is so it doesn't try to guess it. You still "
+"need to create the output disk with the right format. See L</QCOW2 AND NON-"
+"SPARSE RAW FORMATS>."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:495
+msgid "Don't print the summary."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:497
+msgid "B<--resize part=size>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:499
+msgid ""
+"Resize the named partition (expanding or shrinking it) so that it has the "
+"given size."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:502
+msgid ""
+"C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
+"bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
+"size; or as a relative number or percentage. For example:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:508
+#, no-wrap
+msgid ""
+" --resize /dev/sda2=10G\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:510
+#, no-wrap
+msgid ""
+" --resize /dev/sda4=90%\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:512
+#, no-wrap
+msgid ""
+" --resize /dev/sda2=+1G\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:514
+#, no-wrap
+msgid ""
+" --resize /dev/sda2=-200M\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:516
+#, no-wrap
+msgid ""
+" --resize /dev/sda1=+128K\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:518
+#, no-wrap
+msgid ""
+" --resize /dev/sda1=+10%\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:520
+#, no-wrap
+msgid ""
+" --resize /dev/sda1=-10%\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:522
+msgid ""
+"You can increase the size of any partition. Virt-resize will expand the "
+"direct content of the partition if it knows how (see I<--expand> below)."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:526
+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 I<--resize-"
+"force>)."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:533
+msgid "B<--resize-force part=size>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:535
+msgid ""
+"This is the same as I<--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
+#: ../resize/virt-resize.pod:541
+msgid "See also the I<--ignore> option."
+msgstr ""
+
+#. type: =item
+#: ../resize/virt-resize.pod:543
+msgid "B<--shrink part>"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:545
+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."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:551
+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: =head1
+#: ../resize/virt-resize.pod:569 ../sparsify/virt-sparsify.pod:177
+msgid "MACHINE READABLE OUTPUT"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:571
+msgid ""
+"The I<--machine-readable> option can be used to make the output more machine "
+"friendly, which is useful when calling virt-resize from other programs, GUIs "
+"etc."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:575 ../sparsify/virt-sparsify.pod:183
+msgid "There are two ways to use this option."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:577
+msgid ""
+"Firstly use the option on its own to query the capabilities of the virt-"
+"resize binary. Typical output looks like this:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:580
+#, no-wrap
+msgid ""
+" $ virt-resize --machine-readable\n"
+" virt-resize\n"
+" ntfsresize-force\n"
+" 32bitok\n"
+" ntfs\n"
+" btrfs\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:587 ../sparsify/virt-sparsify.pod:193
+msgid ""
+"A list of features is printed, one per line, and the program exits with "
+"status 0."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:590 ../sparsify/virt-sparsify.pod:196
+msgid ""
+"Secondly use the option in conjunction with other options to make the "
+"regular program output more machine friendly."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:593 ../sparsify/virt-sparsify.pod:199
+msgid "At the moment this means:"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:599 ../sparsify/virt-sparsify.pod:205
+msgid ""
+"Progress bar messages can be parsed from stdout by looking for this regular "
+"expression:"
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:602 ../sparsify/virt-sparsify.pod:208
+#, no-wrap
+msgid ""
+" ^[0-9]+/[0-9]+$\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:606 ../sparsify/virt-sparsify.pod:212
+msgid ""
+"The calling program should treat messages sent to stdout (except for "
+"progress bar messages) as status messages. They can be logged and/or "
+"displayed to the user."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:612
+msgid ""
+"The calling program should treat messages sent to stderr as error messages. "
+"In addition, virt-resize exits with a non-zero status code if there was a "
+"fatal error."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:618
+msgid ""
+"Versions of the program prior to 1.13.9 did not support the I<--machine-"
+"readable> option and will return an error."
+msgstr ""
+
+#. type: =head2
+#: ../resize/virt-resize.pod:623
+msgid "\"Partition 1 does not end on cylinder boundary.\""
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:625
+msgid ""
+"Virt-resize aligns partitions to multiples of 128 sectors (see the I<--"
+"alignment> parameter). 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
+#: ../resize/virt-resize.pod:632
+msgid "RESIZING WINDOWS VIRTUAL MACHINES"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:634
+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. Resizing the first (boot) "
+"partition causes the bootloader to fail with C<0xC0000225> error. Resizing "
+"the second partition (ie. C: drive) should work."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:641
+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."
+msgstr ""
+
+#. type: =head2
+#: ../resize/virt-resize.pod:645
+msgid "GUEST BOOT STUCK AT \"GRUB\""
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:647
+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."
+msgstr ""
+
+#. type: verbatim
+#: ../resize/virt-resize.pod:650
+#, no-wrap
+msgid ""
+" 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
+#: ../resize/virt-resize.pod:657
+msgid ""
+"For more flexible guest reconfiguration, including if you need to specify "
+"other parameters to grub-install, use L<virt-rescue(1)>."
+msgstr ""
+
+#. type: =head1
+#: ../resize/virt-resize.pod:660
+msgid "ALTERNATIVE TOOLS"
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:662
+msgid ""
+"There are several proprietary tools for resizing partitions. We won't "
+"mention any here."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:665
+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."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:670
+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 "
+"I<--debug> flag."
+msgstr ""
+
+#. type: textblock
+#: ../resize/virt-resize.pod:690
+msgid ""
+"L<virt-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<btrfs(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<virt-sparsify(1)>, "
+"L<virt-alignment-scan(1)>, L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../ruby/examples/guestfs-ruby.pod:5
+msgid "guestfs-ruby - How to use libguestfs from Ruby"
+msgstr ""
+
+#. type: verbatim
+#: ../ruby/examples/guestfs-ruby.pod:9
+#, no-wrap
+msgid ""
+" require 'guestfs'\n"
+" g = Guestfs::Guestfs.new()\n"
+" g.add_drive_opts(\"disk.img\",\n"
+" :readonly => 1, :format => \"raw\")\n"
+" g.launch()\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../ruby/examples/guestfs-ruby.pod:17
+msgid ""
+"This manual page documents how to call libguestfs from the Ruby programming "
+"language. This page just documents the differences from the C API and gives "
+"some examples. If you are not familiar with using libguestfs, you also need "
+"to read L<guestfs(3)>."
+msgstr ""
+
+#. type: textblock
+#: ../ruby/examples/guestfs-ruby.pod:24
+msgid ""
+"Errors from libguestfs functions are mapped into the C<Error> exception. "
+"This has a single parameter which is the error message (a string)."
+msgstr ""
+
+#. type: textblock
+#: ../ruby/examples/guestfs-ruby.pod:38
+msgid ""
+"L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java"
+"(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
+"L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:5
+msgid "virt-sparsify - Make a virtual machine disk sparse"
+msgstr ""
+
+#. type: verbatim
+#: ../sparsify/virt-sparsify.pod:9
+#, no-wrap
+msgid ""
+" virt-sparsify [--options] indisk outdisk\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:13
+msgid ""
+"Virt-sparsify is a tool which can make a virtual machine disk (or any disk "
+"image) sparse a.k.a. thin-provisioned. This means that free space within "
+"the disk image can be converted back to free space on the host."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:18
+msgid ""
+"Virt-sparsify can locate and sparsify free space in most filesystems (eg. "
+"ext2/3/4, btrfs, NTFS, etc.), and also in LVM physical volumes."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:21
+msgid ""
+"Virt-sparsify can also convert between some disk formats, for example "
+"converting a raw disk image to a thin-provisioned qcow2 image."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:24
+msgid ""
+"Virt-sparsify can operate on any disk image, not just ones from virtual "
+"machines. If a virtual machine has more than one attached disk, you must "
+"sparsify each one separately."
+msgstr ""
+
+#. type: =head2
+#: ../sparsify/virt-sparsify.pod:28
+msgid "IMPORTANT LIMITATIONS"
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:34
+msgid ""
+"Virt-sparsify does not do in-place modifications. It copies from a source "
+"image to a destination image, leaving the source unchanged. I<Check that "
+"the sparsification was successful before deleting the source image>."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:41
+msgid "The virtual machine I<must be shut down> before using this tool."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:45
+msgid ""
+"Virt-sparsify may require up to 2x the virtual size of the source disk image "
+"(1 temporary copy + 1 destination image). This is in the worst case and "
+"usually much less space is required."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:51
+msgid ""
+"Virt-sparsify cannot resize disk images. To do that, use L<virt-resize(1)>."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:56
+msgid "Virt-sparsify cannot handle encrypted disks."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:60
+msgid ""
+"Virt-sparsify cannot yet sparsify the space between partitions. Note that "
+"this space is often used for critical items like bootloaders so it's not "
+"really unused."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:66
+msgid ""
+"Virt-sparsify does not yet know how to sparsify swapspace. It is not safe "
+"to do this unless we can be sure there is no hibernation data, so at the "
+"moment swap partitions are ignored."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:72
+msgid ""
+"You may also want to read the manual pages for the associated tools L<virt-"
+"filesystems(1)> and L<virt-df(1)> before starting."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:77
+msgid "Typical usage is:"
+msgstr ""
+
+#. type: verbatim
+#: ../sparsify/virt-sparsify.pod:79
+#, no-wrap
+msgid ""
+" virt-sparsify indisk outdisk\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:81
+msgid ""
+"which copies C<indisk> to C<outdisk>, making the output sparse. C<outdisk> "
+"is created, or overwritten if it already exists. The format of the input "
+"disk is detected (eg. qcow2) and the same format is used for the output disk."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:86
+msgid "To convert between formats, use the I<--convert> option:"
+msgstr ""
+
+#. type: verbatim
+#: ../sparsify/virt-sparsify.pod:88
+#, no-wrap
+msgid ""
+" virt-sparsify disk.raw --convert qcow2 disk.qcow2\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:90
+msgid ""
+"Virt-sparsify tries to zero and sparsify free space on every filesystem it "
+"can find within the source disk image. You can get it to ignore (don't zero "
+"free space on) certain filesystems by doing:"
+msgstr ""
+
+#. type: verbatim
+#: ../sparsify/virt-sparsify.pod:94
+#, no-wrap
+msgid ""
+" virt-sparsify --ignore /dev/sda1 indisk outdisk\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:96
+msgid ""
+"See L<virt-filesystems(1)> to get a list of filesystems within a disk image."
+msgstr ""
+
+#. type: =item
+#: ../sparsify/virt-sparsify.pod:107
+msgid "B<--convert> raw"
+msgstr ""
+
+#. type: =item
+#: ../sparsify/virt-sparsify.pod:109
+msgid "B<--convert> qcow2"
+msgstr ""
+
+#. type: =item
+#: ../sparsify/virt-sparsify.pod:111
+msgid "B<--convert> [other formats]"
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:113
+msgid ""
+"Use C<output-format> as the format for the destination image. If this is "
+"not specified, then the input format is used."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:116
+msgid "Supported and known-working output formats are: C<raw>, C<qcow2>."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:118
+msgid ""
+"You can also use any format supported by the L<qemu-img(1)> program, eg. "
+"C<vdi> or C<vmdk>, but support for other formats is reliant on qemu."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:122
+msgid ""
+"Specifying the I<--convert> option is usually a good idea, because then virt-"
+"sparsify doesn't need to try to guess the input format."
+msgstr ""
+
+#. type: =item
+#: ../sparsify/virt-sparsify.pod:127
+msgid "B<--format> qcow2"
+msgstr ""
+
+#. type: =item
+#: ../sparsify/virt-sparsify.pod:135
+msgid "B<--ignore> filesystem"
+msgstr ""
+
+#. type: =item
+#: ../sparsify/virt-sparsify.pod:137
+msgid "B<--ignore> volgroup"
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:139
+msgid ""
+"Ignore the named filesystem. Free space on the filesystem will not be "
+"zeroed, but existing blocks of zeroes will still be sparsified."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:142
+msgid ""
+"In the second form, this ignores the named volume group. Use the volume "
+"group name without the C</dev/> prefix, eg. I<--ignore vg_foo>"
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:157
+msgid "This disables progress bars and other unnecessary output."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:179
+msgid ""
+"The I<--machine-readable> option can be used to make the output more machine "
+"friendly, which is useful when calling virt-sparsify from other programs, "
+"GUIs etc."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:185
+msgid ""
+"Firstly use the option on its own to query the capabilities of the virt-"
+"sparsify binary. Typical output looks like this:"
+msgstr ""
+
+#. type: verbatim
+#: ../sparsify/virt-sparsify.pod:188
+#, no-wrap
+msgid ""
+" $ virt-sparsify --machine-readable\n"
+" virt-sparsify\n"
+" ntfs\n"
+" btrfs\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:218
+msgid ""
+"The calling program should treat messages sent to stderr as error messages. "
+"In addition, virt-sparsify exits with a non-zero status code if there was a "
+"fatal error."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:224
+msgid ""
+"All versions of virt-sparsify have supported the I<--machine-readable> "
+"option."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:238
+msgid ""
+"Location of the temporary directory used for the potentially large temporary "
+"overlay file."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:241
+msgid ""
+"You should ensure there is enough free space in the worst case for a full "
+"copy of the source disk (I<virtual> size), or else set C<$TMPDIR> to point "
+"to another directory that has enough space."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:245
+msgid "This defaults to C</tmp>."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:249
+msgid ""
+"For other environment variables, see L<guestfs(3)/ENVIRONMENT VARIABLES>."
+msgstr ""
+
+#. type: textblock
+#: ../sparsify/virt-sparsify.pod:253
+msgid ""
+"L<virt-filesystems(1)>, L<virt-df(1)>, L<virt-resize(1)>, L<virt-rescue(1)>, "
+"L<guestfs(3)>, L<guestfish(1)>, L<truncate(1)>, L<fallocate(1)>, L<qemu-img"
+"(1)>, L<http://libguestfs.org/>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1
+msgid "guestfs_add_cdrom"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_cdrom (guestfs_h *g,\n"
+" const char *filename);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:302
+#: ../src/guestfs-actions.pod:323
+msgid ""
+"I<This function is deprecated.> In new code, use the L</"
+"guestfs_add_drive_opts> call instead."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:24
+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:31
+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."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:187
+#: ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:291
+#: ../src/guestfs-actions.pod:312 ../src/guestfs-actions.pod:333
+#: ../src/guestfs-actions.pod:346 ../src/guestfs-actions.pod:360
+#: ../src/guestfs-actions.pod:480 ../src/guestfs-actions.pod:500
+#: ../src/guestfs-actions.pod:514 ../src/guestfs-actions.pod:559
+#: ../src/guestfs-actions.pod:587 ../src/guestfs-actions.pod:605
+#: ../src/guestfs-actions.pod:672 ../src/guestfs-actions.pod:705
+#: ../src/guestfs-actions.pod:719 ../src/guestfs-actions.pod:734
+#: ../src/guestfs-actions.pod:833 ../src/guestfs-actions.pod:851
+#: ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:879
+#: ../src/guestfs-actions.pod:916 ../src/guestfs-actions.pod:1099
+#: ../src/guestfs-actions.pod:1119 ../src/guestfs-actions.pod:1137
+#: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:1286
+#: ../src/guestfs-actions.pod:1332 ../src/guestfs-actions.pod:1372
+#: ../src/guestfs-actions.pod:1423 ../src/guestfs-actions.pod:1474
+#: ../src/guestfs-actions.pod:1530 ../src/guestfs-actions.pod:1582
+#: ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1615
+#: ../src/guestfs-actions.pod:1643 ../src/guestfs-actions.pod:1713
+#: ../src/guestfs-actions.pod:1744 ../src/guestfs-actions.pod:1769
+#: ../src/guestfs-actions.pod:1811 ../src/guestfs-actions.pod:1924
+#: ../src/guestfs-actions.pod:1951 ../src/guestfs-actions.pod:2166
+#: ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:2275
+#: ../src/guestfs-actions.pod:2783 ../src/guestfs-actions.pod:2927
+#: ../src/guestfs-actions.pod:2988 ../src/guestfs-actions.pod:3023
+#: ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4095
+#: ../src/guestfs-actions.pod:4120 ../src/guestfs-actions.pod:4309
+#: ../src/guestfs-actions.pod:4323 ../src/guestfs-actions.pod:4336
+#: ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4365
+#: ../src/guestfs-actions.pod:4401 ../src/guestfs-actions.pod:4473
+#: ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4510
+#: ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4556
+#: ../src/guestfs-actions.pod:4591 ../src/guestfs-actions.pod:4610
+#: ../src/guestfs-actions.pod:4629 ../src/guestfs-actions.pod:4664
+#: ../src/guestfs-actions.pod:4676 ../src/guestfs-actions.pod:4712
+#: ../src/guestfs-actions.pod:4728 ../src/guestfs-actions.pod:4741
+#: ../src/guestfs-actions.pod:4756 ../src/guestfs-actions.pod:4773
+#: ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:4886
+#: ../src/guestfs-actions.pod:4899 ../src/guestfs-actions.pod:4950
+#: ../src/guestfs-actions.pod:4968 ../src/guestfs-actions.pod:4986
+#: ../src/guestfs-actions.pod:5002 ../src/guestfs-actions.pod:5016
+#: ../src/guestfs-actions.pod:5030 ../src/guestfs-actions.pod:5047
+#: ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5089
+#: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5225
+#: ../src/guestfs-actions.pod:5256 ../src/guestfs-actions.pod:5275
+#: ../src/guestfs-actions.pod:5294 ../src/guestfs-actions.pod:5306
+#: ../src/guestfs-actions.pod:5323 ../src/guestfs-actions.pod:5336
+#: ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5366
+#: ../src/guestfs-actions.pod:5398 ../src/guestfs-actions.pod:5424
+#: ../src/guestfs-actions.pod:5463 ../src/guestfs-actions.pod:5483
+#: ../src/guestfs-actions.pod:5497 ../src/guestfs-actions.pod:5514
+#: ../src/guestfs-actions.pod:5563 ../src/guestfs-actions.pod:5616
+#: ../src/guestfs-actions.pod:5663 ../src/guestfs-actions.pod:5706
+#: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:5751
+#: ../src/guestfs-actions.pod:5769 ../src/guestfs-actions.pod:5909
+#: ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:5988
+#: ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6056
+#: ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6139
+#: ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6166
+#: ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6474
+#: ../src/guestfs-actions.pod:6493 ../src/guestfs-actions.pod:6507
+#: ../src/guestfs-actions.pod:6519 ../src/guestfs-actions.pod:6533
+#: ../src/guestfs-actions.pod:6545 ../src/guestfs-actions.pod:6559
+#: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6596
+#: ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6634
+#: ../src/guestfs-actions.pod:6664 ../src/guestfs-actions.pod:6682
+#: ../src/guestfs-actions.pod:6705 ../src/guestfs-actions.pod:6723
+#: ../src/guestfs-actions.pod:6742 ../src/guestfs-actions.pod:6763
+#: ../src/guestfs-actions.pod:6782 ../src/guestfs-actions.pod:6799
+#: ../src/guestfs-actions.pod:6818 ../src/guestfs-actions.pod:6846
+#: ../src/guestfs-actions.pod:6870 ../src/guestfs-actions.pod:6889
+#: ../src/guestfs-actions.pod:6905 ../src/guestfs-actions.pod:6929
+#: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6963
+#: ../src/guestfs-actions.pod:6982 ../src/guestfs-actions.pod:7026
+#: ../src/guestfs-actions.pod:7056 ../src/guestfs-actions.pod:7089
+#: ../src/guestfs-actions.pod:7204 ../src/guestfs-actions.pod:7325
+#: ../src/guestfs-actions.pod:7337 ../src/guestfs-actions.pod:7350
+#: ../src/guestfs-actions.pod:7363 ../src/guestfs-actions.pod:7385
+#: ../src/guestfs-actions.pod:7398 ../src/guestfs-actions.pod:7411
+#: ../src/guestfs-actions.pod:7424 ../src/guestfs-actions.pod:7439
+#: ../src/guestfs-actions.pod:7498 ../src/guestfs-actions.pod:7515
+#: ../src/guestfs-actions.pod:7531 ../src/guestfs-actions.pod:7547
+#: ../src/guestfs-actions.pod:7564 ../src/guestfs-actions.pod:7577
+#: ../src/guestfs-actions.pod:7597 ../src/guestfs-actions.pod:7633
+#: ../src/guestfs-actions.pod:7647 ../src/guestfs-actions.pod:7688
+#: ../src/guestfs-actions.pod:7701 ../src/guestfs-actions.pod:7719
+#: ../src/guestfs-actions.pod:7753 ../src/guestfs-actions.pod:7789
+#: ../src/guestfs-actions.pod:7905 ../src/guestfs-actions.pod:7920
+#: ../src/guestfs-actions.pod:7934 ../src/guestfs-actions.pod:7989
+#: ../src/guestfs-actions.pod:8002 ../src/guestfs-actions.pod:8047
+#: ../src/guestfs-actions.pod:8087 ../src/guestfs-actions.pod:8143
+#: ../src/guestfs-actions.pod:8163 ../src/guestfs-actions.pod:8196
+#: ../src/guestfs-actions.pod:8260 ../src/guestfs-actions.pod:8283
+#: ../src/guestfs-actions.pod:8312
+msgid "This function returns 0 on success or -1 on error."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:189
+#: ../src/guestfs-actions.pod:1334 ../src/guestfs-actions.pod:2389
+#: ../src/guestfs-actions.pod:2487 ../src/guestfs-actions.pod:2612
+#: ../src/guestfs-actions.pod:4082 ../src/guestfs-actions.pod:4102
+#: ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:6684
+#: ../src/guestfs-actions.pod:6801 ../src/guestfs-actions.pod:6950
+#: ../src/guestfs-actions.pod:7441 ../src/guestfs-actions.pod:7566
+#: ../src/guestfs-actions.pod:8089
+msgid "(Added in 0.3)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:41
+msgid "guestfs_add_domain"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:43
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_domain (guestfs_h *g,\n"
+" const char *dom,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:198
+#: ../src/guestfs-actions.pod:890 ../src/guestfs-actions.pod:1214
+#: ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1344
+#: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1462
+#: ../src/guestfs-actions.pod:1513 ../src/guestfs-actions.pod:3280
+#: ../src/guestfs-actions.pod:5101 ../src/guestfs-actions.pod:5410
+#: ../src/guestfs-actions.pod:5627
+msgid ""
+"You may supply a list of optional arguments to this call. Use zero or more "
+"of the following pairs of parameters, and terminate the list with C<-1> on "
+"its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:53
+#, no-wrap
+msgid ""
+" GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
+" GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
+" GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
+" GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
+" GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
+" GUESTFS_ADD_DOMAIN_READONLYDISK, const char *readonlydisk,\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:60
+msgid ""
+"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:141
+msgid ""
+"The other optional parameters are passed directly through to "
+"C<guestfs_add_drive_opts>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:144 ../src/guestfs-actions.pod:403
+#: ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:751
+#: ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800
+#: ../src/guestfs-actions.pod:819 ../src/guestfs-actions.pod:1789
+#: ../src/guestfs-actions.pod:2145 ../src/guestfs-actions.pod:2348
+#: ../src/guestfs-actions.pod:2459 ../src/guestfs-actions.pod:2510
+#: ../src/guestfs-actions.pod:2562 ../src/guestfs-actions.pod:2576
+#: ../src/guestfs-actions.pod:2599 ../src/guestfs-actions.pod:2914
+#: ../src/guestfs-actions.pod:3398 ../src/guestfs-actions.pod:3416
+#: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:5806
+#: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6236
+#: ../src/guestfs-actions.pod:6262 ../src/guestfs-actions.pod:7674
+#: ../src/guestfs-actions.pod:8100 ../src/guestfs-actions.pod:8113
+#: ../src/guestfs-actions.pod:8126
+msgid "On error this function returns -1."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:146
+msgid "(Added in 1.7.4)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:148
+msgid "guestfs_add_domain_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:150
+#, no-wrap
+msgid ""
+" 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:155
+msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:157 ../src/guestfs-actions.pod:168
+#: ../src/guestfs-actions.pod:267 ../src/guestfs-actions.pod:278
+#: ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:940
+#: ../src/guestfs-actions.pod:1242 ../src/guestfs-actions.pod:1255
+#: ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1314
+#: ../src/guestfs-actions.pod:1389 ../src/guestfs-actions.pod:1401
+#: ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1452
+#: ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:1503
+#: ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1559
+#: ../src/guestfs-actions.pod:3364 ../src/guestfs-actions.pod:3376
+#: ../src/guestfs-actions.pod:5166 ../src/guestfs-actions.pod:5178
+#: ../src/guestfs-actions.pod:5438 ../src/guestfs-actions.pod:5450
+#: ../src/guestfs-actions.pod:5676 ../src/guestfs-actions.pod:5687
+msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:159
+msgid "guestfs_add_domain_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:161
+#, no-wrap
+msgid ""
+" 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:166
+msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:170
+msgid "guestfs_add_drive"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:172
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_drive (guestfs_h *g,\n"
+" const char *filename);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:176
+msgid ""
+"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:180
+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:191
+msgid "guestfs_add_drive_opts"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:193
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_drive_opts (guestfs_h *g,\n"
+" const char *filename,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:203
+#, 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"
+" GUESTFS_ADD_DRIVE_OPTS_NAME, const char *name,\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:233
+msgid ""
+"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:244
+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:256
+msgid "(Added in 1.5.23)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:258
+msgid "guestfs_add_drive_opts_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:260
+#, no-wrap
+msgid ""
+" 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:265
+msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:269
+msgid "guestfs_add_drive_opts_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:271
+#, no-wrap
+msgid ""
+" 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:276
+msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:280
+msgid "guestfs_add_drive_ro"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:282
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_add_drive_ro (guestfs_h *g,\n"
+" const char *filename);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:286
+msgid ""
+"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:293
+msgid "(Added in 1.0.38)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:295
+msgid "guestfs_add_drive_ro_with_if"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:297
+#, no-wrap
+msgid ""
+" 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:309
+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:314 ../src/guestfs-actions.pod:335
+#: ../src/guestfs-actions.pod:2873
+msgid "(Added in 1.0.84)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:316
+msgid "guestfs_add_drive_with_if"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:318
+#, no-wrap
+msgid ""
+" 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:330
+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:337
+msgid "guestfs_aug_clear"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:339
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_aug_clear (guestfs_h *g,\n"
+" const char *augpath);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:348 ../src/guestfs-actions.pod:2601
+msgid "(Added in 1.3.4)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:350
+msgid "guestfs_aug_close"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:352
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_aug_close (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:355
+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:362 ../src/guestfs-actions.pod:387
+#: ../src/guestfs-actions.pod:405 ../src/guestfs-actions.pod:419
+#: ../src/guestfs-actions.pod:482 ../src/guestfs-actions.pod:502
+#: ../src/guestfs-actions.pod:516 ../src/guestfs-actions.pod:547
+#: ../src/guestfs-actions.pod:561 ../src/guestfs-actions.pod:575
+#: ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:607
+#: ../src/guestfs-actions.pod:6313
+msgid "(Added in 0.7)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:364
+msgid "guestfs_aug_defnode"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:366
+#, no-wrap
+msgid ""
+" 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:375
+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."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:383
+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:389
+msgid "guestfs_aug_defvar"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:391
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_aug_defvar (guestfs_h *g,\n"
+" const char *name,\n"
+" const char *expr);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:407
+msgid "guestfs_aug_get"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:409
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_aug_get (guestfs_h *g,\n"
+" const char *augpath);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:416 ../src/guestfs-actions.pod:980
+#: ../src/guestfs-actions.pod:998 ../src/guestfs-actions.pod:1058
+#: ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1177
+#: ../src/guestfs-actions.pod:1658 ../src/guestfs-actions.pod:1675
+#: ../src/guestfs-actions.pod:1694 ../src/guestfs-actions.pod:1828
+#: ../src/guestfs-actions.pod:2016 ../src/guestfs-actions.pod:2128
+#: ../src/guestfs-actions.pod:2291 ../src/guestfs-actions.pod:2308
+#: ../src/guestfs-actions.pod:2375 ../src/guestfs-actions.pod:2418
+#: ../src/guestfs-actions.pod:2439 ../src/guestfs-actions.pod:2624
+#: ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:3042
+#: ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3248
+#: ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:3482
+#: ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3531
+#: ../src/guestfs-actions.pod:3565 ../src/guestfs-actions.pod:3628
+#: ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:3668
+#: ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4648
+#: ../src/guestfs-actions.pod:4818 ../src/guestfs-actions.pod:4928
+#: ../src/guestfs-actions.pod:5824 ../src/guestfs-actions.pod:6025
+#: ../src/guestfs-actions.pod:6211 ../src/guestfs-actions.pod:6389
+#: ../src/guestfs-actions.pod:6438 ../src/guestfs-actions.pod:7110
+#: ../src/guestfs-actions.pod:7126 ../src/guestfs-actions.pod:7150
+#: ../src/guestfs-actions.pod:7174 ../src/guestfs-actions.pod:7848
+#: ../src/guestfs-actions.pod:7867 ../src/guestfs-actions.pod:7885
+#: ../src/guestfs-actions.pod:8059 ../src/guestfs-actions.pod:8376
+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:421
+msgid "guestfs_aug_init"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:423
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_aug_init (guestfs_h *g,\n"
+" const char *root,\n"
+" int flags);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:432
+msgid "You must call this before using any other C<guestfs_aug_*> commands."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:457
+msgid ""
+"This option is only useful when debugging Augeas lenses. Use of this option "
+"may require additional memory for the libguestfs appliance. You may need to "
+"set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
+"C<guestfs_set_memsize>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:472
+msgid "Do not load the tree in C<guestfs_aug_init>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:476
+msgid "To close the handle, you can call C<guestfs_aug_close>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:484
+msgid "guestfs_aug_insert"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:486
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_aug_insert (guestfs_h *g,\n"
+" const char *augpath,\n"
+" const char *label,\n"
+" int before);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:504
+msgid "guestfs_aug_load"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:506
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_aug_load (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:518
+msgid "guestfs_aug_ls"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:520
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_aug_ls (guestfs_h *g,\n"
+" const char *augpath);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:524
+msgid ""
+"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:527 ../src/guestfs-actions.pod:543
+#: ../src/guestfs-actions.pod:689 ../src/guestfs-actions.pod:1196
+#: ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:1862
+#: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:1984
+#: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2696
+#: ../src/guestfs-actions.pod:2712 ../src/guestfs-actions.pod:2731
+#: ../src/guestfs-actions.pod:2796 ../src/guestfs-actions.pod:2820
+#: ../src/guestfs-actions.pod:2891 ../src/guestfs-actions.pod:2940
+#: ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3584
+#: ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:4178
+#: ../src/guestfs-actions.pod:4195 ../src/guestfs-actions.pod:4215
+#: ../src/guestfs-actions.pod:4277 ../src/guestfs-actions.pod:4382
+#: ../src/guestfs-actions.pod:4790 ../src/guestfs-actions.pod:5547
+#: ../src/guestfs-actions.pod:6183 ../src/guestfs-actions.pod:6309
+#: ../src/guestfs-actions.pod:6423 ../src/guestfs-actions.pod:7190
+#: ../src/guestfs-actions.pod:7251 ../src/guestfs-actions.pod:7306
+#: ../src/guestfs-actions.pod:7452 ../src/guestfs-actions.pod:7476
+#: ../src/guestfs-actions.pod:7952 ../src/guestfs-actions.pod:7972
+#: ../src/guestfs-actions.pod:8019 ../src/guestfs-actions.pod:8213
+#: ../src/guestfs-actions.pod:8232 ../src/guestfs-actions.pod:8326
+#: ../src/guestfs-actions.pod:8345 ../src/guestfs-actions.pod:8391
+#: ../src/guestfs-actions.pod:8410
+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>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:1121
+#: ../src/guestfs-actions.pod:1139 ../src/guestfs-actions.pod:1900
+#: ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:3973
+#: ../src/guestfs-actions.pod:4631 ../src/guestfs-actions.pod:4681
+#: ../src/guestfs-actions.pod:4868 ../src/guestfs-actions.pod:4901
+#: ../src/guestfs-actions.pod:5064 ../src/guestfs-actions.pod:5551
+#: ../src/guestfs-actions.pod:6124 ../src/guestfs-actions.pod:6521
+#: ../src/guestfs-actions.pod:6535 ../src/guestfs-actions.pod:6547
+#: ../src/guestfs-actions.pod:7031 ../src/guestfs-actions.pod:7690
+#: ../src/guestfs-actions.pod:7703 ../src/guestfs-actions.pod:7936
+#: ../src/guestfs-actions.pod:8201
+msgid "(Added in 0.8)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:533
+msgid "guestfs_aug_match"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:535
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_aug_match (guestfs_h *g,\n"
+" const char *augpath);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:549
+msgid "guestfs_aug_mv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:551
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_aug_mv (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:563
+msgid "guestfs_aug_rm"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:565
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_aug_rm (guestfs_h *g,\n"
+" const char *augpath);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:577
+msgid "guestfs_aug_save"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:579
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_aug_save (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:584
+msgid ""
+"The flags which were passed to C<guestfs_aug_init> affect exactly how files "
+"are saved."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:591
+msgid "guestfs_aug_set"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:593
+#, no-wrap
+msgid ""
+" 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:600
+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:609
+msgid "guestfs_available"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:611
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_available (guestfs_h *g,\n"
+" char *const *groups);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:619
+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>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:643
+msgid "You must call C<guestfs_launch> before calling this function."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:665
+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>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:1645
+msgid "(Added in 1.0.80)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:676
+msgid "guestfs_available_all_groups"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:678
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_available_all_groups (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:681
+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."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:687
+msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:693
+msgid "(Added in 1.3.15)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:695
+msgid "guestfs_base64_in"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:697
+#, no-wrap
+msgid ""
+" 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:707 ../src/guestfs-actions.pod:721
+msgid "(Added in 1.3.5)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:709
+msgid "guestfs_base64_out"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:711
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_base64_out (guestfs_h *g,\n"
+" const char *filename,\n"
+" const char *base64file);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:723
+msgid "guestfs_blockdev_flushbufs"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:725
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_blockdev_flushbufs (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:736 ../src/guestfs-actions.pod:753
+#: ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:784
+#: ../src/guestfs-actions.pod:802 ../src/guestfs-actions.pod:821
+#: ../src/guestfs-actions.pod:835 ../src/guestfs-actions.pod:853
+#: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:881
+msgid "(Added in 0.9.3)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:738
+msgid "guestfs_blockdev_getbsz"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:740
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_blockdev_getbsz (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:755
+msgid "guestfs_blockdev_getro"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:757
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_blockdev_getro (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1883
+#: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:2387
+#: ../src/guestfs-actions.pod:2398 ../src/guestfs-actions.pod:2470
+#: ../src/guestfs-actions.pod:2496 ../src/guestfs-actions.pod:2536
+#: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2587
+#: ../src/guestfs-actions.pod:2610 ../src/guestfs-actions.pod:3685
+#: ../src/guestfs-actions.pod:3701 ../src/guestfs-actions.pod:3719
+#: ../src/guestfs-actions.pod:3881 ../src/guestfs-actions.pod:3895
+#: ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:3924
+#: ../src/guestfs-actions.pod:3940 ../src/guestfs-actions.pod:3955
+#: ../src/guestfs-actions.pod:3971 ../src/guestfs-actions.pod:3985
+#: ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4012
+#: ../src/guestfs-actions.pod:4027 ../src/guestfs-actions.pod:4042
+#: ../src/guestfs-actions.pod:4055 ../src/guestfs-actions.pod:4069
+#: ../src/guestfs-actions.pod:5788
+msgid "This function returns a C truth value on success or -1 on error."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:770
+msgid "guestfs_blockdev_getsize64"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:772
+#, no-wrap
+msgid ""
+" int64_t\n"
+" guestfs_blockdev_getsize64 (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:778
+msgid "See also C<guestfs_blockdev_getsz>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:786
+msgid "guestfs_blockdev_getss"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:788
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_blockdev_getss (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:795
+msgid ""
+"(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
+"that)."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:804
+msgid "guestfs_blockdev_getsz"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:806
+#, no-wrap
+msgid ""
+" int64_t\n"
+" guestfs_blockdev_getsz (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:813
+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>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:823
+msgid "guestfs_blockdev_rereadpt"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:825
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_blockdev_rereadpt (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:837
+msgid "guestfs_blockdev_setbsz"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:839
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_blockdev_setbsz (guestfs_h *g,\n"
+" const char *device,\n"
+" int blocksize);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:855
+msgid "guestfs_blockdev_setro"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:857
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_blockdev_setro (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:869
+msgid "guestfs_blockdev_setrw"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:871
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_blockdev_setrw (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:883
+msgid "guestfs_btrfs_filesystem_resize"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:885
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
+" const char *mountpoint,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:895
+#, no-wrap
+msgid ""
+" GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:918
+msgid "(Added in 1.11.17)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:920
+msgid "guestfs_btrfs_filesystem_resize_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:922
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
+" const char *mountpoint,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:927
+msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:931
+msgid "guestfs_btrfs_filesystem_resize_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:933
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
+" const char *mountpoint,\n"
+" const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:938
+msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:942
+msgid "guestfs_case_sensitive_path"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:944
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_case_sensitive_path (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:970
+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)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:978
+msgid "See also C<guestfs_realpath>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:983 ../src/guestfs-actions.pod:7870
+msgid "(Added in 1.0.75)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:985
+msgid "guestfs_cat"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:987
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_cat (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:993
+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."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:4199
+#: ../src/guestfs-actions.pod:4281 ../src/guestfs-actions.pod:4298
+#: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4794
+#: ../src/guestfs-actions.pod:4808 ../src/guestfs-actions.pod:6187
+#: ../src/guestfs-actions.pod:6201 ../src/guestfs-actions.pod:8023
+#: ../src/guestfs-actions.pod:8037
+msgid "(Added in 0.4)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1006
+msgid "guestfs_checksum"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1008
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_checksum (guestfs_h *g,\n"
+" const char *csumtype,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1054
+msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1056
+msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1720
+#: ../src/guestfs-actions.pod:2578 ../src/guestfs-actions.pod:3897
+#: ../src/guestfs-actions.pod:3926 ../src/guestfs-actions.pod:3987
+#: ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:7726
+msgid "(Added in 1.0.2)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1063
+msgid "guestfs_checksum_device"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1065
+#, 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:1070
+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:1077 ../src/guestfs-actions.pod:5618
+#: ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5790
+#: ../src/guestfs-actions.pod:5808 ../src/guestfs-actions.pod:5990
+#: ../src/guestfs-actions.pod:7635 ../src/guestfs-actions.pod:7649
+#: ../src/guestfs-actions.pod:8049
+msgid "(Added in 1.3.2)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1079
+msgid "guestfs_checksums_out"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1081
+#, 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:1101
+msgid "(Added in 1.3.7)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1103
+msgid "guestfs_chmod"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1105
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_chmod (guestfs_h *g,\n"
+" int mode,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1123
+msgid "guestfs_chown"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1125
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_chown (guestfs_h *g,\n"
+" int owner,\n"
+" int group,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1141
+msgid "guestfs_command"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1143
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_command (guestfs_h *g,\n"
+" char *const *arguments);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1152
+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:1183 ../src/guestfs-actions.pod:1203
+#: ../src/guestfs-actions.pod:2019
+msgid "(Added in 0.9.1)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1185
+msgid "guestfs_command_lines"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1187
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_command_lines (guestfs_h *g,\n"
+" char *const *arguments);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1191
+msgid ""
+"This is the same as C<guestfs_command>, but splits the result into a list of "
+"lines."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1194
+msgid "See also: C<guestfs_sh_lines>"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1205
+msgid "guestfs_compress_device_out"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1207
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_compress_device_out (guestfs_h *g,\n"
+" const char *ctype,\n"
+" const char *device,\n"
+" const char *zdevice,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1219
+#, no-wrap
+msgid ""
+" GUESTFS_COMPRESS_DEVICE_OUT_LEVEL, int level,\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1224
+msgid ""
+"The C<ctype> and optional C<level> parameters have the same meaning as in "
+"C<guestfs_compress_out>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1288
+#: ../src/guestfs-actions.pod:2564 ../src/guestfs-actions.pod:6907
+msgid "(Added in 1.13.15)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1231
+msgid "guestfs_compress_device_out_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1233
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_compress_device_out_va (guestfs_h *g,\n"
+" const char *ctype,\n"
+" const char *device,\n"
+" const char *zdevice,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1240
+msgid "This is the \"va_list variant\" of L</guestfs_compress_device_out>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1244
+msgid "guestfs_compress_device_out_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1246
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_compress_device_out_argv (guestfs_h *g,\n"
+" const char *ctype,\n"
+" const char *device,\n"
+" const char *zdevice,\n"
+" const struct guestfs_compress_device_out_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1253
+msgid "This is the \"argv variant\" of L</guestfs_compress_device_out>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1257
+msgid "guestfs_compress_out"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1259
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_compress_out (guestfs_h *g,\n"
+" const char *ctype,\n"
+" const char *file,\n"
+" const char *zfile,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1271
+#, no-wrap
+msgid ""
+" GUESTFS_COMPRESS_OUT_LEVEL, int level,\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1290
+msgid "guestfs_compress_out_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1292
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_compress_out_va (guestfs_h *g,\n"
+" const char *ctype,\n"
+" const char *file,\n"
+" const char *zfile,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1299
+msgid "This is the \"va_list variant\" of L</guestfs_compress_out>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1303
+msgid "guestfs_compress_out_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1305
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_compress_out_argv (guestfs_h *g,\n"
+" const char *ctype,\n"
+" const char *file,\n"
+" const char *zfile,\n"
+" const struct guestfs_compress_out_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1312
+msgid "This is the \"argv variant\" of L</guestfs_compress_out>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1316
+msgid "guestfs_config"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1318
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_config (guestfs_h *g,\n"
+" const char *qemuparam,\n"
+" const char *qemuvalue);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1336
+msgid "guestfs_copy_device_to_device"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1338
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_device_to_device (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1349
+#, no-wrap
+msgid ""
+" GUESTFS_COPY_DEVICE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
+" GUESTFS_COPY_DEVICE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
+" GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, int64_t size,\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1353
+msgid ""
+"The four calls C<guestfs_copy_device_to_device>, "
+"C<guestfs_copy_device_to_file>, C<guestfs_copy_file_to_device>, and "
+"C<guestfs_copy_file_to_file> let you copy from a source (device|file) to a "
+"destination (device|file)."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1374 ../src/guestfs-actions.pod:1425
+#: ../src/guestfs-actions.pod:1476 ../src/guestfs-actions.pod:1532
+#: ../src/guestfs-actions.pod:1584 ../src/guestfs-actions.pod:1715
+#: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:1791
+#: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2190
+#: ../src/guestfs-actions.pod:4097 ../src/guestfs-actions.pod:7721
+#: ../src/guestfs-actions.pod:7755 ../src/guestfs-actions.pod:8262
+#: ../src/guestfs-actions.pod:8285
+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 event callback. See L<guestfs"
+"(3)/GUESTFS_EVENT_PROGRESS>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1379
+msgid "guestfs_copy_device_to_device_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1381
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_device_to_device_va (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1387
+msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_device>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1391
+msgid "guestfs_copy_device_to_device_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1393
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_device_to_device_argv (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" const struct guestfs_copy_device_to_device_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1399
+msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_device>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1403
+msgid "guestfs_copy_device_to_file"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1405
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_device_to_file (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1416
+#, no-wrap
+msgid ""
+" GUESTFS_COPY_DEVICE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
+" GUESTFS_COPY_DEVICE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
+" GUESTFS_COPY_DEVICE_TO_FILE_SIZE, int64_t size,\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1420 ../src/guestfs-actions.pod:1471
+#: ../src/guestfs-actions.pod:1522
+msgid ""
+"See C<guestfs_copy_device_to_device> for a general overview of this call."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1430
+msgid "guestfs_copy_device_to_file_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1432
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_device_to_file_va (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1438
+msgid "This is the \"va_list variant\" of L</guestfs_copy_device_to_file>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1442
+msgid "guestfs_copy_device_to_file_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1444
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_device_to_file_argv (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" const struct guestfs_copy_device_to_file_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1450
+msgid "This is the \"argv variant\" of L</guestfs_copy_device_to_file>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1454
+msgid "guestfs_copy_file_to_device"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1456
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_file_to_device (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1467
+#, no-wrap
+msgid ""
+" GUESTFS_COPY_FILE_TO_DEVICE_SRCOFFSET, int64_t srcoffset,\n"
+" GUESTFS_COPY_FILE_TO_DEVICE_DESTOFFSET, int64_t destoffset,\n"
+" GUESTFS_COPY_FILE_TO_DEVICE_SIZE, int64_t size,\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1481
+msgid "guestfs_copy_file_to_device_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1483
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_file_to_device_va (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1489
+msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_device>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1493
+msgid "guestfs_copy_file_to_device_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1495
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_file_to_device_argv (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" const struct guestfs_copy_file_to_device_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1501
+msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_device>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1505
+msgid "guestfs_copy_file_to_file"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1507
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_file_to_file (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" ...);\n"
+"\n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1518
+#, no-wrap
+msgid ""
+" GUESTFS_COPY_FILE_TO_FILE_SRCOFFSET, int64_t srcoffset,\n"
+" GUESTFS_COPY_FILE_TO_FILE_DESTOFFSET, int64_t destoffset,\n"
+" GUESTFS_COPY_FILE_TO_FILE_SIZE, int64_t size,\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1525
+msgid ""
+"This is B<not> the function you want for copying files. This is for copying "
+"blocks within existing files. See C<guestfs_cp>, C<guestfs_cp_a> and "
+"C<guestfs_mv> for general file copying and moving functions."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1537
+msgid "guestfs_copy_file_to_file_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1539
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_file_to_file_va (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" va_list args);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1545
+msgid "This is the \"va_list variant\" of L</guestfs_copy_file_to_file>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1549
+msgid "guestfs_copy_file_to_file_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1551
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_copy_file_to_file_argv (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest,\n"
+" const struct guestfs_copy_file_to_file_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1557
+msgid "This is the \"argv variant\" of L</guestfs_copy_file_to_file>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1561
+msgid "guestfs_copy_size"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1563
+#, no-wrap
+msgid ""
+" 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:1569 ../src/guestfs-actions.pod:1626
+msgid ""
+"I<This function is deprecated.> In new code, use the L</"
+"guestfs_copy_device_to_device> call instead."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:4821
+#: ../src/guestfs-actions.pod:6214 ../src/guestfs-actions.pod:7956
+#: ../src/guestfs-actions.pod:7976 ../src/guestfs-actions.pod:8062
+msgid "(Added in 1.0.87)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1591
+msgid "guestfs_cp"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1593
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_cp (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:1617
+#: ../src/guestfs-actions.pod:1697 ../src/guestfs-actions.pod:1771
+#: ../src/guestfs-actions.pod:1885 ../src/guestfs-actions.pod:5565
+#: ../src/guestfs-actions.pod:6058
+msgid "(Added in 1.0.18)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1605
+msgid "guestfs_cp_a"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1607
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_cp_a (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1619
+msgid "guestfs_dd"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1621
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_dd (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1638
+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_device_to_device>)."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1647
+msgid "guestfs_df"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1649
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_df (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1654 ../src/guestfs-actions.pod:1671
+msgid ""
+"This command is mostly useful for interactive sessions. It is I<not> "
+"intended that you try to parse the output string. Use C<guestfs_statvfs> "
+"from programs."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1678
+#: ../src/guestfs-actions.pod:1796 ../src/guestfs-actions.pod:2803
+#: ../src/guestfs-actions.pod:2827 ../src/guestfs-actions.pod:2895
+#: ../src/guestfs-actions.pod:4931 ../src/guestfs-actions.pod:5465
+#: ../src/guestfs-actions.pod:7459 ../src/guestfs-actions.pod:7483
+#: ../src/guestfs-actions.pod:8102 ../src/guestfs-actions.pod:8115
+#: ../src/guestfs-actions.pod:8128
+msgid "(Added in 1.0.54)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1663
+msgid "guestfs_df_h"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1665
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_df_h (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1680
+msgid "guestfs_dmesg"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1682
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_dmesg (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1689
+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:1699
+msgid "guestfs_download"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1701
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_download (guestfs_h *g,\n"
+" const char *remotefilename,\n"
+" const char *filename);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1711
+msgid "See also C<guestfs_upload>, C<guestfs_cat>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1722
+msgid "guestfs_download_offset"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1724
+#, no-wrap
+msgid ""
+" 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:1737
+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:1742
+msgid "See also C<guestfs_download>, C<guestfs_pread>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1751 ../src/guestfs-actions.pod:7760
+msgid "(Added in 1.5.17)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1753
+msgid "guestfs_drop_caches"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1755
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_drop_caches (guestfs_h *g,\n"
+" int whattodrop);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1773
+msgid "guestfs_du"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1775
+#, no-wrap
+msgid ""
+" int64_t\n"
+" guestfs_du (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1798
+msgid "guestfs_e2fsck_f"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1800
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_e2fsck_f (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1808
+msgid ""
+"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:1813
+msgid "(Added in 1.0.29)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1815
+msgid "guestfs_echo_daemon"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1817
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_echo_daemon (guestfs_h *g,\n"
+" char *const *words);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1826
+msgid "See also C<guestfs_ping_daemon>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1831 ../src/guestfs-actions.pod:2589
+#: ../src/guestfs-actions.pod:6931
+msgid "(Added in 1.0.69)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1833
+msgid "guestfs_egrep"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1835
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_egrep (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1869
+#: ../src/guestfs-actions.pod:1926 ../src/guestfs-actions.pod:1972
+#: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2719
+#: ../src/guestfs-actions.pod:2738 ../src/guestfs-actions.pod:2916
+#: ../src/guestfs-actions.pod:2929 ../src/guestfs-actions.pod:2944
+#: ../src/guestfs-actions.pod:2990 ../src/guestfs-actions.pod:3012
+#: ../src/guestfs-actions.pod:3025 ../src/guestfs-actions.pod:4311
+#: ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4338
+#: ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:5353
+#: ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6441
+#: ../src/guestfs-actions.pod:7327 ../src/guestfs-actions.pod:7339
+#: ../src/guestfs-actions.pod:7352 ../src/guestfs-actions.pod:7365
+#: ../src/guestfs-actions.pod:7387 ../src/guestfs-actions.pod:7400
+#: ../src/guestfs-actions.pod:7413 ../src/guestfs-actions.pod:7426
+#: ../src/guestfs-actions.pod:8220 ../src/guestfs-actions.pod:8239
+#: ../src/guestfs-actions.pod:8333 ../src/guestfs-actions.pod:8352
+#: ../src/guestfs-actions.pod:8398 ../src/guestfs-actions.pod:8417
+msgid "(Added in 1.0.66)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1852
+msgid "guestfs_egrepi"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1854
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_egrepi (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1871
+msgid "guestfs_equal"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1873
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_equal (guestfs_h *g,\n"
+" const char *file1,\n"
+" const char *file2);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1887
+msgid "guestfs_exists"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1889
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_exists (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1896
+msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1902
+msgid "guestfs_fallocate"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1904
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_fallocate (guestfs_h *g,\n"
+" const char *path,\n"
+" int len);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1909
+msgid ""
+"I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
+"call instead."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1928
+msgid "guestfs_fallocate64"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1930
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_fallocate64 (guestfs_h *g,\n"
+" const char *path,\n"
+" int64_t len);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:1939
+msgid ""
+"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:1942
+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:1953
+msgid "(Added in 1.3.17)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1955
+msgid "guestfs_fgrep"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1957
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_fgrep (guestfs_h *g,\n"
+" const char *pattern,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1974
+msgid "guestfs_fgrepi"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1976
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_fgrepi (guestfs_h *g,\n"
+" const char *pattern,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:1993
+msgid "guestfs_file"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:1995
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_file (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2013
+msgid ""
+"See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
+"C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2021
+msgid "guestfs_file_architecture"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2023
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_file_architecture (guestfs_h *g,\n"
+" const char *filename);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:2294
+#: ../src/guestfs-actions.pod:2311 ../src/guestfs-actions.pod:3045
+#: ../src/guestfs-actions.pod:3147 ../src/guestfs-actions.pod:3213
+#: ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3418
+#: ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3534
+#: ../src/guestfs-actions.pod:3631 ../src/guestfs-actions.pod:3868
+#: ../src/guestfs-actions.pod:4000
+msgid "(Added in 1.5.3)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2133
+msgid "guestfs_filesize"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2135
+#, no-wrap
+msgid ""
+" int64_t\n"
+" guestfs_filesize (guestfs_h *g,\n"
+" const char *file);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2141
+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: textblock
+#: ../src/guestfs-actions.pod:2147
+msgid "(Added in 1.0.82)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2149
+msgid "guestfs_fill"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2151
+#, no-wrap
+msgid ""
+" 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:2161
+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: textblock
+#: ../src/guestfs-actions.pod:2173
+msgid "(Added in 1.0.79)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2175
+msgid "guestfs_fill_pattern"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2177
+#, no-wrap
+msgid ""
+" 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:2183
+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."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2195
+msgid "(Added in 1.3.12)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2197
+msgid "guestfs_find"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2199
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_find (guestfs_h *g,\n"
+" const char *directory);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2215
+msgid ""
+"then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2228
+msgid "See also C<guestfs_find0>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2237 ../src/guestfs-actions.pod:4758
+#: ../src/guestfs-actions.pod:6476
+msgid "(Added in 1.0.27)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2239
+msgid "guestfs_find0"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2241
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_find0 (guestfs_h *g,\n"
+" const char *directory,\n"
+" const char *files);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2250
+msgid ""
+"This command works the same way as C<guestfs_find> with the following "
+"exceptions:"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2277
+msgid "(Added in 1.0.74)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2279
+msgid "guestfs_findfs_label"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2281
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_findfs_label (guestfs_h *g,\n"
+" const char *label);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2289
+msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2296
+msgid "guestfs_findfs_uuid"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2298
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_findfs_uuid (guestfs_h *g,\n"
+" const char *uuid);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2306
+msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2313
+msgid "guestfs_fsck"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2315
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_fsck (guestfs_h *g,\n"
+" const char *fstype,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2350 ../src/guestfs-actions.pod:8267
+msgid "(Added in 1.0.16)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2352
+msgid "guestfs_get_append"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2354
+#, no-wrap
+msgid ""
+" const char *\n"
+" guestfs_get_append (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2362
+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."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2366 ../src/guestfs-actions.pod:6154
+#: ../src/guestfs-actions.pod:6636 ../src/guestfs-actions.pod:7094
+#: ../src/guestfs-actions.pod:7113 ../src/guestfs-actions.pod:7129
+#: ../src/guestfs-actions.pod:7153 ../src/guestfs-actions.pod:7907
+#: ../src/guestfs-actions.pod:7922 ../src/guestfs-actions.pod:8314
+msgid "(Added in 1.0.26)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2368
+msgid "guestfs_get_attach_method"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2370
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_get_attach_method (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2373
+msgid "Return the current attach method. See C<guestfs_set_attach_method>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2378 ../src/guestfs-actions.pod:6666
+msgid "(Added in 1.9.8)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2380
+msgid "guestfs_get_autosync"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2382
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_autosync (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2391
+msgid "guestfs_get_direct"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2393
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_direct (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:6707
+msgid "(Added in 1.0.72)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2402
+msgid "guestfs_get_e2label"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2404
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_get_e2label (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2408
+msgid ""
+"I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
+"call instead."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2421 ../src/guestfs-actions.pod:2442
+#: ../src/guestfs-actions.pod:6725 ../src/guestfs-actions.pod:6744
+msgid "(Added in 1.0.15)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2423
+msgid "guestfs_get_e2uuid"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2425
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_get_e2uuid (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2429
+msgid ""
+"I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
+"call instead."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2444
+msgid "guestfs_get_memsize"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2446
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_memsize (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2452
+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."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2461 ../src/guestfs-actions.pod:5049
+#: ../src/guestfs-actions.pod:5258 ../src/guestfs-actions.pod:5277
+#: ../src/guestfs-actions.pod:5296 ../src/guestfs-actions.pod:5308
+#: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5338
+#: ../src/guestfs-actions.pod:6379 ../src/guestfs-actions.pod:6765
+#: ../src/guestfs-actions.pod:7061 ../src/guestfs-actions.pod:7676
+msgid "(Added in 1.0.55)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2463
+msgid "guestfs_get_network"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2465
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_network (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:6784
+msgid "(Added in 1.5.4)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2474
+msgid "guestfs_get_path"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2476
+#, no-wrap
+msgid ""
+" const char *\n"
+" guestfs_get_path (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2484 ../src/guestfs-actions.pod:2524
+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:2489
+msgid "guestfs_get_pgroup"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2491
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_pgroup (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2498 ../src/guestfs-actions.pod:6820
+#: ../src/guestfs-actions.pod:8168
+msgid "(Added in 1.11.18)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2500
+msgid "guestfs_get_pid"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2502
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_pid (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2512
+msgid "(Added in 1.0.56)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2514
+msgid "guestfs_get_qemu"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2516
+#, no-wrap
+msgid ""
+" const char *\n"
+" guestfs_get_qemu (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2527 ../src/guestfs-actions.pod:6848
+msgid "(Added in 1.0.6)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2529
+msgid "guestfs_get_recovery_proc"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2531
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_recovery_proc (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2538 ../src/guestfs-actions.pod:4122
+#: ../src/guestfs-actions.pod:4453 ../src/guestfs-actions.pod:4856
+#: ../src/guestfs-actions.pod:4888 ../src/guestfs-actions.pod:6084
+#: ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6872
+#: ../src/guestfs-actions.pod:7579 ../src/guestfs-actions.pod:7599
+#: ../src/guestfs-actions.pod:7791
+msgid "(Added in 1.0.77)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2540
+msgid "guestfs_get_selinux"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2542
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_selinux (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2545
+msgid ""
+"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:2553 ../src/guestfs-actions.pod:2627
+#: ../src/guestfs-actions.pod:6891 ../src/guestfs-actions.pod:6965
+msgid "(Added in 1.0.67)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2555
+msgid "guestfs_get_smp"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2557
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_smp (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2566
+msgid "guestfs_get_state"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2568
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_state (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2580
+msgid "guestfs_get_trace"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2582
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_trace (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2591
+msgid "guestfs_get_umask"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2593
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_umask (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2596
+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:2603
+msgid "guestfs_get_verbose"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2605
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_get_verbose (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2614
+msgid "guestfs_getcon"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2616
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_getcon (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2621
+msgid ""
+"See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2629
+msgid "guestfs_getxattr"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2631
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_getxattr (guestfs_h *g,\n"
+" const char *path,\n"
+" const char *name,\n"
+" size_t *size_r);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2637
+msgid ""
+"Get a single extended attribute from file C<path> named C<name>. This call "
+"follows symlinks. If you want to lookup an extended attribute for the "
+"symlink itself, use C<guestfs_lgetxattr>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2641 ../src/guestfs-actions.pod:4136
+msgid ""
+"Normally it is better to get all extended attributes from a file in one go "
+"by calling C<guestfs_getxattrs>. However some Linux filesystem "
+"implementations are buggy and do not provide a way to list out attributes. "
+"For these filesystems (notably ntfs-3g) you have to know the names of the "
+"extended attributes you want in advance and call this function."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2651
+msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2653 ../src/guestfs-actions.pod:2866
+#: ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:4148
+#: ../src/guestfs-actions.pod:6077 ../src/guestfs-actions.pod:6103
+#: ../src/guestfs-actions.pod:6284
+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>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2657 ../src/guestfs-actions.pod:4152
+msgid "(Added in 1.7.24)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2659
+msgid "guestfs_getxattrs"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2661
+#, no-wrap
+msgid ""
+" struct guestfs_xattr_list *\n"
+" guestfs_getxattrs (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2671
+msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2673 ../src/guestfs-actions.pod:4164
+#: ../src/guestfs-actions.pod:4852
+msgid ""
+"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:2677 ../src/guestfs-actions.pod:4168
+#: ../src/guestfs-actions.pod:4367 ../src/guestfs-actions.pod:4403
+#: ../src/guestfs-actions.pod:6457 ../src/guestfs-actions.pod:6984
+#: ../src/guestfs-actions.pod:8379
+msgid "(Added in 1.0.59)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2679
+msgid "guestfs_glob_expand"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2681
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_glob_expand (guestfs_h *g,\n"
+" const char *pattern);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2700 ../src/guestfs-actions.pod:7177
+#: ../src/guestfs-actions.pod:7194
+msgid "(Added in 1.0.50)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2702
+msgid "guestfs_grep"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2704
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_grep (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2721
+msgid "guestfs_grepi"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2723
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_grepi (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2740
+msgid "guestfs_grub_install"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2742
+#, no-wrap
+msgid ""
+" 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:2785
+msgid "(Added in 1.0.17)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2787
+msgid "guestfs_head"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2789
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_head (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2805
+msgid "guestfs_head_n"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2807
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_head_n (guestfs_h *g,\n"
+" int nrlines,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2829
+msgid "guestfs_hexdump"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2831
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_hexdump (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2844 ../src/guestfs-actions.pod:7258
+#: ../src/guestfs-actions.pod:7313
+msgid "(Added in 1.0.22)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2846
+msgid "guestfs_initrd_cat"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2848
+#, no-wrap
+msgid ""
+" 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:2864
+msgid "See also C<guestfs_initrd_list>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2875
+msgid "guestfs_initrd_list"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2877
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_initrd_list (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2897
+msgid "guestfs_inotify_add_watch"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2899
+#, no-wrap
+msgid ""
+" int64_t\n"
+" guestfs_inotify_add_watch (guestfs_h *g,\n"
+" const char *path,\n"
+" int mask);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2918
+msgid "guestfs_inotify_close"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2920
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_inotify_close (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2931
+msgid "guestfs_inotify_files"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2933
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_inotify_files (guestfs_h *g);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2936
+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."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2946
+msgid "guestfs_inotify_init"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2948
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_inotify_init (guestfs_h *g,\n"
+" int maxevents);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2956
+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: textblock
+#: ../src/guestfs-actions.pod:2966
+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>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2972
+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."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:2979
+msgid ""
+"The handle should be closed after use by calling C<guestfs_inotify_close>. "
+"This also removes any watches automatically."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:2992
+msgid "guestfs_inotify_read"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:2994
#, 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"
+" struct guestfs_inotify_event_list *\n"
+" guestfs_inotify_read (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:106
+#. type: textblock
+#: ../src/guestfs-actions.pod:3008
+msgid ""
+"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:3014
+msgid "guestfs_inotify_rm_watch"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3016
#, 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_inotify_rm_watch (guestfs_h *g,\n"
+" int wd);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:111
+#. type: textblock
+#: ../src/guestfs-actions.pod:3020
+msgid ""
+"Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3027
+msgid "guestfs_inspect_get_arch"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3029
#, 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"
+" char *\n"
+" guestfs_inspect_get_arch (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:127
+#. type: textblock
+#: ../src/guestfs-actions.pod:3033
+msgid ""
+"This returns the architecture of the inspected operating system. The "
+"possible return values are listed under C<guestfs_file_architecture>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3047
+msgid "guestfs_inspect_get_distro"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3049
#, 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"
+" char *\n"
+" guestfs_inspect_get_distro (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:132
+#. type: =head2
+#: ../src/guestfs-actions.pod:3149
+msgid "guestfs_inspect_get_drive_mappings"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3151
#, no-wrap
msgid ""
-" void guestfs_free_stat (struct guestfs_free_stat *);\n"
-" void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
+" char **\n"
+" guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:137
+#. type: textblock
+#: ../src/guestfs-actions.pod:3180
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3452
+#: ../src/guestfs-actions.pod:4255 ../src/guestfs-actions.pod:5527
+#: ../src/guestfs-actions.pod:7615
+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: textblock
+#: ../src/guestfs-actions.pod:3190 ../src/guestfs-actions.pod:3651
+msgid "(Added in 1.9.17)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3192
+msgid "guestfs_inspect_get_filesystems"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3194
#, 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"
-" int64_t ffree;\n"
-" int64_t favail;\n"
-" int64_t fsid;\n"
-" int64_t flag;\n"
-" int64_t namemax;\n"
-" };\n"
-" \n"
+" char **\n"
+" guestfs_inspect_get_filesystems (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:151
+#. type: textblock
+#: ../src/guestfs-actions.pod:3206
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"C<guestfs_inspect_get_mountpoints>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3215
+msgid "guestfs_inspect_get_format"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3217
#, 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"
+" char *\n"
+" guestfs_inspect_get_format (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:156
+#. type: textblock
+#: ../src/guestfs-actions.pod:3251 ../src/guestfs-actions.pod:3687
+#: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:3721
+#: ../src/guestfs-actions.pod:6495
+msgid "(Added in 1.9.4)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3253
+msgid "guestfs_inspect_get_hostname"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3255
#, no-wrap
msgid ""
-" void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
-" void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
+" char *\n"
+" guestfs_inspect_get_hostname (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:159
-msgid "guestfs_dirent"
+#. type: textblock
+#: ../src/guestfs-actions.pod:3270
+msgid "(Added in 1.7.9)"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:161
+#. type: =head2
+#: ../src/guestfs-actions.pod:3272
+msgid "guestfs_inspect_get_icon"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3274
#, no-wrap
msgid ""
-" struct guestfs_dirent {\n"
-" int64_t ino;\n"
-" char ftyp;\n"
-" char *name;\n"
-" };\n"
-" \n"
+" char *\n"
+" guestfs_inspect_get_icon (guestfs_h *g,\n"
+" const char *root,\n"
+" size_t *size_r,\n"
+" ...);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:167
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3285
#, 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"
+" GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
+" GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:172
+#. type: textblock
+#: ../src/guestfs-actions.pod:3352 ../src/guestfs-actions.pod:4182
+#: ../src/guestfs-actions.pod:5426
+msgid "(Added in 1.11.12)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3354
+msgid "guestfs_inspect_get_icon_va"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3356
#, no-wrap
msgid ""
-" void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
-" void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
+" char *\n"
+" guestfs_inspect_get_icon_va (guestfs_h *g,\n"
+" const char *root,\n"
+" size_t *size_r,\n"
+" va_list args);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:177
+#. type: textblock
+#: ../src/guestfs-actions.pod:3362
+msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3366
+msgid "guestfs_inspect_get_icon_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3368
#, no-wrap
msgid ""
-" struct guestfs_version {\n"
-" int64_t major;\n"
-" int64_t minor;\n"
-" int64_t release;\n"
-" char *extra;\n"
-" };\n"
-" \n"
+" char *\n"
+" guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
+" const char *root,\n"
+" size_t *size_r,\n"
+" const struct guestfs_inspect_get_icon_argv *optargs);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:184
+#. type: textblock
+#: ../src/guestfs-actions.pod:3374
+msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3378
+msgid "guestfs_inspect_get_major_version"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3380
#, 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"
+" int\n"
+" guestfs_inspect_get_major_version (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:189
+#. type: =head2
+#: ../src/guestfs-actions.pod:3402
+msgid "guestfs_inspect_get_minor_version"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3404
#, no-wrap
msgid ""
-" void guestfs_free_version (struct guestfs_free_version *);\n"
-" void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
+" int\n"
+" guestfs_inspect_get_minor_version (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:192
-msgid "guestfs_xattr"
+#. type: textblock
+#: ../src/guestfs-actions.pod:3413
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"C<guestfs_inspect_get_major_version>."
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:194
+#. type: =head2
+#: ../src/guestfs-actions.pod:3420
+msgid "guestfs_inspect_get_mountpoints"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3422
#, 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"
+" char **\n"
+" guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:201
+#. type: textblock
+#: ../src/guestfs-actions.pod:3443
+msgid ""
+"For operating systems like Windows which still use drive letters, this call "
+"will only return an entry for the first drive \"mounted on\" C</>. For "
+"information about the mapping of drive letters to partitions, see "
+"C<guestfs_inspect_get_drive_mappings>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:3449
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"C<guestfs_inspect_get_filesystems>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3460
+msgid "guestfs_inspect_get_package_format"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3462
#, 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"
+" char *\n"
+" guestfs_inspect_get_package_format (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:3466
+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:3485 ../src/guestfs-actions.pod:3513
+msgid "(Added in 1.7.5)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3487
+msgid "guestfs_inspect_get_package_management"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3489
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_inspect_get_package_management (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:3493
+msgid ""
+"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: =head2
+#: ../src/guestfs-actions.pod:3515
+msgid "guestfs_inspect_get_product_name"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3517
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_inspect_get_product_name (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3536
+msgid "guestfs_inspect_get_product_variant"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3538
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_inspect_get_product_variant (guestfs_h *g,\n"
+" const char *root);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:3561
+msgid ""
+"Please read L<guestfs(3)/INSPECTION> for more details. See also "
+"C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:3568
+msgid "(Added in 1.9.13)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3570
+msgid "guestfs_inspect_get_roots"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:206
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3572
#, no-wrap
msgid ""
-" void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
-" void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
+" char **\n"
+" guestfs_inspect_get_roots (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:209
-msgid "guestfs_inotify_event"
+#. type: textblock
+#: ../src/guestfs-actions.pod:3575
+msgid ""
+"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: verbatim
-#: ../src/guestfs-structs.pod:211
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:3579
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"
+"This returns an empty list if either no root devices were found or the "
+"caller has not called C<guestfs_inspect_os>."
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"
+#. type: textblock
+#: ../src/guestfs-actions.pod:3588
+msgid "(Added in 1.7.3)"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:223
+#. type: =head2
+#: ../src/guestfs-actions.pod:3590
+msgid "guestfs_inspect_get_type"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3592
#, 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"
+" char *\n"
+" guestfs_inspect_get_type (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../src/guestfs-structs.pod:226
-msgid "guestfs_partition"
+#. type: =head2
+#: ../src/guestfs-actions.pod:3633
+msgid "guestfs_inspect_get_windows_current_control_set"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:228
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3635
#, 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"
+" char *\n"
+" guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
+" const char *root);\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"
+#. type: =head2
+#: ../src/guestfs-actions.pod:3653
+msgid "guestfs_inspect_get_windows_systemroot"
msgstr ""
-# type: verbatim
-#: ../src/guestfs-structs.pod:240
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3655
#, no-wrap
msgid ""
-" void guestfs_free_partition (struct guestfs_free_partition *);\n"
-" void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
+" char *\n"
+" guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:5
-msgid "guestfish - the libguestfs Filesystem Interactive SHell"
+#. type: textblock
+#: ../src/guestfs-actions.pod:3671
+msgid "(Added in 1.5.25)"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:9
+#. type: =head2
+#: ../src/guestfs-actions.pod:3673
+msgid "guestfs_inspect_is_live"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3675
#, no-wrap
msgid ""
-" guestfish [--options] [commands]\n"
+" int\n"
+" guestfs_inspect_is_live (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:11
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:3679
msgid ""
-" guestfish\n"
-"\n"
+"If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
+"disk), then this returns true if a live image was detected on the disk."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:13
+#. type: =head2
+#: ../src/guestfs-actions.pod:3689
+msgid "guestfs_inspect_is_multipart"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3691
#, no-wrap
msgid ""
-" guestfish -a disk.img\n"
+" int\n"
+" guestfs_inspect_is_multipart (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:15
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:3695
msgid ""
-" guestfish -a disk.img -m dev[:mountpoint]\n"
-"\n"
+"If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
+"disk), then this returns true if the disk is part of a set."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:17
+#. type: =head2
+#: ../src/guestfs-actions.pod:3705
+msgid "guestfs_inspect_is_netinst"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3707
#, no-wrap
msgid ""
-" guestfish -d libvirt-domain\n"
+" int\n"
+" guestfs_inspect_is_netinst (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:19
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:3711
msgid ""
-" guestfish -a disk.img -i\n"
-"\n"
+"If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
+"disk), then this returns true if the disk is a network installer, ie. not a "
+"self-contained install CD but one which is likely to require network access "
+"to complete the install."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:21
+#. type: =head2
+#: ../src/guestfs-actions.pod:3723
+msgid "guestfs_inspect_list_applications"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3725
#, no-wrap
msgid ""
-" guestfish -d libvirt-domain -i\n"
+" struct guestfs_application_list *\n"
+" guestfs_inspect_list_applications (guestfs_h *g,\n"
+" const char *root);\n"
"\n"
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: textblock
+#: ../src/guestfs-actions.pod:3731
+msgid ""
+"I<Note:> This call works differently from other parts of the inspection "
+"API. You have to call C<guestfs_inspect_os>, then "
+"C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
+"this. Listing applications is a significantly more difficult operation "
+"which requires access to the full filesystem. Also note that unlike the "
+"other C<guestfs_inspect_get_*> calls which are just returning data cached in "
+"the libguestfs handle, this call actually reads parts of the mounted "
+"filesystems during the call."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:25
+#. type: textblock
+#: ../src/guestfs-actions.pod:3821
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."
+"This function returns a C<struct guestfs_application_list *>, or NULL if "
+"there was an error. I<The caller must call C<guestfs_free_application_list> "
+"after use>."
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
+#: ../src/guestfs-actions.pod:3825
+msgid "(Added in 1.7.8)"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:32
-msgid "As an interactive shell"
+#. type: =head2
+#: ../src/guestfs-actions.pod:3827
+msgid "guestfs_inspect_os"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:34
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3829
#, no-wrap
msgid ""
-" $ guestfish\n"
-" \n"
+" char **\n"
+" guestfs_inspect_os (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:36
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:3845
msgid ""
-" Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
-" editing virtual machine filesystems.\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: verbatim
-#: ../fish/guestfish.pod:39
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:3850
msgid ""
-" Type: 'help' for a list of commands\n"
-" 'man' to read the manual\n"
-" 'quit' to quit the shell\n"
-" \n"
+"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: verbatim
-#: ../fish/guestfish.pod:43
+#. type: textblock
+#: ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:4193
+#: ../src/guestfs-actions.pod:4275
+msgid "See also C<guestfs_list_filesystems>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3870
+msgid "guestfs_is_blockdev"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3872
#, no-wrap
msgid ""
-" ><fs> man\n"
+" int\n"
+" guestfs_is_blockdev (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:45
-msgid "From shell scripts"
+#. type: textblock
+#: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3908
+#: ../src/guestfs-actions.pod:3938 ../src/guestfs-actions.pod:3953
+#: ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:4025
+#: ../src/guestfs-actions.pod:4040
+msgid "See also C<guestfs_stat>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:47
-msgid "Create a new C</etc/motd> file in a guest:"
+#. type: textblock
+#: ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3912
+#: ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:4029
+#: ../src/guestfs-actions.pod:4044
+msgid "(Added in 1.5.10)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:3885
+msgid "guestfs_is_busy"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:49
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3887
#, 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"
+" int\n"
+" guestfs_is_busy (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:56
-msgid "List the LVM logical volumes in a guest:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:3899
+msgid "guestfs_is_chardev"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:58
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3901
#, no-wrap
msgid ""
-" guestfish -a disk.img --ro <<_EOF_\n"
-" run\n"
-" lvs\n"
-" _EOF_\n"
+" int\n"
+" guestfs_is_chardev (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:63
-msgid "On one command line"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:65
-msgid "Update C</etc/resolv.conf> in a guest:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:3914
+msgid "guestfs_is_config"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:67
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3916
#, 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"
+" int\n"
+" guestfs_is_config (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:71
-msgid "Edit C</boot/grub/grub.conf> interactively:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:3928
+msgid "guestfs_is_dir"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:73
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3930
#, 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"
+" int\n"
+" guestfs_is_dir (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:78
-msgid "Mount disks automatically"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:80
-msgid ""
-"Use the I<-i> option to automatically mount the disks from a virtual machine:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:3944
+msgid "guestfs_is_fifo"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:83
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3946
#, no-wrap
msgid ""
-" guestfish --ro -a disk.img -i cat /etc/group\n"
+" int\n"
+" guestfs_is_fifo (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:85
+#. type: =head2
+#: ../src/guestfs-actions.pod:3959
+msgid "guestfs_is_file"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3961
#, no-wrap
msgid ""
-" guestfish --ro -d libvirt-domain -i cat /etc/group\n"
+" int\n"
+" guestfs_is_file (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:87
-msgid "As a script interpreter"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:89
-msgid "Create a 100MB disk containing an ext2-formatted partition:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:3975
+msgid "guestfs_is_launching"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:91
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3977
#, 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"
+" int\n"
+" guestfs_is_launching (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:97
-msgid "Start with a prepared disk"
-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:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:3989
+msgid "guestfs_is_lv"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:102
+#. type: verbatim
+#: ../src/guestfs-actions.pod:3991
#, no-wrap
msgid ""
-" guestfish -N fs\n"
+" int\n"
+" guestfs_is_lv (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:104
-msgid "To list what is available do:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4002
+msgid "guestfs_is_ready"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:106 ../fish/guestfish.pod:720
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4004
#, no-wrap
msgid ""
-" guestfish -N help | less\n"
+" int\n"
+" guestfs_is_ready (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:108
-msgid "Remote control"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4016
+msgid "guestfs_is_socket"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:110
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4018
#, no-wrap
msgid ""
-" eval `guestfish --listen --ro`\n"
-" guestfish --remote add disk.img\n"
-" guestfish --remote run\n"
-" guestfish --remote lvs\n"
+" int\n"
+" guestfs_is_socket (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:117
-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)>."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4031
+msgid "guestfs_is_symlink"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:121
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4033
+#, no-wrap
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."
+" int\n"
+" guestfs_is_symlink (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
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"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4046
+msgid "guestfs_is_zero"
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>"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4048
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_is_zero (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:132
-msgid "Displays general help on options."
+#. type: textblock
+#: ../src/guestfs-actions.pod:4057 ../src/guestfs-actions.pod:4071
+msgid "(Added in 1.11.8)"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:134
-msgid "B<-h> | B<--cmd-help>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4059
+msgid "guestfs_is_zero_device"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:136
-msgid "Lists all available guestfish commands."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4061
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_is_zero_device (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:138
-msgid "B<-h cmd> | B<--cmd-help cmd>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4073
+msgid "guestfs_kill_subprocess"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:140
-msgid "Displays detailed help on a single command C<cmd>."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4075
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_kill_subprocess (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:142 ../fuse/guestmount.pod:74
-msgid "B<-a image> | B<--add image>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4084
+msgid "guestfs_launch"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:144
-msgid "Add a block device or virtual machine image to the shell."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4086
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_launch (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:146
-msgid "B<-c URI> | B<--connect URI>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4104
+msgid "guestfs_lchown"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:148
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4106
+#, no-wrap
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:152
-msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
+" int\n"
+" guestfs_lchown (guestfs_h *g,\n"
+" int owner,\n"
+" int group,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:154
+#. type: textblock
+#: ../src/guestfs-actions.pod:4112
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."
+"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: =item
-#: ../fish/guestfish.pod:158
-msgid "B<-D> | B<--no-dest-paths>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4124
+msgid "guestfs_lgetxattr"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:160
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4126
+#, no-wrap
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."
+" char *\n"
+" guestfs_lgetxattr (guestfs_h *g,\n"
+" const char *path,\n"
+" const char *name,\n"
+" size_t *size_r);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:165
-msgid "B<-f file> | B<--file file>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4146
+msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:167
-msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4154
+msgid "guestfs_lgetxattrs"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:170
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4156
#, no-wrap
msgid ""
-" #!/usr/bin/guestfish -f\n"
+" struct guestfs_xattr_list *\n"
+" guestfs_lgetxattrs (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:172
-msgid "B<-i> | B<--inspector>"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:174
+#. type: textblock
+#: ../src/guestfs-actions.pod:4160
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."
+"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: textblock
-#: ../fish/guestfish.pod:178
-msgid "Typical usage is either:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4170
+msgid "guestfs_list_9p"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:180
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4172
#, no-wrap
msgid ""
-" guestfish -d myguest -i\n"
+" char **\n"
+" guestfs_list_9p (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:182
-msgid "(for an inactive libvirt domain called I<myguest>), or:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4184
+msgid "guestfs_list_devices"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:184
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4186
#, no-wrap
msgid ""
-" guestfish --ro -d myguest -i\n"
+" char **\n"
+" guestfs_list_devices (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:186
-msgid "(for active domains, readonly), or specify the block device directly:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4201
+msgid "guestfs_list_dm_devices"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:188
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4203
#, no-wrap
msgid ""
-" guestfish -a /dev/Guests/MyGuest -i\n"
+" char **\n"
+" guestfs_list_dm_devices (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:190
+#. type: textblock
+#: ../src/guestfs-actions.pod:4208
msgid ""
-"Note that the command line syntax changed slightly over older versions of "
-"guestfish. You can still use the old syntax:"
+"The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
+"previous call to C<guestfs_luks_open>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:193
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:4211
msgid ""
-" guestfish [--ro] -i disk.img\n"
-"\n"
+"Device mapper devices which correspond to logical volumes are I<not> "
+"returned in this list. Call C<guestfs_lvs> if you want to list logical "
+"volumes."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:195
-#, no-wrap
-msgid ""
-" guestfish [--ro] -i libvirt-domain\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4219 ../src/guestfs-actions.pod:5665
+msgid "(Added in 1.11.15)"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:197
-msgid "B<--keys-from-stdin>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4221
+msgid "guestfs_list_filesystems"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:199
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4223
+#, no-wrap
msgid ""
-"Read key or passphrase parameters from stdin. The default is to try to read "
-"passphrases from the user by opening C</dev/tty>."
+" char **\n"
+" guestfs_list_filesystems (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:202
-msgid "B<--listen>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4243
+msgid ""
+"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
-#: ../fish/guestfish.pod:204
+#. type: textblock
+#: ../src/guestfs-actions.pod:4247
msgid ""
-"Fork into the background and listen for remote commands. See section L</"
-"REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
+"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: =item
-#: ../fish/guestfish.pod:207
-msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:6028
+msgid "(Added in 1.5.15)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:209
-msgid "Mount the named partition or logical volume on the given mountpoint."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4263
+msgid "guestfs_list_partitions"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:211
-msgid "If the mountpoint is omitted, it defaults to C</>."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4265
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_list_partitions (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:213
-msgid "You have to mount something on C</> before most commands will work."
+#. type: textblock
+#: ../src/guestfs-actions.pod:4272
+msgid ""
+"This does not return logical volumes. For that you will need to call "
+"C<guestfs_lvs>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:215
-msgid ""
-"If any I<-m> or I<--mount> options are given, the guest is automatically "
-"launched."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4283
+msgid "guestfs_ll"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:218
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4285
+#, no-wrap
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."
+" char *\n"
+" guestfs_ll (guestfs_h *g,\n"
+" const char *directory);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:223 ../fuse/guestmount.pod:106
-msgid "B<-n> | B<--no-sync>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4300
+msgid "guestfs_ln"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:225
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4302
+#, no-wrap
msgid ""
-"Disable autosync. This is enabled by default. See the discussion of "
-"autosync in the L<guestfs(3)> manpage."
+" int\n"
+" guestfs_ln (guestfs_h *g,\n"
+" const char *target,\n"
+" const char *linkname);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:228
-msgid "B<-N type> | B<--new type> | B<-N help>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4313
+msgid "guestfs_ln_f"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:230
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4315
+#, no-wrap
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."
+" int\n"
+" guestfs_ln_f (guestfs_h *g,\n"
+" const char *target,\n"
+" const char *linkname);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:235
-msgid "B<--progress-bars>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4327
+msgid "guestfs_ln_s"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:237
-msgid "Enable progress bars, even when guestfish is used non-interactively."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4329
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_ln_s (guestfs_h *g,\n"
+" const char *target,\n"
+" const char *linkname);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:239
-msgid ""
-"Progress bars are enabled by default when guestfish is used as an "
-"interactive shell."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4340
+msgid "guestfs_ln_sf"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:242
-msgid "B<--no-progress-bars>"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4342
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_ln_sf (guestfs_h *g,\n"
+" const char *target,\n"
+" const char *linkname);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:244
-msgid "Disable progress bars."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4354
+msgid "guestfs_lremovexattr"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:246
-msgid "B<--remote[=pid]>"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4356
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lremovexattr (guestfs_h *g,\n"
+" const char *xattr,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:248
+#. type: textblock
+#: ../src/guestfs-actions.pod:4361
msgid ""
-"Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
-"CONTROL GUESTFISH OVER A SOCKET> below."
+"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: =item
-#: ../fish/guestfish.pod:251 ../fuse/guestmount.pod:148
-msgid "B<-r> | B<--ro>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4369
+msgid "guestfs_ls"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:253
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4371
+#, no-wrap
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>)."
+" char **\n"
+" guestfs_ls (guestfs_h *g,\n"
+" const char *directory);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:256 ../tools/virt-rescue.pl:162
+#. type: textblock
+#: ../src/guestfs-actions.pod:4379
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."
+"This command is mostly useful for interactive sessions. Programs should "
+"probably use C<guestfs_readdir> instead."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:4388
+msgid "guestfs_lsetxattr"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:260
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4390
+#, no-wrap
msgid ""
-"Note that prepared disk images created with I<-N> are not affected by the "
-"I<--ro> option."
+" 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: =item
-#: ../fish/guestfish.pod:263 ../fuse/guestmount.pod:158
-#: ../tools/virt-rescue.pl:170
-msgid "B<--selinux>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4397
+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."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:265
-msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4405
+msgid "guestfs_lstat"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:267 ../fuse/guestmount.pod:168
-msgid "B<-v> | B<--verbose>"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4407
+#, no-wrap
+msgid ""
+" struct guestfs_stat *\n"
+" guestfs_lstat (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:269
+#. type: textblock
+#: ../src/guestfs-actions.pod:4413
msgid ""
-"Enable very verbose messages. This is particularly useful if you find a bug."
+"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: =item
-#: ../fish/guestfish.pod:272 ../fuse/guestmount.pod:172
-msgid "B<-V> | B<--version>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4419 ../src/guestfs-actions.pod:7218
+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>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:274
-msgid "Display the guestfish / libguestfs version number and exit."
+#. type: textblock
+#: ../src/guestfs-actions.pod:4423 ../src/guestfs-actions.pod:7222
+#: ../src/guestfs-actions.pod:7240 ../src/guestfs-actions.pod:7621
+msgid "(Added in 0.9.2)"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:276
-msgid "B<-x>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4425
+msgid "guestfs_lstatlist"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:278
-msgid "Echo each command before executing it."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4427
+#, no-wrap
+msgid ""
+" struct guestfs_stat_list *\n"
+" guestfs_lstatlist (guestfs_h *g,\n"
+" const char *path,\n"
+" char *const *names);\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:282
-msgid "COMMANDS ON COMMAND LINE"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4432
+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
-#: ../fish/guestfish.pod:284
+#. type: textblock
+#: ../src/guestfs-actions.pod:4441
msgid ""
-"Any additional (non-option) arguments are treated as commands to execute."
+"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
-#: ../fish/guestfish.pod:287
+#. type: textblock
+#: ../src/guestfs-actions.pod:4449
msgid ""
-"Commands to execute should be separated by a colon (C<:>), where the colon "
-"is a separate parameter. Thus:"
+"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: verbatim
-#: ../fish/guestfish.pod:290
+#. type: =head2
+#: ../src/guestfs-actions.pod:4455
+msgid "guestfs_luks_add_key"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4457
#, no-wrap
msgid ""
-" guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\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
-#: ../fish/guestfish.pod:292
+#. type: textblock
+#: ../src/guestfs-actions.pod:4469
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."
+"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
-#: ../fish/guestfish.pod:296
+#. type: textblock
+#: ../src/guestfs-actions.pod:4475 ../src/guestfs-actions.pod:4515
+#: ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4558
+#: ../src/guestfs-actions.pod:4593 ../src/guestfs-actions.pod:4612
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."
+"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: =head1
-#: ../fish/guestfish.pod:301
-msgid "USING launch (OR run)"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4479 ../src/guestfs-actions.pod:4519
+#: ../src/guestfs-actions.pod:4542 ../src/guestfs-actions.pod:4562
+msgid "(Added in 1.5.2)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:303
-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:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4481
+msgid "guestfs_luks_close"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:311
-msgid "add or -a/--add"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4483
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_luks_close (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:315
-msgid "launch (aka run)"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4487
+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."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:319
-msgid "mount or -m/--mount"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4495 ../src/guestfs-actions.pod:4597
+#: ../src/guestfs-actions.pod:4616 ../src/guestfs-actions.pod:4666
+#: ../src/guestfs-actions.pod:4714
+msgid "(Added in 1.5.1)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:323
-msgid "any other commands"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4497
+msgid "guestfs_luks_format"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:327
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4499
+#, 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."
+" int\n"
+" guestfs_luks_format (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *key,\n"
+" int keyslot);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:330
-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)."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4521
+msgid "guestfs_luks_format_cipher"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:334
-msgid "QUOTING"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4523
+#, no-wrap
+msgid ""
+" 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
-#: ../fish/guestfish.pod:336
+#. type: textblock
+#: ../src/guestfs-actions.pod:4530
msgid ""
-"You can quote ordinary parameters using either single or double quotes. For "
-"example:"
+"This command is the same as C<guestfs_luks_format> but it also allows you to "
+"set the C<cipher> used."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:339
-#, no-wrap
-msgid ""
-" add \"file with a space.img\"\n"
-"\n"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4544
+msgid "guestfs_luks_kill_slot"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:341
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4546
#, no-wrap
msgid ""
-" rm '/file name'\n"
+" int\n"
+" guestfs_luks_kill_slot (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *key,\n"
+" int keyslot);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:343
+#. type: =head2
+#: ../src/guestfs-actions.pod:4564
+msgid "guestfs_luks_open"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4566
#, no-wrap
msgid ""
-" rm '/\"'\n"
+" 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
-#: ../fish/guestfish.pod:345
+#. type: textblock
+#: ../src/guestfs-actions.pod:4584
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."
+"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:4588
+msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:4599
+msgid "guestfs_luks_open_ro"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:350
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4601
#, no-wrap
msgid ""
-" vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
-" command \"/bin/echo 'foo bar'\"\n"
-" command \"/bin/echo \\'foo\\'\"\n"
+" 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: =head1
-#: ../fish/guestfish.pod:354
-msgid "NUMBERS"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:356
+#. type: textblock
+#: ../src/guestfs-actions.pod:4607
msgid ""
-"This section applies to all commands which can take integers as parameters."
+"This is the same as C<guestfs_luks_open> except that a read-only mapping is "
+"created."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:359
-msgid "SIZE SUFFIX"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4618
+msgid "guestfs_lvcreate"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:361
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4620
+#, no-wrap
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:"
+" int\n"
+" guestfs_lvcreate (guestfs_h *g,\n"
+" const char *logvol,\n"
+" const char *volgroup,\n"
+" int mbytes);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:367
-msgid "B<k> or B<K> or B<KiB>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4633
+msgid "guestfs_lvm_canonical_lv_name"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:369
-msgid "The size in kilobytes (multiplied by 1024)."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4635
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
+" const char *lvname);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:371
-msgid "B<KB>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4646
+msgid "See also C<guestfs_is_lv>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:373
-msgid "The size in SI 1000 byte units."
+#. type: textblock
+#: ../src/guestfs-actions.pod:4651
+msgid "(Added in 1.5.24)"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:375
-msgid "B<M> or B<MiB>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4653
+msgid "guestfs_lvm_clear_filter"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4655
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvm_clear_filter (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:377
-msgid "The size in megabytes (multiplied by 1048576)."
+#. type: textblock
+#: ../src/guestfs-actions.pod:4658
+msgid ""
+"This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
+"see every block device."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:379
-msgid "B<MB>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4668
+msgid "guestfs_lvm_remove_all"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:381
-msgid "The size in SI 1000000 byte units."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4670
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvm_remove_all (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:383
-msgid "B<G> or B<GiB>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4683
+msgid "guestfs_lvm_set_filter"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:385
-msgid "The size in gigabytes (multiplied by 2**30)."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4685
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvm_set_filter (guestfs_h *g,\n"
+" char *const *devices);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:387
-msgid "B<GB>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4716
+msgid "guestfs_lvremove"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:389
-msgid "The size in SI 10**9 byte units."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4718
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvremove (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:391
-msgid "B<T> or B<TiB>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4730 ../src/guestfs-actions.pod:6141
+#: ../src/guestfs-actions.pod:7991
+msgid "(Added in 1.0.13)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:393
-msgid "The size in terabytes (multiplied by 2**40)."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4732
+msgid "guestfs_lvrename"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:395
-msgid "B<TB>"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4734
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvrename (guestfs_h *g,\n"
+" const char *logvol,\n"
+" const char *newlogvol);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:397
-msgid "The size in SI 10**12 byte units."
+#. type: textblock
+#: ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:8004
+msgid "(Added in 1.0.83)"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:399
-msgid "B<P> or B<PiB>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4745
+msgid "guestfs_lvresize"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:401
-msgid "The size in petabytes (multiplied by 2**50)."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4747
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvresize (guestfs_h *g,\n"
+" const char *device,\n"
+" int mbytes);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:403
-msgid "B<PB>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4760
+msgid "guestfs_lvresize_free"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:405
-msgid "The size in SI 10**15 byte units."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4762
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_lvresize_free (guestfs_h *g,\n"
+" const char *lv,\n"
+" int percent);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:407
-msgid "B<E> or B<EiB>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4775
+msgid "(Added in 1.3.3)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:409
-msgid "The size in exabytes (multiplied by 2**60)."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4777
+msgid "guestfs_lvs"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:411
-msgid "B<EB>"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4779
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_lvs (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:413
-msgid "The size in SI 10**18 byte units."
+#. type: textblock
+#: ../src/guestfs-actions.pod:4788
+msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:415
-msgid "B<Z> or B<ZiB>"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4796
+msgid "guestfs_lvs_full"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:417
-msgid "The size in zettabytes (multiplied by 2**70)."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4798
+#, no-wrap
+msgid ""
+" struct guestfs_lvm_lv_list *\n"
+" guestfs_lvs_full (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:419
-msgid "B<ZB>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4804
+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: textblock
-#: ../fish/guestfish.pod:421
-msgid "The size in SI 10**21 byte units."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4810
+msgid "guestfs_lvuuid"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:423
-msgid "B<Y> or B<YiB>"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4812
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_lvuuid (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:425
-msgid "The size in yottabytes (multiplied by 2**80)."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4823
+msgid "guestfs_lxattrlist"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:427
-msgid "B<YB>"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4825
+#, no-wrap
+msgid ""
+" struct guestfs_xattr_list *\n"
+" guestfs_lxattrlist (guestfs_h *g,\n"
+" const char *path,\n"
+" char *const *names);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:429
-msgid "The size in SI 10**24 byte units."
+#. type: textblock
+#: ../src/guestfs-actions.pod:4844
+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: textblock
-#: ../fish/guestfish.pod:433
-msgid "For example:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4858
+msgid "guestfs_mkdir"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:435
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4860
#, no-wrap
msgid ""
-" truncate-size /file 1G\n"
+" int\n"
+" guestfs_mkdir (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:437
-msgid "would truncate the file to 1 gigabyte."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4870
+msgid "guestfs_mkdir_mode"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:439
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4872
+#, no-wrap
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."
+" int\n"
+" guestfs_mkdir_mode (guestfs_h *g,\n"
+" const char *path,\n"
+" int mode);\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:443
-msgid "OCTAL AND HEXADECIMAL NUMBERS"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4884
+msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
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:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4890
+msgid "guestfs_mkdir_p"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:448
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4892
#, no-wrap
msgid ""
-" 1234 decimal number 1234\n"
-" 02322 octal number, equivalent to decimal 1234\n"
-" 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
+" int\n"
+" guestfs_mkdir_p (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:452
-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):"
+#. type: =head2
+#: ../src/guestfs-actions.pod:4903
+msgid "guestfs_mkdtemp"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:456
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4905
#, no-wrap
msgid ""
-" chmod 0777 /public # OK\n"
-" chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
+" char *\n"
+" guestfs_mkdtemp (guestfs_h *g,\n"
+" const char *template);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:459
+#. type: =head2
+#: ../src/guestfs-actions.pod:4933
+msgid "guestfs_mke2fs_J"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4935
+#, no-wrap
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>)."
+" 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: =head1
-#: ../fish/guestfish.pod:463
-msgid "WILDCARDS AND GLOBBING"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4948
+msgid "See also C<guestfs_mke2journal>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:465
-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:"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:4970
+#: ../src/guestfs-actions.pod:4988 ../src/guestfs-actions.pod:5004
+#: ../src/guestfs-actions.pod:5018 ../src/guestfs-actions.pod:5032
+#: ../src/guestfs-actions.pod:5091 ../src/guestfs-actions.pod:5368
+msgid "(Added in 1.0.68)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:4954
+msgid "guestfs_mke2fs_JL"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:469
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4956
#, no-wrap
msgid ""
-" rm-rf /home/*\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
-#: ../fish/guestfish.pod:471
-msgid ""
-"Assuming you don't have a directory literally called C</home/*> then the "
-"above command will return an error."
+#. type: textblock
+#: ../src/guestfs-actions.pod:4966
+msgid "See also C<guestfs_mke2journal_L>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:474
-msgid "To perform wildcard expansion, use the C<glob> command."
+#. type: =head2
+#: ../src/guestfs-actions.pod:4972
+msgid "guestfs_mke2fs_JU"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:476
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4974
#, no-wrap
msgid ""
-" glob rm-rf /home/*\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
-#: ../fish/guestfish.pod:478
-msgid ""
-"runs C<rm-rf> on each path that matches (ie. potentially running the command "
-"many times), equivalent to:"
+#. type: textblock
+#: ../src/guestfs-actions.pod:4984
+msgid "See also C<guestfs_mke2journal_U>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:4990
+msgid "guestfs_mke2journal"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:481
+#. type: verbatim
+#: ../src/guestfs-actions.pod:4992
#, no-wrap
msgid ""
-" rm-rf /home/jim\n"
-" rm-rf /home/joe\n"
-" rm-rf /home/mary\n"
+" int\n"
+" guestfs_mke2journal (guestfs_h *g,\n"
+" int blocksize,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:485
-msgid "C<glob> only works on simple guest paths and not on device names."
+#. type: =head2
+#: ../src/guestfs-actions.pod:5006
+msgid "guestfs_mke2journal_L"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:487
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5008
+#, no-wrap
msgid ""
-"If you have several parameters, each containing a wildcard, then glob will "
-"perform a cartesian product."
+" int\n"
+" guestfs_mke2journal_L (guestfs_h *g,\n"
+" int blocksize,\n"
+" const char *label,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:490
-msgid "COMMENTS"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5020
+msgid "guestfs_mke2journal_U"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:492
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5022
+#, no-wrap
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:"
+" int\n"
+" guestfs_mke2journal_U (guestfs_h *g,\n"
+" int blocksize,\n"
+" const char *uuid,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:496
+#. type: =head2
+#: ../src/guestfs-actions.pod:5034
+msgid "guestfs_mkfifo"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5036
#, no-wrap
msgid ""
-" # this is a comment\n"
-" # this is a comment\n"
-" foo # NOT a comment\n"
+" int\n"
+" guestfs_mkfifo (guestfs_h *g,\n"
+" int mode,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:500
-msgid "Blank lines are also ignored."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5041
+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: =head1
-#: ../fish/guestfish.pod:502
-msgid "RUNNING COMMANDS LOCALLY"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5051
+msgid "guestfs_mkfs"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:504
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5053
+#, no-wrap
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:"
+" int\n"
+" guestfs_mkfs (guestfs_h *g,\n"
+" const char *fstype,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:508
+#. type: =head2
+#: ../src/guestfs-actions.pod:5066
+msgid "guestfs_mkfs_b"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5068
#, no-wrap
msgid ""
-" !mkdir local\n"
-" tgz-out /remote local/remote-data.tar.gz\n"
+" int\n"
+" guestfs_mkfs_b (guestfs_h *g,\n"
+" const char *fstype,\n"
+" int blocksize,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:511
+#. type: textblock
+#: ../src/guestfs-actions.pod:5074
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>)."
+"I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
+"call instead."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:515
+#. type: textblock
+#: ../src/guestfs-actions.pod:5081
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."
+"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: =head1
-#: ../fish/guestfish.pod:518
-msgid "PIPES"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5093
+msgid "guestfs_mkfs_opts"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:520
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5095
+#, no-wrap
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:"
+" int\n"
+" guestfs_mkfs_opts (guestfs_h *g,\n"
+" const char *fstype,\n"
+" const char *device,\n"
+" ...);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:524
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5106
#, no-wrap
msgid ""
-" cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
+" GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
+" GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
+" GUESTFS_MKFS_OPTS_INODE, int inode,\n"
+" GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:526
-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:"
+#. type: textblock
+#: ../src/guestfs-actions.pod:5154
+msgid "(Added in 1.7.19)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:5156
+msgid "guestfs_mkfs_opts_va"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:531
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5158
#, no-wrap
msgid ""
-" hexdump /bin/ls | head\n"
-" list-devices | tail -1\n"
-" tgz-out / - | tar ztf -\n"
+" int\n"
+" guestfs_mkfs_opts_va (guestfs_h *g,\n"
+" const char *fstype,\n"
+" const char *device,\n"
+" va_list args);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:535
-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."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5164
+msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:540
+#. type: =head2
+#: ../src/guestfs-actions.pod:5168
+msgid "guestfs_mkfs_opts_argv"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5170
+#, no-wrap
msgid ""
-"To use a literal argument which begins with a pipe symbol, you have to quote "
-"it, eg:"
+" int\n"
+" guestfs_mkfs_opts_argv (guestfs_h *g,\n"
+" const char *fstype,\n"
+" const char *device,\n"
+" const struct guestfs_mkfs_opts_argv *optargs);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:5176
+msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:543
+#. type: =head2
+#: ../src/guestfs-actions.pod:5180
+msgid "guestfs_mkmountpoint"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5182
#, no-wrap
msgid ""
-" echo \"|\"\n"
+" int\n"
+" guestfs_mkmountpoint (guestfs_h *g,\n"
+" const char *exemptpath);\n"
"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:545
-msgid "HOME DIRECTORIES"
+#. type: textblock
+#: ../src/guestfs-actions.pod:5186
+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: textblock
-#: ../fish/guestfish.pod:547
+#. type: textblock
+#: ../src/guestfs-actions.pod:5210
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)."
+"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:5214
+msgid ""
+"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
-#: ../fish/guestfish.pod:551
+#. type: textblock
+#: ../src/guestfs-actions.pod:5221
msgid ""
-"Note that home directory expansion happens for users known I<on the host>, "
-"not in the guest filesystem."
+"Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
+"can cause C<guestfs_umount_all> to be called when the handle is closed which "
+"can also trigger these issues."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:554
-msgid ""
-"To use a literal argument which begins with a tilde, you have to quote it, "
-"eg:"
+#. type: textblock
+#: ../src/guestfs-actions.pod:5227 ../src/guestfs-actions.pod:5533
+#: ../src/guestfs-actions.pod:6561
+msgid "(Added in 1.0.62)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:5229
+msgid "guestfs_mknod"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:557
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5231
#, no-wrap
msgid ""
-" echo \"~\"\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
-#: ../fish/guestfish.pod:561
+#. type: textblock
+#: ../src/guestfs-actions.pod:5246
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."
+"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: textblock
-#: ../fish/guestfish.pod:566
-msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5260
+msgid "guestfs_mknod_b"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:568
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5262
#, no-wrap
msgid ""
-" ><fs> vfs-type /dev/sda2\n"
-" crypto_LUKS\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
-#: ../fish/guestfish.pod:571
+#. type: textblock
+#: ../src/guestfs-actions.pod:5269
msgid ""
-"Then open those devices using L</luks-open>. This creates a device-mapper "
-"device called C</dev/mapper/luksdev>."
+"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:5279
+msgid "guestfs_mknod_c"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:574
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5281
#, no-wrap
msgid ""
-" ><fs> luks-open /dev/sda2 luksdev\n"
-" Enter key or passphrase (\"key\"): <enter the passphrase>\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
-#: ../fish/guestfish.pod:577
+#. type: textblock
+#: ../src/guestfs-actions.pod:5288
msgid ""
-"Finally you have to tell LVM to scan for volume groups on the newly created "
-"mapper device:"
+"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:5298
+msgid "guestfs_mkswap"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:580
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5300
#, no-wrap
msgid ""
-" ><fs> vgscan\n"
-" ><fs> vg-activate-all true\n"
+" int\n"
+" guestfs_mkswap (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:583
-msgid "The logical volume(s) can now be mounted in the usual way."
-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:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5310
+msgid "guestfs_mkswap_L"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:589
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5312
#, no-wrap
msgid ""
-" ><fs> vg-activate false /dev/VG\n"
-" ><fs> luks-close /dev/mapper/luksdev\n"
+" int\n"
+" guestfs_mkswap_L (guestfs_h *g,\n"
+" const char *label,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:592
-msgid "WINDOWS PATHS"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5327
+msgid "guestfs_mkswap_U"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:594
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5329
+#, no-wrap
msgid ""
-"If a path is prefixed with C<win:> then you can use Windows-style paths "
-"(with some limitations). The following commands are equivalent:"
+" int\n"
+" guestfs_mkswap_U (guestfs_h *g,\n"
+" const char *uuid,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:5340
+msgid "guestfs_mkswap_file"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:597
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5342
#, no-wrap
msgid ""
-" file /WINDOWS/system32/config/system.LOG\n"
+" int\n"
+" guestfs_mkswap_file (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:599
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:5348
msgid ""
-" file win:/windows/system32/config/system.log\n"
-"\n"
+"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: verbatim
-#: ../fish/guestfish.pod:601
+#. type: =head2
+#: ../src/guestfs-actions.pod:5355
+msgid "guestfs_modprobe"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5357
#, no-wrap
msgid ""
-" file win:\\windows\\system32\\config\\system.log\n"
+" int\n"
+" guestfs_modprobe (guestfs_h *g,\n"
+" const char *modulename);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:603
+#. type: =head2
+#: ../src/guestfs-actions.pod:5370
+msgid "guestfs_mount"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5372
#, no-wrap
msgid ""
-" file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
+" int\n"
+" guestfs_mount (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *mountpoint);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:605
+#. type: textblock
+#: ../src/guestfs-actions.pod:5391
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."
+"Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
+"and C<noatime>. The C<sync> option greatly slowed writes and caused many "
+"problems for users. If your program might need to work with older versions "
+"of libguestfs, use C<guestfs_mount_options> instead (using an empty string "
+"for the first parameter if you don't want any options)."
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:609
-msgid "UPLOADING AND DOWNLOADING FILES"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5402
+msgid "guestfs_mount_9p"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:611
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5404
+#, no-wrap
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:"
+" int\n"
+" guestfs_mount_9p (guestfs_h *g,\n"
+" const char *mounttag,\n"
+" const char *mountpoint,\n"
+" ...);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:615
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5415
#, no-wrap
msgid ""
-" upload - /foo\n"
+" GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:617
-msgid ""
-"reads stdin and creates from that a file C</foo> in the disk image, and:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5428
+msgid "guestfs_mount_9p_va"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:620
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5430
#, no-wrap
msgid ""
-" tar-out /etc - | tar tf -\n"
+" int\n"
+" guestfs_mount_9p_va (guestfs_h *g,\n"
+" const char *mounttag,\n"
+" const char *mountpoint,\n"
+" va_list args);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:622
-msgid ""
-"writes the tarball to stdout and then pipes that into the external \"tar\" "
-"command (see L</PIPES>)."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5436
+msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:625
-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:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5440
+msgid "guestfs_mount_9p_argv"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:629
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5442
#, no-wrap
msgid ""
-" upload -<<END /foo\n"
-" input line 1\n"
-" input line 2\n"
-" input line 3\n"
-" END\n"
+" int\n"
+" guestfs_mount_9p_argv (guestfs_h *g,\n"
+" const char *mounttag,\n"
+" const char *mountpoint,\n"
+" const struct guestfs_mount_9p_argv *optargs);\n"
"\n"
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)."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5448
+msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:639
-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)."
+#. type: =head2
+#: ../src/guestfs-actions.pod:5452
+msgid "guestfs_mount_loop"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:642
-msgid "EXIT ON ERROR BEHAVIOUR"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5454
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_mount_loop (guestfs_h *g,\n"
+" const char *file,\n"
+" const char *mountpoint);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:644
-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)."
+#. type: =head2
+#: ../src/guestfs-actions.pod:5467
+msgid "guestfs_mount_options"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:649
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5469
+#, no-wrap
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."
+" int\n"
+" guestfs_mount_options (guestfs_h *g,\n"
+" const char *options,\n"
+" const char *device,\n"
+" const char *mountpoint);\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:653
-msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
+#. type: textblock
+#: ../src/guestfs-actions.pod:5475
+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."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:655
-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."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5485 ../src/guestfs-actions.pod:5499
+#: ../src/guestfs-actions.pod:5516
+msgid "(Added in 1.0.10)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:660
-msgid "Start a guestfish server process using:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5487
+msgid "guestfs_mount_ro"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:662
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5489
#, no-wrap
msgid ""
-" eval `guestfish --listen`\n"
+" int\n"
+" guestfs_mount_ro (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *mountpoint);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:664
-msgid "and then send it commands by doing:"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish.pod:666
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:5494
msgid ""
-" guestfish --remote cmd [...]\n"
-"\n"
+"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: textblock
-#: ../fish/guestfish.pod:668
-msgid "To cause the server to exit, send it the exit command:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5501
+msgid "guestfs_mount_vfs"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:670
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5503
#, no-wrap
msgid ""
-" guestfish --remote exit\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
-#: ../fish/guestfish.pod:672
+#. type: textblock
+#: ../src/guestfs-actions.pod:5510
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 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
-#: ../fish/guestfish.pod:676
-msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5518
+msgid "guestfs_mountpoints"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:678
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5520
+#, no-wrap
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:"
+" char **\n"
+" guestfs_mountpoints (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:682
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:5523
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"
-"\n"
+"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
-#: ../fish/guestfish.pod:690
-msgid "REMOTE CONTROL DETAILS"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5535
+msgid "guestfs_mounts"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:692
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5537
+#, no-wrap
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."
+" char **\n"
+" guestfs_mounts (guestfs_h *g);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:696
-msgid "Guestfish client and server versions must match exactly."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5545
+msgid "See also: C<guestfs_mountpoints>"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:698
-msgid "PREPARED DISK IMAGES"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5553
+msgid "guestfs_mv"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:700
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5555
+#, no-wrap
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>)."
+" int\n"
+" guestfs_mv (guestfs_h *g,\n"
+" const char *src,\n"
+" const char *dest);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:706
-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>."
+#. type: =head2
+#: ../src/guestfs-actions.pod:5567
+msgid "guestfs_ntfs_3g_probe"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:710
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5569
+#, no-wrap
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."
+" int\n"
+" guestfs_ntfs_3g_probe (guestfs_h *g,\n"
+" int rw,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:718
-msgid "To list the available types and any extra parameters they take, run:"
+#. type: textblock
+#: ../src/guestfs-actions.pod:5588
+msgid "(Added in 1.0.43)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:722
+#. type: =head2
+#: ../src/guestfs-actions.pod:5590
+msgid "guestfs_ntfsresize"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5592
+#, no-wrap
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."
+" int\n"
+" guestfs_ntfsresize (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:726
+#. type: textblock
+#: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5696
msgid ""
-"If any I<-N> or I<--new> options are given, the guest is automatically "
-"launched."
+"I<This function is deprecated.> In new code, use the L</"
+"guestfs_ntfsresize_opts> call instead."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:731
-msgid "Create a 100MB disk with an ext4-formatted partition:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5620
+msgid "guestfs_ntfsresize_opts"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:733
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5622
#, no-wrap
msgid ""
-" guestfish -N fs:ext4\n"
+" int\n"
+" guestfs_ntfsresize_opts (guestfs_h *g,\n"
+" const char *device,\n"
+" ...);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:735
-msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish.pod:737
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5632
#, no-wrap
msgid ""
-" guestfish -N fs:vfat:32M -m /dev/sda1\n"
+" GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
+" GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:739
-msgid "Create a blank 200MB disk:"
+#. type: textblock
+#: ../src/guestfs-actions.pod:5652
+msgid ""
+"After the resize operation, the filesystem is always marked as requiring a "
+"consistency check (for safety). You have to boot into Windows to perform "
+"this check and clear this condition. If you I<don't> set the C<force> "
+"option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
+"times on a single filesystem without booting into Windows between each "
+"resize."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:5667
+msgid "guestfs_ntfsresize_opts_va"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:741
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5669
#, no-wrap
msgid ""
-" guestfish -N disk:200M\n"
+" int\n"
+" guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
+" const char *device,\n"
+" va_list args);\n"
"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:743
-msgid "PROGRESS BARS"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:745
-msgid ""
-"Some (not all) long-running commands send progress notification messages as "
-"they are running. Guestfish turns these messages into progress bars."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5674
+msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:749
-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:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5678
+msgid "guestfs_ntfsresize_opts_argv"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:753
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5680
#, no-wrap
msgid ""
-" ><fs> copy-size /large-file /another-file 2048M\n"
-" / 10% [#####-----------------------------------------] 00:30\n"
+" int\n"
+" guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
+" const char *device,\n"
+" const struct guestfs_ntfsresize_opts_argv *optargs);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:756
-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."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5685
+msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:5689
+msgid "guestfs_ntfsresize_size"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:763
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5691
+#, no-wrap
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>."
+" int\n"
+" guestfs_ntfsresize_size (guestfs_h *g,\n"
+" const char *device,\n"
+" int64_t size);\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:768
-msgid "GUESTFISH COMMANDS"
+#. type: textblock
+#: ../src/guestfs-actions.pod:5703
+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: textblock
-#: ../fish/guestfish.pod:770
-msgid ""
-"The commands in this section are guestfish convenience commands, in other "
-"words, they are not part of the L<guestfs(3)> API."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5708 ../src/guestfs-actions.pod:6168
+#: ../src/guestfs-actions.pod:6241 ../src/guestfs-actions.pod:6509
+#: ../src/guestfs-actions.pod:8148
+msgid "(Added in 1.3.14)"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:773
-msgid "alloc | allocate"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5710
+msgid "guestfs_part_add"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:775
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5712
#, no-wrap
msgid ""
-" alloc filename size\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
-#: ../fish/guestfish.pod:777
+#. type: textblock
+#: ../src/guestfs-actions.pod:5719
msgid ""
-"This creates an empty (zeroed) file of the given size, and then adds so it "
-"can be further examined."
+"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
-#: ../fish/guestfish.pod:780 ../fish/guestfish.pod:903
-msgid "For more advanced image creation, see L<qemu-img(1)> utility."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5731
+msgid ""
+"Creating a partition which covers the whole disk is not so easy. Use "
+"C<guestfs_part_disk> to do that."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:782 ../fish/guestfish.pod:905
-msgid "Size can be specified using standard suffixes, eg. C<1M>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5736 ../src/guestfs-actions.pod:5774
+#: ../src/guestfs-actions.pod:5827 ../src/guestfs-actions.pod:5911
+#: ../src/guestfs-actions.pod:5949 ../src/guestfs-actions.pod:5968
+#: ../src/guestfs-actions.pod:6008
+msgid "(Added in 1.0.78)"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:784
-msgid "copy-in"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5738
+msgid "guestfs_part_del"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:786
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5740
#, no-wrap
msgid ""
-" copy-in local [local ...] /remotedir\n"
+" int\n"
+" guestfs_part_del (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum);\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:5755
+msgid "guestfs_part_disk"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5757
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_part_disk (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *parttype);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:788
+#. type: textblock
+#: ../src/guestfs-actions.pod:5762
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."
+"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
-#: ../fish/guestfish.pod:793
+#. type: textblock
+#: ../src/guestfs-actions.pod:5766
msgid ""
-"Multiple local files and directories can be specified, but the last "
-"parameter must always be a remote directory. Wildcards cannot be used."
+"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
-#: ../fish/guestfish.pod:797
-msgid "copy-out"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5776
+msgid "guestfs_part_get_bootable"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:799
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5778
#, no-wrap
msgid ""
-" copy-out remote [remote ...] localdir\n"
+" int\n"
+" guestfs_part_get_bootable (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:801
-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."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5786
+msgid "See also C<guestfs_part_set_bootable>."
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
+#: ../src/guestfs-actions.pod:5792
+msgid "guestfs_part_get_mbr_id"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:811
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5794
#, no-wrap
msgid ""
-" copy-out /home .\n"
+" int\n"
+" guestfs_part_get_mbr_id (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:813
+#. type: textblock
+#: ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:5984
msgid ""
-"Wildcards cannot be used in the ordinary command, but you can use them with "
-"the help of L</glob> like this:"
+"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:5810
+msgid "guestfs_part_get_parttype"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:816
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5812
#, no-wrap
msgid ""
-" glob copy-out /home/* .\n"
+" char *\n"
+" guestfs_part_get_parttype (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:818
-msgid "echo"
+#. type: textblock
+#: ../src/guestfs-actions.pod:5819
+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: verbatim
-#: ../fish/guestfish.pod:820
+#. type: =head2
+#: ../src/guestfs-actions.pod:5829
+msgid "guestfs_part_init"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5831
#, no-wrap
msgid ""
-" echo [params ...]\n"
+" int\n"
+" guestfs_part_init (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *parttype);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:822
-msgid "This echos the parameters to the terminal."
+#. type: textblock
+#: ../src/guestfs-actions.pod:5840
+msgid ""
+"Initially there are no partitions. Following this, you should call "
+"C<guestfs_part_add> for each partition required."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:824
-msgid "edit | vi | emacs"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5913
+msgid "guestfs_part_list"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:826
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5915
#, no-wrap
msgid ""
-" edit filename\n"
+" struct guestfs_partition_list *\n"
+" guestfs_part_list (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:828
+#. type: textblock
+#: ../src/guestfs-actions.pod:5932
msgid ""
-"This is used to edit a file. It downloads the file, edits it locally using "
-"your editor, then uploads the result."
+"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: textblock
-#: ../fish/guestfish.pod:831
+#. type: textblock
+#: ../src/guestfs-actions.pod:5945
msgid ""
-"The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
-"or C<emacs> you will get those corresponding editors."
+"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
-#: ../fish/guestfish.pod:835
-msgid "glob"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5951
+msgid "guestfs_part_set_bootable"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:837
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5953
#, no-wrap
msgid ""
-" glob command args...\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
-#: ../fish/guestfish.pod:839
-msgid ""
-"Expand wildcards in any paths in the args list, and run C<command> "
-"repeatedly on each matching path."
+#. type: =head2
+#: ../src/guestfs-actions.pod:5970
+msgid "guestfs_part_set_mbr_id"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:842
-msgid "See section WILDCARDS AND GLOBBING."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5972
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_part_set_mbr_id (guestfs_h *g,\n"
+" const char *device,\n"
+" int partnum,\n"
+" int idbyte);\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:844
-msgid "help"
+#. type: =head2
+#: ../src/guestfs-actions.pod:5992
+msgid "guestfs_part_set_name"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:846
+#. type: verbatim
+#: ../src/guestfs-actions.pod:5994
#, no-wrap
msgid ""
-" help\n"
-" help cmd\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
-#: ../fish/guestfish.pod:849
-msgid ""
-"Without any parameter, this lists all commands. With a C<cmd> parameter, "
-"this displays detailed help for a command."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish.pod:852
-msgid "lcd"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6010
+msgid "guestfs_part_to_dev"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:854
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6012
#, no-wrap
msgid ""
-" lcd directory\n"
+" char *\n"
+" guestfs_part_to_dev (guestfs_h *g,\n"
+" const char *partition);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:856
+#. type: textblock
+#: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6039
msgid ""
-"Change the local directory, ie. the current directory of guestfish itself."
+"The named partition must exist, for example as a string returned from "
+"C<guestfs_list_partitions>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:859
-msgid "Note that C<!cd> won't do what you might expect."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6023
+msgid "See also C<guestfs_part_to_partnum>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:861
-msgid "man | manual"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6030
+msgid "guestfs_part_to_partnum"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:863
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6032
#, no-wrap
msgid ""
-" man\n"
+" int\n"
+" guestfs_part_to_partnum (guestfs_h *g,\n"
+" const char *partition);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:865
-msgid "Opens the manual page for guestfish."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6042
+msgid "See also C<guestfs_part_to_dev>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:867
-msgid "more | less"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6046
+msgid "guestfs_ping_daemon"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:869
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6048
#, no-wrap
msgid ""
-" more filename\n"
+" int\n"
+" guestfs_ping_daemon (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:871
+#. type: =head2
+#: ../src/guestfs-actions.pod:6060
+msgid "guestfs_pread"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6062
#, no-wrap
msgid ""
-" less filename\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
-#: ../fish/guestfish.pod:873
-msgid "This is used to view a file."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6075
+msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:6086
+msgid "guestfs_pread_device"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:875
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6088
+#, no-wrap
msgid ""
-"The default viewer is C<$PAGER>. However if you use the alternate command "
-"C<less> you will get the C<less> command specifically."
+" 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: =head2
-#: ../fish/guestfish.pod:878
-msgid "quit | exit"
+#. type: textblock
+#: ../src/guestfs-actions.pod:6101
+msgid "See also C<guestfs_pread>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:880
-msgid "This exits guestfish. You can also use C<^D> key."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6110
+msgid "(Added in 1.5.21)"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:882
-msgid "reopen"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6112
+msgid "guestfs_pvcreate"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:884
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6114
#, no-wrap
msgid ""
-" reopen\n"
+" int\n"
+" guestfs_pvcreate (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:886
+#. type: =head2
+#: ../src/guestfs-actions.pod:6126
+msgid "guestfs_pvremove"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6128
+#, no-wrap
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."
+" int\n"
+" guestfs_pvremove (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:890
-msgid "sparse"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6143
+msgid "guestfs_pvresize"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:892
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6145
#, no-wrap
msgid ""
-" sparse filename size\n"
+" int\n"
+" guestfs_pvresize (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:894
+#. type: =head2
+#: ../src/guestfs-actions.pod:6156
+msgid "guestfs_pvresize_size"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6158
+#, no-wrap
msgid ""
-"This creates an empty sparse file of the given size, and then adds so it can "
-"be further examined."
+" int\n"
+" guestfs_pvresize_size (guestfs_h *g,\n"
+" const char *device,\n"
+" int64_t size);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:897
+#. type: textblock
+#: ../src/guestfs-actions.pod:6163
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."
+"This command is the same as C<guestfs_pvresize> except that it allows you to "
+"specify the new size (in bytes) explicitly."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:907
-msgid "supported"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6170
+msgid "guestfs_pvs"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:909
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6172
#, no-wrap
msgid ""
-" supported\n"
+" char **\n"
+" guestfs_pvs (guestfs_h *g);\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."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish.pod:915
-msgid "See also L<guestfs(3)/AVAILABILITY>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6181
+msgid "See also C<guestfs_pvs_full>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish.pod:917
-msgid "time"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6189
+msgid "guestfs_pvs_full"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:919
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6191
#, no-wrap
msgid ""
-" time command args...\n"
+" struct guestfs_lvm_pv_list *\n"
+" guestfs_pvs_full (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:921
+#. type: textblock
+#: ../src/guestfs-actions.pod:6197
msgid ""
-"Run the command as usual, but print the elapsed time afterwards. This can "
-"be useful for benchmarking operations."
+"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: =head1
-#: ../fish/guestfish.pod:924
-msgid "COMMANDS"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6203
+msgid "guestfs_pvuuid"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6205
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_pvuuid (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../fish/guestfish.pod:928 ../test-tool/libguestfs-test-tool.pod:83
-msgid "EXIT CODE"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6216
+msgid "guestfs_pwrite"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:930
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6218
+#, no-wrap
msgid ""
-"guestfish returns 0 if the commands completed without error, or 1 if there "
-"was an error."
+" 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: =item
-#: ../fish/guestfish.pod:937
-msgid "EDITOR"
+#. type: textblock
+#: ../src/guestfs-actions.pod:6234
+msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:939
+#. type: =head2
+#: ../src/guestfs-actions.pod:6243
+msgid "guestfs_pwrite_device"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6245
+#, no-wrap
msgid ""
-"The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
-"C<vi>."
+" 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: =item
-#: ../fish/guestfish.pod:942
-msgid "GUESTFISH_PID"
+#. type: textblock
+#: ../src/guestfs-actions.pod:6260
+msgid "See also C<guestfs_pwrite>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:944
-msgid ""
-"Used with the I<--remote> option to specify the remote guestfish process to "
-"control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6267
+msgid "(Added in 1.5.20)"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:948
-msgid "HOME"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6269
+msgid "guestfs_read_file"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:950
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6271
+#, no-wrap
msgid ""
-"If compiled with GNU readline support, various files in the home directory "
-"can be used. See L</FILES>."
+" char *\n"
+" guestfs_read_file (guestfs_h *g,\n"
+" const char *path,\n"
+" size_t *size_r);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:959
+#. type: textblock
+#: ../src/guestfs-actions.pod:6279
msgid ""
-"Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
-"effect as using the B<-v> option."
+"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
-#: ../fish/guestfish.pod:971
-msgid ""
-"Set the path that guestfish uses to search for kernel and initrd.img. See "
-"the discussion of paths in L<guestfs(3)>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6291
+msgid "(Added in 1.0.63)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:982
-msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
+#. type: =head2
+#: ../src/guestfs-actions.pod:6293
+msgid "guestfs_read_lines"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:984
-msgid "PAGER"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6295
+#, no-wrap
+msgid ""
+" char **\n"
+" guestfs_read_lines (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:986
+#. type: textblock
+#: ../src/guestfs-actions.pod:6304
msgid ""
-"The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
-"C<more>."
+"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: =head1
-#: ../fish/guestfish.pod:1001 ../test-tool/libguestfs-test-tool.pod:88
-msgid "FILES"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6315
+msgid "guestfs_readdir"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1005
-msgid "$HOME/.guestfish"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6317
+#, no-wrap
+msgid ""
+" struct guestfs_dirent_list *\n"
+" guestfs_readdir (guestfs_h *g,\n"
+" const char *dir);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1007
+#. type: textblock
+#: ../src/guestfs-actions.pod:6371
msgid ""
-"If compiled with GNU readline support, then the command history is saved in "
-"this file."
+"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:6375
+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: =item
-#: ../fish/guestfish.pod:1010
-msgid "$HOME/.inputrc"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6381
+msgid "guestfs_readlink"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1012
-msgid "/etc/inputrc"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6383
+#, no-wrap
+msgid ""
+" char *\n"
+" guestfs_readlink (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1014
+#. type: =head2
+#: ../src/guestfs-actions.pod:6394
+msgid "guestfs_readlinklist"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6396
+#, no-wrap
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>."
+" char **\n"
+" guestfs_readlinklist (guestfs_h *g,\n"
+" const char *path,\n"
+" char *const *names);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1018
-msgid "To write rules which only apply to guestfish, use:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6429
+msgid "guestfs_realpath"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:1020
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6431
#, no-wrap
msgid ""
-" $if guestfish\n"
-" ...\n"
-" $endif\n"
+" char *\n"
+" guestfs_realpath (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1024
+#. type: =head2
+#: ../src/guestfs-actions.pod:6443
+msgid "guestfs_removexattr"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6445
+#, no-wrap
msgid ""
-"Variables that you can set in inputrc that change the behaviour of guestfish "
-"in useful ways include:"
+" int\n"
+" guestfs_removexattr (guestfs_h *g,\n"
+" const char *xattr,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1029
-msgid "completion-ignore-case (default: on)"
+#. type: textblock
+#: ../src/guestfs-actions.pod:6453
+msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1031
-msgid ""
-"By default, guestfish will ignore case when tab-completing paths on the "
-"disk. Use:"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6459
+msgid "guestfs_resize2fs"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish.pod:1034
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6461
#, no-wrap
msgid ""
-" set completion-ignore-case off\n"
+" int\n"
+" guestfs_resize2fs (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1036
-msgid "to make guestfish case sensitive."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6468
+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."
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1040
-msgid "test1.img"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6478
+msgid "guestfs_resize2fs_M"
msgstr ""
-# type: =item
-#: ../fish/guestfish.pod:1042
-msgid "test2.img (etc)"
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6480
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_resize2fs_M (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1044
+#. type: textblock
+#: ../src/guestfs-actions.pod:6484
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."
+"This command is the same as C<guestfs_resize2fs>, but the filesystem is "
+"resized to its minimum size. This works like the I<-M> option to the "
+"C<resize2fs> command."
msgstr ""
-# type: textblock
-#: ../fish/guestfish.pod:1053
+#. type: textblock
+#: ../src/guestfs-actions.pod:6488
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)>."
+"To get the resulting size of the filesystem you should call "
+"C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
+"These two numbers, multiplied together, give the resulting size of the "
+"minimal filesystem in bytes."
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
+#: ../src/guestfs-actions.pod:6497
+msgid "guestfs_resize2fs_size"
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
+#: ../src/guestfs-actions.pod:6499
+#, 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."
+" int\n"
+" guestfs_resize2fs_size (guestfs_h *g,\n"
+" const char *device,\n"
+" int64_t size);\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: textblock
+#: ../src/guestfs-actions.pod:6504
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."
+"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
-#: ../fish/guestfish-actions.pod:1
-msgid "add-cdrom | cdrom"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6511
+msgid "guestfs_rm"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6513
#, no-wrap
msgid ""
-" add-cdrom filename\n"
+" int\n"
+" guestfs_rm (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:15
+#. type: =head2
+#: ../src/guestfs-actions.pod:6523
+msgid "guestfs_rm_rf"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6525
+#, 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."
+" int\n"
+" guestfs_rm_rf (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:22
+#. type: =head2
+#: ../src/guestfs-actions.pod:6537
+msgid "guestfs_rmdir"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6539
+#, no-wrap
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."
+" int\n"
+" guestfs_rmdir (guestfs_h *g,\n"
+" const char *path);\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:28
-msgid "add-drive | add"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6549
+msgid "guestfs_rmmountpoint"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:30
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6551
#, no-wrap
msgid ""
-" add-drive filename\n"
+" int\n"
+" guestfs_rmmountpoint (guestfs_h *g,\n"
+" const char *exemptpath);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:49 ../fish/guestfish-actions.pod:75
+#. type: textblock
+#: ../src/guestfs-actions.pod:6555
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>."
+"This calls removes a mountpoint that was previously created with "
+"C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:54 ../fish/guestfish-actions.pod:80
+#. type: =head2
+#: ../src/guestfs-actions.pod:6563
+msgid "guestfs_scrub_device"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6565
+#, no-wrap
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."
+" int\n"
+" guestfs_scrub_device (guestfs_h *g,\n"
+" const char *device);\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:6580 ../src/guestfs-actions.pod:6598
+#: ../src/guestfs-actions.pod:6617
+msgid "(Added in 1.0.52)"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:59
-msgid "add-drive-ro | add-ro"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6582
+msgid "guestfs_scrub_file"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:61
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6584
#, no-wrap
msgid ""
-" add-drive-ro filename\n"
+" int\n"
+" guestfs_scrub_file (guestfs_h *g,\n"
+" const char *file);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:85
-msgid "add-drive-ro-with-if"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6600
+msgid "guestfs_scrub_freespace"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:87
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6602
#, no-wrap
msgid ""
-" add-drive-ro-with-if filename iface\n"
+" int\n"
+" guestfs_scrub_freespace (guestfs_h *g,\n"
+" const char *dir);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:89
+#. type: textblock
+#: ../src/guestfs-actions.pod:6606
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."
+"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: =head2
-#: ../fish/guestfish-actions.pod:92
-msgid "add-drive-with-if"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6619
+msgid "guestfs_set_append"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:94
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6621
#, no-wrap
msgid ""
-" add-drive-with-if filename iface\n"
+" int\n"
+" guestfs_set_append (guestfs_h *g,\n"
+" const char *append);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:96
+#. type: =head2
+#: ../src/guestfs-actions.pod:6638
+msgid "guestfs_set_attach_method"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6640
+#, no-wrap
msgid ""
-"This is the same as C<add-drive> but it allows you to specify the QEMU "
-"interface emulation to use at run time."
+" int\n"
+" guestfs_set_attach_method (guestfs_h *g,\n"
+" const char *attachmethod);\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:99
-msgid "aug-clear"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6668
+msgid "guestfs_set_autosync"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:101
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6670
#, no-wrap
msgid ""
-" aug-clear augpath\n"
+" int\n"
+" guestfs_set_autosync (guestfs_h *g,\n"
+" int autosync);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:106
-msgid "aug-close"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6686
+msgid "guestfs_set_direct"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:108
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6688
#, no-wrap
msgid ""
-" aug-close\n"
+" int\n"
+" guestfs_set_direct (guestfs_h *g,\n"
+" int direct);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:110
+#. type: textblock
+#: ../src/guestfs-actions.pod:6696
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."
+"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: =head2
-#: ../fish/guestfish-actions.pod:115
-msgid "aug-defnode"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6709
+msgid "guestfs_set_e2label"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:117
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6711
#, no-wrap
msgid ""
-" aug-defnode name expr val\n"
+" int\n"
+" guestfs_set_e2label (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *label);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:122
+#. type: textblock
+#: ../src/guestfs-actions.pod:6720
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."
+"You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
+"the existing label on a filesystem."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:130
-msgid "aug-defvar"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6727
+msgid "guestfs_set_e2uuid"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:132
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6729
#, no-wrap
msgid ""
-" aug-defvar name expr\n"
+" int\n"
+" guestfs_set_e2uuid (guestfs_h *g,\n"
+" const char *device,\n"
+" const char *uuid);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:141
-msgid "aug-get"
+#. type: textblock
+#: ../src/guestfs-actions.pod:6739
+msgid ""
+"You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
+"the existing UUID of a filesystem."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:143
+#. type: =head2
+#: ../src/guestfs-actions.pod:6746
+msgid "guestfs_set_memsize"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6748
#, no-wrap
msgid ""
-" aug-get augpath\n"
+" int\n"
+" guestfs_set_memsize (guestfs_h *g,\n"
+" int memsize);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:148
-msgid "aug-init"
+#. type: textblock
+#: ../src/guestfs-actions.pod:6752
+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: verbatim
-#: ../fish/guestfish-actions.pod:150
+#. type: =head2
+#: ../src/guestfs-actions.pod:6767
+msgid "guestfs_set_network"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6769
#, no-wrap
msgid ""
-" aug-init root flags\n"
+" int\n"
+" guestfs_set_network (guestfs_h *g,\n"
+" int network);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:156
-msgid "You must call this before using any other C<aug-*> commands."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6779
+msgid ""
+"You must call this before calling C<guestfs_launch>, otherwise it has no "
+"effect."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:191
-msgid "Do not load the tree in C<aug-init>."
+#. type: =head2
+#: ../src/guestfs-actions.pod:6786
+msgid "guestfs_set_path"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:195
-msgid "To close the handle, you can call C<aug-close>."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6788
+#, no-wrap
+msgid ""
+" int\n"
+" guestfs_set_path (guestfs_h *g,\n"
+" const char *searchpath);\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:199
-msgid "aug-insert"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6803
+msgid "guestfs_set_pgroup"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:201
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6805
#, no-wrap
msgid ""
-" aug-insert augpath label true|false\n"
+" int\n"
+" guestfs_set_pgroup (guestfs_h *g,\n"
+" int pgroup);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:211
-msgid "aug-load"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6822
+msgid "guestfs_set_qemu"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:213
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6824
#, no-wrap
msgid ""
-" aug-load\n"
+" int\n"
+" guestfs_set_qemu (guestfs_h *g,\n"
+" const char *qemu);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:220
-msgid "aug-ls"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6850
+msgid "guestfs_set_recovery_proc"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:222
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6852
#, no-wrap
msgid ""
-" aug-ls augpath\n"
+" int\n"
+" guestfs_set_recovery_proc (guestfs_h *g,\n"
+" int recoveryproc);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:224
+#. type: textblock
+#: ../src/guestfs-actions.pod:6856
msgid ""
-"This is just a shortcut for listing C<aug-match> C<path/*> and sorting the "
-"resulting nodes into alphabetical order."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:227
-msgid "aug-match"
+"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: verbatim
-#: ../fish/guestfish-actions.pod:229
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:6861
msgid ""
-" aug-match augpath\n"
-"\n"
+"This only has any effect if called before C<guestfs_launch>, and the default "
+"is true."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:235
-msgid "aug-mv"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6874
+msgid "guestfs_set_selinux"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:237
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6876
#, no-wrap
msgid ""
-" aug-mv src dest\n"
+" int\n"
+" guestfs_set_selinux (guestfs_h *g,\n"
+" int selinux);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:242
-msgid "aug-rm"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6893
+msgid "guestfs_set_smp"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:244
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6895
#, no-wrap
msgid ""
-" aug-rm augpath\n"
+" int\n"
+" guestfs_set_smp (guestfs_h *g,\n"
+" int smp);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:250
-msgid "aug-save"
+#. type: textblock
+#: ../src/guestfs-actions.pod:6903
+msgid "This function must be called before C<guestfs_launch>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:6909
+msgid "guestfs_set_trace"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:252
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6911
#, no-wrap
msgid ""
-" aug-save\n"
+" int\n"
+" guestfs_set_trace (guestfs_h *g,\n"
+" int trace);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:256
+#. type: textblock
+#: ../src/guestfs-actions.pod:6925
msgid ""
-"The flags which were passed to C<aug-init> affect exactly how files are "
-"saved."
+"Trace messages are normally sent to C<stderr>, unless you register a "
+"callback to send them somewhere else (see C<guestfs_set_event_callback>)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:259
-msgid "aug-set"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6933
+msgid "guestfs_set_verbose"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:261
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6935
#, no-wrap
msgid ""
-" aug-set augpath val\n"
+" int\n"
+" guestfs_set_verbose (guestfs_h *g,\n"
+" int verbose);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:265
+#. type: textblock
+#: ../src/guestfs-actions.pod:6944
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."
+"Verbose messages are normally sent to C<stderr>, unless you register a "
+"callback to send them somewhere else (see C<guestfs_set_event_callback>)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:270
-msgid "available"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6952
+msgid "guestfs_setcon"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:272
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6954
#, no-wrap
msgid ""
-" available 'groups ...'\n"
+" int\n"
+" guestfs_setcon (guestfs_h *g,\n"
+" const char *context);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:278
-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>."
+#. type: =head2
+#: ../src/guestfs-actions.pod:6967
+msgid "guestfs_setxattr"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:302
-msgid "You must call C<launch> before calling this function."
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6969
+#, no-wrap
+msgid ""
+" 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
-#: ../fish/guestfish-actions.pod:324
-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>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:6980
+msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:331
-msgid "available-all-groups"
+#. type: =head2
+#: ../src/guestfs-actions.pod:6986
+msgid "guestfs_sfdisk"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:333
+#. type: verbatim
+#: ../src/guestfs-actions.pod:6988
#, no-wrap
msgid ""
-" available-all-groups\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
-#: ../fish/guestfish-actions.pod:335
+#. type: textblock
+#: ../src/guestfs-actions.pod:6996 ../src/guestfs-actions.pod:7040
+#: ../src/guestfs-actions.pod:7074
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."
+"I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
+"call instead."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:341
-msgid "See also C<available> and L<guestfs(3)/AVAILABILITY>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7023
+msgid ""
+"See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:343
-msgid "base64-in"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7033
+msgid "guestfs_sfdiskM"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:345
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7035
#, no-wrap
msgid ""
-" base64-in (base64file|-) filename\n"
+" int\n"
+" guestfs_sfdiskM (guestfs_h *g,\n"
+" const char *device,\n"
+" char *const *lines);\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."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7047
+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."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:352
-msgid "base64-out"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7053
+msgid ""
+"See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
+"C<guestfs_part_disk>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:354
+#. type: =head2
+#: ../src/guestfs-actions.pod:7063
+msgid "guestfs_sfdisk_N"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7065
#, no-wrap
msgid ""
-" base64-out filename (base64file|-)\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: =head2
-#: ../fish/guestfish-actions.pod:361
-msgid "blockdev-flushbufs"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7084
+msgid ""
+"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:7087
+msgid "See also: C<guestfs_part_add>"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7096
+msgid "guestfs_sfdisk_disk_geometry"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:363
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7098
#, no-wrap
msgid ""
-" blockdev-flushbufs device\n"
+" char *\n"
+" guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:370
-msgid "blockdev-getbsz"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:372
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:7102
msgid ""
-" blockdev-getbsz device\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:381
-msgid "blockdev-getro"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7115
+msgid "guestfs_sfdisk_kernel_geometry"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:383
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7117
#, no-wrap
msgid ""
-" blockdev-getro device\n"
+" char *\n"
+" guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:390
-msgid "blockdev-getsize64"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7131
+msgid "guestfs_sfdisk_l"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:392
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7133
#, no-wrap
msgid ""
-" blockdev-getsize64 device\n"
+" char *\n"
+" guestfs_sfdisk_l (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:396
-msgid "See also C<blockdev-getsz>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7137
+msgid ""
+"I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
+"call instead."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:400
-msgid "blockdev-getss"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7148
+msgid "See also: C<guestfs_part_list>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:402
+#. type: =head2
+#: ../src/guestfs-actions.pod:7155
+msgid "guestfs_sh"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7157
#, no-wrap
msgid ""
-" blockdev-getss device\n"
+" char *\n"
+" guestfs_sh (guestfs_h *g,\n"
+" const char *command);\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)."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7164
+msgid "This is like C<guestfs_command>, but passes the command to:"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:412
-msgid "blockdev-getsz"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7172
+msgid "All the provisos about C<guestfs_command> apply to this call."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7179
+msgid "guestfs_sh_lines"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:414
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7181
#, no-wrap
msgid ""
-" blockdev-getsz device\n"
+" char **\n"
+" guestfs_sh_lines (guestfs_h *g,\n"
+" const char *command);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:419
+#. type: textblock
+#: ../src/guestfs-actions.pod:7185
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>."
+"This is the same as C<guestfs_sh>, but splits the result into a list of "
+"lines."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:425
-msgid "blockdev-rereadpt"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7188
+msgid "See also: C<guestfs_command_lines>"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7196
+msgid "guestfs_sleep"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:427
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7198
#, no-wrap
msgid ""
-" blockdev-rereadpt device\n"
+" int\n"
+" guestfs_sleep (guestfs_h *g,\n"
+" int secs);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:433
-msgid "blockdev-setbsz"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7206
+msgid "(Added in 1.0.41)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7208 ../src/guestfs-structs.pod:109
+msgid "guestfs_stat"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:435
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7210
#, no-wrap
msgid ""
-" blockdev-setbsz device blocksize\n"
+" struct guestfs_stat *\n"
+" guestfs_stat (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:444
-msgid "blockdev-setro"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7224 ../src/guestfs-structs.pod:135
+msgid "guestfs_statvfs"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:446
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7226
#, no-wrap
msgid ""
-" blockdev-setro device\n"
+" struct guestfs_statvfs *\n"
+" guestfs_statvfs (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:452
-msgid "blockdev-setrw"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7236
+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>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7242
+msgid "guestfs_strings"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:454
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7244
#, no-wrap
msgid ""
-" blockdev-setrw device\n"
+" char **\n"
+" guestfs_strings (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:460
-msgid "case-sensitive-path"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7260
+msgid "guestfs_strings_e"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:462
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7262
#, no-wrap
msgid ""
-" case-sensitive-path path\n"
+" char **\n"
+" guestfs_strings_e (guestfs_h *g,\n"
+" const char *encoding,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:486
+#. type: textblock
+#: ../src/guestfs-actions.pod:7267
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)."
+"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
-#: ../fish/guestfish-actions.pod:494
-msgid "See also C<realpath>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7277
+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: =head2
-#: ../fish/guestfish-actions.pod:496
-msgid "cat"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7315
+msgid "guestfs_swapoff_device"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:498
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7317
#, no-wrap
msgid ""
-" cat path\n"
+" int\n"
+" guestfs_swapoff_device (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:502
+#. type: textblock
+#: ../src/guestfs-actions.pod:7321
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."
+"This command disables the libguestfs appliance swap device or partition "
+"named C<device>. See C<guestfs_swapon_device>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:510
-msgid "checksum"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7329
+msgid "guestfs_swapoff_file"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:512
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7331
#, no-wrap
msgid ""
-" checksum csumtype path\n"
+" int\n"
+" guestfs_swapoff_file (guestfs_h *g,\n"
+" const char *file);\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"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7341
+msgid "guestfs_swapoff_label"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:561
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7343
#, no-wrap
msgid ""
-" checksum-device csumtype device\n"
+" int\n"
+" guestfs_swapoff_label (guestfs_h *g,\n"
+" const char *label);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:563
-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."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:567
-msgid "checksums-out"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7354
+msgid "guestfs_swapoff_uuid"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:569
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7356
#, no-wrap
msgid ""
-" checksums-out csumtype directory (sumsfile|-)\n"
+" int\n"
+" guestfs_swapoff_uuid (guestfs_h *g,\n"
+" const char *uuid);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:585
-msgid "chmod"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7367
+msgid "guestfs_swapon_device"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:587
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7369
#, no-wrap
msgid ""
-" chmod mode path\n"
+" int\n"
+" guestfs_swapon_device (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:598
-msgid "chown"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7373
+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>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7389
+msgid "guestfs_swapon_file"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:600
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7391
#, no-wrap
msgid ""
-" chown owner group path\n"
+" int\n"
+" guestfs_swapon_file (guestfs_h *g,\n"
+" const char *file);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:608
-msgid "command"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7395
+msgid ""
+"This command enables swap to a file. See C<guestfs_swapon_device> for other "
+"notes."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7402
+msgid "guestfs_swapon_label"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:610
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7404
#, no-wrap
msgid ""
-" command 'arguments ...'\n"
+" int\n"
+" guestfs_swapon_label (guestfs_h *g,\n"
+" const char *label);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:617
+#. type: textblock
+#: ../src/guestfs-actions.pod:7408
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>)."
+"This command enables swap to a labeled swap partition. See "
+"C<guestfs_swapon_device> for other notes."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:645
-msgid "command-lines"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7415
+msgid "guestfs_swapon_uuid"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:647
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7417
#, no-wrap
msgid ""
-" command-lines 'arguments ...'\n"
+" int\n"
+" guestfs_swapon_uuid (guestfs_h *g,\n"
+" const char *uuid);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:649
+#. type: textblock
+#: ../src/guestfs-actions.pod:7421
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>"
+"This command enables swap to a swap partition with the given UUID. See "
+"C<guestfs_swapon_device> for other notes."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:657
-msgid "config"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7428
+msgid "guestfs_sync"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:659
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7430
#, no-wrap
msgid ""
-" config qemuparam qemuvalue\n"
+" int\n"
+" guestfs_sync (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:670
-msgid "copy-size"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7443
+msgid "guestfs_tail"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:672
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7445
#, no-wrap
msgid ""
-" copy-size src dest size\n"
+" char **\n"
+" guestfs_tail (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:680
-msgid "cp"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7461
+msgid "guestfs_tail_n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:682
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7463
#, no-wrap
msgid ""
-" cp src dest\n"
+" char **\n"
+" guestfs_tail_n (guestfs_h *g,\n"
+" int nrlines,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:687
-msgid "cp-a"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7485
+msgid "guestfs_tar_in"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:689
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7487
#, no-wrap
msgid ""
-" cp-a src dest\n"
+" int\n"
+" guestfs_tar_in (guestfs_h *g,\n"
+" const char *tarfile,\n"
+" const char *directory);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:694
-msgid "dd"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7495
+msgid ""
+"To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-actions.pod:7500 ../src/guestfs-actions.pod:7517
+#: ../src/guestfs-actions.pod:7533 ../src/guestfs-actions.pod:7549
+msgid "(Added in 1.0.3)"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:696
+#. type: =head2
+#: ../src/guestfs-actions.pod:7502
+msgid "guestfs_tar_out"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7504
#, no-wrap
msgid ""
-" dd src dest\n"
+" int\n"
+" guestfs_tar_out (guestfs_h *g,\n"
+" const char *directory,\n"
+" const char *tarfile);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:703
+#. type: textblock
+#: ../src/guestfs-actions.pod:7512
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>)."
+"To download a compressed tarball, use C<guestfs_tgz_out> or "
+"C<guestfs_txz_out>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:707
-msgid "debug"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7519
+msgid "guestfs_tgz_in"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:709
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7521
#, no-wrap
msgid ""
-" debug subcmd 'extraargs ...'\n"
+" int\n"
+" guestfs_tgz_in (guestfs_h *g,\n"
+" const char *tarball,\n"
+" const char *directory);\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."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7529
+msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:719
-msgid "debug-upload"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7535
+msgid "guestfs_tgz_out"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:721
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7537
#, no-wrap
msgid ""
-" debug-upload (filename|-) tmpname mode\n"
+" int\n"
+" guestfs_tgz_out (guestfs_h *g,\n"
+" const char *directory,\n"
+" const char *tarball);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:723
-msgid "The C<debug-upload> command uploads a file to the libguestfs appliance."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7545
+msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:732
-msgid "df"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7551
+msgid "guestfs_touch"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:734
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7553
#, no-wrap
msgid ""
-" df\n"
+" int\n"
+" guestfs_touch (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:742
-msgid "df-h"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7568
+msgid "guestfs_truncate"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:744
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7570
#, no-wrap
msgid ""
-" df-h\n"
+" int\n"
+" guestfs_truncate (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:753
-msgid "dmesg"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7581
+msgid "guestfs_truncate_size"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:755
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7583
#, no-wrap
msgid ""
-" dmesg\n"
+" int\n"
+" guestfs_truncate_size (guestfs_h *g,\n"
+" const char *path,\n"
+" int64_t size);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:761
+#. type: textblock
+#: ../src/guestfs-actions.pod:7591
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."
+"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
-#: ../fish/guestfish-actions.pod:766
-msgid "download"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7601
+msgid "guestfs_tune2fs_l"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:768
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7603
#, no-wrap
msgid ""
-" download remotefilename (filename|-)\n"
+" char **\n"
+" guestfs_tune2fs_l (guestfs_h *g,\n"
+" const char *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"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7623
+msgid "guestfs_txz_in"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:781
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7625
#, no-wrap
msgid ""
-" drop-caches whattodrop\n"
+" int\n"
+" guestfs_txz_in (guestfs_h *g,\n"
+" const char *tarball,\n"
+" const char *directory);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:793
-msgid "du"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7637
+msgid "guestfs_txz_out"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:795
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7639
#, no-wrap
msgid ""
-" du path\n"
+" int\n"
+" guestfs_txz_out (guestfs_h *g,\n"
+" const char *directory,\n"
+" const char *tarball);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:807
-msgid "e2fsck-f"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7651
+msgid "guestfs_umask"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:809
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7653
#, no-wrap
msgid ""
-" e2fsck-f device\n"
+" int\n"
+" guestfs_umask (guestfs_h *g,\n"
+" int mask);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:815
+#. type: textblock
+#: ../src/guestfs-actions.pod:7669
msgid ""
-"This command is only needed because of C<resize2fs> (q.v.). Normally you "
-"should use C<fsck>."
+"See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
+"C<guestfs_mkdir>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:818
-msgid "echo-daemon"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7678
+msgid "guestfs_umount"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:820
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7680
#, no-wrap
msgid ""
-" echo-daemon 'words ...'\n"
+" int\n"
+" guestfs_umount (guestfs_h *g,\n"
+" const char *pathordevice);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:827
-msgid "See also C<ping-daemon>."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:829
-msgid "egrep"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7692
+msgid "guestfs_umount_all"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:831
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7694
#, no-wrap
msgid ""
-" egrep regex path\n"
+" int\n"
+" guestfs_umount_all (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:839
-msgid "egrepi"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7705
+msgid "guestfs_upload"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:841
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7707
#, no-wrap
msgid ""
-" egrepi regex path\n"
+" int\n"
+" guestfs_upload (guestfs_h *g,\n"
+" const char *filename,\n"
+" const char *remotefilename);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:849
-msgid "equal"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7717
+msgid "See also C<guestfs_download>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:851
+#. type: =head2
+#: ../src/guestfs-actions.pod:7728
+msgid "guestfs_upload_offset"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7730
#, no-wrap
msgid ""
-" equal file1 file2\n"
+" int\n"
+" guestfs_upload_offset (guestfs_h *g,\n"
+" const char *filename,\n"
+" const char *remotefilename,\n"
+" int64_t offset);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:858
-msgid "exists"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:860
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:7746
msgid ""
-" exists path\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:865
-msgid "See also C<is-file>, C<is-dir>, C<stat>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7751
+msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:867
-msgid "fallocate"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7762
+msgid "guestfs_utimens"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:869
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7764
#, no-wrap
msgid ""
-" fallocate path len\n"
+" 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: =head2
-#: ../fish/guestfish-actions.pod:886
-msgid "fallocate64"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7793 ../src/guestfs-structs.pod:175
+msgid "guestfs_version"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:888
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7795
#, no-wrap
msgid ""
-" fallocate64 path len\n"
+" struct guestfs_version *\n"
+" guestfs_version (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:894
+#. type: textblock
+#: ../src/guestfs-actions.pod:7823
msgid ""
-"Note that this call allocates disk blocks for the file. To create a sparse "
-"file use C<truncate-size> instead."
+"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
-#: ../fish/guestfish-actions.pod:897
+#. type: textblock
+#: ../src/guestfs-actions.pod:7829
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."
+"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: =head2
-#: ../fish/guestfish-actions.pod:906
-msgid "fgrep"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7833
+msgid "(Added in 1.0.58)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7835
+msgid "guestfs_vfs_label"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:908
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7837
#, no-wrap
msgid ""
-" fgrep pattern path\n"
+" char *\n"
+" guestfs_vfs_label (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:916
-msgid "fgrepi"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7846
+msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:918
+#. type: textblock
+#: ../src/guestfs-actions.pod:7851 ../src/guestfs-actions.pod:7888
+msgid "(Added in 1.3.18)"
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7853
+msgid "guestfs_vfs_type"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7855
#, no-wrap
msgid ""
-" fgrepi pattern path\n"
+" char *\n"
+" guestfs_vfs_type (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:926
-msgid "file"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7872
+msgid "guestfs_vfs_uuid"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:928
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7874
#, no-wrap
msgid ""
-" file path\n"
+" char *\n"
+" guestfs_vfs_uuid (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:940
-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>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7883
+msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:950
-msgid "file-architecture"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7890
+msgid "guestfs_vg_activate"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:952
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7892
#, no-wrap
msgid ""
-" file-architecture filename\n"
+" int\n"
+" guestfs_vg_activate (guestfs_h *g,\n"
+" int activate,\n"
+" char *const *volgroups);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1055
-msgid "filesize"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7909
+msgid "guestfs_vg_activate_all"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1057
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7911
#, no-wrap
msgid ""
-" filesize file\n"
+" int\n"
+" guestfs_vg_activate_all (guestfs_h *g,\n"
+" int activate);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1061
-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>."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1065
-msgid "fill"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7924
+msgid "guestfs_vgcreate"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1067
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7926
#, no-wrap
msgid ""
-" fill c len path\n"
+" int\n"
+" guestfs_vgcreate (guestfs_h *g,\n"
+" const char *volgroup,\n"
+" char *const *physvols);\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"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7938
+msgid "guestfs_vglvuuids"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1080
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7940
#, no-wrap
msgid ""
-" fill-pattern pattern len path\n"
+" char **\n"
+" guestfs_vglvuuids (guestfs_h *g,\n"
+" const char *vgname);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1082
+#. type: textblock
+#: ../src/guestfs-actions.pod:7947
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."
+"You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
+"associate logical volumes and volume groups."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1087
-msgid "find"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7950
+msgid "See also C<guestfs_vgpvuuids>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:7958
+msgid "guestfs_vgpvuuids"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1089
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7960
#, no-wrap
msgid ""
-" find directory\n"
+" char **\n"
+" guestfs_vgpvuuids (guestfs_h *g,\n"
+" const char *vgname);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1103
-msgid "then the returned list from C<find> C</tmp> would be 4 elements:"
+#. type: textblock
+#: ../src/guestfs-actions.pod:7967
+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
-#: ../fish/guestfish-actions.pod:1116
-msgid "See also C<find0>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:7970
+msgid "See also C<guestfs_vglvuuids>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1121
-msgid "find0"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7978
+msgid "guestfs_vgremove"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1123
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7980
#, no-wrap
msgid ""
-" find0 directory (files|-)\n"
+" int\n"
+" guestfs_vgremove (guestfs_h *g,\n"
+" const char *vgname);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1129
-msgid ""
-"This command works the same way as C<find> with the following exceptions:"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1156
-msgid "findfs-label"
+#. type: =head2
+#: ../src/guestfs-actions.pod:7993
+msgid "guestfs_vgrename"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1158
+#. type: verbatim
+#: ../src/guestfs-actions.pod:7995
#, no-wrap
msgid ""
-" findfs-label label\n"
+" int\n"
+" guestfs_vgrename (guestfs_h *g,\n"
+" const char *volgroup,\n"
+" const char *newvolgroup);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1164
-msgid "To find the label of a filesystem, use C<vfs-label>."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1166
-msgid "findfs-uuid"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8006
+msgid "guestfs_vgs"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1168
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8008
#, no-wrap
msgid ""
-" findfs-uuid uuid\n"
+" char **\n"
+" guestfs_vgs (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1174
-msgid "To find the UUID of a filesystem, use C<vfs-uuid>."
+#. type: textblock
+#: ../src/guestfs-actions.pod:8017
+msgid "See also C<guestfs_vgs_full>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1176
-msgid "fsck"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8025
+msgid "guestfs_vgs_full"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1178
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8027
#, no-wrap
msgid ""
-" fsck fstype device\n"
+" struct guestfs_lvm_vg_list *\n"
+" guestfs_vgs_full (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1208
-msgid "get-append"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1210
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:8033
msgid ""
-" get-append\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:1217
-msgid "get-autosync"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8039
+msgid "guestfs_vgscan"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1219
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8041
#, no-wrap
msgid ""
-" get-autosync\n"
+" int\n"
+" guestfs_vgscan (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1223
-msgid "get-direct"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8051
+msgid "guestfs_vguuid"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1225
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8053
#, no-wrap
msgid ""
-" get-direct\n"
+" char *\n"
+" guestfs_vguuid (guestfs_h *g,\n"
+" const char *vgname);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1229
-msgid "get-e2label"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8064
+msgid "guestfs_wait_ready"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1231
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8066
#, no-wrap
msgid ""
-" get-e2label device\n"
+" int\n"
+" guestfs_wait_ready (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1243
-msgid "get-e2uuid"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1245
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:8069
msgid ""
-" get-e2uuid device\n"
-"\n"
+"I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
+"instead."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1257
-msgid "get-memsize"
+#. type: textblock
+#: ../src/guestfs-actions.pod:8076
+msgid "This function is a no op."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1259
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:8078
msgid ""
-" get-memsize\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:1264
+#. type: textblock
+#: ../src/guestfs-actions.pod:8083
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."
+"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
-#: ../fish/guestfish-actions.pod:1271
-msgid "get-network"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8091
+msgid "guestfs_wc_c"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1273
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8093
#, no-wrap
msgid ""
-" get-network\n"
+" int\n"
+" guestfs_wc_c (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1277
-msgid "get-path"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8104
+msgid "guestfs_wc_l"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1279
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8106
#, no-wrap
msgid ""
-" get-path\n"
+" int\n"
+" guestfs_wc_l (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1286
-msgid "get-pid | pid"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8117
+msgid "guestfs_wc_w"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1288
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8119
#, no-wrap
msgid ""
-" get-pid\n"
+" int\n"
+" guestfs_wc_w (guestfs_h *g,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1295
-msgid "get-qemu"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8130
+msgid "guestfs_write"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1297
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8132
#, no-wrap
msgid ""
-" get-qemu\n"
+" int\n"
+" guestfs_write (guestfs_h *g,\n"
+" const char *path,\n"
+" const char *content,\n"
+" size_t content_size);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1304
-msgid "get-recovery-proc"
+#. type: textblock
+#: ../src/guestfs-actions.pod:8141
+msgid "See also C<guestfs_write_append>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:8150
+msgid "guestfs_write_append"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1306
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8152
#, no-wrap
msgid ""
-" get-recovery-proc\n"
+" int\n"
+" guestfs_write_append (guestfs_h *g,\n"
+" const char *path,\n"
+" const char *content,\n"
+" size_t content_size);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1310
-msgid "get-selinux"
+#. type: textblock
+#: ../src/guestfs-actions.pod:8161
+msgid "See also C<guestfs_write>."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs-actions.pod:8170
+msgid "guestfs_write_file"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1312
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8172
#, no-wrap
msgid ""
-" get-selinux\n"
+" int\n"
+" guestfs_write_file (guestfs_h *g,\n"
+" const char *path,\n"
+" const char *content,\n"
+" int size);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1314
+#. type: textblock
+#: ../src/guestfs-actions.pod:8178
msgid ""
-"This returns the current setting of the selinux flag which is passed to the "
-"appliance at boot time. See C<set-selinux>."
+"I<This function is deprecated.> In new code, use the L</guestfs_write> call "
+"instead."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1320
-msgid "get-state"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8203
+msgid "guestfs_zegrep"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1322
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8205
#, no-wrap
msgid ""
-" get-state\n"
+" char **\n"
+" guestfs_zegrep (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1329
-msgid "get-trace"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8222
+msgid "guestfs_zegrepi"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1331
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8224
#, no-wrap
msgid ""
-" get-trace\n"
+" char **\n"
+" guestfs_zegrepi (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1335
-msgid "get-umask"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8241
+msgid "guestfs_zero"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1337
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8243
#, no-wrap
msgid ""
-" get-umask\n"
+" int\n"
+" guestfs_zero (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1339
+#. type: textblock
+#: ../src/guestfs-actions.pod:8257
msgid ""
-"Return the current umask. By default the umask is C<022> unless it has been "
-"set by calling C<umask>."
+"See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
+"C<guestfs_is_zero_device>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1342
-msgid "get-verbose"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8269
+msgid "guestfs_zero_device"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1344
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8271
#, no-wrap
msgid ""
-" get-verbose\n"
+" int\n"
+" guestfs_zero_device (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1348
-msgid "getcon"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1350
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:8275
msgid ""
-" getcon\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:1354
-msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<setcon>"
+#. type: textblock
+#: ../src/guestfs-actions.pod:8293
+msgid "(Added in 1.3.1)"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1357
-msgid "getxattrs"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8295
+msgid "guestfs_zerofree"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1359
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8297
#, no-wrap
msgid ""
-" getxattrs path\n"
+" int\n"
+" guestfs_zerofree (guestfs_h *g,\n"
+" const char *device);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1367
-msgid "See also: C<lgetxattrs>, L<attr(5)>."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1369
-msgid "glob-expand"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8316
+msgid "guestfs_zfgrep"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1371
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8318
#, no-wrap
msgid ""
-" glob-expand pattern\n"
+" char **\n"
+" guestfs_zfgrep (guestfs_h *g,\n"
+" const char *pattern,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1384
-msgid "grep"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8335
+msgid "guestfs_zfgrepi"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1386
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8337
#, no-wrap
msgid ""
-" grep regex path\n"
+" char **\n"
+" guestfs_zfgrepi (guestfs_h *g,\n"
+" const char *pattern,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1394
-msgid "grepi"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8354
+msgid "guestfs_zfile"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1396
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8356
#, no-wrap
msgid ""
-" grepi regex path\n"
+" char *\n"
+" guestfs_zfile (guestfs_h *g,\n"
+" const char *meth,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1404
-msgid "grub-install"
+#. type: textblock
+#: ../src/guestfs-actions.pod:8361
+msgid ""
+"I<This function is deprecated.> In new code, use the L</guestfs_file> call "
+"instead."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1406
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-actions.pod:8373
msgid ""
-" grub-install root device\n"
-"\n"
+"Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
+"files."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1422
-msgid "head"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8381
+msgid "guestfs_zgrep"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1424
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8383
#, no-wrap
msgid ""
-" head path\n"
+" char **\n"
+" guestfs_zgrep (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1432
-msgid "head-n"
+#. type: =head2
+#: ../src/guestfs-actions.pod:8400
+msgid "guestfs_zgrepi"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1434
+#. type: verbatim
+#: ../src/guestfs-actions.pod:8402
#, no-wrap
msgid ""
-" head-n nrlines path\n"
+" char **\n"
+" guestfs_zgrepi (guestfs_h *g,\n"
+" const char *regex,\n"
+" const char *path);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1447
-msgid "hexdump"
+#. type: =item
+#: ../src/guestfs-availability.pod:3
+msgid "B<augeas>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1449
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-availability.pod:5
msgid ""
-" hexdump path\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:1457
-msgid "initrd-cat"
+#. type: =item
+#: ../src/guestfs-availability.pod:21
+msgid "B<btrfs>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1459
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-availability.pod:23
+msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs-availability.pod:26
+msgid "B<grub>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-availability.pod:28
+msgid "The following functions: L</guestfs_grub_install>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs-availability.pod:31
+msgid "B<inotify>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-availability.pod:33
msgid ""
-" initrd-cat initrdpath filename\n"
-"\n"
+"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: textblock
-#: ../fish/guestfish-actions.pod:1471
-msgid "See also C<initrd-list>."
+#. type: =item
+#: ../src/guestfs-availability.pod:41
+msgid "B<linuxfsuuid>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1476
-msgid "initrd-list"
+#. type: textblock
+#: ../src/guestfs-availability.pod:43
+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: verbatim
-#: ../fish/guestfish-actions.pod:1478
-#, no-wrap
+#. type: =item
+#: ../src/guestfs-availability.pod:50
+msgid "B<linuxmodules>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-availability.pod:52
+msgid "The following functions: L</guestfs_modprobe>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs-availability.pod:55
+msgid "B<linuxxattrs>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs-availability.pod:57
msgid ""
-" initrd-list path\n"
-"\n"
+"The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
+"guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
+"guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
+"guestfs_setxattr>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1490
-msgid "inotify-add-watch"
+#. type: =item
+#: ../src/guestfs-availability.pod:68
+msgid "B<luks>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1492
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-availability.pod:70
msgid ""
-" inotify-add-watch path mask\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:1504
-msgid "inotify-close"
+#. type: =item
+#: ../src/guestfs-availability.pod:79
+msgid "B<lvm2>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1506
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-availability.pod:81
msgid ""
-" inotify-close\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:1512
-msgid "inotify-files"
+#. type: =item
+#: ../src/guestfs-availability.pod:104
+msgid "B<mknod>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1514
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-availability.pod:106
msgid ""
-" inotify-files\n"
-"\n"
+"The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
+"guestfs_mknod_b> L</guestfs_mknod_c>"
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs-availability.pod:112
+msgid "B<ntfs3g>"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1516
-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."
+#. type: textblock
+#: ../src/guestfs-availability.pod:114
+msgid "The following functions: L</guestfs_ntfs_3g_probe>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1520
-msgid "inotify-init"
+#. type: =item
+#: ../src/guestfs-availability.pod:117
+msgid "B<ntfsprogs>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1522
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs-availability.pod:119
msgid ""
-" inotify-init maxevents\n"
-"\n"
+"The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
+"L</guestfs_ntfsresize_size>"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1528
-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>)."
+#. type: =item
+#: ../src/guestfs-availability.pod:124
+msgid "B<realpath>"
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: textblock
+#: ../src/guestfs-availability.pod:126
+msgid "The following functions: L</guestfs_realpath>"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1544
-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."
+#. type: =item
+#: ../src/guestfs-availability.pod:129
+msgid "B<scrub>"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1551
+#. type: textblock
+#: ../src/guestfs-availability.pod:131
msgid ""
-"The handle should be closed after use by calling C<inotify-close>. This "
-"also removes any watches automatically."
+"The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
+"guestfs_scrub_freespace>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1560
-msgid "inotify-read"
+#. type: =item
+#: ../src/guestfs-availability.pod:136
+msgid "B<selinux>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1562
-#, no-wrap
-msgid ""
-" inotify-read\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs-availability.pod:138
+msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1575
-msgid "inotify-rm-watch"
+#. type: =item
+#: ../src/guestfs-availability.pod:142
+msgid "B<xz>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1577
-#, no-wrap
-msgid ""
-" inotify-rm-watch wd\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs-availability.pod:144
+msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1579
-msgid "Remove a previously defined inotify watch. See C<inotify-add-watch>."
+#. type: =item
+#: ../src/guestfs-availability.pod:148
+msgid "B<zerofree>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1582
-msgid "inspect-get-arch"
+#. type: textblock
+#: ../src/guestfs-availability.pod:150
+msgid "The following functions: L</guestfs_zerofree>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1584
-#, no-wrap
-msgid ""
-" inspect-get-arch root\n"
-"\n"
+#. type: =head2
+#: ../src/guestfs-structs.pod:1
+msgid "guestfs_int_bool"
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
+#. type: verbatim
+#: ../src/guestfs-structs.pod:3
+#, no-wrap
msgid ""
-"This function should only be called with a root device string as returned by "
-"C<inspect-os>."
+" struct guestfs_int_bool {\n"
+" int32_t i;\n"
+" int32_t b;\n"
+" };\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1589
+#. type: verbatim
+#: ../src/guestfs-structs.pod:8
+#, no-wrap
msgid ""
-"This returns the architecture of the inspected operating system. The "
-"possible return values are listed under C<file-architecture>."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1598
-msgid "inspect-get-distro"
+" 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
-#: ../fish/guestfish-actions.pod:1600
+#. type: verbatim
+#: ../src/guestfs-structs.pod:13
#, no-wrap
msgid ""
-" inspect-get-distro root\n"
+" 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
-#: ../fish/guestfish-actions.pod:1644
-msgid "inspect-get-filesystems"
+#. type: =head2
+#: ../src/guestfs-structs.pod:16
+msgid "guestfs_lvm_pv"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1646
+#. type: verbatim
+#: ../src/guestfs-structs.pod:18
#, no-wrap
msgid ""
-" inspect-get-filesystems root\n"
-"\n"
+" 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: textblock
-#: ../fish/guestfish-actions.pod:1659
+#. type: verbatim
+#: ../src/guestfs-structs.pod:36
+#, no-wrap
msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also C<inspect-"
-"get-mountpoints>."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1662
-msgid "inspect-get-major-version"
+" 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
-#: ../fish/guestfish-actions.pod:1664
+#. type: verbatim
+#: ../src/guestfs-structs.pod:41
#, no-wrap
msgid ""
-" inspect-get-major-version root\n"
+" 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
-#: ../fish/guestfish-actions.pod:1683
-msgid "inspect-get-minor-version"
+#. type: =head2
+#: ../src/guestfs-structs.pod:44
+msgid "guestfs_lvm_vg"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1685
+#. type: verbatim
+#: ../src/guestfs-structs.pod:46
#, no-wrap
msgid ""
-" inspect-get-minor-version root\n"
-"\n"
+" 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: textblock
-#: ../fish/guestfish-actions.pod:1695
+#. type: verbatim
+#: ../src/guestfs-structs.pod:69
+#, no-wrap
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"
+" 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
-#: ../fish/guestfish-actions.pod:1700
+#. type: verbatim
+#: ../src/guestfs-structs.pod:74
#, no-wrap
msgid ""
-" inspect-get-mountpoints root\n"
+" 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: textblock
-#: ../fish/guestfish-actions.pod:1718
-msgid ""
-"Please read L<guestfs(3)/INSPECTION> for more details. See also C<inspect-"
-"get-filesystems>."
+#. type: =head2
+#: ../src/guestfs-structs.pod:77
+msgid "guestfs_lvm_lv"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1721
-msgid "inspect-get-product-name"
+#. 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
-#: ../fish/guestfish-actions.pod:1723
+#. type: verbatim
+#: ../src/guestfs-structs.pod:101
#, no-wrap
msgid ""
-" inspect-get-product-name root\n"
-"\n"
+" 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: =head2
-#: ../fish/guestfish-actions.pod:1738
-msgid "inspect-get-type"
+#. 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
-#: ../fish/guestfish-actions.pod:1740
+#. type: verbatim
+#: ../src/guestfs-structs.pod:111
#, no-wrap
msgid ""
-" inspect-get-type root\n"
-"\n"
+" 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: =head2
-#: ../fish/guestfish-actions.pod:1769
-msgid "inspect-os"
+#. 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
-#: ../fish/guestfish-actions.pod:1771
+#. type: verbatim
+#: ../src/guestfs-structs.pod:132
#, no-wrap
msgid ""
-" inspect-os\n"
+" void guestfs_free_stat (struct guestfs_free_stat *);\n"
+" void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1786
+#. type: verbatim
+#: ../src/guestfs-structs.pod:137
+#, no-wrap
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."
+" 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"
+" int64_t ffree;\n"
+" int64_t favail;\n"
+" int64_t fsid;\n"
+" int64_t flag;\n"
+" int64_t namemax;\n"
+" };\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1791
+#. type: verbatim
+#: ../src/guestfs-structs.pod:151
+#, no-wrap
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."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1803
-msgid "is-blockdev"
+" 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
-#: ../fish/guestfish-actions.pod:1805
+#. type: verbatim
+#: ../src/guestfs-structs.pod:156
#, no-wrap
msgid ""
-" is-blockdev path\n"
+" void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
+" void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\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"
+#. type: =head2
+#: ../src/guestfs-structs.pod:159
+msgid "guestfs_dirent"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1814
+#. type: verbatim
+#: ../src/guestfs-structs.pod:161
#, no-wrap
msgid ""
-" is-busy\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1821
-msgid "is-chardev"
+" struct guestfs_dirent {\n"
+" int64_t ino;\n"
+" char ftyp;\n"
+" char *name;\n"
+" };\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1823
+#. type: verbatim
+#: ../src/guestfs-structs.pod:167
#, no-wrap
msgid ""
-" is-chardev path\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1830
-msgid "is-config"
+" 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
-#: ../fish/guestfish-actions.pod:1832
+#. type: verbatim
+#: ../src/guestfs-structs.pod:172
#, no-wrap
msgid ""
-" is-config\n"
+" void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
+" void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1839
-msgid "is-dir"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1841
+#. type: verbatim
+#: ../src/guestfs-structs.pod:177
#, no-wrap
msgid ""
-" is-dir path\n"
-"\n"
+" struct guestfs_version {\n"
+" int64_t major;\n"
+" int64_t minor;\n"
+" int64_t release;\n"
+" char *extra;\n"
+" };\n"
+" \n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1849
-msgid "is-fifo"
+#. 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
-#: ../fish/guestfish-actions.pod:1851
+#. type: verbatim
+#: ../src/guestfs-structs.pod:189
#, no-wrap
msgid ""
-" is-fifo path\n"
+" void guestfs_free_version (struct guestfs_free_version *);\n"
+" void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1858
-msgid "is-file"
+#. type: =head2
+#: ../src/guestfs-structs.pod:192
+msgid "guestfs_xattr"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1860
+#. type: verbatim
+#: ../src/guestfs-structs.pod:194
#, no-wrap
msgid ""
-" is-file path\n"
-"\n"
+" 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: =head2
-#: ../fish/guestfish-actions.pod:1868
-msgid "is-launching"
+#. 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
-#: ../fish/guestfish-actions.pod:1870
+#. type: verbatim
+#: ../src/guestfs-structs.pod:206
#, no-wrap
msgid ""
-" is-launching\n"
+" void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
+" void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1877
-msgid "is-lv"
+#. type: =head2
+#: ../src/guestfs-structs.pod:209
+msgid "guestfs_inotify_event"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1879
+#. type: verbatim
+#: ../src/guestfs-structs.pod:211
#, no-wrap
msgid ""
-" is-lv device\n"
-"\n"
+" 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: =head2
-#: ../fish/guestfish-actions.pod:1884
-msgid "is-ready"
+#. 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
-#: ../fish/guestfish-actions.pod:1886
+#. type: verbatim
+#: ../src/guestfs-structs.pod:223
#, no-wrap
msgid ""
-" is-ready\n"
+" 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
-#: ../fish/guestfish-actions.pod:1893
-msgid "is-socket"
+#. type: =head2
+#: ../src/guestfs-structs.pod:226
+msgid "guestfs_partition"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1895
+#. type: verbatim
+#: ../src/guestfs-structs.pod:228
#, no-wrap
msgid ""
-" is-socket path\n"
-"\n"
+" 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: =head2
-#: ../fish/guestfish-actions.pod:1902
-msgid "is-symlink"
+#. 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
-#: ../fish/guestfish-actions.pod:1904
+#. type: verbatim
+#: ../src/guestfs-structs.pod:240
#, no-wrap
msgid ""
-" is-symlink path\n"
+" void guestfs_free_partition (struct guestfs_free_partition *);\n"
+" void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1911
-msgid "kill-subprocess"
+#. type: =head2
+#: ../src/guestfs-structs.pod:243
+msgid "guestfs_application"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1913
+#. type: verbatim
+#: ../src/guestfs-structs.pod:245
#, no-wrap
msgid ""
-" kill-subprocess\n"
-"\n"
+" struct guestfs_application {\n"
+" char *app_name;\n"
+" char *app_display_name;\n"
+" int32_t app_epoch;\n"
+" char *app_version;\n"
+" char *app_release;\n"
+" char *app_install_path;\n"
+" char *app_trans_path;\n"
+" char *app_publisher;\n"
+" char *app_url;\n"
+" char *app_source_package;\n"
+" char *app_summary;\n"
+" char *app_description;\n"
+" };\n"
+" \n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1917
-msgid "launch | run"
+#. type: verbatim
+#: ../src/guestfs-structs.pod:260
+#, no-wrap
+msgid ""
+" struct guestfs_application_list {\n"
+" uint32_t len; /* Number of elements in list. */\n"
+" struct guestfs_application *val; /* Elements. */\n"
+" };\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1919
+#. type: verbatim
+#: ../src/guestfs-structs.pod:265
#, no-wrap
msgid ""
-" launch\n"
+" void guestfs_free_application (struct guestfs_free_application *);\n"
+" void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1927
-msgid "lchown"
+#. type: textblock
+#: ../src/guestfs.pod:5
+msgid "guestfs - Library for accessing and modifying virtual machine images"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1929
+#. type: verbatim
+#: ../src/guestfs.pod:11
#, no-wrap
msgid ""
-" lchown owner group path\n"
+" guestfs_h *g = guestfs_create ();\n"
+" guestfs_add_drive (g, \"guest.img\");\n"
+" guestfs_launch (g);\n"
+" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
+" guestfs_touch (g, \"/hello\");\n"
+" guestfs_umount (g, \"/\");\n"
+" guestfs_close (g);\n"
"\n"
msgstr ""
+" guestfs_h *g = guestfs_create ();\n"
+" guestfs_add_drive (g, \"guest.img\");\n"
+" guestfs_launch (g);\n"
+" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
+" guestfs_touch (g, \"/hello\");\n"
+" guestfs_umount (g, \"/\");\n"
+" guestfs_close (g);\n"
+"\n"
-# type: textblock
-#: ../fish/guestfish-actions.pod:1931
+#. type: textblock
+#: ../src/guestfs.pod:25
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."
+"Libguestfs is a library for accessing and modifying guest disk images. "
+"Amongst the things this is good for: making batch configuration changes to "
+"guests, getting disk used/free statistics (see also: virt-df), migrating "
+"between virtualization systems (see also: virt-p2v), performing partial "
+"backups, performing partial guest clones, cloning guests and changing "
+"registry/UUID/hostname info, and much else besides."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1939
-msgid "lgetxattrs"
+#. type: textblock
+#: ../src/guestfs.pod:33
+msgid ""
+"Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
+"filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
+"btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
+"qcow2, vmdk."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1941
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:38
msgid ""
-" lgetxattrs path\n"
-"\n"
+"Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
+"what filesystem is in each LV, etc.). It can also run commands in the "
+"context of the guest. Also you can access filesystems over FUSE."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1943
+#. type: textblock
+#: ../src/guestfs.pod:43
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."
+"Libguestfs is a library that can be linked with C and C++ management "
+"programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
+"PHP, Erlang, Haskell or C#). You can also use it from shell scripts or the "
+"command line."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1947
-msgid "list-devices"
+#. type: textblock
+#: ../src/guestfs.pod:48
+msgid ""
+"You don't need to be root to use libguestfs, although obviously you do need "
+"enough permissions to access the disk images."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1949
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:51
msgid ""
-" list-devices\n"
-"\n"
+"Libguestfs is a large API because it can do many things. For a gentle "
+"introduction, please read the L</API OVERVIEW> section next."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1955
-msgid "list-partitions"
+#. type: textblock
+#: ../src/guestfs.pod:54
+msgid ""
+"There are also some example programs in the L<guestfs-examples(3)> manual "
+"page."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1957
-#, no-wrap
-msgid ""
-" list-partitions\n"
-"\n"
+#. type: =head1
+#: ../src/guestfs.pod:57
+msgid "API OVERVIEW"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:1963
+#. type: textblock
+#: ../src/guestfs.pod:59
msgid ""
-"This does not return logical volumes. For that you will need to call C<lvs>."
+"This section provides a gentler overview of the libguestfs API. We also try "
+"to group API calls together, where that may not be obvious from reading "
+"about the individual calls in the main section of this manual."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1966
-msgid "ll"
+#. type: =head2
+#: ../src/guestfs.pod:64
+msgid "HANDLES"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1968
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:66
msgid ""
-" ll directory\n"
-"\n"
+"Before you can use libguestfs calls, you have to create a handle. Then you "
+"must add at least one disk image to the handle, followed by launching the "
+"handle, then performing whatever operations you want, and finally closing "
+"the handle. By convention we use the single letter C<g> for the name of the "
+"handle variable, although of course you can use any name you want."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1976
-msgid "ln"
+#. type: textblock
+#: ../src/guestfs.pod:73
+msgid "The general structure of all libguestfs-using programs looks like this:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1978
+#. type: verbatim
+#: ../src/guestfs.pod:76
#, no-wrap
msgid ""
-" ln target linkname\n"
-"\n"
+" guestfs_h *g = guestfs_create ();\n"
+" \n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1982
-msgid "ln-f"
+#. type: verbatim
+#: ../src/guestfs.pod:78
+#, no-wrap
+msgid ""
+" /* Call guestfs_add_drive additional times if there are\n"
+" * multiple disk images.\n"
+" */\n"
+" guestfs_add_drive (g, \"guest.img\");\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1984
+#. type: verbatim
+#: ../src/guestfs.pod:83
#, no-wrap
msgid ""
-" ln-f target linkname\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:1989
-msgid "ln-s"
+" /* Most manipulation calls won't work until you've launched\n"
+" * the handle 'g'. You have to do this _after_ adding drives\n"
+" * and _before_ other commands.\n"
+" */\n"
+" guestfs_launch (g);\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1991
+#. type: verbatim
+#: ../src/guestfs.pod:89
#, no-wrap
msgid ""
-" ln-s target linkname\n"
-"\n"
+" /* Now you can examine what partitions, LVs etc are available.\n"
+" */\n"
+" char **partitions = guestfs_list_partitions (g);\n"
+" char **logvols = guestfs_lvs (g);\n"
+" \n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:1995
-msgid "ln-sf"
+#. type: verbatim
+#: ../src/guestfs.pod:94
+#, no-wrap
+msgid ""
+" /* To access a filesystem in the image, you must mount it.\n"
+" */\n"
+" guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:1997
+#. type: verbatim
+#: ../src/guestfs.pod:98
#, no-wrap
msgid ""
-" ln-sf target linkname\n"
-"\n"
+" /* Now you can perform filesystem actions on the guest\n"
+" * disk image.\n"
+" */\n"
+" guestfs_touch (g, \"/hello\");\n"
+" \n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2002
-msgid "lremovexattr"
+#. type: verbatim
+#: ../src/guestfs.pod:103
+#, no-wrap
+msgid ""
+" /* This is only needed for libguestfs < 1.5.24. Since then\n"
+" * it is done automatically when you close the handle. See\n"
+" * discussion of autosync in this page.\n"
+" */\n"
+" guestfs_sync (g);\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2004
+#. type: verbatim
+#: ../src/guestfs.pod:109
#, no-wrap
msgid ""
-" lremovexattr xattr path\n"
+" /* Close the handle 'g'. */\n"
+" guestfs_close (g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2006
+#. type: textblock
+#: ../src/guestfs.pod:112
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."
+"The code above doesn't include any error checking. In real code you should "
+"check return values carefully for errors. In general all functions that "
+"return integers return C<-1> on error, and all functions that return "
+"pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
+"how to handle errors, and consult the documentation for each function call "
+"below to see precisely how they return error indications. See L<guestfs-"
+"examples(3)> for fully worked examples."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2010
-msgid "ls"
+#. type: =head2
+#: ../src/guestfs.pod:121
+msgid "DISK IMAGES"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2012
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:123
msgid ""
-" ls directory\n"
-"\n"
+"The image filename (C<\"guest.img\"> in the example above) could be a disk "
+"image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
+"actual block device, or simply an empty file of zeroes that you have created "
+"through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
+"of these."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2018
+#. type: textblock
+#: ../src/guestfs.pod:129
msgid ""
-"This command is mostly useful for interactive sessions. Programs should "
-"probably use C<readdir> instead."
+"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: =head2
-#: ../fish/guestfish-actions.pod:2021
-msgid "lsetxattr"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2023
+#. type: verbatim
+#: ../src/guestfs.pod:133
#, no-wrap
msgid ""
-" lsetxattr xattr val vallen path\n"
+" guestfs_add_drive_opts (g, filename,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
+" -1);\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"
+#. type: textblock
+#: ../src/guestfs.pod:137
+msgid "You can add a disk read-only using:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2031
+#. type: verbatim
+#: ../src/guestfs.pod:139
#, no-wrap
msgid ""
-" lstat path\n"
+" 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
-#: ../fish/guestfish-actions.pod:2035
+#. type: textblock
+#: ../src/guestfs.pod:144
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."
+"or by calling the older function L</guestfs_add_drive_ro>. In either case "
+"libguestfs won't modify the file."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2041
-msgid "lstatlist"
+#. type: textblock
+#: ../src/guestfs.pod:147
+msgid ""
+"Be extremely cautious if the disk image is in use, eg. if it is being used "
+"by a virtual machine. Adding it read-write will almost certainly cause disk "
+"corruption, but adding it read-only is safe."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2043
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:151
msgid ""
-" lstatlist path 'names ...'\n"
-"\n"
+"You must add at least one disk image, and you may add multiple disk images. "
+"In the API, the disk images are usually referred to as C</dev/sda> (for the "
+"first one you added), C</dev/sdb> (for the second one you added), etc."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2045
+#. type: textblock
+#: ../src/guestfs.pod:156
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."
+"Once L</guestfs_launch> has been called you cannot add any more images. You "
+"can call L</guestfs_list_devices> to get a list of the device names, in the "
+"order that you added them. See also L</BLOCK DEVICE NAMING> below."
msgstr ""
-# type: 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."
+#. type: =head2
+#: ../src/guestfs.pod:161
+msgid "MOUNTING"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2062
-msgid "luks-add-key"
+#. type: textblock
+#: ../src/guestfs.pod:163
+msgid ""
+"Before you can read or write files, create directories and so on in a disk "
+"image that contains filesystems, you have to mount those filesystems using "
+"L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
+"a disk image contains (for example) one partition with a filesystem on that "
+"partition, then you can mount it directly:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2064
+#. type: verbatim
+#: ../src/guestfs.pod:170
#, no-wrap
msgid ""
-" luks-add-key device keyslot\n"
+" guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2071
+#. type: textblock
+#: ../src/guestfs.pod:172
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."
+"where C</dev/sda1> means literally the first partition (C<1>) of the first "
+"disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
+"logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
+"that these are libguestfs virtual devices, and are nothing to do with host "
+"devices."
msgstr ""
-# type: textblock
-#: ../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
+#. type: textblock
+#: ../src/guestfs.pod:178
msgid ""
-"This command has one or more key or passphrase parameters. Guestfish will "
-"prompt for these separately."
+"If you are given a disk image and you don't know what it contains then you "
+"have to find out. Libguestfs can do that too: use L</"
+"guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
+"LVs, and either try mounting each to see what is mountable, or else examine "
+"them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
+"filesystems, use L</guestfs_list_filesystems>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2078
-msgid "luks-close"
+#. type: textblock
+#: ../src/guestfs.pod:186
+msgid ""
+"Libguestfs also has a set of APIs for inspection of unknown disk images (see "
+"L</INSPECTION> below). But you might find it easier to look at higher level "
+"programs built on top of libguestfs, in particular L<virt-inspector(1)>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2080
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:191
msgid ""
-" luks-close device\n"
-"\n"
+"To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
+"several other variations of the C<guestfs_mount_*> call."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2082
-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."
+#. type: =head2
+#: ../src/guestfs.pod:194
+msgid "FILESYSTEM ACCESS AND MODIFICATION"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2088
-msgid "luks-format"
+#. type: textblock
+#: ../src/guestfs.pod:196
+msgid ""
+"The majority of the libguestfs API consists of fairly low-level calls for "
+"accessing and modifying the files, directories, symlinks etc on mounted "
+"filesystems. There are over a hundred such calls which you can find listed "
+"in detail below in this man page, and we don't even pretend to cover them "
+"all in this overview."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2090
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:202
msgid ""
-" luks-format device keyslot\n"
-"\n"
+"Specify filenames as full paths, starting with C<\"/\"> and including the "
+"mount point."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2103
-msgid "luks-format-cipher"
+#. type: textblock
+#: ../src/guestfs.pod:205
+msgid ""
+"For example, if you mounted a filesystem at C<\"/\"> and you want to read "
+"the file called C<\"etc/passwd\"> then you could do:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2105
+#. type: verbatim
+#: ../src/guestfs.pod:208
#, no-wrap
msgid ""
-" luks-format-cipher device keyslot cipher\n"
+" char *data = guestfs_cat (g, \"/etc/passwd\");\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2107
+#. type: textblock
+#: ../src/guestfs.pod:210
msgid ""
-"This command is the same as C<luks-format> but it also allows you to set the "
-"C<cipher> used."
+"This would return C<data> as a newly allocated buffer containing the full "
+"content of that file (with some conditions: see also L</DOWNLOADING> below), "
+"or C<NULL> if there was an error."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2116
-msgid "luks-kill-slot"
+#. type: textblock
+#: ../src/guestfs.pod:214
+msgid ""
+"As another example, to create a top-level directory on that filesystem "
+"called C<\"var\"> you would do:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2118
+#. type: verbatim
+#: ../src/guestfs.pod:217
#, no-wrap
msgid ""
-" luks-kill-slot device keyslot\n"
+" guestfs_mkdir (g, \"/var\");\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2127
-msgid "luks-open"
+#. type: textblock
+#: ../src/guestfs.pod:219
+msgid "To create a symlink you could do:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2129
+#. type: verbatim
+#: ../src/guestfs.pod:221
#, no-wrap
msgid ""
-" luks-open device mapname\n"
+" guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
+" \"/etc/rc3.d/S30portmap\");\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2143
+#. type: textblock
+#: ../src/guestfs.pod:224
msgid ""
-"If this block device contains LVM volume groups, then calling C<vgscan> "
-"followed by C<vg-activate-all> will make them visible."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2150
-msgid "luks-open-ro"
+"Libguestfs will reject attempts to use relative paths and there is no "
+"concept of a current working directory."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2152
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:227
msgid ""
-" luks-open-ro device mapname\n"
-"\n"
+"Libguestfs can return errors in many situations: for example if the "
+"filesystem isn't writable, or if a file or directory that you requested "
+"doesn't exist. If you are using the C API (documented here) you have to "
+"check for those error conditions after each call. (Other language bindings "
+"turn these errors into exceptions)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2154
+#. type: textblock
+#: ../src/guestfs.pod:233
msgid ""
-"This is the same as C<luks-open> except that a read-only mapping is created."
+"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
-#: ../fish/guestfish-actions.pod:2160
-msgid "lvcreate"
+#. type: =head2
+#: ../src/guestfs.pod:236
+msgid "PARTITIONING"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2162
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:238
msgid ""
-" lvcreate logvol volgroup mbytes\n"
-"\n"
+"Libguestfs contains API calls to read, create and modify partition tables on "
+"disk images."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2167
-msgid "lvm-clear-filter"
+#. type: textblock
+#: ../src/guestfs.pod:241
+msgid ""
+"In the common case where you want to create a single partition covering the "
+"whole disk, you should use the L</guestfs_part_disk> call:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2169
+#. type: verbatim
+#: ../src/guestfs.pod:245
#, no-wrap
msgid ""
-" lvm-clear-filter\n"
+" const char *parttype = \"mbr\";\n"
+" if (disk_is_larger_than_2TB)\n"
+" parttype = \"gpt\";\n"
+" guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2171
+#. type: textblock
+#: ../src/guestfs.pod:250
msgid ""
-"This undoes the effect of C<lvm-set-filter>. LVM will be able to see every "
-"block device."
+"Obviously this effectively wipes anything that was on that disk image before."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2177
-msgid "lvm-remove-all"
+#. type: =head2
+#: ../src/guestfs.pod:253
+msgid "LVM2"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2179
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:255
msgid ""
-" lvm-remove-all\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2187
-msgid "lvm-set-filter"
+"Libguestfs provides access to a large part of the LVM2 API, such as L</"
+"guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
+"you familiarize yourself with the concepts of physical volumes, volume "
+"groups and logical volumes."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2189
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:260
msgid ""
-" lvm-set-filter 'devices ...'\n"
-"\n"
+"This author strongly recommends reading the LVM HOWTO, online at L<http://"
+"tldp.org/HOWTO/LVM-HOWTO/>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2214
-msgid "lvremove"
+#. type: =head2
+#: ../src/guestfs.pod:263
+msgid "DOWNLOADING"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2216
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:265
msgid ""
-" lvremove device\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2224
-msgid "lvrename"
+"Use L</guestfs_cat> to download small, text only files. This call is "
+"limited to files which are less than 2 MB and which cannot contain any ASCII "
+"NUL (C<\\0>) characters. However the API is very simple to use."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2226
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:269
msgid ""
-" lvrename logvol newlogvol\n"
-"\n"
+"L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
+"bit data, since it returns a (pointer, size) pair. However it is still "
+"limited to \"small\" files, less than 2 MB."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2230
-msgid "lvresize"
+#. type: textblock
+#: ../src/guestfs.pod:273
+msgid ""
+"L</guestfs_download> can be used to download any file, with no limits on "
+"content or size (even files larger than 4 GB)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2232
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:276
msgid ""
-" lvresize device mbytes\n"
-"\n"
+"To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2238
-msgid "lvresize-free"
+#. type: =head2
+#: ../src/guestfs.pod:279
+msgid "UPLOADING"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2240
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:281
msgid ""
-" lvresize-free lv percent\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2248
-msgid "lvs"
+"It's often the case that you want to write a file or files to the disk image."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2250
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:284
msgid ""
-" lvs\n"
-"\n"
+"To write a small file with fixed content, use L</guestfs_write>. To create "
+"a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
+"guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
+"of other functions for creating test files, for example L</guestfs_fill> and "
+"L</guestfs_fill_pattern>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2258
-msgid "See also C<lvs-full>."
+#. type: textblock
+#: ../src/guestfs.pod:290
+msgid ""
+"To upload a single file, use L</guestfs_upload>. This call has no limits on "
+"file content or size (even files larger than 4 GB)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2260
-msgid "lvs-full"
+#. type: textblock
+#: ../src/guestfs.pod:293
+msgid ""
+"To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2262
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:295
msgid ""
-" lvs-full\n"
-"\n"
+"However the fastest way to upload I<large numbers of arbitrary files> is to "
+"turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
+">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
+"in a predictable way (eg. adding it last after all other drives) then you "
+"can get the device name from L</guestfs_list_devices> and mount it directly "
+"using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
+"portable between kernel versions, and they don't support labels or UUIDs. "
+"If you want to pre-build an image or you need to mount it using a label or "
+"UUID, use an ISO image instead."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2267
-msgid "lvuuid"
+#. type: =head2
+#: ../src/guestfs.pod:306
+msgid "COPYING"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2269
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:308
msgid ""
-" lvuuid device\n"
-"\n"
+"There are various different commands for copying between files and devices "
+"and in and out of the guest filesystem. These are summarised in the table "
+"below."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2273
-msgid "lxattrlist"
+#. type: =item
+#: ../src/guestfs.pod:314
+msgid "B<file> to B<file>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2275
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:316
msgid ""
-" lxattrlist path 'names ...'\n"
-"\n"
+"Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
+"directories recursively."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2291
+#. type: textblock
+#: ../src/guestfs.pod:319
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."
+"To copy part of a file (offset and size) use L</guestfs_copy_file_to_file>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2299
-msgid "mkdir"
+#. type: =item
+#: ../src/guestfs.pod:322
+msgid "B<file> to B<device>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2301
-#, no-wrap
-msgid ""
-" mkdir path\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:324
+msgid "B<device> to B<file>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2305
-msgid "mkdir-mode"
+#. type: =item
+#: ../src/guestfs.pod:326
+msgid "B<device> to B<device>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2307
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:328
msgid ""
-" mkdir-mode path mode\n"
-"\n"
+"Use L</guestfs_copy_file_to_device>, L</guestfs_copy_device_to_file>, or L</"
+"guestfs_copy_device_to_device>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2316
-msgid "See also C<mkdir>, C<umask>"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2318
-msgid "mkdir-p"
+#. type: textblock
+#: ../src/guestfs.pod:331
+msgid "Example: duplicate the contents of an LV:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2320
+#. type: verbatim
+#: ../src/guestfs.pod:333
#, no-wrap
msgid ""
-" mkdir-p path\n"
+" guestfs_copy_device_to_device (g,\n"
+" \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
+" /* -1 marks the end of the list of optional parameters */\n"
+" -1);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2325
-msgid "mkdtemp"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2327
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:338
msgid ""
-" mkdtemp template\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2348
-msgid "mke2fs-J"
+"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 the "
+"optional C<size> parameter:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2350
+#. type: verbatim
+#: ../src/guestfs.pod:342
#, no-wrap
msgid ""
-" mke2fs-J fstype blocksize device journal\n"
+" guestfs_copy_device_to_device (g,\n"
+" \"/dev/VG/Original\", \"/dev/VG/Copy\",\n"
+" GUESTFS_COPY_DEVICE_TO_DEVICE_SIZE, 10000,\n"
+" -1);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2358
-msgid "See also C<mke2journal>."
+#. type: =item
+#: ../src/guestfs.pod:347
+msgid "B<file on the host> to B<file or device>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2360
-msgid "mke2fs-JL"
+#. type: textblock
+#: ../src/guestfs.pod:349
+msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2362
-#, no-wrap
-msgid ""
-" mke2fs-JL fstype blocksize device label\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:351
+msgid "B<file or device> to B<file on the host>"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2367
-msgid "See also C<mke2journal-L>."
+#. type: textblock
+#: ../src/guestfs.pod:353
+msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2369
-msgid "mke2fs-JU"
+#. type: =head2
+#: ../src/guestfs.pod:357
+msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2371
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:359
msgid ""
-" mke2fs-JU fstype blocksize device uuid\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:2376
-msgid "See also C<mke2journal-U>."
+"Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
+"guestfs_tar_out> etc appear to only take filenames as arguments, so it "
+"appears you can only upload and download to files. However many Un*x-like "
+"hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
+"dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
+"and arbitrary file descriptor N."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2378
-msgid "mke2journal"
+#. type: textblock
+#: ../src/guestfs.pod:367
+msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2380
+#. type: verbatim
+#: ../src/guestfs.pod:370
#, no-wrap
msgid ""
-" mke2journal blocksize device\n"
+" guestfs_download (g, filename, \"/dev/stdout\");\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2387
-msgid "mke2journal-L"
+#. type: textblock
+#: ../src/guestfs.pod:372
+msgid "and you can write tar output to a file descriptor C<fd> by doing:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2389
+#. type: verbatim
+#: ../src/guestfs.pod:374
#, no-wrap
msgid ""
-" mke2journal-L blocksize label device\n"
+" char devfd[64];\n"
+" snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
+" guestfs_tar_out (g, \"/\", devfd);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2393
-msgid "mke2journal-U"
+#. type: =head2
+#: ../src/guestfs.pod:378
+msgid "LISTING FILES"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2395
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:380
msgid ""
-" mke2journal-U blocksize uuid device\n"
-"\n"
+"L</guestfs_ll> is just designed for humans to read (mainly when using the "
+"L<guestfish(1)>-equivalent command C<ll>)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2399
-msgid "mkfifo"
+#. type: textblock
+#: ../src/guestfs.pod:383
+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: verbatim
-#: ../fish/guestfish-actions.pod:2401
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:386
msgid ""
-" mkfifo mode path\n"
-"\n"
+"L</guestfs_readdir> is a programmatic way to get a list of files in a "
+"directory, plus additional information about each one. It is more "
+"equivalent to using the L<readdir(3)> call on a local filesystem."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2403
+#. type: textblock
+#: ../src/guestfs.pod:390
msgid ""
-"This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
-"is just a convenient wrapper around C<mknod>."
+"L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2409
-msgid "mkfs"
+#. type: =head2
+#: ../src/guestfs.pod:393
+msgid "RUNNING COMMANDS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2411
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:395
msgid ""
-" mkfs fstype device\n"
-"\n"
+"Although libguestfs is primarily an API for manipulating files inside guest "
+"images, we also provide some limited facilities for running commands inside "
+"guests."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2417
-msgid "mkfs-b"
+#. type: textblock
+#: ../src/guestfs.pod:399
+msgid "There are many limitations to this:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2419
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:405
msgid ""
-" mkfs-b fstype blocksize device\n"
-"\n"
+"The kernel version that the command runs under will be different from what "
+"it expects."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2421
+#. type: textblock
+#: ../src/guestfs.pod:410
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."
+"If the command needs to communicate with daemons, then most likely they "
+"won't be running."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2429
-msgid "mkmountpoint"
+#. type: textblock
+#: ../src/guestfs.pod:415
+msgid "The command will be running in limited memory."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2431
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:419
msgid ""
-" mkmountpoint exemptpath\n"
-"\n"
+"The network may not be available unless you enable it (see L</"
+"guestfs_set_network>)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2433
-msgid ""
-"C<mkmountpoint> and C<rmmountpoint> are specialized calls that can be used "
-"to create extra mountpoints before mounting the first filesystem."
+#. type: textblock
+#: ../src/guestfs.pod:424
+msgid "Only supports Linux guests (not Windows, BSD, etc)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2457
-msgid "mknod"
+#. type: textblock
+#: ../src/guestfs.pod:428
+msgid ""
+"Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2459
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:433
msgid ""
-" mknod mode devmajor devminor path\n"
-"\n"
+"For SELinux guests, you may need to enable SELinux and load policy first. "
+"See L</SELINUX> in this manpage."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2469
+#. type: textblock
+#: ../src/guestfs.pod:438
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."
+"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: =head2
-#: ../fish/guestfish-actions.pod:2479
-msgid "mknod-b"
+#. type: textblock
+#: ../src/guestfs.pod:447
+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: verbatim
-#: ../fish/guestfish-actions.pod:2481
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:455
msgid ""
-" mknod-b mode devmajor devminor path\n"
-"\n"
+"The two main API calls to run commands are L</guestfs_command> and L</"
+"guestfs_sh> (there are also variations)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2483
+#. type: textblock
+#: ../src/guestfs.pod:458
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>."
+"The difference is that L</guestfs_sh> runs commands using the shell, so any "
+"shell globs, redirections, etc will work."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2489
-msgid "mknod-c"
+#. type: =head2
+#: ../src/guestfs.pod:461
+msgid "CONFIGURATION FILES"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2491
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:463
msgid ""
-" mknod-c mode devmajor devminor path\n"
-"\n"
+"To read and write configuration files in Linux guest filesystems, we "
+"strongly recommend using Augeas. For example, Augeas understands how to "
+"read and write, say, a Linux shadow password file or X.org configuration "
+"file, and so avoids you having to write that code."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2493
+#. type: textblock
+#: ../src/guestfs.pod:468
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>."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2499
-msgid "mkswap"
+"The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
+"document Augeas itself here because there is excellent documentation on the "
+"L<http://augeas.net/> website."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2501
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:472
msgid ""
-" mkswap device\n"
-"\n"
+"If you don't want to use Augeas (you fool!) then try calling L</"
+"guestfs_read_lines> to get the file as a list of lines which you can iterate "
+"over."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2505
-msgid "mkswap-L"
+#. type: =head2
+#: ../src/guestfs.pod:476
+msgid "SELINUX"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2507
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:478
msgid ""
-" mkswap-L label device\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:2515
-msgid "mkswap-U"
+#. type: textblock
+#: ../src/guestfs.pod:486
+msgid "Before launching, do:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2517
+#. type: verbatim
+#: ../src/guestfs.pod:488
#, no-wrap
msgid ""
-" mkswap-U uuid device\n"
+" guestfs_set_selinux (g, 1);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2521
-msgid "mkswap-file"
+#. type: textblock
+#: ../src/guestfs.pod:492
+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
-#: ../fish/guestfish-actions.pod:2523
+#. type: verbatim
+#: ../src/guestfs.pod:496
#, no-wrap
msgid ""
-" mkswap-file path\n"
+" guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2527
+#. type: textblock
+#: ../src/guestfs.pod:498
msgid ""
-"This command just writes a swap file signature to an existing file. To "
-"create the file itself, use something like C<fallocate>."
+"(Older versions of C<load_policy> require you to specify the name of the "
+"policy file)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2530
-msgid "modprobe"
+#. type: textblock
+#: ../src/guestfs.pod:503
+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
-#: ../fish/guestfish-actions.pod:2532
+#. type: verbatim
+#: ../src/guestfs.pod:507
#, no-wrap
msgid ""
-" modprobe modulename\n"
+" guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2539
-msgid "mount"
+#. type: textblock
+#: ../src/guestfs.pod:511
+msgid "This will work for running commands and editing existing files."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2541
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:513
msgid ""
-" mount device mountpoint\n"
-"\n"
+"When new files are created, you may need to label them explicitly, for "
+"example by running the external command C<restorecon pathname>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2557
+#. type: =head2
+#: ../src/guestfs.pod:517
+msgid "UMASK"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:519
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)."
+"Certain calls are affected by the current file mode creation mask (the "
+"\"umask\"). In particular ones which create files or directories, such as "
+"L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
+"either the default mode that the file is created with or modifies the mode "
+"that you supply."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2567
-msgid "mount-loop"
+#. type: textblock
+#: ../src/guestfs.pod:525
+msgid ""
+"The default umask is C<022>, so files are created with modes such as C<0644> "
+"and directories with C<0755>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2569
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:528
msgid ""
-" mount-loop file mountpoint\n"
-"\n"
+"There are two ways to avoid being affected by umask. Either set umask to 0 "
+"(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
+"guestfs_chmod> after creating each file or directory."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2575
-msgid "mount-options"
+#. type: textblock
+#: ../src/guestfs.pod:532
+msgid "For more information about umask, see L<umask(2)>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2577
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:536
msgid ""
-" mount-options options device mountpoint\n"
-"\n"
+"Libguestfs allows you to access Linux guests which have been encrypted using "
+"whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
+"standard. This includes nearly all whole disk encryption systems used by "
+"modern Linux guests."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:542
+msgid ""
+"Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
+"returns the string C<crypto_LUKS>)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2579
+#. type: textblock
+#: ../src/guestfs.pod:545
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."
+"Then open these devices by calling L</guestfs_luks_open>. Obviously you "
+"will require the passphrase!"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2587
-msgid "mount-ro"
+#. type: textblock
+#: ../src/guestfs.pod:548
+msgid ""
+"Opening a LUKS device creates a new device mapper device called C</dev/"
+"mapper/mapname> (where C<mapname> is the string you supply to L</"
+"guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
+"from and encrypted to the underlying block device respectively."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2589
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:554
msgid ""
-" mount-ro device mountpoint\n"
-"\n"
+"LVM volume groups on the device can be made visible by calling L</"
+"guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
+"(s) can now be mounted in the usual way."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2591
+#. type: textblock
+#: ../src/guestfs.pod:558
msgid ""
-"This is the same as the C<mount> command, but it mounts the filesystem with "
-"the read-only (I<-o ro>) flag."
+"Use the reverse process to close a LUKS device. Unmount any logical volumes "
+"on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
+"[\"/dev/VG\"])>. Then close the mapper device by calling L</"
+"guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
+"underlying encrypted block device)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2594
-msgid "mount-vfs"
+#. type: =head2
+#: ../src/guestfs.pod:565
+msgid "INSPECTION"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2596
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:567
msgid ""
-" mount-vfs options vfstype device mountpoint\n"
-"\n"
+"Libguestfs has APIs for inspecting an unknown disk image to find out if it "
+"contains operating systems, an install CD or a live CD. (These APIs used to "
+"be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
+"version 1.5.3 the most frequently used part of this library has been "
+"rewritten in C and moved into the core code)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2598
+#. type: textblock
+#: ../src/guestfs.pod:574
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."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2602
-msgid "mountpoints"
+"Add all disks belonging to the unknown virtual machine and call L</"
+"guestfs_launch> in the usual way."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2604
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:577
msgid ""
-" mountpoints\n"
-"\n"
+"Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
+"and certain heuristics, and returns a list of operating systems that were "
+"found. An empty list means none were found. A single element is the root "
+"filesystem of the operating system. For dual- or multi-boot guests, "
+"multiple roots can be returned, each one corresponding to a separate "
+"operating system. (Multi-boot virtual machines are extremely rare in the "
+"world of virtualization, but since this scenario can happen, we have built "
+"libguestfs to deal with it.)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2606
+#. type: textblock
+#: ../src/guestfs.pod:586
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."
+"For each root, you can then call various C<guestfs_inspect_get_*> functions "
+"to get additional details about that operating system. For example, call L</"
+"guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
+"Windows and Linux-based operating systems respectively."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2610
-msgid "mounts"
+#. type: textblock
+#: ../src/guestfs.pod:592
+msgid ""
+"Un*x-like and Linux-based operating systems usually consist of several "
+"filesystems which are mounted at boot time (for example, a separate boot "
+"partition mounted on C</boot>). The inspection rules are able to detect how "
+"filesystems correspond to mount points. Call "
+"C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
+"hash table like this example:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2612
+#. type: verbatim
+#: ../src/guestfs.pod:599
#, no-wrap
msgid ""
-" mounts\n"
+" /boot => /dev/sda1\n"
+" / => /dev/vg_guest/lv_root\n"
+" /usr => /dev/vg_guest/lv_usr\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2619
-msgid "See also: C<mountpoints>"
+#. type: textblock
+#: ../src/guestfs.pod:603
+msgid ""
+"The caller can then make calls to L</guestfs_mount_options> to mount the "
+"filesystems as suggested."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2621
-msgid "mv"
+#. type: textblock
+#: ../src/guestfs.pod:606
+msgid ""
+"Be careful to mount filesystems in the right order (eg. C</> before C</"
+"usr>). Sorting the keys of the hash by length, shortest first, should work."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2623
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:610
msgid ""
-" mv src dest\n"
-"\n"
+"Inspection currently only works for some common operating systems. "
+"Contributors are welcome to send patches for other operating systems that we "
+"currently cannot detect."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2628
-msgid "ntfs-3g-probe"
+#. type: textblock
+#: ../src/guestfs.pod:614
+msgid ""
+"Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
+"for more details. The L</guestfs_inspect_os> function just ignores any "
+"encrypted devices."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2630
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:618
msgid ""
-" ntfs-3g-probe true|false device\n"
-"\n"
+"A note on the implementation: The call L</guestfs_inspect_os> performs "
+"inspection and caches the results in the guest handle. Subsequent calls to "
+"C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
+"read the disks. If you change the content of the guest disks, you can redo "
+"inspection by calling L</guestfs_inspect_os> again. (L</"
+"guestfs_inspect_list_applications> works a little differently from the other "
+"calls and does read the disks. See documentation for that function for "
+"details)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2644
-msgid "ntfsresize"
+#. type: =head3
+#: ../src/guestfs.pod:627
+msgid "INSPECTING INSTALL DISKS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2646
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:629
msgid ""
-" ntfsresize device\n"
-"\n"
+"Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
+"CDs and more."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2652
-msgid "ntfsresize-size"
+#. type: textblock
+#: ../src/guestfs.pod:632
+msgid ""
+"Call L</guestfs_inspect_get_format> to return the format of the operating "
+"system, which currently can be C<installed> (a regular operating system) or "
+"C<installer> (some sort of install disk)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2654
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:636
msgid ""
-" ntfsresize-size device size\n"
-"\n"
+"Further information is available about the operating system that can be "
+"installed using the regular inspection APIs like L</"
+"guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2656
+#. type: textblock
+#: ../src/guestfs.pod:641
msgid ""
-"This command is the same as C<ntfsresize> except that it allows you to "
-"specify the new size (in bytes) explicitly."
+"Some additional information specific to installer disks is also available "
+"from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
+"guestfs_inspect_is_multipart> calls."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2659
-msgid "part-add"
+#. type: =head2
+#: ../src/guestfs.pod:646
+msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2661
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:648
msgid ""
-" part-add device prlogex startsect endsect\n"
-"\n"
+"Libguestfs can mount NTFS partitions. It does this using the L<http://www."
+"ntfs-3g.org/> driver."
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."
+#. type: =head3
+#: ../src/guestfs.pod:651
+msgid "DRIVE LETTERS AND PATHS"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2675
+#. type: textblock
+#: ../src/guestfs.pod:653
msgid ""
-"Creating a partition which covers the whole disk is not so easy. Use C<part-"
-"disk> to do that."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:2678
-msgid "part-del"
+"DOS and Windows still use drive letters, and the filesystems are always "
+"treated as case insensitive by Windows itself, and therefore you might find "
+"a Windows configuration file referring to a path like C<c:\\windows"
+"\\system32>. When the filesystem is mounted in libguestfs, that directory "
+"might be referred to as C</WINDOWS/System32>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2680
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:659
msgid ""
-" part-del device partnum\n"
-"\n"
+"Drive letter mappings can be found using inspection (see L</INSPECTION> and "
+"L</guestfs_inspect_get_drive_mappings>)"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2688
-msgid "part-disk"
+#. type: textblock
+#: ../src/guestfs.pod:662
+msgid ""
+"Dealing with separator characters (backslash vs forward slash) is outside "
+"the scope of libguestfs, but usually a simple character replacement will "
+"work."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2690
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:666
msgid ""
-" part-disk device parttype\n"
-"\n"
+"To resolve the case insensitivity of paths, call L</"
+"guestfs_case_sensitive_path>."
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: =head3
+#: ../src/guestfs.pod:669
+msgid "ACCESSING THE WINDOWS REGISTRY"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2696
+#. type: textblock
+#: ../src/guestfs.pod:671
msgid ""
-"C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
-"possible values are described in C<part-init>."
+"Libguestfs also provides some help for decoding Windows Registry \"hive\" "
+"files, through the library C<hivex> which is part of the libguestfs project "
+"although ships as a separate tarball. You have to locate and download the "
+"hive file(s) yourself, and then pass them to C<hivex> functions. See also "
+"the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
+"reg(1)> for more help on this issue."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2702
-msgid "part-get-bootable"
+#. type: =head3
+#: ../src/guestfs.pod:679
+msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2704
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:681
msgid ""
-" part-get-bootable device partnum\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:2709
-msgid "See also C<part-set-bootable>."
+"Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
+"provide something which looks like a Linux symlink. The way it tries to do "
+"the rewriting is described here:"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2711
-msgid "part-get-mbr-id"
+#. type: textblock
+#: ../src/guestfs.pod:685
+msgid ""
+"L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
+"symbolic-links/>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2713
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:687
msgid ""
-" part-get-mbr-id device partnum\n"
-"\n"
+"The essential problem is that ntfs-3g simply does not have enough "
+"information to do a correct job. NTFS links can contain drive letters and "
+"references to external device GUIDs that ntfs-3g has no way of resolving. "
+"It is almost certainly the case that libguestfs callers should ignore what "
+"ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2718 ../fish/guestfish-actions.pod:2856
+#. type: textblock
+#: ../src/guestfs.pod:694
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>)."
+"Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
+"guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
+"attribute, and read the raw reparse data from that (you can find the format "
+"documented in various places around the web)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2722
-msgid "part-get-parttype"
+#. type: =head3
+#: ../src/guestfs.pod:699
+msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2724
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:701
msgid ""
-" part-get-parttype device\n"
-"\n"
+"There are other useful extended attributes that can be read from ntfs-3g "
+"filesystems (using L</guestfs_getxattr>). See:"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2729
+#. type: textblock
+#: ../src/guestfs.pod:704
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."
+"L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2734
-msgid "part-init"
+#. type: =head2
+#: ../src/guestfs.pod:706
+msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2736
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:708
msgid ""
-" part-init device parttype\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:2742
+#. type: textblock
+#: ../src/guestfs.pod:711
msgid ""
-"Initially there are no partitions. Following this, you should call C<part-"
-"add> for each partition required."
+"The API is broadly identical in all supported languages. This means that "
+"the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
+"in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
+"OCaml. In other words, a straightforward, predictable isomorphism between "
+"each language."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2805
-msgid "part-list"
+#. type: textblock
+#: ../src/guestfs.pod:717
+msgid ""
+"Error messages are automatically transformed into exceptions if the language "
+"supports it."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2807
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:720
msgid ""
-" part-list device\n"
-"\n"
+"We don't try to \"object orientify\" parts of the API in OO languages, "
+"although contributors are welcome to write higher level APIs above what we "
+"provide in their favourite languages if they wish."
+msgstr ""
+
+#. type: =item
+#: ../src/guestfs.pod:726
+msgid "B<C++>"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2822
+#. type: textblock
+#: ../src/guestfs.pod:728
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>."
+"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: =head2
-#: ../fish/guestfish-actions.pod:2835
-msgid "part-set-bootable"
+#. type: =item
+#: ../src/guestfs.pod:732
+msgid "B<C#>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2837
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:734
msgid ""
-" part-set-bootable device partnum true|false\n"
-"\n"
+"The C# bindings are highly experimental. Please read the warnings at the "
+"top of C<csharp/Libguestfs.cs>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2846
-msgid "part-set-mbr-id"
+#. type: =item
+#: ../src/guestfs.pod:737
+msgid "B<Erlang>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2848
-#, no-wrap
-msgid ""
-" part-set-mbr-id device partnum idbyte\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:739
+msgid "See L<guestfs-erlang(3)>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2860
-msgid "part-set-name"
+#. type: =item
+#: ../src/guestfs.pod:741
+msgid "B<Haskell>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2862
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:743
msgid ""
-" part-set-name device partnum name\n"
-"\n"
+"This is the only language binding that is working but incomplete. Only "
+"calls which return simple integers have been bound in Haskell, and we are "
+"looking for help to complete this binding."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2870
-msgid "ping-daemon"
+#. type: =item
+#: ../src/guestfs.pod:747
+msgid "B<Java>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2872
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:749
msgid ""
-" ping-daemon\n"
-"\n"
+"Full documentation is contained in the Javadoc which is distributed with "
+"libguestfs. For examples, see L<guestfs-java(3)>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2879
-msgid "pread"
+#. type: =item
+#: ../src/guestfs.pod:752
+msgid "B<OCaml>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2881
-#, no-wrap
-msgid ""
-" pread path count offset\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:754
+msgid "See L<guestfs-ocaml(3)>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2889
-msgid "See also C<pwrite>."
+#. type: =item
+#: ../src/guestfs.pod:756
+msgid "B<Perl>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2894
-msgid "pvcreate"
+#. type: textblock
+#: ../src/guestfs.pod:758
+msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2896
-#, no-wrap
+#. type: =item
+#: ../src/guestfs.pod:760
+msgid "B<PHP>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:762
msgid ""
-" pvcreate device\n"
-"\n"
+"For documentation see C<README-PHP> supplied with libguestfs sources or in "
+"the php-libguestfs package for your distribution."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2902
-msgid "pvremove"
+#. type: textblock
+#: ../src/guestfs.pod:765
+msgid "The PHP binding only works correctly on 64 bit machines."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2904
-#, no-wrap
-msgid ""
-" pvremove device\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:767
+msgid "B<Python>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2913
-msgid "pvresize"
+#. type: textblock
+#: ../src/guestfs.pod:769
+msgid "See L<guestfs-python(3)>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2915
-#, no-wrap
-msgid ""
-" pvresize device\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:771
+msgid "B<Ruby>"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2920
-msgid "pvresize-size"
+#. type: textblock
+#: ../src/guestfs.pod:773
+msgid "See L<guestfs-ruby(3)>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2922
-#, no-wrap
-msgid ""
-" pvresize-size device size\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:775
+msgid "B<shell scripts>"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2924
-msgid ""
-"This command is the same as C<pvresize> except that it allows you to specify "
-"the new size (in bytes) explicitly."
+#. type: textblock
+#: ../src/guestfs.pod:777
+msgid "See L<guestfish(1)>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2927
-msgid "pvs"
+#. type: =head2
+#: ../src/guestfs.pod:781
+msgid "LIBGUESTFS GOTCHAS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2929
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:783
msgid ""
-" pvs\n"
-"\n"
+"L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
+"system [...] that works in the way it is documented but is counterintuitive "
+"and almost invites mistakes.\""
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2937
-msgid "See also C<pvs-full>."
+#. type: textblock
+#: ../src/guestfs.pod:787
+msgid ""
+"Since we developed libguestfs and the associated tools, there are several "
+"things we would have designed differently, but are now stuck with for "
+"backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
+"release, you can expect these to change. Beware of them."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2939
-msgid "pvs-full"
+#. type: =item
+#: ../src/guestfs.pod:795
+msgid "Autosync / forgetting to sync."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2941
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:797
msgid ""
-" pvs-full\n"
-"\n"
+"I<Update:> Autosync is enabled by default for all API users starting from "
+"libguestfs 1.5.24. This section only applies to older versions."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2946
-msgid "pvuuid"
+#. type: textblock
+#: ../src/guestfs.pod:800
+msgid ""
+"When modifying a filesystem from C or another language, you B<must> unmount "
+"all filesystems and call L</guestfs_sync> explicitly before you close the "
+"libguestfs handle. You can also call:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2948
+#. type: verbatim
+#: ../src/guestfs.pod:804
#, no-wrap
msgid ""
-" pvuuid device\n"
+" guestfs_set_autosync (g, 1);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2952
-msgid "pwrite"
+#. type: textblock
+#: ../src/guestfs.pod:806
+msgid ""
+"to have the unmount/sync done automatically for you when the handle 'g' is "
+"closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2954
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:810
msgid ""
-" pwrite path content offset\n"
-"\n"
+"If you forget to do this, then it is entirely possible that your changes "
+"won't be written out, or will be partially written, or (very rarely) that "
+"you'll get disk corruption."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2965
-msgid "See also C<pread>."
+#. type: textblock
+#: ../src/guestfs.pod:814
+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: =head2
-#: ../fish/guestfish-actions.pod:2970
-msgid "read-file"
+#. type: =item
+#: ../src/guestfs.pod:818
+msgid "Mount option C<-o sync> should not be the default."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2972
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:820
msgid ""
-" read-file path\n"
-"\n"
+"I<Update:> L</guestfs_mount> no longer adds any options starting from "
+"libguestfs 1.13.16. This section only applies to older versions."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2977
+#. type: textblock
+#: ../src/guestfs.pod:823
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."
+"If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
+"However C<-o sync> does not add any reliability benefit, but does have a "
+"very large performance impact."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:2985
-msgid "read-lines"
+#. type: textblock
+#: ../src/guestfs.pod:827
+msgid ""
+"The work around is to use L</guestfs_mount_options> and set the mount "
+"options that you actually want to use."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:2987
-#, no-wrap
-msgid ""
-" read-lines path\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:830
+msgid "Read-only should be the default."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:2994
+#. type: textblock
+#: ../src/guestfs.pod:832
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."
+"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: =head2
-#: ../fish/guestfish-actions.pod:2999
-msgid "readdir"
+#. type: textblock
+#: ../src/guestfs.pod:835
+msgid "This would reduce the potential to corrupt live VM images."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3001
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:837
msgid ""
-" readdir dir\n"
-"\n"
+"Note that many filesystems change the disk when you just mount and unmount, "
+"even if you didn't perform any writes. You need to use L</"
+"guestfs_add_drive_ro> to guarantee that the disk is not changed."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3053
+#. type: =item
+#: ../src/guestfs.pod:841
+msgid "guestfish command line is hard to use."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:843
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>."
+"C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
+"examination). It tries to run a guestfish command C<disk.img> which doesn't "
+"exist, so it fails. In earlier versions of guestfish the error message was "
+"also unintuitive, but we have corrected this since. Like the Bourne shell, "
+"we should have used C<guestfish -c command> to run commands."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3057
-msgid "readlink"
+#. type: =item
+#: ../src/guestfs.pod:850
+msgid "guestfish megabyte modifiers don't work right on all commands"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3059
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:852
msgid ""
-" readlink path\n"
-"\n"
+"In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
+"other modifiers). What guestfish actually does is to multiply the number "
+"part by the modifier part and pass the result to the C API. However this "
+"doesn't work for a few APIs which aren't expecting bytes, but are already "
+"expecting some other unit (eg. megabytes)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3063
-msgid "readlinklist"
+#. type: textblock
+#: ../src/guestfs.pod:859
+msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3065
+#. type: verbatim
+#: ../src/guestfs.pod:861
#, no-wrap
msgid ""
-" readlinklist path 'names ...'\n"
+" lvcreate LV VG 100M\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3089
-msgid "realpath"
+#. type: textblock
+#: ../src/guestfs.pod:863
+msgid ""
+"does not do what you might expect. Instead because L</guestfs_lvcreate> is "
+"already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
+"megabytes * megabytes) logical volume. The error message you get from this "
+"is also a little obscure."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3091
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:868
msgid ""
-" realpath path\n"
-"\n"
+"This could be fixed in the generator by specially marking parameters and "
+"return values which take bytes or other units."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3096
-msgid "removexattr"
+#. type: =item
+#: ../src/guestfs.pod:871
+msgid "Ambiguity between devices and paths"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3098
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:873
msgid ""
-" removexattr xattr path\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3103
-msgid "See also: C<lremovexattr>, L<attr(5)>."
+#. type: textblock
+#: ../src/guestfs.pod:878
+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: =head2
-#: ../fish/guestfish-actions.pod:3105
-msgid "resize2fs"
+#. type: textblock
+#: ../src/guestfs.pod:884
+msgid ""
+"To avoid both the ambiguity and the need to duplicate some calls, we could "
+"make paths/devices into structured names. One way to do this would be to "
+"use a notation like grub (C<hd(0,0)>), although nobody really likes this "
+"aspect of grub. Another way would be to use a structured type, equivalent "
+"to this OCaml type:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3107
+#. type: verbatim
+#: ../src/guestfs.pod:890
#, no-wrap
msgid ""
-" resize2fs device\n"
+" type path = Path of string | Device of int | Partition of int * int\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3112
-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."
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:3118
-msgid "resize2fs-size"
+#. type: textblock
+#: ../src/guestfs.pod:892
+msgid "which would allow you to pass arguments like:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3120
+#. type: verbatim
+#: ../src/guestfs.pod:894
#, no-wrap
msgid ""
-" resize2fs-size device size\n"
+" 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
-#: ../fish/guestfish-actions.pod:3122
+#. type: textblock
+#: ../src/guestfs.pod:899
msgid ""
-"This command is the same as C<resize2fs> except that it allows you to "
-"specify the new size (in bytes) explicitly."
+"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
-#: ../fish/guestfish-actions.pod:3125
-msgid "rm"
+#. type: =head2
+#: ../src/guestfs.pod:904
+msgid "KEYS AND PASSPHRASES"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3127
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:906
msgid ""
-" rm path\n"
-"\n"
+"Certain libguestfs calls take a parameter that contains sensitive key "
+"material, passed in as a C string."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3131
-msgid "rm-rf"
+#. type: textblock
+#: ../src/guestfs.pod:909
+msgid ""
+"In the future we would hope to change the libguestfs implementation so that "
+"keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
+"swap. However this is I<not> done at the moment, because of the complexity "
+"of such an implementation."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3133
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:914
msgid ""
-" rm-rf path\n"
-"\n"
+"Therefore you should be aware that any key parameter you pass to libguestfs "
+"might end up being written out to the swap partition. If this is a concern, "
+"scrub the swap partition or don't use libguestfs on encrypted devices."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3139
-msgid "rmdir"
+#. type: =head2
+#: ../src/guestfs.pod:919
+msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3141
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:921
msgid ""
-" rmdir path\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:3145
-msgid "rmmountpoint"
+"All high-level libguestfs actions are synchronous. If you want to use "
+"libguestfs asynchronously then you must create a thread."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3147
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:924
msgid ""
-" rmmountpoint exemptpath\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
-#: ../fish/guestfish-actions.pod:3149
+#. type: textblock
+#: ../src/guestfs.pod:928
msgid ""
-"This calls removes a mountpoint that was previously created with "
-"C<mkmountpoint>. See C<mkmountpoint> for full details."
+"See the graphical program guestfs-browser for one possible architecture for "
+"multithreaded programs using libvirt and libguestfs."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3153
-msgid "scrub-device"
+#. type: =head2
+#: ../src/guestfs.pod:931
+msgid "PATH"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3155
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:933
msgid ""
-" scrub-device device\n"
-"\n"
+"Libguestfs needs a supermin appliance, which it finds by looking along an "
+"internal path."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3166
-msgid "scrub-file"
+#. type: textblock
+#: ../src/guestfs.pod:936
+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: verbatim
-#: ../fish/guestfish-actions.pod:3168
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:939
msgid ""
-" scrub-file file\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3178
-msgid "scrub-freespace"
+#. type: =head2
+#: ../src/guestfs.pod:946
+msgid "QEMU WRAPPERS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3180
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:948
msgid ""
-" scrub-freespace dir\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3182
+#. type: textblock
+#: ../src/guestfs.pod:952
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>."
+"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: =head2
-#: ../fish/guestfish-actions.pod:3191
-msgid "set-append | append"
+#. type: textblock
+#: ../src/guestfs.pod:957
+msgid ""
+"Here is an example of a wrapper, where I have built my own copy of qemu from "
+"source:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3193
+#. type: verbatim
+#: ../src/guestfs.pod:960
#, no-wrap
msgid ""
-" set-append append\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: =head2
-#: ../fish/guestfish-actions.pod:3204
-msgid "set-autosync | autosync"
+#. type: textblock
+#: ../src/guestfs.pod:964
+msgid ""
+"Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
+"then use it by setting the LIBGUESTFS_QEMU environment variable. For "
+"example:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3206
+#. type: verbatim
+#: ../src/guestfs.pod:968
#, no-wrap
msgid ""
-" set-autosync true|false\n"
+" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3208
+#. type: textblock
+#: ../src/guestfs.pod:970
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)."
+"Note that libguestfs also calls qemu with the -help and -version options in "
+"order to determine features."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3216
-msgid "set-direct | direct"
+#. type: textblock
+#: ../src/guestfs.pod:973
+msgid ""
+"Wrappers can also be used to edit the options passed to qemu. In the "
+"following example, the C<-machine ...> option (C<-machine> and the following "
+"argument) are removed from the command line and replaced with C<-machine pc,"
+"accel=tcg>. The while loop iterates over the options until it finds the "
+"right one to remove, putting the remaining options into the C<args> array."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3218
+#. type: verbatim
+#: ../src/guestfs.pod:982
#, no-wrap
msgid ""
-" set-direct true|false\n"
-"\n"
+" i=0\n"
+" while [ $# -gt 0 ]; do\n"
+" case \"$1\" in\n"
+" -machine)\n"
+" shift 2;;\n"
+" *)\n"
+" args[i]=\"$1\"\n"
+" (( i++ ))\n"
+" shift ;;\n"
+" esac\n"
+" done\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3224
+#. type: verbatim
+#: ../src/guestfs.pod:994
+#, no-wrap
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."
+" exec qemu-kvm -machine pc,accel=tcg \"${args[@]}\"\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3233
-msgid "set-e2label"
+#. type: =head2
+#: ../src/guestfs.pod:996
+msgid "ATTACHING TO RUNNING DAEMONS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3235
-#, no-wrap
-msgid ""
-" set-e2label device label\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:998
+msgid ""
+"I<Note (1):> This is B<highly experimental> and has a tendency to eat "
+"babies. Use with caution."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3241
+#. type: textblock
+#: ../src/guestfs.pod:1001
msgid ""
-"You can use either C<tune2fs-l> or C<get-e2label> to return the existing "
-"label on a filesystem."
+"I<Note (2):> This section explains how to attach to a running daemon from a "
+"low level perspective. For most users, simply using virt tools such as "
+"L<guestfish(1)> with the I<--live> option will \"just work\"."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3244
-msgid "set-e2uuid"
+#. type: =head3
+#: ../src/guestfs.pod:1005
+msgid "Using guestfs_set_attach_method"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3246
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1007
msgid ""
-" set-e2uuid device uuid\n"
-"\n"
+"By calling L</guestfs_set_attach_method> you can change how the library "
+"connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
+"ARCHITECTURE> for some background)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3253
+#. type: textblock
+#: ../src/guestfs.pod:1011
msgid ""
-"You can use either C<tune2fs-l> or C<get-e2uuid> to return the existing UUID "
-"of a filesystem."
+"The normal attach method is C<appliance>, where a small appliance is created "
+"containing the daemon, and then the library connects to this."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3256
-msgid "set-memsize | memsize"
+#. type: textblock
+#: ../src/guestfs.pod:1014
+msgid ""
+"Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
+"Unix domain socket) causes L</guestfs_launch> to connect to an existing "
+"daemon over the Unix domain socket."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3258
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1018
msgid ""
-" set-memsize memsize\n"
-"\n"
+"The normal use for this is to connect to a running virtual machine that "
+"contains a C<guestfsd> daemon, and send commands so you can read and write "
+"files inside the live virtual machine."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3260
-msgid ""
-"This sets the memory size in megabytes allocated to the qemu subprocess. "
-"This only has any effect if called before C<launch>."
+#. type: =head3
+#: ../src/guestfs.pod:1022
+msgid "Using guestfs_add_domain with live flag"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3271
-msgid "set-network | network"
+#. type: textblock
+#: ../src/guestfs.pod:1024
+msgid ""
+"L</guestfs_add_domain> provides some help for getting the correct attach "
+"method. If you pass the C<live> option to this function, then (if the "
+"virtual machine is running) it will examine the libvirt XML looking for a "
+"virtio-serial channel to connect to:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3273
+#. type: verbatim
+#: ../src/guestfs.pod:1030
#, no-wrap
msgid ""
-" set-network true|false\n"
+" <domain>\n"
+" ...\n"
+" <devices>\n"
+" ...\n"
+" <channel type='unix'>\n"
+" <source mode='bind' path='/path/to/socket'/>\n"
+" <target type='virtio' name='org.libguestfs.channel.0'/>\n"
+" </channel>\n"
+" ...\n"
+" </devices>\n"
+" </domain>\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3281
+#. type: textblock
+#: ../src/guestfs.pod:1042
msgid ""
-"You must call this before calling C<launch>, otherwise it has no effect."
+"L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
+"method to C<unix:/path/to/socket>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3284
-msgid "set-path | path"
+#. type: textblock
+#: ../src/guestfs.pod:1045
+msgid ""
+"Some of the libguestfs tools (including guestfish) support a I<--live> "
+"option which is passed through to L</guestfs_add_domain> thus allowing you "
+"to attach to and modify live virtual machines."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3286
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1049
msgid ""
-" set-path searchpath\n"
-"\n"
+"The virtual machine needs to have been set up beforehand so that it has the "
+"virtio-serial channel and so that guestfsd is running inside it."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3295
-msgid "set-qemu | qemu"
+#. type: =head2
+#: ../src/guestfs.pod:1053
+msgid "ABI GUARANTEE"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3297
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1055
msgid ""
-" set-qemu qemu\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3317
-msgid "set-recovery-proc | recovery-proc"
+#. type: =head2
+#: ../src/guestfs.pod:1061
+msgid "BLOCK DEVICE NAMING"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3319
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1063
msgid ""
-" set-recovery-proc true|false\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3321
+#. type: textblock
+#: ../src/guestfs.pod:1075
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."
+"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
-#: ../fish/guestfish-actions.pod:3326
+#. type: textblock
+#: ../src/guestfs.pod:1079
msgid ""
-"This only has any effect if called before C<launch>, and the default is true."
+"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: =head2
-#: ../fish/guestfish-actions.pod:3335
-msgid "set-selinux | selinux"
+#. type: textblock
+#: ../src/guestfs.pod:1084
+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: verbatim
-#: ../fish/guestfish-actions.pod:3337
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1090
msgid ""
-" set-selinux true|false\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:3348
-msgid "set-trace | trace"
+#. type: =head3
+#: ../src/guestfs.pod:1095
+msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3350
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1097
msgid ""
-" set-trace true|false\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: =head2
-#: ../fish/guestfish-actions.pod:3366
-msgid "set-verbose | verbose"
+#. type: textblock
+#: ../src/guestfs.pod:1103
+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: verbatim
-#: ../fish/guestfish-actions.pod:3368
-#, no-wrap
-msgid ""
-" set-verbose true|false\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:1111
+msgid "Is the string a parameter which is a device or partition name?"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3375
-msgid "setcon"
+#. type: textblock
+#: ../src/guestfs.pod:1115
+msgid "Does the string begin with C</dev/sd>?"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3377
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1119
msgid ""
-" setcon context\n"
-"\n"
+"Does the named device exist? If so, we use that device. However if I<not> "
+"then we continue with this algorithm."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3384
-msgid "setxattr"
+#. type: textblock
+#: ../src/guestfs.pod:1124
+msgid "Replace initial C</dev/sd> string with C</dev/hd>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3386
-#, no-wrap
-msgid ""
-" setxattr xattr val vallen path\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:1126
+msgid "For example, change C</dev/sda2> to C</dev/hda2>."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3392
-msgid "See also: C<lsetxattr>, L<attr(5)>."
+#. type: textblock
+#: ../src/guestfs.pod:1128
+msgid "If that named device exists, use it. If not, continue."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3394
-msgid "sfdisk"
+#. type: textblock
+#: ../src/guestfs.pod:1132
+msgid "Replace initial C</dev/sd> string with C</dev/vd>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3396
-#, no-wrap
-msgid ""
-" sfdisk device cyls heads sectors 'lines ...'\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:1134
+msgid "If that named device exists, use it. If not, return an error."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3418
-msgid "See also: C<sfdisk-l>, C<sfdisk-N>, C<part-init>"
+#. type: =head3
+#: ../src/guestfs.pod:1138
+msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3424
-msgid "sfdiskM"
+#. type: textblock
+#: ../src/guestfs.pod:1140
+msgid ""
+"Although the standard naming scheme and automatic translation is useful for "
+"simple programs and guestfish scripts, for larger programs it is best not to "
+"rely on this mechanism."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3426
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1144
msgid ""
-" sfdiskM device 'lines ...'\n"
-"\n"
+"Where possible for maximum future portability programs using libguestfs "
+"should use these future-proof techniques:"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3428
+#. type: textblock
+#: ../src/guestfs.pod:1151
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."
+"Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
+"device names, and then use those names directly."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3434
-msgid "See also: C<sfdisk>, the L<sfdisk(8)> manpage and C<part-disk>"
+#. type: textblock
+#: ../src/guestfs.pod:1154
+msgid ""
+"Since those device names exist by definition, they will never be translated."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3440
-msgid "sfdisk-N"
+#. type: textblock
+#: ../src/guestfs.pod:1159
+msgid ""
+"Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
+"filesystem labels."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3442
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1166
msgid ""
-" sfdisk-N device partnum cyls heads sectors line\n"
-"\n"
+"This section discusses security implications of using libguestfs, "
+"particularly with untrusted or malicious guests or disk images."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3447
+#. type: =head2
+#: ../src/guestfs.pod:1169
+msgid "GENERAL SECURITY CONSIDERATIONS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1171
msgid ""
-"For other parameters, see C<sfdisk>. You should usually pass C<0> for the "
-"cyls/heads/sectors parameters."
+"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
-#: ../fish/guestfish-actions.pod:3450
-msgid "See also: C<part-add>"
+#. type: textblock
+#: ../src/guestfs.pod:1181
+msgid "the data (file etc) not being present"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3455
-msgid "sfdisk-disk-geometry"
+#. type: textblock
+#: ../src/guestfs.pod:1185
+msgid "being present but empty"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3457
-#, no-wrap
-msgid ""
-" sfdisk-disk-geometry device\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:1189
+msgid "being much larger than normal"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3459
-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>)."
+#. type: textblock
+#: ../src/guestfs.pod:1193
+msgid "containing arbitrary 8 bit data"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3467
-msgid "sfdisk-kernel-geometry"
+#. type: textblock
+#: ../src/guestfs.pod:1197
+msgid "being in an unexpected character encoding"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3469
-#, no-wrap
-msgid ""
-" sfdisk-kernel-geometry device\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:1201
+msgid "containing homoglyphs."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3476
-msgid "sfdisk-l"
+#. type: =head2
+#: ../src/guestfs.pod:1205
+msgid "SECURITY OF MOUNTING FILESYSTEMS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3478
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1207
msgid ""
-" sfdisk-l device\n"
-"\n"
+"When you mount a filesystem under Linux, mistakes in the kernel filesystem "
+"(VFS) module can sometimes be escalated into exploits by deliberately "
+"creating a malicious, malformed filesystem. These exploits are very severe "
+"for two reasons. Firstly there are very many filesystem drivers in the "
+"kernel, and many of them are infrequently used and not much developer "
+"attention has been paid to the code. Linux userspace helps potential "
+"crackers by detecting the filesystem type and automatically choosing the "
+"right VFS driver, even if that filesystem type is obscure or unexpected for "
+"the administrator. Secondly, a kernel-level exploit is like a local root "
+"exploit (worse in some ways), giving immediate and total access to the "
+"system right down to the hardware level."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1220
+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
-#: ../fish/guestfish-actions.pod:3484
-msgid "See also: C<part-list>"
+#. type: textblock
+#: ../src/guestfs.pod:1231
+msgid ""
+"In any case callers can reduce the attack surface by forcing the filesystem "
+"type when mounting (use L</guestfs_mount_vfs>)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3486
-msgid "sh"
+#. type: =head2
+#: ../src/guestfs.pod:1234
+msgid "PROTOCOL SECURITY"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3488
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1236
msgid ""
-" sh command\n"
-"\n"
+"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: textblock
-#: ../fish/guestfish-actions.pod:3493
-msgid "This is like C<command>, but passes the command to:"
+#. type: =head2
+#: ../src/guestfs.pod:1242
+msgid "INSPECTION SECURITY"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3501
-msgid "All the provisos about C<command> apply to this call."
+#. type: textblock
+#: ../src/guestfs.pod:1244
+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: =head2
-#: ../fish/guestfish-actions.pod:3503
-msgid "sh-lines"
+#. type: textblock
+#: ../src/guestfs.pod:1250
+msgid ""
+"Guest configuration may be altered in unusual ways by the administrator of "
+"the virtual machine, and may not reflect reality (particularly for untrusted "
+"or actively malicious guests). For example we parse the hostname from "
+"configuration files like C</etc/sysconfig/network> that we find in the "
+"guest, but the guest administrator can easily manipulate these files to "
+"provide the wrong hostname."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3505
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1258
msgid ""
-" sh-lines command\n"
-"\n"
+"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: textblock
-#: ../fish/guestfish-actions.pod:3507
-msgid "This is the same as C<sh>, but splits the result into a list of lines."
+#. type: =head2
+#: ../src/guestfs.pod:1264
+msgid "RUNNING UNTRUSTED GUEST COMMANDS"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3510
-msgid "See also: C<command-lines>"
+#. type: textblock
+#: ../src/guestfs.pod:1266
+msgid ""
+"Be very cautious about running commands from the guest. By running a "
+"command in the guest, you are giving CPU time to a binary that you do not "
+"control, under the same user account as the library, albeit wrapped in qemu "
+"virtualization. More information and alternatives can be found in the "
+"section L</RUNNING COMMANDS>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3512
-msgid "sleep"
+#. type: =head2
+#: ../src/guestfs.pod:1272
+msgid "CVE-2010-3851"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3514
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1274
+msgid "https://bugzilla.redhat.com/642934"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1276
msgid ""
-" sleep secs\n"
-"\n"
+"This security bug concerns the automatic disk format detection that qemu "
+"does on disk images."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3518
-msgid "stat"
+#. type: textblock
+#: ../src/guestfs.pod:1279
+msgid ""
+"A raw disk image is just the raw bytes, there is no header. Other disk "
+"images like qcow2 contain a special header. Qemu deals with this by looking "
+"for one of the known headers, and if none is found then assuming the disk "
+"image must be raw."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3520
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1284
msgid ""
-" stat path\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: =head2
-#: ../fish/guestfish-actions.pod:3526
-msgid "statvfs"
+#. type: textblock
+#: ../src/guestfs.pod:1289
+msgid ""
+"This in itself would not be a problem, but qcow2 offers many features, one "
+"of which is to allow a disk image to refer to another image (called the "
+"\"backing disk\"). It does this by placing the path to the backing disk "
+"into the qcow2 header. This path is not validated and could point to any "
+"host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
+"\"holes\" in the qcow2 disk image, which of course is completely under the "
+"control of the attacker."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3528
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1297
msgid ""
-" statvfs path\n"
-"\n"
+"In libguestfs this is rather hard to exploit except under two circumstances:"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3536
-msgid "strings"
+#. type: textblock
+#: ../src/guestfs.pod:1304
+msgid "You have enabled the network or have opened the disk in write mode."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3538
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1308
msgid ""
-" strings path\n"
-"\n"
+"You are also running untrusted code from the guest (see L</RUNNING "
+"COMMANDS>)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3546
-msgid "strings-e"
+#. type: textblock
+#: ../src/guestfs.pod:1313
+msgid ""
+"The way to avoid this is to specify the expected disk format when adding "
+"disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
+"should always do this if the disk is raw format, and it's a good idea for "
+"other cases too."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3548
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1318
msgid ""
-" strings-e encoding path\n"
-"\n"
+"For disks added from libvirt using calls like L</guestfs_add_domain>, the "
+"format is fetched from libvirt and passed through."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3550
+#. type: textblock
+#: ../src/guestfs.pod:1321
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>."
+"For libguestfs tools, use the I<--format> command line parameter as "
+"appropriate."
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)."
+#. type: =head1
+#: ../src/guestfs.pod:1324
+msgid "CONNECTION MANAGEMENT"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3592
-msgid "swapoff-device"
+#. type: =head2
+#: ../src/guestfs.pod:1326
+msgid "guestfs_h *"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3594
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1328
msgid ""
-" swapoff-device device\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3596
+#. type: textblock
+#: ../src/guestfs.pod:1332
msgid ""
-"This command disables the libguestfs appliance swap device or partition "
-"named C<device>. See C<swapon-device>."
+"For information on using multiple handles and threads, see the section L</"
+"MULTIPLE HANDLES AND MULTIPLE THREADS> above."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3600
-msgid "swapoff-file"
+#. type: =head2
+#: ../src/guestfs.pod:1335
+msgid "guestfs_create"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3602
+#. type: verbatim
+#: ../src/guestfs.pod:1337
#, no-wrap
msgid ""
-" swapoff-file file\n"
+" guestfs_h *guestfs_create (void);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3606
-msgid "swapoff-label"
+#. type: textblock
+#: ../src/guestfs.pod:1339
+msgid "Create a connection handle."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3608
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1341
msgid ""
-" swapoff-label label\n"
-"\n"
+"On success this returns a non-NULL pointer to a handle. On error it returns "
+"NULL."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3613
-msgid "swapoff-uuid"
+#. type: textblock
+#: ../src/guestfs.pod:1344
+msgid ""
+"You have to \"configure\" the handle after creating it. This includes "
+"calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
+"handle at least once."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1348
+msgid "After configuring the handle, you have to call L</guestfs_launch>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3615
+#. type: textblock
+#: ../src/guestfs.pod:1350
+msgid ""
+"You may also want to configure error handling for the handle. See the L</"
+"ERROR HANDLING> section below."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1353
+msgid "guestfs_close"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1355
#, no-wrap
msgid ""
-" swapoff-uuid uuid\n"
+" void guestfs_close (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3620
-msgid "swapon-device"
+#. type: textblock
+#: ../src/guestfs.pod:1357
+msgid "This closes the connection handle and frees up all resources used."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:1359
+msgid ""
+"If autosync was set on the handle and the handle was launched, then this "
+"implicitly calls various functions to unmount filesystems and sync the "
+"disk. See L</guestfs_set_autosync> for more details."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3622
-#, no-wrap
-msgid ""
-" swapon-device device\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:1363
+msgid "If a close callback was set on the handle, then it is called."
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>."
+#. type: =head1
+#: ../src/guestfs.pod:1365
+msgid "ERROR HANDLING"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3636
-msgid "swapon-file"
+#. type: textblock
+#: ../src/guestfs.pod:1367
+msgid ""
+"API functions can return errors. For example, almost all functions that "
+"return C<int> will return C<-1> to indicate an error."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3638
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1370
msgid ""
-" swapon-file file\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3640
+#. type: textblock
+#: ../src/guestfs.pod:1374
msgid ""
-"This command enables swap to a file. See C<swapon-device> for other notes."
+"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: =head2
-#: ../fish/guestfish-actions.pod:3643
-msgid "swapon-label"
+#. type: textblock
+#: ../src/guestfs.pod:1379
+msgid ""
+"When the handle is created, a default error handler is installed which "
+"prints the error message string to C<stderr>. For small short-running "
+"command line programs it is sufficient to do:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3645
+#. type: verbatim
+#: ../src/guestfs.pod:1383
#, no-wrap
msgid ""
-" swapon-label label\n"
+" if (guestfs_launch (g) == -1)\n"
+" exit (EXIT_FAILURE);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3647
+#. type: textblock
+#: ../src/guestfs.pod:1386
msgid ""
-"This command enables swap to a labeled swap partition. See C<swapon-device> "
-"for other notes."
+"since the default error handler will ensure that an error message has been "
+"printed to C<stderr> before the program exits."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3650
-msgid "swapon-uuid"
+#. type: textblock
+#: ../src/guestfs.pod:1389
+msgid ""
+"For other programs the caller will almost certainly want to install an "
+"alternate error handler or do error handling in-line like this:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3652
+#. type: verbatim
+#: ../src/guestfs.pod:1392
#, no-wrap
msgid ""
-" swapon-uuid uuid\n"
-"\n"
+" /* This disables the default behaviour of printing errors\n"
+" on stderr. */\n"
+" guestfs_set_error_handler (g, NULL, NULL);\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3654
+#. type: verbatim
+#: ../src/guestfs.pod:1396
+#, no-wrap
msgid ""
-"This command enables swap to a swap partition with the given UUID. See "
-"C<swapon-device> for other notes."
+" 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\", msg);\n"
+" if (errnum != 0)\n"
+" fprintf (stderr, \": %s\", strerror (errnum));\n"
+" fprintf (stderr, \"\\n\");\n"
+" /* ... */\n"
+" }\n"
+"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3657
-msgid "sync"
+#. type: textblock
+#: ../src/guestfs.pod:1407
+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: verbatim
-#: ../fish/guestfish-actions.pod:3659
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1411
msgid ""
-" sync\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3667
-msgid "tail"
+#. type: =head2
+#: ../src/guestfs.pod:1417
+msgid "guestfs_last_error"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3669
+#. type: verbatim
+#: ../src/guestfs.pod:1419
#, no-wrap
msgid ""
-" tail path\n"
+" const char *guestfs_last_error (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3677
-msgid "tail-n"
+#. type: textblock
+#: ../src/guestfs.pod:1421
+msgid ""
+"This returns the last error message that happened on C<g>. If there has not "
+"been an error since the handle was created, then this returns C<NULL>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3679
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1425
msgid ""
-" tail-n nrlines path\n"
-"\n"
+"The lifetime of the returned string is until the next error occurs, or L</"
+"guestfs_close> is called."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3692
-msgid "tar-in"
+#. type: =head2
+#: ../src/guestfs.pod:1428
+msgid "guestfs_last_errno"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3694
+#. type: verbatim
+#: ../src/guestfs.pod:1430
#, no-wrap
msgid ""
-" tar-in (tarfile|-) directory\n"
+" int guestfs_last_errno (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3699
-msgid "To upload a compressed tarball, use C<tgz-in> or C<txz-in>."
+#. type: textblock
+#: ../src/guestfs.pod:1432
+msgid "This returns the last error number (errno) that happened on C<g>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3704
-msgid "tar-out"
+#. type: textblock
+#: ../src/guestfs.pod:1434
+msgid "If successful, an errno integer not equal to zero is returned."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3706
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1436
msgid ""
-" tar-out directory (tarfile|-)\n"
-"\n"
+"If no error, this returns 0. This call can return 0 in three situations:"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3711
-msgid "To download a compressed tarball, use C<tgz-out> or C<txz-out>."
+#. type: textblock
+#: ../src/guestfs.pod:1443
+msgid "There has not been any error on the handle."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3716
-msgid "tgz-in"
+#. type: textblock
+#: ../src/guestfs.pod:1447
+msgid ""
+"There has been an error but the errno was meaningless. This corresponds to "
+"the case where the error did not come from a failed system call, but for "
+"some other reason."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3718
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1453
msgid ""
-" tgz-in (tarball|-) directory\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3723
-msgid "To upload an uncompressed tarball, use C<tar-in>."
+#. type: textblock
+#: ../src/guestfs.pod:1459
+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
-#: ../fish/guestfish-actions.pod:3727
-msgid "tgz-out"
+#. type: =head2
+#: ../src/guestfs.pod:1467
+msgid "guestfs_set_error_handler"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3729
+#. type: verbatim
+#: ../src/guestfs.pod:1469
#, no-wrap
msgid ""
-" tgz-out directory (tarball|-)\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
-#: ../fish/guestfish-actions.pod:3734
-msgid "To download an uncompressed tarball, use C<tar-out>."
+#. type: textblock
+#: ../src/guestfs.pod:1476
+msgid ""
+"The callback C<cb> will be called if there is an error. The parameters "
+"passed to the callback are an opaque data pointer and the error message "
+"string."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3738
-msgid "touch"
+#. type: textblock
+#: ../src/guestfs.pod:1480
+msgid ""
+"C<errno> is not passed to the callback. To get that the callback must call "
+"L</guestfs_last_errno>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3740
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1483
msgid ""
-" touch path\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:3749
-msgid "truncate"
+#. type: textblock
+#: ../src/guestfs.pod:1487
+msgid "The default handler prints messages on C<stderr>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3751
+#. type: textblock
+#: ../src/guestfs.pod:1489
+msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
+msgstr ""
+
+#. type: =head2
+#: ../src/guestfs.pod:1491
+msgid "guestfs_get_error_handler"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1493
#, no-wrap
msgid ""
-" truncate path\n"
+" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
+" void **opaque_rtn);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3756
-msgid "truncate-size"
+#. type: textblock
+#: ../src/guestfs.pod:1496
+msgid "Returns the current error handler callback."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3758
+#. type: =head2
+#: ../src/guestfs.pod:1498
+msgid "guestfs_set_out_of_memory_handler"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1500
#, no-wrap
msgid ""
-" truncate-size path size\n"
+" typedef void (*guestfs_abort_cb) (void);\n"
+" void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
+" guestfs_abort_cb);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3763
+#. type: textblock
+#: ../src/guestfs.pod:1504
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."
+"The callback C<cb> will be called if there is an out of memory situation. "
+"I<Note this callback must not return>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3769
-msgid "tune2fs-l"
+#. type: textblock
+#: ../src/guestfs.pod:1507
+msgid "The default is to call L<abort(3)>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3771
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1509
msgid ""
-" tune2fs-l device\n"
-"\n"
+"You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3781
-msgid "txz-in"
+#. type: =head2
+#: ../src/guestfs.pod:1512
+msgid "guestfs_get_out_of_memory_handler"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3783
+#. type: verbatim
+#: ../src/guestfs.pod:1514
#, no-wrap
msgid ""
-" txz-in (tarball|-) directory\n"
+" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3790
-msgid "txz-out"
+#. type: textblock
+#: ../src/guestfs.pod:1516
+msgid "This returns the current out of memory handler."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3792
-#, no-wrap
-msgid ""
-" txz-out directory (tarball|-)\n"
-"\n"
+#. type: =head1
+#: ../src/guestfs.pod:1518
+msgid "API CALLS"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3799
-msgid "umask"
+#. type: =head1
+#: ../src/guestfs.pod:1522
+msgid "STRUCTURES"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3801
-#, no-wrap
-msgid ""
-" umask mask\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:1524
+msgid "@STRUCTS@"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3815
-msgid "See also C<get-umask>, L<umask(2)>, C<mknod>, C<mkdir>."
+#. type: =head1
+#: ../src/guestfs.pod:1526
+msgid "AVAILABILITY"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3820
-msgid "umount | unmount"
+#. type: =head2
+#: ../src/guestfs.pod:1528
+msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3822
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1530
msgid ""
-" umount pathordevice\n"
-"\n"
+"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:1535
+msgid "@AVAILABILITY@"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3828
-msgid "umount-all | unmount-all"
+#. type: =head2
+#: ../src/guestfs.pod:1537
+msgid "GUESTFISH supported COMMAND"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3830
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1539
msgid ""
-" umount-all\n"
-"\n"
+"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
-#: ../fish/guestfish-actions.pod:3836
-msgid "upload"
+#. type: =head2
+#: ../src/guestfs.pod:1544
+msgid "SINGLE CALLS AT COMPILE TIME"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3838
+#. type: textblock
+#: ../src/guestfs.pod:1546
+msgid ""
+"Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
+"function, such as:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:1549
#, no-wrap
msgid ""
-" upload (filename|-) remotefilename\n"
+" #define LIBGUESTFS_HAVE_DD 1\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3845
-msgid "See also C<download>."
+#. type: textblock
+#: ../src/guestfs.pod:1551
+msgid "if L</guestfs_dd> is available."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3849
-msgid "utimens"
+#. type: textblock
+#: ../src/guestfs.pod:1553
+msgid ""
+"Before version 1.5.8, if you needed to test whether a single libguestfs "
+"function is available at compile time, we recommended using build tools such "
+"as autoconf or cmake. For example in autotools you could use:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3851
+#. type: verbatim
+#: ../src/guestfs.pod:1558
#, no-wrap
msgid ""
-" utimens path atsecs atnsecs mtsecs mtnsecs\n"
+" AC_CHECK_LIB([guestfs],[guestfs_create])\n"
+" AC_CHECK_FUNCS([guestfs_dd])\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3870
-msgid "version"
+#. type: textblock
+#: ../src/guestfs.pod:1561
+msgid ""
+"which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
+"in your program."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3872
-#, no-wrap
-msgid ""
-" version\n"
-"\n"
+#. type: =head2
+#: ../src/guestfs.pod:1564
+msgid "SINGLE CALLS AT RUN TIME"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3899
+#. type: textblock
+#: ../src/guestfs.pod:1566
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."
+"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: =head2
-#: ../fish/guestfish-actions.pod:3905
-msgid "vfs-label"
+#. type: textblock
+#: ../src/guestfs.pod:1573
+msgid ""
+"You can use L<dlopen(3)> to test if a function is available at run time, as "
+"in this example program (note that you still need the compile time check as "
+"well):"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3907
+#. type: verbatim
+#: ../src/guestfs.pod:1577
#, no-wrap
msgid ""
-" vfs-label device\n"
-"\n"
+" #include <stdio.h>\n"
+" #include <stdlib.h>\n"
+" #include <unistd.h>\n"
+" #include <dlfcn.h>\n"
+" #include <guestfs.h>\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3914
-msgid "To find a filesystem from the label, use C<findfs-label>."
+#. type: verbatim
+#: ../src/guestfs.pod:1583
+#, no-wrap
+msgid ""
+" main ()\n"
+" {\n"
+" #ifdef LIBGUESTFS_HAVE_DD\n"
+" void *dl;\n"
+" int has_function;\n"
+" \n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3916
-msgid "vfs-type"
+#. type: verbatim
+#: ../src/guestfs.pod:1589
+#, no-wrap
+msgid ""
+" /* Test if the function guestfs_dd is really available. */\n"
+" dl = dlopen (NULL, RTLD_LAZY);\n"
+" if (!dl) {\n"
+" fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
+" exit (EXIT_FAILURE);\n"
+" }\n"
+" has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
+" dlclose (dl);\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3918
+#. type: verbatim
+#: ../src/guestfs.pod:1598
#, no-wrap
msgid ""
-" vfs-type device\n"
+" 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: =head2
-#: ../fish/guestfish-actions.pod:3928
-msgid "vfs-uuid"
+#. type: textblock
+#: ../src/guestfs.pod:1611
+msgid ""
+"You may think the above is an awful lot of hassle, and it is. There are "
+"other ways outside of the C linking system to ensure that this kind of "
+"incompatibility never arises, such as using package versioning:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3930
+#. type: verbatim
+#: ../src/guestfs.pod:1616
#, no-wrap
msgid ""
-" vfs-uuid device\n"
+" Requires: libguestfs >= 1.0.80\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3937
-msgid "To find a filesystem from the UUID, use C<findfs-uuid>."
+#. type: =head1
+#: ../src/guestfs.pod:1618
+msgid "CALLS WITH OPTIONAL ARGUMENTS"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3939
-msgid "vg-activate"
+#. type: textblock
+#: ../src/guestfs.pod:1620
+msgid ""
+"A recent feature of the API is the introduction of calls which take optional "
+"arguments. In C these are declared 3 ways. The main way is as a call which "
+"takes variable arguments (ie. C<...>), as in this example:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3941
+#. type: verbatim
+#: ../src/guestfs.pod:1625
#, no-wrap
msgid ""
-" vg-activate true|false 'volgroups ...'\n"
+" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3954
-msgid "vg-activate-all"
+#. type: textblock
+#: ../src/guestfs.pod:1627
+msgid ""
+"Call this with a list of optional arguments, terminated by C<-1>. So to "
+"call with no optional arguments specified:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3956
+#. type: verbatim
+#: ../src/guestfs.pod:1630
#, no-wrap
msgid ""
-" vg-activate-all true|false\n"
+" guestfs_add_drive_opts (g, filename, -1);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3966
-msgid "vgcreate"
+#. type: textblock
+#: ../src/guestfs.pod:1632
+msgid "With a single optional argument:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3968
+#. type: verbatim
+#: ../src/guestfs.pod:1634
#, no-wrap
msgid ""
-" vgcreate volgroup 'physvols ...'\n"
+" guestfs_add_drive_opts (g, filename,\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
+" -1);\n"
"\n"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3973
-msgid "vglvuuids"
+#. type: textblock
+#: ../src/guestfs.pod:1638
+msgid "With two:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3975
+#. type: verbatim
+#: ../src/guestfs.pod:1640
#, no-wrap
msgid ""
-" vglvuuids vgname\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
-#: ../fish/guestfish-actions.pod:3980
+#. type: textblock
+#: ../src/guestfs.pod:1645
msgid ""
-"You can use this along with C<lvs> and C<lvuuid> calls to associate logical "
-"volumes and volume groups."
+"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
+"happen!"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3983
-msgid "See also C<vgpvuuids>."
+#. type: =head2
+#: ../src/guestfs.pod:1648
+msgid "USING va_list FOR OPTIONAL ARGUMENTS"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3985
-msgid "vgpvuuids"
+#. type: textblock
+#: ../src/guestfs.pod:1650
+msgid ""
+"The second variant has the same name with the suffix C<_va>, which works the "
+"same way but takes a C<va_list>. See the C manual for details. For the "
+"example function, this is declared:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3987
+#. type: verbatim
+#: ../src/guestfs.pod:1654
#, no-wrap
msgid ""
-" vgpvuuids vgname\n"
+" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
+" va_list args);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:3992
-msgid ""
-"You can use this along with C<pvs> and C<pvuuid> calls to associate physical "
-"volumes and volume groups."
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:3995
-msgid "See also C<vglvuuids>."
+#. type: =head2
+#: ../src/guestfs.pod:1657
+msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:3997
-msgid "vgremove"
+#. type: textblock
+#: ../src/guestfs.pod:1659
+msgid ""
+"The third variant is useful where you need to construct these calls. You "
+"pass in a structure where you fill in the optional fields. The structure "
+"has a bitmask as the first element which you must set to indicate which "
+"fields you have filled in. For our example function the structure and call "
+"are declared:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:3999
+#. type: verbatim
+#: ../src/guestfs.pod:1665
#, no-wrap
msgid ""
-" vgremove vgname\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: =head2
-#: ../fish/guestfish-actions.pod:4006
-msgid "vgrename"
+#. type: textblock
+#: ../src/guestfs.pod:1674
+msgid "You could call it like this:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4008
+#. type: verbatim
+#: ../src/guestfs.pod:1676
#, no-wrap
msgid ""
-" vgrename volgroup newvolgroup\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:4012
-msgid "vgs"
+" struct guestfs_add_drive_opts_argv optargs = {\n"
+" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
+" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
+" .readonly = 1,\n"
+" .format = \"qcow2\"\n"
+" };\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4014
+#. type: verbatim
+#: ../src/guestfs.pod:1683
#, no-wrap
msgid ""
-" vgs\n"
+" guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:4022
-msgid "See also C<vgs-full>."
+#. type: textblock
+#: ../src/guestfs.pod:1691
+msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4024
-msgid "vgs-full"
+#. type: textblock
+#: ../src/guestfs.pod:1696
+msgid "You do not need to fill in all fields of the structure."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4026
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1700
msgid ""
-" vgs-full\n"
-"\n"
+"There must be a one-to-one correspondence between fields of the structure "
+"that are filled in, and bits set in the bitmask."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4031
-msgid "vgscan"
+#. type: =head2
+#: ../src/guestfs.pod:1705
+msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4033
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1707
msgid ""
-" vgscan\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:4038
-msgid "vguuid"
+"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
-#: ../fish/guestfish-actions.pod:4040
-#, no-wrap
-msgid ""
-" vguuid vgname\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:1711
+msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4044
-msgid "wc-c"
+#. type: =head2
+#: ../src/guestfs.pod:1713
+msgid "SETTING CALLBACKS TO HANDLE EVENTS"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4046
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1715
msgid ""
-" wc-c path\n"
-"\n"
+"B<Note:> This section documents the generic event mechanism introduced in "
+"libguestfs 1.10, which you should use in new code if possible. The old "
+"functions C<guestfs_set_log_message_callback>, "
+"C<guestfs_set_subprocess_quit_callback>, "
+"C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
+"C<guestfs_set_progress_callback> are no longer documented in this manual "
+"page. Because of the ABI guarantee, the old functions continue to work."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4051
-msgid "wc-l"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4053
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1724
msgid ""
-" wc-l path\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:4058
-msgid "wc-w"
+"Handles generate events when certain things happen, such as log messages "
+"being generated, progress messages during long-running operations, or the "
+"handle being closed. The API calls described below let you register a "
+"callback to be called when events happen. You can register multiple "
+"callbacks (for the same, different or overlapping sets of events), and "
+"individually remove callbacks. If callbacks are not removed, then they "
+"remain in force until the handle is closed."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4060
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1732
msgid ""
-" wc-w path\n"
-"\n"
-msgstr ""
-
-# type: =head2
-#: ../fish/guestfish-actions.pod:4065
-msgid "write"
+"In the current implementation, events are only generated synchronously: that "
+"means that events (and hence callbacks) can only happen while you are in the "
+"middle of making another libguestfs call. The callback is called in the "
+"same thread."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4067
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1737
msgid ""
-" write path content\n"
-"\n"
+"Events may contain a payload, usually nothing (void), an array of 64 bit "
+"unsigned integers, or a message buffer. Payloads are discussed later on."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4075
-msgid "write-file"
-msgstr ""
-
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4077
-#, no-wrap
-msgid ""
-" write-file path content size\n"
-"\n"
+#. type: =head3
+#: ../src/guestfs.pod:1741
+msgid "CLASSES OF EVENTS"
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4100
-msgid "zegrep"
+#. type: =item
+#: ../src/guestfs.pod:1745
+msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4102
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1748
msgid ""
-" zegrep regex path\n"
-"\n"
+"The callback function will be called while the handle is being closed "
+"(synchronously from L</guestfs_close>)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4110
-msgid "zegrepi"
+#. type: textblock
+#: ../src/guestfs.pod:1751
+msgid ""
+"Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
+"handles that are open when the program exits. This means that this callback "
+"might be called indirectly from L<exit(3)>, which can cause unexpected "
+"problems in higher-level languages (eg. if your HLL interpreter has already "
+"been cleaned up by the time this is called, and if your callback then jumps "
+"into some HLL function)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4112
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1758
msgid ""
-" zegrepi regex path\n"
-"\n"
+"If no callback is registered: the handle is closed without any callback "
+"being invoked."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4120
-msgid "zero"
+#. type: =item
+#: ../src/guestfs.pod:1761
+msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4122
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1764
msgid ""
-" zero device\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../fish/guestfish-actions.pod:4130
-msgid "See also: C<zero-device>, C<scrub-device>."
+"The callback function will be called when the child process quits, either "
+"asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
+"corresponds to a transition from any state to the CONFIG state)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4132
-msgid "zero-device"
+#. type: textblock
+#: ../src/guestfs.pod:1768 ../src/guestfs.pod:1777 ../src/guestfs.pod:1894
+msgid "If no callback is registered: the event is ignored."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4134
-#, no-wrap
-msgid ""
-" zero-device device\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:1770
+msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:4136
+#. type: textblock
+#: ../src/guestfs.pod:1773
msgid ""
-"This command writes zeroes over the entire C<device>. Compare with C<zero> "
-"which just zeroes the first few blocks of a device."
+"The callback function will be called when the child process becomes ready "
+"first time after it has been launched. (This corresponds to a transition "
+"from LAUNCHING to the READY state)."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4143
-msgid "zerofree"
+#. type: =item
+#: ../src/guestfs.pod:1779
+msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4145
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1782
msgid ""
-" zerofree device\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:4158
-msgid "zfgrep"
+#. type: textblock
+#: ../src/guestfs.pod:1788
+msgid ""
+"The callback receives in the payload four unsigned 64 bit numbers which are "
+"(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4160
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1791
msgid ""
-" zfgrep pattern path\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:4168
-msgid "zfgrepi"
+#. type: textblock
+#: ../src/guestfs.pod:1796
+msgid "The only defined and stable parts of the API are:"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4170
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1802
msgid ""
-" zfgrepi pattern path\n"
-"\n"
+"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: =head2
-#: ../fish/guestfish-actions.pod:4178
-msgid "zfile"
+#. type: textblock
+#: ../src/guestfs.pod:1807
+msgid "0 E<lt>= C<position> E<lt>= C<total>"
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4180
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1811
msgid ""
-" zfile meth path\n"
-"\n"
+"If any progress notification is sent during a call, then a final progress "
+"notification is always sent when C<position> = C<total> (I<unless> the call "
+"fails with an error)."
msgstr ""
-# type: textblock
-#: ../fish/guestfish-actions.pod:4187
+#. type: textblock
+#: ../src/guestfs.pod:1815
msgid ""
-"Since 1.0.63, use C<file> instead which can now process compressed files."
+"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: =head2
-#: ../fish/guestfish-actions.pod:4197
-msgid "zgrep"
+#. type: textblock
+#: ../src/guestfs.pod:1821
+msgid ""
+"For some calls we are unable to estimate the progress of the call, but we "
+"can still generate progress messages to indicate activity. This is known as "
+"\"pulse mode\", and is directly supported by certain progress bar "
+"implementations (eg. GtkProgressBar)."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4199
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1826
msgid ""
-" zgrep regex path\n"
-"\n"
+"For these calls, zero or more progress messages are generated with "
+"C<position = 0> and C<total = 1>, followed by a final message with "
+"C<position = total = 1>."
msgstr ""
-# type: =head2
-#: ../fish/guestfish-actions.pod:4207
-msgid "zgrepi"
+#. type: textblock
+#: ../src/guestfs.pod:1830
+msgid ""
+"As noted above, if the call fails with an error then the final message may "
+"not be generated."
msgstr ""
-# type: verbatim
-#: ../fish/guestfish-actions.pod:4209
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1835
msgid ""
-" zgrepi regex path\n"
-"\n"
+"The callback also receives the procedure number (C<proc_nr>) and serial "
+"number (C<serial>) of the call. These are only useful for debugging "
+"protocol issues, and the callback can normally ignore them. The callback "
+"may want to print these numbers in error messages or debugging messages."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:5
-msgid "libguestfs-test-tool - End user tests for libguestfs"
+#. type: textblock
+#: ../src/guestfs.pod:1841
+msgid "If no callback is registered: progress messages are discarded."
msgstr ""
-# type: verbatim
-#: ../test-tool/libguestfs-test-tool.pod:9
-#, no-wrap
-msgid ""
-" libguestfs-test-tool [--options]\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:1843
+msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:13
+#. type: textblock
+#: ../src/guestfs.pod:1846
msgid ""
-"libguestfs-test-tool is a test program shipped with libguestfs to end users "
-"and developers, to allow them to check basic libguestfs functionality is "
-"working. This is needed because libguestfs occasionally breaks for reasons "
-"beyond our control: usually because of changes in the underlying qemu or "
-"kernel packages, or the host environment."
+"The callback function is called whenever a log message is generated by qemu, "
+"the appliance kernel, guestfsd (daemon), or utility programs."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:20
-msgid "If you suspect a problem in libguestfs, then just run:"
+#. type: textblock
+#: ../src/guestfs.pod:1849
+msgid ""
+"If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
+"guestfs_launch>) then additional debug messages are generated."
msgstr ""
-# type: verbatim
-#: ../test-tool/libguestfs-test-tool.pod:22
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1852 ../src/guestfs.pod:1866
msgid ""
-" libguestfs-test-tool\n"
-"\n"
+"If no callback is registered: the messages are discarded unless the verbose "
+"flag is set in which case they are sent to stderr. You can override the "
+"printing of verbose messages to stderr by setting up a callback."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:24
-msgid "It will print lots of diagnostic messages."
+#. type: =item
+#: ../src/guestfs.pod:1857
+msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:26
-msgid "If it runs to completion successfully, you will see this near the end:"
+#. type: textblock
+#: ../src/guestfs.pod:1860
+msgid ""
+"The callback function is called whenever a log message is generated by the "
+"library part of libguestfs."
msgstr ""
-# type: verbatim
-#: ../test-tool/libguestfs-test-tool.pod:28
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1863
msgid ""
-" ===== TEST FINISHED OK =====\n"
-"\n"
+"If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
+"messages are generated."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:30
-msgid "and the test tool will exit with code 0."
+#. type: =item
+#: ../src/guestfs.pod:1871
+msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:32
+#. type: textblock
+#: ../src/guestfs.pod:1874
msgid ""
-"If it fails (and/or exits with non-zero error code), please paste the "
-"B<complete, unedited> output of the test tool into a bug report. More "
-"information about reporting bugs can be found on the L<http://libguestfs.org/"
-"> website."
-msgstr ""
-
-# type: =item
-#: ../test-tool/libguestfs-test-tool.pod:41
-msgid "I<--help>"
+"The callback function is called whenever a trace message is generated. This "
+"only applies if the trace flag (L</guestfs_set_trace>) is set."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:43
-msgid "Display short usage information and exit."
+#. type: textblock
+#: ../src/guestfs.pod:1877
+msgid ""
+"If no callback is registered: the messages are sent to stderr. You can "
+"override the printing of trace messages to stderr by setting up a callback."
msgstr ""
-# type: =item
-#: ../test-tool/libguestfs-test-tool.pod:45
-msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
+#. type: =item
+#: ../src/guestfs.pod:1881
+msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:47
+#. type: textblock
+#: ../src/guestfs.pod:1884
msgid ""
-"Pass an alternate name for the helper program. libguestfs-test-tool will "
-"normally look in the C<$libexec> directory that was configured when the tool "
-"was built."
+"The callback function is called whenever a libguestfs function is entered."
msgstr ""
-# type: =item
-#: ../test-tool/libguestfs-test-tool.pod:51
-msgid "I<--qemu qemu_binary>"
+#. type: textblock
+#: ../src/guestfs.pod:1887
+msgid ""
+"The payload is a string which contains the name of the function that we are "
+"entering (not including C<guestfs_> prefix)."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:53
+#. type: textblock
+#: ../src/guestfs.pod:1890
msgid ""
-"If you have downloaded another qemu binary, point this option at the full "
-"path of the binary to try it."
+"Note that libguestfs functions can call themselves, so you may see many "
+"events from a single call. A few libguestfs functions do not generate this "
+"event."
msgstr ""
-# type: =item
-#: ../test-tool/libguestfs-test-tool.pod:56
-msgid "I<--qemudir qemu_source_dir>"
+#. type: =head3
+#: ../src/guestfs.pod:1898
+msgid "guestfs_set_event_callback"
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:58
+#. type: verbatim
+#: ../src/guestfs.pod:1900
+#, no-wrap
msgid ""
-"If you have compiled qemu from source, point this option at the source "
-"directory to try it."
+" int guestfs_set_event_callback (guestfs_h *g,\n"
+" guestfs_event_callback cb,\n"
+" uint64_t event_bitmask,\n"
+" int flags,\n"
+" void *opaque);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../test-tool/libguestfs-test-tool.pod:61
-msgid "I<--timeout N>"
+#. type: textblock
+#: ../src/guestfs.pod:1906
+msgid ""
+"This function registers a callback (C<cb>) for all event classes in the "
+"C<event_bitmask>."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:63
+#. type: textblock
+#: ../src/guestfs.pod:1909
msgid ""
-"Set the launch timeout to C<N> seconds. The default is 120 seconds which "
-"does not usually need to be adjusted unless your machine is very slow."
+"For example, to register for all log message events, you could call this "
+"function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
+"To register a single callback for all possible classes of events, use "
+"C<GUESTFS_EVENT_ALL>."
msgstr ""
-# type: =head1
-#: ../test-tool/libguestfs-test-tool.pod:69
-msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
+#. type: textblock
+#: ../src/guestfs.pod:1915
+msgid "C<flags> should always be passed as 0."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:71
+#. type: textblock
+#: ../src/guestfs.pod:1917
msgid ""
-"If you have compiled another version of qemu from source and would like to "
-"try that, then you can use the I<--qemudir> option to point to the qemu "
-"source directory."
+"C<opaque> is an opaque pointer which is passed to the callback. You can use "
+"it for any purpose."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:75
+#. type: textblock
+#: ../src/guestfs.pod:1920
msgid ""
-"If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
-"option to point to the binary."
+"The return value is the event handle (an integer) which you can use to "
+"delete the callback (see below)."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:78
+#. type: textblock
+#: ../src/guestfs.pod:1923
msgid ""
-"When using an alternate qemu with libguestfs, usually you would need to "
-"write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
-">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
-"use either of the I<--qemudir> or I<--qemu> options."
+"If there is an error, this function returns C<-1>, and sets the error in the "
+"handle in the usual way (see L</guestfs_last_error> etc.)"
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:85
+#. type: textblock
+#: ../src/guestfs.pod:1926
msgid ""
-"libguestfs-test-tool returns I<0> if the tests completed without error, or "
-"I<1> if there was an error."
-msgstr ""
-
-# type: =item
-#: ../test-tool/libguestfs-test-tool.pod:92
-msgid "/usr/libexec/libguestfs-test-tool-helper"
+"Callbacks remain in effect until they are deleted, or until the handle is "
+"closed."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:94
+#. type: textblock
+#: ../src/guestfs.pod:1929
msgid ""
-"This helper program is run inside the appliance and provides additional "
-"tests."
+"In the case where multiple callbacks are registered for a particular event "
+"class, all of the callbacks are called. The order in which multiple "
+"callbacks are called is not defined."
msgstr ""
-# type: =item
-#: ../test-tool/libguestfs-test-tool.pod:97
-msgid "/usr/bin/mkisofs"
+#. type: =head3
+#: ../src/guestfs.pod:1933
+msgid "guestfs_delete_event_callback"
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:99
+#. type: verbatim
+#: ../src/guestfs.pod:1935
+#, no-wrap
msgid ""
-"The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
-"which is used as part of the tests."
+" void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:106
+#. type: textblock
+#: ../src/guestfs.pod:1937
msgid ""
-"For the full list of environment variables which may affect libguestfs, "
-"please see the L<guestfs(3)> manual page."
+"Delete a callback that was previously registered. C<event_handle> should be "
+"the integer that was returned by a previous call to "
+"C<guestfs_set_event_callback> on the same handle."
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:111
-msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
+#. type: =head3
+#: ../src/guestfs.pod:1941
+msgid "guestfs_event_callback"
msgstr ""
-# type: textblock
-#: ../test-tool/libguestfs-test-tool.pod:121 ../fuse/guestmount.pod:195
-msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
+#. type: verbatim
+#: ../src/guestfs.pod:1943
+#, no-wrap
+msgid ""
+" typedef void (*guestfs_event_callback) (\n"
+" guestfs_h *g,\n"
+" void *opaque,\n"
+" uint64_t event,\n"
+" int event_handle,\n"
+" int flags,\n"
+" const char *buf, size_t buf_len,\n"
+" const uint64_t *array, size_t array_len);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:5
+#. type: textblock
+#: ../src/guestfs.pod:1952
msgid ""
-"guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
+"This is the type of the event callback function that you have to provide."
msgstr ""
-# type: verbatim
-#: ../fuse/guestmount.pod:9
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1955
msgid ""
-" guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
-"\n"
+"The basic parameters are: the handle (C<g>), the opaque user pointer "
+"(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
+"handle, and C<flags> which in the current API you should ignore."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:13
+#. type: textblock
+#: ../src/guestfs.pod:1959
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."
+"The remaining parameters contain the event payload (if any). Each event may "
+"contain a payload, which usually relates to the event class, but for future "
+"proofing your code should be written to handle any payload for any event "
+"class."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:18
+#. type: textblock
+#: ../src/guestfs.pod:1964
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 "
-"filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
-"a mountable device."
+"C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
+"there is no message buffer). Note that this message buffer can contain "
+"arbitrary 8 bit data, including NUL bytes."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:23
+#. type: textblock
+#: ../src/guestfs.pod:1968
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."
+"C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
+"moment this is only used for progress messages."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:29
-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 "
-"make certain global configuration changes to C</etc/fuse.conf>. To unmount "
-"the filesystem, use the C<fusermount -u> command."
+#. type: =head3
+#: ../src/guestfs.pod:1971
+msgid "EXAMPLE: CAPTURING LOG MESSAGES"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:37
+#. type: textblock
+#: ../src/guestfs.pod:1973
msgid ""
-"For a typical Windows guest which has its main filesystem on the first "
-"partition:"
+"One motivation for the generic event API was to allow GUI programs to "
+"capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
+"unconditionally to C<stderr>."
msgstr ""
-# type: verbatim
-#: ../fuse/guestmount.pod:40
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:1977
msgid ""
-" guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
-"\n"
+"Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
+"C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
+"messages are not events; you must capture error messages separately)."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:42
+#. type: textblock
+#: ../src/guestfs.pod:1982
msgid ""
-"For a typical Linux guest which has a /boot filesystem on the first "
-"partition, and the root filesystem on a logical volume:"
+"Programs have to set up a callback to capture the classes of events of "
+"interest:"
msgstr ""
-# type: verbatim
-#: ../fuse/guestmount.pod:45
+#. type: verbatim
+#: ../src/guestfs.pod:1985
#, no-wrap
msgid ""
-" guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
+" int eh =\n"
+" guestfs_set_event_callback\n"
+" (g, message_callback,\n"
+" GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
+" GUESTFS_EVENT_TRACE,\n"
+" 0, NULL) == -1)\n"
+" if (eh == -1) {\n"
+" // handle error in the usual way\n"
+" }\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:47
+#. type: textblock
+#: ../src/guestfs.pod:1995
msgid ""
-"To get L<virt-inspector(1)> to do the hard work of detecting guest "
-"mountpoints for you:"
+"The callback can then direct messages to the appropriate place. In this "
+"example, messages are directed to syslog:"
msgstr ""
-# type: verbatim
-#: ../fuse/guestmount.pod:50
+#. type: verbatim
+#: ../src/guestfs.pod:1998
#, no-wrap
msgid ""
-" guestmount $(virt-inspector --ro-fish MyGuest) /mnt\n"
+" static void\n"
+" message_callback (\n"
+" guestfs_h *g,\n"
+" void *opaque,\n"
+" uint64_t event,\n"
+" int event_handle,\n"
+" int flags,\n"
+" const char *buf, size_t buf_len,\n"
+" const uint64_t *array, size_t array_len)\n"
+" {\n"
+" const int priority = LOG_USER|LOG_INFO;\n"
+" if (buf_len > 0)\n"
+" syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
+" }\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:52
-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)>."
+#. type: =head1
+#: ../src/guestfs.pod:2013
+msgid "CANCELLING LONG TRANSFERS"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:56
+#. type: textblock
+#: ../src/guestfs.pod:2015
msgid ""
-"If you don't know what filesystems are contained in a guest or disk image, "
-"use L<virt-list-filesystems(1)> first:"
+"Some operations can be cancelled by the caller while they are in progress. "
+"Currently only operations that involve uploading or downloading data can be "
+"cancelled (technically: operations that have C<FileIn> or C<FileOut> "
+"parameters in the generator)."
msgstr ""
-# type: verbatim
-#: ../fuse/guestmount.pod:59
+#. type: =head2
+#: ../src/guestfs.pod:2020
+msgid "guestfs_user_cancel"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:2022
#, no-wrap
msgid ""
-" virt-list-filesystems MyGuest\n"
+" void guestfs_user_cancel (guestfs_h *g);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:61
+#. type: textblock
+#: ../src/guestfs.pod:2024
msgid ""
-"If you want to trace the libguestfs calls but without excessive debugging, "
-"we recommend:"
+"C<guestfs_user_cancel> cancels the current upload or download operation."
msgstr ""
-# type: verbatim
-#: ../fuse/guestmount.pod:64
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2027
msgid ""
-" guestmount [-a ... -m ...] --trace /mnt\n"
-"\n"
+"Unlike most other libguestfs calls, this function is signal safe and thread "
+"safe. You can call it from a signal handler or from another thread, without "
+"needing to do any locking."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:66
-msgid "If you want to debug the program, we recommend:"
+#. type: textblock
+#: ../src/guestfs.pod:2031
+msgid ""
+"The transfer that was in progress (if there is one) will stop shortly "
+"afterwards, and will return an error. The errno (see L</"
+"guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
+"out if the operation was cancelled or failed because of another error."
msgstr ""
-# type: verbatim
-#: ../fuse/guestmount.pod:68
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2037
msgid ""
-" guestmount [-a ... -m ...] --trace --verbose /mnt\n"
-"\n"
+"No cleanup is performed: for example, if a file was being uploaded then "
+"after cancellation there may be a partially uploaded file. It is the "
+"caller's responsibility to clean up if necessary."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:76
-msgid "Add a block device or virtual machine image."
+#. type: textblock
+#: ../src/guestfs.pod:2041
+msgid "There are two common places that you might call C<guestfs_user_cancel>."
msgstr ""
-# type: =item
-#: ../fuse/guestmount.pod:78
-msgid "B<--dir-cache-timeout N>"
+#. type: textblock
+#: ../src/guestfs.pod:2043
+msgid ""
+"In an interactive text-based program, you might call it from a C<SIGINT> "
+"signal handler so that pressing C<^C> cancels the current operation. (You "
+"also need to call L</guestfs_set_pgroup> so that child processes don't "
+"receive the C<^C> signal)."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:80
+#. type: textblock
+#: ../src/guestfs.pod:2048
msgid ""
-"Set the readdir cache timeout to I<N> seconds, the default being 60 "
-"seconds. The readdir cache [actually, there are several semi-independent "
-"caches] is populated after a readdir(2) call with the stat and extended "
-"attributes of the files in the directory, in anticipation that they will be "
-"requested soon after."
+"In a graphical program, when the main thread is displaying a progress bar "
+"with a cancel button, wire up the cancel button to call this function."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:86
-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."
+#. type: =head1
+#: ../src/guestfs.pod:2052
+msgid "PRIVATE DATA AREA"
msgstr ""
-# type: =item
-#: ../fuse/guestmount.pod:90
-msgid "B<--fuse-help>"
+#. type: textblock
+#: ../src/guestfs.pod:2054
+msgid ""
+"You can attach named pieces of private data to the libguestfs handle, fetch "
+"them by name, and walk over them, for the lifetime of the handle. This is "
+"called the private data area and is only available from the C API."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:92
-msgid "Display help on special FUSE options (see I<-o> below)."
+#. type: textblock
+#: ../src/guestfs.pod:2059
+msgid "To attach a named piece of data, use the following call:"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:96
-msgid "Display brief help and exit."
+#. type: verbatim
+#: ../src/guestfs.pod:2061
+#, no-wrap
+msgid ""
+" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fuse/guestmount.pod:98
-msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
+#. type: textblock
+#: ../src/guestfs.pod:2063
+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 key is "
+"overwritten."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:100
+#. type: textblock
+#: ../src/guestfs.pod:2067
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)."
+"You can use any C<key> you want, but your key should I<not> start with an "
+"underscore character. Keys beginning with an underscore character are "
+"reserved for internal libguestfs purposes (eg. for implementing language "
+"bindings). It is recommended that you prefix the key with some unique "
+"string to avoid collisions with other users."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2073
+msgid "To retrieve the pointer, use:"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:103
+#. type: verbatim
+#: ../src/guestfs.pod:2075
+#, no-wrap
msgid ""
-"If the mountpoint is omitted, it defaults to C</>. You have to mount "
-"something on C</>."
+" void *guestfs_get_private (guestfs_h *g, const char *key);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:108
+#. type: textblock
+#: ../src/guestfs.pod:2077
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 "
-"disk. See the discussion of autosync in the L<guestfs(3)> manpage."
+"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
-#: ../fuse/guestmount.pod:113
-msgid "B<-o option> | B<--option option>"
+#. type: textblock
+#: ../src/guestfs.pod:2081
+msgid ""
+"Libguestfs does not try to look at or interpret the C<data> pointer in any "
+"way. As far as libguestfs is concerned, it need not be a valid pointer at "
+"all. In particular, libguestfs does I<not> try to free the data when the "
+"handle is closed. If the data must be freed, then the caller must either "
+"free it before calling L</guestfs_close> or must set up a close callback to "
+"do it (see L</GUESTFS_EVENT_CLOSE>)."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:115
-msgid "Pass extra options to FUSE."
+#. type: textblock
+#: ../src/guestfs.pod:2088
+msgid "To walk over all entries, use these two functions:"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:117
+#. type: verbatim
+#: ../src/guestfs.pod:2090
+#, no-wrap
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 "
-"of them are a good idea."
+" void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../fuse/guestmount.pod:121
+#. type: verbatim
+#: ../src/guestfs.pod:2092
#, no-wrap
msgid ""
-" guestmount --fuse-help\n"
+" void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
"\n"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:123
-msgid "Some potentially useful FUSE options:"
+#. type: textblock
+#: ../src/guestfs.pod:2094
+msgid ""
+"C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
+"not have any particular meaning -- keys are not returned in any defined "
+"order). A pointer to the key is returned in C<*key_rtn> and the "
+"corresponding data pointer is returned from the function. C<NULL> is "
+"returned if there are no keys stored in the handle."
msgstr ""
-# type: =item
-#: ../fuse/guestmount.pod:127
-msgid "B<-o allow_other>"
+#. type: textblock
+#: ../src/guestfs.pod:2100
+msgid ""
+"C<guestfs_next_private> returns the next key, pointer pair. The return "
+"value of this function is also C<NULL> is there are no further entries to "
+"return."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:129
-msgid "Allow other users to see the filesystem."
+#. type: textblock
+#: ../src/guestfs.pod:2104
+msgid "Notes about walking over entries:"
msgstr ""
-# type: =item
-#: ../fuse/guestmount.pod:131
-msgid "B<-o attr_timeout=N>"
+#. type: textblock
+#: ../src/guestfs.pod:2110
+msgid ""
+"You must not call C<guestfs_set_private> while walking over the entries."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:133
-msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
+#. type: textblock
+#: ../src/guestfs.pod:2115
+msgid ""
+"The handle maintains an internal iterator which is reset when you call "
+"C<guestfs_first_private>. This internal iterator is invalidated when you "
+"call C<guestfs_set_private>."
msgstr ""
-# type: =item
-#: ../fuse/guestmount.pod:135
-msgid "B<-o kernel_cache>"
+#. type: textblock
+#: ../src/guestfs.pod:2121
+msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:137
+#. type: verbatim
+#: ../src/guestfs.pod:2123
+#, no-wrap
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 "
-"afford the extra memory usage."
+" guestfs_set_private (g, key, NULL);\n"
+"\n"
msgstr ""
-# type: =item
-#: ../fuse/guestmount.pod:141
-msgid "B<-o uid=N> B<-o gid=N>"
+#. type: textblock
+#: ../src/guestfs.pod:2125
+msgid "then that C<key> is not returned when walking."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:143
+#. type: textblock
+#: ../src/guestfs.pod:2129
msgid ""
-"Use these options to map all UIDs and GIDs inside the guest filesystem to "
-"the chosen values."
+"C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
+"C<guestfs_next_private> or C<guestfs_set_private>."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:150
+#. type: textblock
+#: ../src/guestfs.pod:2135
msgid ""
-"Add devices and mount everything read-only. Also disallow writes and make "
-"the disk appear read-only to FUSE."
+"The following example code shows how to print all keys and data pointers "
+"that are associated with the handle C<g>:"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:153
+#. type: verbatim
+#: ../src/guestfs.pod:2138
+#, no-wrap
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 "
-"strong risk of disk corruption in the guest. We try to prevent this from "
-"happening, but it is not always possible."
+" const char *key;\n"
+" void *data = guestfs_first_private (g, &key);\n"
+" while (data != NULL)\n"
+" {\n"
+" printf (\"key = %s, data = %p\\n\", key, data);\n"
+" data = guestfs_next_private (g, &key);\n"
+" }\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:160
-msgid "Enable SELinux support for the guest."
+#. type: textblock
+#: ../src/guestfs.pod:2146
+msgid ""
+"More commonly you are only interested in keys that begin with an application-"
+"specific prefix C<foo_>. Modify the loop like so:"
msgstr ""
-# type: =item
-#: ../fuse/guestmount.pod:162
-msgid "B<--trace>"
+#. type: verbatim
+#: ../src/guestfs.pod:2149
+#, no-wrap
+msgid ""
+" const char *key;\n"
+" void *data = guestfs_first_private (g, &key);\n"
+" while (data != NULL)\n"
+" {\n"
+" if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
+" printf (\"key = %s, data = %p\\n\", key, data);\n"
+" data = guestfs_next_private (g, &key);\n"
+" }\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:164
-msgid "Trace libguestfs calls (to stderr)."
+#. type: textblock
+#: ../src/guestfs.pod:2158
+msgid ""
+"If you need to modify keys while walking, then you have to jump back to the "
+"beginning of the loop. For example, to delete all keys prefixed with "
+"C<foo_>:"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:166
-msgid "This also stops the daemon from forking into the background."
+#. type: verbatim
+#: ../src/guestfs.pod:2162
+#, no-wrap
+msgid ""
+" const char *key;\n"
+" void *data;\n"
+" again:\n"
+" data = guestfs_first_private (g, &key);\n"
+" while (data != NULL)\n"
+" {\n"
+" if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
+" {\n"
+" guestfs_set_private (g, key, NULL);\n"
+" /* note that 'key' pointer is now invalid, and so is\n"
+" the internal iterator */\n"
+" goto again;\n"
+" }\n"
+" data = guestfs_next_private (g, &key);\n"
+" }\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:170
-msgid "Enable verbose messages from underlying libguestfs."
+#. type: textblock
+#: ../src/guestfs.pod:2178
+msgid ""
+"Note that the above loop is guaranteed to terminate because the keys are "
+"being deleted, but other manipulations of keys within the loop might not "
+"terminate unless you also maintain an indication of which keys have been "
+"visited."
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:174
-msgid "Display the program version and exit."
+#. type: =head1
+#: ../src/guestfs.pod:2183
+msgid "SYSTEMTAP"
msgstr ""
-# type: textblock
-#: ../fuse/guestmount.pod:180
+#. type: textblock
+#: ../src/guestfs.pod:2185
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/>, L<http://fuse.sf."
-"net/>."
+"The libguestfs C library can be probed using systemtap or DTrace. This is "
+"true of any library, not just libguestfs. However libguestfs also contains "
+"static markers to help in probing internal operations."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:40
-msgid ""
-"virt-inspector - Display OS version, kernel, drivers, mount points, "
-"applications, etc. in a virtual machine"
+#. type: textblock
+#: ../src/guestfs.pod:2189
+msgid "You can list all the static markers by doing:"
msgstr ""
-# type: verbatim
-#: ../inspector/virt-inspector.pl:44
+#. type: verbatim
+#: ../src/guestfs.pod:2191
#, no-wrap
msgid ""
-" virt-inspector [--connect URI] domname\n"
+" stap -l 'process(\"/usr/lib*/libguestfs.so.0\")\n"
+" .provider(\"guestfs\").mark(\"*\")'\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../inspector/virt-inspector.pl:46
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2194
msgid ""
-" virt-inspector guest.img [guest.img ...]\n"
-"\n"
+"B<Note:> These static markers are I<not> part of the stable API and may "
+"change in future versions."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:50
-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."
+#. type: =head2
+#: ../src/guestfs.pod:2197
+msgid "SYSTEMTAP SCRIPT EXAMPLE"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:55
+#. type: textblock
+#: ../src/guestfs.pod:2199
msgid ""
-"Virt-inspector can produce output in several formats, including a readable "
-"text report, and XML for feeding into other programs."
+"This script contains examples of displaying both the static markers and some "
+"ordinary C entry points:"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:58
+#. type: verbatim
+#: ../src/guestfs.pod:2202
+#, no-wrap
msgid ""
-"In the normal usage, use C<virt-inspector domname> where C<domname> is the "
-"libvirt domain (see: C<virsh list --all>)."
+" global last;\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:61
+#. type: verbatim
+#: ../src/guestfs.pod:2204
+#, no-wrap
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 "
-"has several block devices, in which case you should list them one after "
-"another, with the first corresponding to the guest's C</dev/sda>, the second "
-"to the guest's C</dev/sdb> and so on."
+" function display_time () {\n"
+" now = gettimeofday_us ();\n"
+" delta = 0;\n"
+" if (last > 0)\n"
+" delta = now - last;\n"
+" last = now;\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:67
+#. type: verbatim
+#: ../src/guestfs.pod:2211
+#, no-wrap
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 "
-"times (for example, from a shell script for-loop)."
+" printf (\"%d (+%d):\", now, delta);\n"
+" }\n"
+" \n"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:72
+#. type: verbatim
+#: ../src/guestfs.pod:2214
+#, no-wrap
msgid ""
-"Because virt-inspector needs direct access to guest images, it won't "
-"normally work over remote libvirt connections."
+" probe begin {\n"
+" last = 0;\n"
+" printf (\"ready\\n\");\n"
+" }\n"
+" \n"
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
-msgid "Display brief help."
+#. type: verbatim
+#: ../src/guestfs.pod:2219
+#, no-wrap
+msgid ""
+" /* Display all calls to static markers. */\n"
+" probe process(\"/usr/lib*/libguestfs.so.0\")\n"
+" .provider(\"guestfs\").mark(\"*\") ? {\n"
+" display_time();\n"
+" printf (\"\\t%s %s\\n\", $$name, $$parms);\n"
+" }\n"
+" \n"
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
-msgid "B<--version>"
+#. type: verbatim
+#: ../src/guestfs.pod:2226
+#, no-wrap
+msgid ""
+" /* Display all calls to guestfs_mkfs* functions. */\n"
+" probe process(\"/usr/lib*/libguestfs.so.0\")\n"
+" .function(\"guestfs_mkfs*\") ? {\n"
+" display_time();\n"
+" printf (\"\\t%s %s\\n\", probefunc(), $$parms);\n"
+" }\n"
+"\n"
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
-msgid "Display version number and exit."
+#. type: textblock
+#: ../src/guestfs.pod:2233
+msgid ""
+"The script above can be saved to C<test.stap> and run using the L<stap(1)> "
+"program. Note that you either have to be root, or you have to add yourself "
+"to several special stap groups. Consult the systemtap documentation for "
+"more information."
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
-msgid "B<--connect URI> | B<-c URI>"
+#. type: verbatim
+#: ../src/guestfs.pod:2238
+#, no-wrap
+msgid ""
+" # stap /tmp/test.stap\n"
+" ready\n"
+"\n"
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
-msgid ""
-"If using libvirt, connect to the given I<URI>. If omitted, then we connect "
-"to the default libvirt hypervisor."
+#. type: textblock
+#: ../src/guestfs.pod:2241
+msgid "In another terminal, run a guestfish command such as this:"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:104
-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."
+#. type: textblock
+#: ../src/guestfs.pod:2245
+msgid "In the first terminal, stap trace output similar to this is shown:"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:114
+#. type: verbatim
+#: ../src/guestfs.pod:2247
+#, no-wrap
msgid ""
-"The following options select the output format. Use only one of them. The "
-"default is a readable text report."
+" 1318248056692655 (+0):\tlaunch_start\n"
+" 1318248056692850 (+195): launch_build_appliance_start\n"
+" 1318248056818285 (+125435): launch_build_appliance_end\n"
+" 1318248056838059 (+19774): launch_run_qemu\n"
+" 1318248061071167 (+4233108): launch_end\n"
+" 1318248061280324 (+209157): guestfs_mkfs g=0x1024ab0 fstype=0x46116f device=0x1024e60\n"
+"\n"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:119
-msgid "B<--text> (default)"
+#. type: =end
+#: ../src/guestfs.pod:2254 ../src/guestfs.pod:2259
+msgid "html"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:121
-msgid "Plain text report."
+#. type: textblock
+#: ../src/guestfs.pod:2256
+msgid ""
+"<!-- old anchor for the next section --> <a name="
+"\"state_machine_and_low_level_event_api\"/>"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:123
-msgid "B<--none>"
+#. type: =head1
+#: ../src/guestfs.pod:2261
+msgid "ARCHITECTURE"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:125
-msgid "Produce no output at all."
+#. type: textblock
+#: ../src/guestfs.pod:2263
+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: =item
-#: ../inspector/virt-inspector.pl:127
-msgid "B<--xml>"
+#. type: verbatim
+#: ../src/guestfs.pod:2267
+#, no-wrap
+msgid ""
+" ___________________\n"
+" / \\\n"
+" | main program |\n"
+" | |\n"
+" | | child process / appliance\n"
+" | | __________________________\n"
+" | | / qemu \\\n"
+" +-------------------+ RPC | +-----------------+ |\n"
+" | libguestfs <--------------------> guestfsd | |\n"
+" | | | +-----------------+ |\n"
+" \\___________________/ | | Linux kernel | |\n"
+" | +--^--------------+ |\n"
+" \\_________|________________/\n"
+" |\n"
+" _______v______\n"
+" / \\\n"
+" | Device or |\n"
+" | disk image |\n"
+" \\______________/\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:129
+#. type: textblock
+#: ../src/guestfs.pod:2287
msgid ""
-"If you select I<--xml> then you get XML output which can be fed to other "
-"programs."
+"The library, linked to the main program, creates the child process and hence "
+"the appliance in the L</guestfs_launch> function."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:132
-msgid "B<--yaml>"
+#. type: textblock
+#: ../src/guestfs.pod:2290
+msgid ""
+"Inside the appliance is a Linux kernel and a complete stack of userspace "
+"tools (such as LVM and ext2 programs) and a small controlling daemon called "
+"L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
+"calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
+"API calls and RPC calls to the daemon. Lastly the disk image(s) are "
+"attached to the qemu process which translates device access by the "
+"appliance's Linux kernel into accesses to the image."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:134
+#. type: textblock
+#: ../src/guestfs.pod:2299
msgid ""
-"If you select I<--yaml> then you get YAML output which can be fed to other "
-"programs."
+"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: =item
-#: ../inspector/virt-inspector.pl:137
-msgid "B<--perl>"
+#. type: =head1
+#: ../src/guestfs.pod:2306
+msgid "STATE MACHINE"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:139
-msgid ""
-"If you select I<--perl> then you get Perl structures output which can be "
-"used directly in another Perl program."
+#. type: textblock
+#: ../src/guestfs.pod:2308
+msgid "libguestfs uses a state machine to model the child process:"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:142
-msgid "B<--fish>"
+#. type: verbatim
+#: ../src/guestfs.pod:2310
+#, 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: =item
-#: ../inspector/virt-inspector.pl:144
-msgid "B<--ro-fish>"
+#. type: textblock
+#: ../src/guestfs.pod:2332
+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
-#: ../inspector/virt-inspector.pl:146
+#. type: textblock
+#: ../src/guestfs.pod:2337
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:"
+"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: verbatim
-#: ../inspector/virt-inspector.pl:150
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2341
msgid ""
-" guestfish $(virt-inspector --fish guest.img)\n"
-"\n"
+"Configuration commands for qemu such as L</guestfs_add_drive> can only be "
+"issued when in the CONFIG state."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:152
+#. type: textblock
+#: ../src/guestfs.pod:2344
msgid ""
-"I<--ro-fish> is the same, but the I<--ro> option is passed to guestfish so "
-"that the filesystems are mounted read-only."
+"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: =item
-#: ../inspector/virt-inspector.pl:155
-msgid "B<--query>"
+#. type: textblock
+#: ../src/guestfs.pod:2350
+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
-#: ../inspector/virt-inspector.pl:157
+#. type: textblock
+#: ../src/guestfs.pod:2356
msgid ""
-"In \"query mode\" we answer common questions about the guest, such as "
-"whether it is fullvirt or needs a Xen hypervisor to run."
+"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: textblock
-#: ../inspector/virt-inspector.pl:160
-msgid "See section I<QUERY MODE> below."
+#. type: =head1
+#: ../src/guestfs.pod:2360
+msgid "INTERNALS"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:166
-msgid "B<--windows-registry>"
+#. type: =head2
+#: ../src/guestfs.pod:2362
+msgid "APPLIANCE BOOT PROCESS"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:168
+#. type: textblock
+#: ../src/guestfs.pod:2364
msgid ""
-"This flag is ignored for compatibility with earlier releases of the software."
+"This process has evolved and continues to evolve. The description here "
+"corresponds only to the current version of libguestfs and is provided for "
+"information only."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:171
+#. type: textblock
+#: ../src/guestfs.pod:2368
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."
+"In order to follow the stages involved below, enable libguestfs debugging "
+"(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
msgstr ""
-# type: =head1
-#: ../inspector/virt-inspector.pl:218
-msgid "OUTPUT FORMAT"
+#. type: =item
+#: ../src/guestfs.pod:2373
+msgid "Create the appliance"
msgstr ""
-# type: verbatim
-#: ../inspector/virt-inspector.pl:220
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2375
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"
-"\n"
+"C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
+"initrd and the appliance."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:235
-msgid "The output of virt-inspector is a complex two-level data structure."
+#. type: textblock
+#: ../src/guestfs.pod:2378
+msgid ""
+"The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
+"directory if C<TMPDIR> is set)."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:237
+#. type: textblock
+#: ../src/guestfs.pod:2381
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."
+"For a complete description of how the appliance is created and cached, read "
+"the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:242
-msgid "The diagram above shows what we return for each OS."
+#. type: =item
+#: ../src/guestfs.pod:2385
+msgid "Start qemu and boot the kernel"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:244
-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."
+#. type: textblock
+#: ../src/guestfs.pod:2387
+msgid "qemu is invoked to boot the kernel."
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:"
+#. type: =item
+#: ../src/guestfs.pod:2389
+msgid "Run the initrd"
msgstr ""
-# type: verbatim
-#: ../inspector/virt-inspector.pl:254
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2391
msgid ""
-" guestfish $(virt-inspector --ro-fish guest.img)\n"
-" ==> guestfish --ro -a guest.img -m /dev/VG/LV:/ -m /dev/sda1:/boot\n"
-"\n"
+"C<febootstrap-supermin-helper> builds a small initrd. The initrd is not the "
+"appliance. The purpose of the initrd is to load enough kernel modules in "
+"order that the appliance itself can be mounted and started."
msgstr ""
-# type: =head1
-#: ../inspector/virt-inspector.pl:589
-msgid "QUERY MODE"
+#. type: textblock
+#: ../src/guestfs.pod:2395
+msgid ""
+"The initrd is a cpio archive called C</var/tmp/.guestfs-E<lt>UIDE<gt>/"
+"initrd>."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:591
+#. type: textblock
+#: ../src/guestfs.pod:2398
msgid ""
-"When you use C<virt-inspector --query>, the output is a series of lines of "
-"the form:"
+"When the initrd has started you will see messages showing that kernel "
+"modules are being loaded, similar to this:"
msgstr ""
-# type: verbatim
-#: ../inspector/virt-inspector.pl:594
+#. type: verbatim
+#: ../src/guestfs.pod:2401
#, no-wrap
msgid ""
-" windows=no\n"
-" linux=yes\n"
-" fullvirt=yes\n"
-" xen_pv_drivers=no\n"
+" febootstrap: ext2 mini initrd starting up\n"
+" febootstrap: mounting /sys\n"
+" febootstrap: internal insmod libcrc32c.ko\n"
+" febootstrap: internal insmod crc32c-intel.ko\n"
"\n"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:599
-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)."
+#. type: =item
+#: ../src/guestfs.pod:2406
+msgid "Find and mount the appliance device"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:602
+#. type: textblock
+#: ../src/guestfs.pod:2408
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."
-msgstr ""
-
-# type: textblock
-#: ../inspector/virt-inspector.pl:609
-msgid "This section describes the full range of answers possible."
-msgstr ""
-
-# type: =item
-#: ../inspector/virt-inspector.pl:630
-msgid "windows=(yes|no)"
-msgstr ""
-
-# type: textblock
-#: ../inspector/virt-inspector.pl:632
-msgid "Answer C<yes> if Microsoft Windows is installed in the guest."
+"The appliance is a sparse file containing an ext2 filesystem which contains "
+"a familiar (although reduced in size) Linux operating system. It would "
+"normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:645
-msgid "linux=(yes|no)"
+#. type: textblock
+#: ../src/guestfs.pod:2412
+msgid ""
+"The regular disks being inspected by libguestfs are the first devices "
+"exposed by qemu (eg. as C</dev/vda>)."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:647
-msgid "Answer C<yes> if a Linux kernel is installed in the guest."
+#. type: textblock
+#: ../src/guestfs.pod:2415
+msgid ""
+"The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
+"there was only one regular disk)."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:660
-msgid "rhel=(yes|no)"
+#. type: textblock
+#: ../src/guestfs.pod:2418
+msgid ""
+"Thus the final job of the initrd is to locate the appliance disk, mount it, "
+"and switch root into the appliance, and run C</init> from the appliance."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:662
-msgid "Answer C<yes> if the guest contains Red Hat Enterprise Linux."
+#. type: textblock
+#: ../src/guestfs.pod:2422
+msgid "If this works successfully you will see messages such as:"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:676
-msgid "fedora=(yes|no)"
+#. type: verbatim
+#: ../src/guestfs.pod:2424
+#, no-wrap
+msgid ""
+" febootstrap: picked /sys/block/vdb/dev as root device\n"
+" febootstrap: creating /dev/root as block special 252:16\n"
+" febootstrap: mounting new root on /root\n"
+" febootstrap: chroot\n"
+" Starting /init script ...\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:678
-msgid "Answer C<yes> if the guest contains the Fedora Linux distribution."
+#. type: textblock
+#: ../src/guestfs.pod:2430
+msgid ""
+"Note that C<Starting /init script ...> indicates that the appliance's init "
+"script is now running."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:691
-msgid "debian=(yes|no)"
+#. type: =item
+#: ../src/guestfs.pod:2433
+msgid "Initialize the appliance"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:693
-msgid "Answer C<yes> if the guest contains the Debian Linux distribution."
+#. type: textblock
+#: ../src/guestfs.pod:2435
+msgid ""
+"The appliance itself now initializes itself. This involves starting certain "
+"processes like C<udev>, possibly printing some debug information, and "
+"finally running the daemon (C<guestfsd>)."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:706
-msgid "fullvirt=(yes|no)"
+#. type: =item
+#: ../src/guestfs.pod:2439
+msgid "The daemon"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:708
+#. type: textblock
+#: ../src/guestfs.pod:2441
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."
+"Finally the daemon (C<guestfsd>) runs inside the appliance. If it runs you "
+"should see:"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:731
-msgid "xen_domU_kernel=(yes|no)"
-msgstr ""
-
-# type: textblock
-#: ../inspector/virt-inspector.pl:733
+#. type: verbatim
+#: ../src/guestfs.pod:2444
+#, 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)."
+" verbose daemon enabled\n"
+"\n"
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:753
-msgid "xen_pv_drivers=(yes|no)"
+#. type: textblock
+#: ../src/guestfs.pod:2446
+msgid ""
+"The daemon expects to see a named virtio-serial port exposed by qemu and "
+"connected on the other end to the library."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:755
+#. type: textblock
+#: ../src/guestfs.pod:2449
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)."
+"The daemon connects to this port (and hence to the library) and sends a four "
+"byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
+"protocol (see below)."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:777
-msgid "virtio_drivers=(yes|no)"
+#. type: =head2
+#: ../src/guestfs.pod:2455
+msgid "COMMUNICATION PROTOCOL"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:779
+#. type: textblock
+#: ../src/guestfs.pod:2457
msgid ""
-"Answer C<yes> if the guest has virtio paravirtualized drivers installed. "
-"Virtio drivers are commonly used to improve the performance of KVM."
+"Don't rely on using this protocol directly. This section documents how it "
+"currently works, but it may change at any time."
msgstr ""
-# type: =item
-#: ../inspector/virt-inspector.pl:800
-msgid "userspace_arch=(x86_64|...)"
+#. type: textblock
+#: ../src/guestfs.pod:2460
+msgid ""
+"The protocol used to talk between the library and the daemon running inside "
+"the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
+"1014, RFC 1832, RFC 4506)."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:802
-msgid "Print the architecture of userspace."
+#. type: textblock
+#: ../src/guestfs.pod:2464
+msgid ""
+"The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
+"this file is automatically generated)."
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:804 ../inspector/virt-inspector.pl:825
-msgid "NB. For multi-boot VMs this can print several lines."
+#. type: textblock
+#: ../src/guestfs.pod:2467
+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: =item
-#: ../inspector/virt-inspector.pl:821
-msgid "kernel_arch=(x86_64|...)"
+#. type: =head3
+#: ../src/guestfs.pod:2474
+msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:823
-msgid "Print the architecture of the kernel."
+#. type: textblock
+#: ../src/guestfs.pod:2476
+msgid "For ordinary functions, the request message is:"
msgstr ""
-# type: textblock
-#: ../inspector/virt-inspector.pl:848 ../tools/virt-df.pl:484
+#. type: verbatim
+#: ../src/guestfs.pod:2478
+#, no-wrap
msgid ""
-"L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
-"L<Sys::Virt(3)>, L<http://libguestfs.org/>."
+" 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
-#: ../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/>"
+#. type: textblock
+#: ../src/guestfs.pod:2483
+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
-#: ../inspector/virt-inspector.pl:859
-msgid "Matthew Booth L<mbooth@redhat.com>"
+#. type: textblock
+#: ../src/guestfs.pod:2489
+msgid ""
+"Note also that many functions don't take any arguments, in which case the "
+"C<guestfs_I<foo>_args> is completely omitted."
msgstr ""
-# type: textblock
-#: ../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."
+#. type: textblock
+#: ../src/guestfs.pod:2492
+msgid ""
+"The header contains the procedure number (C<guestfs_proc>) which is how the "
+"receiver knows what type of args structure to expect, or none at all."
msgstr ""
-# type: textblock
-#: ../tools/virt-cat.pl:34
-msgid "virt-cat - Display a file in a virtual machine"
+#. type: textblock
+#: ../src/guestfs.pod:2496
+msgid ""
+"For functions that take optional arguments, the optional arguments are "
+"encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
+"arguments. A bitmask in the header indicates which optional arguments are "
+"meaningful. The bitmask is also checked to see if it contains bits set "
+"which the daemon does not know about (eg. if more optional arguments were "
+"added in a later version of the library), and this causes the call to be "
+"rejected."
msgstr ""
-# type: verbatim
-#: ../tools/virt-cat.pl:38
-#, no-wrap
-msgid ""
-" virt-cat [--options] domname file\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:2504
+msgid "The reply message for ordinary functions is:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-cat.pl:40
+#. type: verbatim
+#: ../src/guestfs.pod:2506
#, no-wrap
msgid ""
-" virt-cat [--options] disk.img [disk.img ...] file\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
-#: ../tools/virt-cat.pl:44
+#. type: textblock
+#: ../src/guestfs.pod:2511
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)."
+"As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
+"functions that return no formal return values."
msgstr ""
-# type: textblock
-#: ../tools/virt-cat.pl:47
+#. type: textblock
+#: ../src/guestfs.pod:2514
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."
+"As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
msgstr ""
-# type: textblock
-#: ../tools/virt-cat.pl:53
+#. type: textblock
+#: ../src/guestfs.pod:2517
msgid ""
-"Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
+"In the case of an error, a flag is set in the header, and the reply message "
+"is slightly changed:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-cat.pl:56
+#. type: verbatim
+#: ../src/guestfs.pod:2520
#, no-wrap
msgid ""
-" virt-cat mydomain /etc/fstab\n"
+" 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
-#: ../tools/virt-cat.pl:58
-msgid "List syslog messages from a VM:"
-msgstr ""
-
-# type: verbatim
-#: ../tools/virt-cat.pl:60
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2525
msgid ""
-" virt-cat mydomain /var/log/messages | tail\n"
-"\n"
+"The C<guestfs_message_error> structure contains the error message as a "
+"string."
msgstr ""
-# type: textblock
-#: ../tools/virt-cat.pl:62
-msgid "Find out what DHCP IP address a VM acquired:"
+#. type: =head3
+#: ../src/guestfs.pod:2528
+msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
msgstr ""
-# type: verbatim
-#: ../tools/virt-cat.pl:64
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2530
msgid ""
-" virt-cat mydomain /var/log/messages | grep 'dhclient: bound to' | tail\n"
-"\n"
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-cat.pl:66
-msgid "Find out what packages were recently installed:"
+"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
-#: ../tools/virt-cat.pl:68
+#. type: verbatim
+#: ../src/guestfs.pod:2534
#, no-wrap
msgid ""
-" virt-cat mydomain /var/log/yum.log | tail\n"
+" 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
-#: ../tools/virt-cat.pl:70
-msgid "Find out who is logged on inside a virtual machine:"
+#. type: textblock
+#: ../src/guestfs.pod:2542
+msgid "The \"sequence of chunks\" is:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-cat.pl:72
+#. type: verbatim
+#: ../src/guestfs.pod:2544
#, no-wrap
msgid ""
-" virt-cat mydomain /var/run/utmp > /tmp/utmp\n"
-" who /tmp/utmp\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
-#: ../tools/virt-cat.pl:75
-msgid "or who was logged on:"
+#. type: textblock
+#: ../src/guestfs.pod:2552
+msgid ""
+"The final chunk has the C<data_len> field set to zero. Additionally a flag "
+"is set in the final chunk to indicate either successful completion or early "
+"cancellation."
msgstr ""
-# type: verbatim
-#: ../tools/virt-cat.pl:77
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2556
msgid ""
-" virt-cat mydomain /var/log/wtmp > /tmp/wtmp\n"
-" last -f /tmp/wtmp\n"
-"\n"
+"At time of writing there are no functions that have more than one FileIn "
+"parameter. However this is (theoretically) supported, by sending the "
+"sequence of chunks for each FileIn parameter one after another (from left to "
+"right)."
msgstr ""
-# type: textblock
-#: ../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
+#. type: textblock
+#: ../src/guestfs.pod:2561
msgid ""
-"If you specify guest block devices directly, then libvirt is not used at all."
+"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
-#: ../tools/virt-cat.pl:165
+#. type: textblock
+#: ../src/guestfs.pod:2567
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/>."
+"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: =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
-msgid "AUTHOR"
+#. type: textblock
+#: ../src/guestfs.pod:2576
+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: textblock
-#: ../tools/virt-df.pl:36
-msgid "virt-df - Display free space on virtual filesystems"
+#. type: =head3
+#: ../src/guestfs.pod:2582
+msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
msgstr ""
-# type: verbatim
-#: ../tools/virt-df.pl:40
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2584
msgid ""
-" virt-df [--options]\n"
-"\n"
+"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
-#: ../tools/virt-df.pl:42
+#. type: verbatim
+#: ../src/guestfs.pod:2587
#, no-wrap
msgid ""
-" virt-df [--options] domname\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: verbatim
-#: ../tools/virt-df.pl:44
-#, no-wrap
-msgid ""
-" virt-df [--options] disk.img [disk.img ...]\n"
-"\n"
+#. type: =head3
+#: ../src/guestfs.pod:2595
+msgid "INITIAL MESSAGE"
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:48
+#. type: textblock
+#: ../src/guestfs.pod:2597
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."
+"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: 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."
+#. type: =head3
+#: ../src/guestfs.pod:2601
+msgid "PROGRESS NOTIFICATION MESSAGES"
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:56
+#. type: textblock
+#: ../src/guestfs.pod:2603
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."
+"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
-#: ../tools/virt-df.pl:60
+#. type: textblock
+#: ../src/guestfs.pod:2607
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."
+"The library turns them into progress callbacks (see L</"
+"GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
+"if not."
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:67
+#. type: textblock
+#: ../src/guestfs.pod:2611
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."
+"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: =item
-#: ../tools/virt-df.pl:107
-msgid "B<--csv>"
+#. type: =head1
+#: ../src/guestfs.pod:2615
+msgid "LIBGUESTFS VERSION NUMBERS"
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:109
+#. type: textblock
+#: ../src/guestfs.pod:2617
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."
-msgstr ""
-
-# type: =item
-#: ../tools/virt-df.pl:117
-msgid "B<--human-readable> | B<-h>"
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-df.pl:119
-msgid "Print sizes in human-readable format."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-df.pl:121
-msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
+"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: =item
-#: ../tools/virt-df.pl:127
-msgid "B<--inodes> | B<-i>"
+#. type: verbatim
+#: ../src/guestfs.pod:2622
+#, no-wrap
+msgid ""
+" even numbers for stable: 1.2.x, 1.4.x, ...\n"
+" .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
+" |\n"
+" v\n"
+" 1 . 3 . 5\n"
+" ^ ^\n"
+" | |\n"
+" | `-------- sub-version\n"
+" |\n"
+" `------ always '1' because we don't change the ABI\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:129
-msgid "Print inodes instead of blocks."
+#. type: textblock
+#: ../src/guestfs.pod:2633
+msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
msgstr ""
-# type: =head1
-#: ../tools/virt-df.pl:458
-msgid "NOTE ABOUT CSV FORMAT"
+#. type: textblock
+#: ../src/guestfs.pod:2635
+msgid ""
+"As time passes we cherry pick fixes from the development branch and backport "
+"those into the stable branch, the effect being that the stable branch should "
+"get more stable and less buggy over time. So the stable releases are ideal "
+"for people who don't need new features but would just like the software to "
+"work."
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:460
-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."
+#. type: textblock
+#: ../src/guestfs.pod:2641
+msgid "Our criteria for backporting changes are:"
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:463
+#. type: textblock
+#: ../src/guestfs.pod:2647
msgid ""
-"Myth: Just split fields at commas. Reality: This does I<not> work "
-"reliably. This example has two columns:"
+"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: verbatim
-#: ../tools/virt-df.pl:466
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2653
msgid ""
-" \"foo,bar\",baz\n"
-"\n"
+"Bug fixes which are not controversial, fix obvious problems, and have been "
+"well tested are backported."
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:468
+#. type: textblock
+#: ../src/guestfs.pod:2658
msgid ""
-"Myth: Read the file one line at a time. Reality: This does I<not> work "
-"reliably. This example has one row:"
+"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
-#: ../tools/virt-df.pl:471
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2664
msgid ""
-" \"foo\n"
-" bar\",baz\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
-#: ../tools/virt-df.pl:474
+#. type: textblock
+#: ../src/guestfs.pod:2670
msgid ""
-"For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
-"packaged in major Linux distributions)."
+"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
-#: ../tools/virt-df.pl:477
-msgid ""
-"For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
-"or Python's built-in csv library)."
+#. type: =head1
+#: ../src/guestfs.pod:2678
+msgid "EXTENDING LIBGUESTFS"
msgstr ""
-# type: textblock
-#: ../tools/virt-df.pl:480
-msgid "Most spreadsheets and databases can import CSV directly."
+#. type: =head2
+#: ../src/guestfs.pod:2680
+msgid "ADDING A NEW API ACTION"
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."
+#. type: textblock
+#: ../src/guestfs.pod:2682
+msgid ""
+"Large amounts of boilerplate code in libguestfs (RPC, bindings, "
+"documentation) are generated, and this makes it easy to extend the "
+"libguestfs API."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:35
-msgid "virt-edit - Edit a file in a virtual machine"
+#. type: textblock
+#: ../src/guestfs.pod:2686
+msgid "To add a new API action there are two changes:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:39
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2692
msgid ""
-" virt-edit [--options] domname file\n"
-"\n"
+"You need to add a description of the call (name, parameters, return type, "
+"tests, documentation) to C<generator/generator_actions.ml>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:41
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2695
msgid ""
-" virt-edit [--options] disk.img [disk.img ...] file\n"
-"\n"
+"There are two sorts of API action, depending on whether the call goes "
+"through to the daemon in the appliance, or is serviced entirely by the "
+"library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
+"former, since the sync is done in the appliance. L</guestfs_set_trace> is "
+"an example of the latter, since a trace flag is maintained in the handle and "
+"all tracing is done on the library side."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:43
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2703
msgid ""
-" virt-edit [domname|disk.img] file -e 'expr'\n"
-"\n"
+"Most new actions are of the first type, and get added to the "
+"C<daemon_functions> list. Each function has a unique procedure number used "
+"in the RPC protocol which is assigned to that action when we publish "
+"libguestfs and cannot be reused. Take the latest procedure number and "
+"increment it."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:47
+#. type: textblock
+#: ../src/guestfs.pod:2709
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."
+"For library-only actions of the second type, add to the "
+"C<non_daemon_functions> list. Since these functions are serviced by the "
+"library and do not travel over the RPC mechanism to the daemon, these "
+"functions do not need a procedure number, and so the procedure number is set "
+"to C<-1>."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:53
-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)."
+#. type: textblock
+#: ../src/guestfs.pod:2717
+msgid "Implement the action (in C):"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:56
+#. type: textblock
+#: ../src/guestfs.pod:2719
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: textblock
-#: ../tools/virt-edit.pl:61
-msgid "Edit the named files interactively:"
+"For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
+"C<daemon/> directory."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:63
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2722
msgid ""
-" virt-edit mydomain /boot/grub/grub.conf\n"
-"\n"
+"For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
+"(note: double underscore) in the C<src/> directory."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:65
-#, no-wrap
-msgid ""
-" virt-edit mydomain /etc/passwd\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:2725
+msgid "In either case, use another function as an example of what to do."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:67
-msgid ""
-"You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
-"below). To change the init default level to 5:"
+#. type: textblock
+#: ../src/guestfs.pod:2729
+msgid "After making these changes, use C<make> to compile."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:71
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2731
msgid ""
-" virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
-"\n"
+"Note that you don't need to implement the RPC, language bindings, manual "
+"pages or anything else. It's all automatically generated from the OCaml "
+"description."
msgstr ""
-# type: =item
-#: ../tools/virt-edit.pl:97
-msgid "B<--backup extension> | B<-b extension>"
+#. type: =head2
+#: ../src/guestfs.pod:2735
+msgid "ADDING TESTS FOR AN API ACTION"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:99
+#. type: textblock
+#: ../src/guestfs.pod:2737
msgid ""
-"Create a backup of the original file I<in the guest disk image>. The backup "
-"has the original filename with C<extension> added."
+"You can supply zero or as many tests as you want per API call. The tests "
+"can either be added as part of the API description (C<generator/"
+"generator_actions.ml>), or in some rarer cases you may want to drop a script "
+"into C<regressions/>. Note that adding a script to C<regressions/> is "
+"slower, so if possible use the first method."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:102
+#. type: textblock
+#: ../src/guestfs.pod:2743
msgid ""
-"Usually the first character of C<extension> would be a dot C<.> so you would "
-"write:"
+"The following describes the test environment used when you add an API test "
+"in C<generator_actions.ml>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:105
-#, no-wrap
-msgid ""
-" virt-edit -b .orig [etc]\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:2746
+msgid "The test environment has 4 block devices:"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:107
-msgid "By default, no backup file is made."
+#. type: =item
+#: ../src/guestfs.pod:2750
+msgid "C</dev/sda> 500MB"
msgstr ""
-# type: =item
-#: ../tools/virt-edit.pl:125
-msgid "B<--expr EXPR> | B<-e EXPR>"
+#. type: textblock
+#: ../src/guestfs.pod:2752
+msgid "General block device for testing."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:127
-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."
+#. type: =item
+#: ../src/guestfs.pod:2754
+msgid "C</dev/sdb> 50MB"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:131
+#. type: textblock
+#: ../src/guestfs.pod:2756
msgid ""
-"Be careful to properly quote the expression to prevent it from being altered "
-"by the shell."
+"C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
+"operations."
msgstr ""
-# type: =head1
-#: ../tools/virt-edit.pl:250
-msgid "NON-INTERACTIVE EDITING"
+#. type: =item
+#: ../src/guestfs.pod:2759
+msgid "C</dev/sdc> 10MB"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:252
-msgid ""
-"C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
-"administrator can interactively edit the file."
+#. type: textblock
+#: ../src/guestfs.pod:2761
+msgid "Used in a few tests where two block devices are needed."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:255
-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.)"
+#. type: =item
+#: ../src/guestfs.pod:2763
+msgid "C</dev/sdd>"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2765
+msgid "ISO with fixed content (see C<images/test.iso>)."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:261
+#. type: textblock
+#: ../src/guestfs.pod:2769
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."
+"To be able to run the tests in a reasonable amount of time, the libguestfs "
+"appliance and block devices are reused between tests. So don't try testing "
+"L</guestfs_kill_subprocess> :-x"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:265
+#. type: textblock
+#: ../src/guestfs.pod:2773
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:"
+"Each test starts with an initial scenario, selected using one of the "
+"C<Init*> expressions, described in C<generator/generator_types.ml>. These "
+"initialize the disks mentioned above in a particular way as documented in "
+"C<generator_types.ml>. You should not assume anything about the previous "
+"contents of other disks that are not initialized."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:269
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2779
msgid ""
-" virt-edit domname filename -e 's/foo/bar/'\n"
-"\n"
+"You can add a prerequisite clause to any individual test. This is a run-"
+"time check, which, if it fails, causes the test to be skipped. Useful if "
+"testing a command which might not work on all variations of libguestfs "
+"builds. A test that has prerequisite of C<Always> means to run "
+"unconditionally."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:271
+#. type: textblock
+#: ../src/guestfs.pod:2785
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:"
+"In addition, packagers can skip individual tests by setting environment "
+"variables before running C<make check>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:274
+#. type: verbatim
+#: ../src/guestfs.pod:2788
#, no-wrap
msgid ""
-" virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
+" SKIP_TEST_<CMD>_<NUM>=1\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."
+#. type: textblock
+#: ../src/guestfs.pod:2790
+msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:281
-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:"
+#. type: textblock
+#: ../src/guestfs.pod:2792
+msgid "or:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:284
+#. type: verbatim
+#: ../src/guestfs.pod:2794
#, no-wrap
msgid ""
-" virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
+" SKIP_TEST_<CMD>=1\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:286
-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."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-edit.pl:292
-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: textblock
-#: ../tools/virt-edit.pl:295
-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."
+#. type: textblock
+#: ../src/guestfs.pod:2796
+msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:299
-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:"
+#. type: textblock
+#: ../src/guestfs.pod:2798
+msgid "Packagers can run only certain tests by setting for example:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:304
+#. type: verbatim
+#: ../src/guestfs.pod:2800
#, no-wrap
msgid ""
-" /some text(\\r?\\n)?$/\n"
+" TEST_ONLY=\"vfs_type zerofree\"\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:306
+#. type: textblock
+#: ../src/guestfs.pod:2802
msgid ""
-"Alternately, use the perl C<chomp> function, being careful not to chomp C<"
-"$_> itself (since that would remove all newlines from the file):"
+"See C<capitests/tests.c> for more details of how these environment variables "
+"work."
msgstr ""
-# type: verbatim
-#: ../tools/virt-edit.pl:310
-#, no-wrap
-msgid ""
-" my $m = $_; chomp $m; $m =~ /some text$/\n"
-"\n"
+#. type: =head2
+#: ../src/guestfs.pod:2805
+msgid "DEBUGGING NEW API ACTIONS"
msgstr ""
-# type: =item
-#: ../tools/virt-edit.pl:316
-msgid "C<EDITOR>"
+#. type: textblock
+#: ../src/guestfs.pod:2807
+msgid "Test new actions work before submitting them."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:2809
+msgid "You can use guestfish to try out new commands."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:318
+#. type: textblock
+#: ../src/guestfs.pod:2811
msgid ""
-"If set, this string is used as the editor. It may contain arguments, eg. C<"
-"\"emacs -nw\">"
+"Debugging the daemon is a problem because it runs inside a minimal "
+"environment. However you can fprintf messages in the daemon to stderr, and "
+"they will show up if you use C<guestfish -v>."
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:321
-msgid "If not set, C<vi> is used."
+#. type: =head2
+#: ../src/guestfs.pod:2815
+msgid "FORMATTING CODE AND OTHER CONVENTIONS"
msgstr ""
-# type: textblock
-#: ../tools/virt-edit.pl:327
+#. type: textblock
+#: ../src/guestfs.pod:2817
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)>."
+"Our C source code generally adheres to some basic code-formatting "
+"conventions. The existing code base is not totally consistent on this "
+"front, but we do prefer that contributed code be formatted similarly. In "
+"short, use spaces-not-TABs for indentation, use 2 spaces for each "
+"indentation level, and other than that, follow the K&R style."
msgstr ""
-# type: textblock
-#: ../tools/virt-list-filesystems.pl:32
+#. type: textblock
+#: ../src/guestfs.pod:2823
msgid ""
-"virt-list-filesystems - List filesystems in a virtual machine or disk image"
+"If you use Emacs, add the following to one of one of your start-up files (e."
+"g., ~/.emacs), to help ensure that you get indentation right:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-list-filesystems.pl:36
+#. type: verbatim
+#: ../src/guestfs.pod:2826
#, no-wrap
msgid ""
-" virt-list-filesystems [--options] domname\n"
-"\n"
+" ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
+" ;;; Exceptions: Makefile and ChangeLog modes.\n"
+" (add-hook 'find-file-hook\n"
+" '(lambda () (if (and buffer-file-name\n"
+" (string-match \"/libguestfs\\\\>\"\n"
+" (buffer-file-name))\n"
+" (not (string-equal mode-name \"Change Log\"))\n"
+" (not (string-equal mode-name \"Makefile\")))\n"
+" (setq indent-tabs-mode nil))))\n"
+" \n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-list-filesystems.pl:38
+#. type: verbatim
+#: ../src/guestfs.pod:2836
#, no-wrap
msgid ""
-" virt-list-filesystems [--options] disk.img [disk.img ...]\n"
+" ;;; When editing C sources in libguestfs, use this style.\n"
+" (defun libguestfs-c-mode ()\n"
+" \"C mode with adjusted defaults for use with libguestfs.\"\n"
+" (interactive)\n"
+" (c-set-style \"K&R\")\n"
+" (setq c-indent-level 2)\n"
+" (setq c-basic-offset 2))\n"
+" (add-hook 'c-mode-hook\n"
+" '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
+" (buffer-file-name))\n"
+" (libguestfs-c-mode))))\n"
"\n"
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."
+#. type: textblock
+#: ../src/guestfs.pod:2848
+msgid "Enable warnings when compiling (and fix any problems this finds):"
msgstr ""
-# type: textblock
-#: ../tools/virt-list-filesystems.pl:46
+#. type: verbatim
+#: ../src/guestfs.pod:2851
+#, no-wrap
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."
+" ./configure --enable-gcc-warnings\n"
+"\n"
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>"
+#. type: textblock
+#: ../src/guestfs.pod:2853
+msgid "Useful targets are:"
msgstr ""
-# type: textblock
-#: ../tools/virt-list-filesystems.pl:88
+#. type: verbatim
+#: ../src/guestfs.pod:2855
+#, no-wrap
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-list-filesystems.pl:95
-msgid "B<-a> | B<--all>"
+" make syntax-check # checks the syntax of the C code\n"
+" make check # runs the test suite\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-list-filesystems.pl:97
-msgid ""
-"Normally we only show mountable filesystems. If this option is given then "
-"swap devices are shown too."
+#. type: =head2
+#: ../src/guestfs.pod:2858
+msgid "DAEMON CUSTOM PRINTF FORMATTERS"
msgstr ""
-# type: textblock
-#: ../tools/virt-list-filesystems.pl:193
+#. type: textblock
+#: ../src/guestfs.pod:2860
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/>."
+"In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
+"which are used to do shell quoting."
msgstr ""
-# type: textblock
-#: ../tools/virt-list-partitions.pl:32
-msgid ""
-"virt-list-partitions - List partitions in a virtual machine or disk image"
+#. type: =item
+#: ../src/guestfs.pod:2865
+msgid "%Q"
msgstr ""
-# type: verbatim
-#: ../tools/virt-list-partitions.pl:36
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2867
msgid ""
-" virt-list-partitions [--options] domname\n"
-"\n"
+"Simple shell quoted string. Any spaces or other shell characters are "
+"escaped for you."
msgstr ""
-# type: verbatim
-#: ../tools/virt-list-partitions.pl:38
-#, no-wrap
-msgid ""
-" virt-list-partitions [--options] disk.img [disk.img ...]\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:2870
+msgid "%R"
msgstr ""
-# type: textblock
-#: ../tools/virt-list-partitions.pl:42
+#. type: textblock
+#: ../src/guestfs.pod:2872
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)>."
+"Same as C<%Q> except the string is treated as a path which is prefixed by "
+"the sysroot."
msgstr ""
-# type: textblock
-#: ../tools/virt-list-partitions.pl:47
+#. type: verbatim
+#: ../src/guestfs.pod:2879
+#, 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>"
+" asprintf (&cmd, \"cat %R\", path);\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-list-partitions.pl:89
-msgid "Show sizes in human-readable form (eg. \"1G\")."
+#. type: textblock
+#: ../src/guestfs.pod:2881
+msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
msgstr ""
-# type: textblock
-#: ../tools/virt-list-partitions.pl:97
+#. type: textblock
+#: ../src/guestfs.pod:2883
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>"
+"I<Note:> Do I<not> use these when you are passing parameters to the C<command"
+"{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
+"they are not passed via the shell (instead, straight to exec). You probably "
+"want to use the C<sysroot_path()> function however."
msgstr ""
-# type: textblock
-#: ../tools/virt-list-partitions.pl:106
-msgid ""
-"Display the total size of each block device (as a separate row or rows)."
+#. type: =head2
+#: ../src/guestfs.pod:2889
+msgid "SUBMITTING YOUR NEW API ACTIONS"
msgstr ""
-# type: textblock
-#: ../tools/virt-list-partitions.pl:231
+#. type: textblock
+#: ../src/guestfs.pod:2891
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<Sys::Virt(3)>, L<http://"
-"libguestfs.org/>."
+"Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
+"libguestfs> and CC to L<rjones@redhat.com>."
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:35
-msgid "virt-ls - List files in a virtual machine"
+#. type: =head2
+#: ../src/guestfs.pod:2895
+msgid "INTERNATIONALIZATION (I18N) SUPPORT"
msgstr ""
-# type: verbatim
-#: ../tools/virt-ls.pl:39
-#, no-wrap
-msgid ""
-" virt-ls [--options] domname directory\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:2897
+msgid "We support i18n (gettext anyhow) in the library."
msgstr ""
-# type: verbatim
-#: ../tools/virt-ls.pl:41
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2899
msgid ""
-" virt-ls [--options] disk.img [disk.img ...] directory\n"
-"\n"
+"However many messages come from the daemon, and we don't translate those at "
+"the moment. One reason is that the appliance generally has all locale files "
+"removed from it, because they take up a lot of space. So we'd have to readd "
+"some of those, as well as copying our PO files into the appliance."
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:45
+#. type: textblock
+#: ../src/guestfs.pod:2905
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."
+"Debugging messages are never translated, since they are intended for the "
+"programmers."
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:48
-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."
+#. type: =head2
+#: ../src/guestfs.pod:2908
+msgid "SOURCE CODE SUBDIRECTORIES"
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:52
-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:"
+#. type: =item
+#: ../src/guestfs.pod:2912
+msgid "C<align>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-ls.pl:55
-#, no-wrap
-msgid ""
-" $ virt-ls myguest /\n"
-" bin\n"
-" boot\n"
-" [etc.]\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:2914
+msgid "L<virt-alignment-scan(1)> command and documentation."
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:60
-msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
+#. type: textblock
+#: ../src/guestfs.pod:2918
+msgid "The libguestfs appliance, build scripts and so on."
msgstr ""
-# type: verbatim
-#: ../tools/virt-ls.pl:62
-#, no-wrap
-msgid ""
-" $ virt-ls -l myguest /\n"
-" total 204\n"
-" dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
-" dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
-" [etc.]\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:2920
+msgid "C<capitests>"
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:68
-msgid ""
-"With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
-"and directories recursively:"
+#. type: textblock
+#: ../src/guestfs.pod:2922
+msgid "Automated tests of the C API."
msgstr ""
-# type: verbatim
-#: ../tools/virt-ls.pl:71
-#, no-wrap
-msgid ""
-" $ virt-ls -R myguest /tmp\n"
-" foo\n"
-" foo/bar\n"
-" [etc.]\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:2924
+msgid "C<cat>"
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:76
+#. type: textblock
+#: ../src/guestfs.pod:2926
msgid ""
-"You I<cannot> combine these options. To do more complicated things, use "
-"L<guestfish(1)>."
+"The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
+"documentation."
msgstr ""
-# type: =item
-#: ../tools/virt-ls.pl:117
-msgid "B<-R> | B<--recursive>"
+#. type: =item
+#: ../src/guestfs.pod:2929
+msgid "C<caution>"
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:119
+#. type: textblock
+#: ../src/guestfs.pod:2931
msgid ""
-"Select the mode. With neither of these options, C<virt-ls> produces a "
-"simple, flat list of the files in the named directory."
+"Safety and liveness tests of components that libguestfs depends upon (not of "
+"libguestfs itself). Mainly this is for qemu and the kernel."
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:122
-msgid ""
-"C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
-"like the plain C<ls -l> command)."
+#. type: =item
+#: ../src/guestfs.pod:2934
+msgid "C<clone>"
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:125
+#. type: textblock
+#: ../src/guestfs.pod:2936
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."
+"Tools for cloning virtual machines. Currently contains L<virt-sysprep(1)> "
+"command and documentation."
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:129
-msgid "You cannot combine these options."
+#. type: =item
+#: ../src/guestfs.pod:2939
+msgid "C<contrib>"
msgstr ""
-# type: textblock
-#: ../tools/virt-ls.pl:212
-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)>, L<http://libguestfs."
-"org/>."
+#. type: textblock
+#: ../src/guestfs.pod:2941
+msgid "Outside contributions, experimental parts."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:37
-msgid "virt-make-fs - Make a filesystem from a tar archive or files"
+#. type: =item
+#: ../src/guestfs.pod:2943
+msgid "C<daemon>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:41
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2945
msgid ""
-" virt-make-fs [--options] input.tar output.img\n"
-"\n"
+"The daemon that runs inside the libguestfs appliance and carries out actions."
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:43
-#, no-wrap
-msgid ""
-" virt-make-fs [--options] input.tar.gz output.img\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:2948
+msgid "C<df>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:45
-#, no-wrap
-msgid ""
-" virt-make-fs [--options] directory output.img\n"
-"\n"
+#. type: textblock
+#: ../src/guestfs.pod:2950
+msgid "L<virt-df(1)> command and documentation."
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)."
+#. type: =item
+#: ../src/guestfs.pod:2952
+msgid "C<edit>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:57
-msgid "Basic usage is:"
+#. type: textblock
+#: ../src/guestfs.pod:2954
+msgid "L<virt-edit(1)> command and documentation."
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:59
-#, no-wrap
-msgid ""
-" virt-make-fs input output\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:2956
+msgid "C<examples>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:61
-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)."
+#. type: textblock
+#: ../src/guestfs.pod:2958
+msgid "C API example code."
msgstr ""
-# type: =head2
-#: ../tools/virt-make-fs.pl:67
-msgid "EXTRA SPACE"
+#. type: =item
+#: ../src/guestfs.pod:2960
+msgid "C<fish>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:69
+#. type: textblock
+#: ../src/guestfs.pod:2962
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."
+"L<guestfish(1)>, the command-line shell, and various shell scripts built on "
+"top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
+"L<virt-tar-out(1)>."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:77
-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."
+#. type: =item
+#: ../src/guestfs.pod:2966
+msgid "C<fuse>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:85
+#. type: textblock
+#: ../src/guestfs.pod:2968
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."
+"L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
msgstr ""
-# type: =head3
-#: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
-#: ../tools/virt-make-fs.pl:142
-msgid "EXAMPLE"
+#. type: =item
+#: ../src/guestfs.pod:2970
+msgid "C<generator>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:91
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:2972
msgid ""
-" virt-make-fs --format=qcow2 --size=+200M input output.img\n"
-"\n"
+"The crucially important generator, used to automatically generate large "
+"amounts of boilerplate C code for things like RPC and bindings."
msgstr ""
-# type: =head2
-#: ../tools/virt-make-fs.pl:93
-msgid "FILESYSTEM TYPE"
+#. type: =item
+#: ../src/guestfs.pod:2975
+msgid "C<images>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:95
-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:"
+#. type: textblock
+#: ../src/guestfs.pod:2977
+msgid "Files used by the test suite."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:101
-msgid "I<ext3>"
+#. type: textblock
+#: ../src/guestfs.pod:2979
+msgid "Some \"phony\" guest images which we test against."
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: =item
+#: ../src/guestfs.pod:2981
+msgid "C<inspector>"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:107
-msgid "I<ntfs> or I<vfat>"
+#. type: textblock
+#: ../src/guestfs.pod:2983
+msgid "L<virt-inspector(1)>, the virtual machine image inspector."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:109
-msgid "Useful if exporting data to a Windows guest."
+#. type: =item
+#: ../src/guestfs.pod:2985
+msgid "C<logo>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:111
-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."
+#. type: textblock
+#: ../src/guestfs.pod:2987
+msgid "Logo used on the website. The fish is called Arthur by the way."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:116
-msgid "I<minix>"
+#. type: =item
+#: ../src/guestfs.pod:2989
+msgid "C<m4>"
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."
+#. type: textblock
+#: ../src/guestfs.pod:2991
+msgid "M4 macros used by autoconf."
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:125
-#, no-wrap
-msgid ""
-" virt-make-fs --type=minix input minixfs.img\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:2993
+msgid "C<po>"
msgstr ""
-# type: =head2
-#: ../tools/virt-make-fs.pl:127
-msgid "TO PARTITION OR NOT TO PARTITION"
+#. type: textblock
+#: ../src/guestfs.pod:2995
+msgid "Translations of simple gettext strings."
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
+#: ../src/guestfs.pod:2997
+msgid "C<po-docs>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:131
+#. type: textblock
+#: ../src/guestfs.pod:2999
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)."
+"The build infrastructure and PO files for translations of manpages and POD "
+"files. Eventually this will be combined with the C<po> directory, but that "
+"is rather complicated."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:136
-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)."
+#. type: =item
+#: ../src/guestfs.pod:3003
+msgid "C<regressions>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:144
-msgid "Add an MBR partition:"
+#. type: textblock
+#: ../src/guestfs.pod:3005
+msgid "Regression tests."
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:146
-#, no-wrap
-msgid ""
-" virt-make-fs --partition -- input disk.img\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:3007
+msgid "C<rescue>"
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:"
+#. type: textblock
+#: ../src/guestfs.pod:3009
+msgid "L<virt-rescue(1)> command and documentation."
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:151
-#, no-wrap
-msgid ""
-" virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
-"\n"
+#. type: =item
+#: ../src/guestfs.pod:3011
+msgid "C<resize>"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:196
-msgid "B<--debug>"
+#. type: textblock
+#: ../src/guestfs.pod:3013
+msgid "L<virt-resize(1)> command and documentation."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:179
-msgid "Enable debugging information."
+#. type: =item
+#: ../src/guestfs.pod:3015
+msgid "C<sparsify>"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:185
-msgid "B<--size=E<lt>NE<gt>>"
+#. type: textblock
+#: ../src/guestfs.pod:3017
+msgid "L<virt-sparsify(1)> command and documentation."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:187
-msgid "B<--size=+E<lt>NE<gt>>"
+#. type: =item
+#: ../src/guestfs.pod:3019
+msgid "C<src>"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:189
-msgid "B<-s E<lt>NE<gt>>"
+#. type: textblock
+#: ../src/guestfs.pod:3021
+msgid "Source code to the C library."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:191
-msgid "B<-s +E<lt>NE<gt>>"
+#. type: =item
+#: ../src/guestfs.pod:3023
+msgid "C<tools>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:193
+#. type: textblock
+#: ../src/guestfs.pod:3025
msgid ""
-"Use the C<--size> (or C<-s>) option to choose the size of the output image."
+"Command line tools written in Perl (L<virt-win-reg(1)> and many others)."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:196
-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."
+#. type: =item
+#: ../src/guestfs.pod:3027
+msgid "C<test-tool>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:199
+#. type: textblock
+#: ../src/guestfs.pod:3029
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."
+"Test tool for end users to test if their qemu/kernel combination will work "
+"with libguestfs."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:204
-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."
+#. type: =item
+#: ../src/guestfs.pod:3032
+msgid "C<csharp>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:210
-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)."
+#. type: =item
+#: ../src/guestfs.pod:3034
+msgid "C<erlang>"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:219
-msgid "B<--format=E<lt>fmtE<gt>>"
+#. type: =item
+#: ../src/guestfs.pod:3036
+msgid "C<haskell>"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:221
-msgid "B<-F E<lt>fmtE<gt>>"
+#. type: =item
+#: ../src/guestfs.pod:3038
+msgid "C<java>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:223
-msgid "Choose the output disk image format."
+#. type: =item
+#: ../src/guestfs.pod:3040
+msgid "C<ocaml>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:225
-msgid "The default is C<raw> (raw disk image)."
+#. type: =item
+#: ../src/guestfs.pod:3042
+msgid "C<php>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:227
-msgid ""
-"For other choices, see the L<qemu-img(1)> manpage. The only other choice "
-"that would really make sense here is C<qcow2>."
+#. type: =item
+#: ../src/guestfs.pod:3044
+msgid "C<perl>"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:234
-msgid "B<--type=E<lt>fsE<gt>>"
+#. type: =item
+#: ../src/guestfs.pod:3046
+msgid "C<python>"
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:236
-msgid "B<-t E<lt>fsE<gt>>"
+#. type: =item
+#: ../src/guestfs.pod:3048
+msgid "C<ruby>"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:238
-msgid "Choose the output filesystem type."
+#. type: textblock
+#: ../src/guestfs.pod:3050
+msgid "Language bindings."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:240
-msgid "The default is C<ext2>."
+#. type: =head2
+#: ../src/guestfs.pod:3054
+msgid "MAKING A STABLE RELEASE"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:242
+#. type: textblock
+#: ../src/guestfs.pod:3056
msgid ""
-"Any filesystem which is supported read-write by libguestfs can be used here."
+"When we make a stable release, there are several steps documented here. See "
+"L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
+"branch policy."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:249
-msgid "B<--partition>"
+#. type: textblock
+#: ../src/guestfs.pod:3064
+msgid ""
+"Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
msgstr ""
-# type: =item
-#: ../tools/virt-make-fs.pl:251
-msgid "B<--partition=E<lt>parttypeE<gt>>"
+#. type: textblock
+#: ../src/guestfs.pod:3069
+msgid "Finalize RELEASE-NOTES."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:253
-msgid ""
-"If specified, this flag adds an MBR partition table to the output disk image."
+#. type: textblock
+#: ../src/guestfs.pod:3073
+msgid "Update ROADMAP."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:256
-msgid ""
-"You can change the partition table type, eg. C<--partition=gpt> for large "
-"disks."
+#. type: textblock
+#: ../src/guestfs.pod:3077
+msgid "Run C<src/api-support/update-from-tarballs.sh>."
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:"
+#. type: textblock
+#: ../src/guestfs.pod:3081
+msgid "Push and pull from Transifex."
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:263
+#. type: textblock
+#: ../src/guestfs.pod:3083
+msgid "Run:"
+msgstr ""
+
+#. type: verbatim
+#: ../src/guestfs.pod:3085
#, no-wrap
msgid ""
-" virt-make-fs --partition input.tar ...\n"
+" tx push -s\n"
"\n"
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:"
+#. type: textblock
+#: ../src/guestfs.pod:3087
+msgid "to push the latest POT files to Transifex. Then run:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:269
+#. type: verbatim
+#: ../src/guestfs.pod:3089
#, no-wrap
msgid ""
-" virt-make-fs --partition -- input.tar ...\n"
+" ./tx-pull.sh\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:529
-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/>."
+#. type: textblock
+#: ../src/guestfs.pod:3091
+msgid "which is a wrapper to pull the latest translated C<*.po> files."
msgstr ""
-# type: textblock
-#: ../tools/virt-make-fs.pl:543 ../tools/virt-win-reg.pl:478
+#. type: textblock
+#: ../src/guestfs.pod:3095
msgid ""
-"When reporting bugs, please enable debugging and capture the I<complete> "
-"output:"
+"Create new stable and development directories under L<http://libguestfs.org/"
+"download>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3100
+msgid "Create the branch in git:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-make-fs.pl:546
+#. type: verbatim
+#: ../src/guestfs.pod:3102
#, no-wrap
msgid ""
-" export LIBGUESTFS_DEBUG=1\n"
-" virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
+" git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
+" git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
+" git branch stable-1.XX\n"
+" git push origin tag 1.XX.0 1.YY.0 stable-1.XX\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/>"
+#. type: =head1
+#: ../src/guestfs.pod:3109
+msgid "LIMITS"
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."
+#. type: =head2
+#: ../src/guestfs.pod:3111
+msgid "PROTOCOL LIMITS"
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:33
-msgid "virt-rescue - Run a rescue shell on a virtual machine"
+#. type: textblock
+#: ../src/guestfs.pod:3113
+msgid ""
+"Internally libguestfs uses a message-based protocol to pass API calls and "
+"their responses to and from a small \"appliance\" (see L</INTERNALS> for "
+"plenty more detail about this). The maximum message size used by the "
+"protocol is slightly less than 4 MB. For some API calls you may need to be "
+"aware of this limit. The API calls which may be affected are individually "
+"documented, with a link back to this section of the documentation."
msgstr ""
-# type: verbatim
-#: ../tools/virt-rescue.pl:37
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:3121
msgid ""
-" virt-rescue [--options] domname\n"
-"\n"
+"A simple call such as L</guestfs_cat> returns its result (the file data) in "
+"a simple string. Because this string is at some point internally encoded as "
+"a message, the maximum size that it can return is slightly under 4 MB. If "
+"the requested file is larger than this then you will get an error."
msgstr ""
-# type: verbatim
-#: ../tools/virt-rescue.pl:39
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:3127
msgid ""
-" virt-rescue [--options] disk.img [disk.img ...]\n"
-"\n"
+"In order to transfer large files into and out of the guest filesystem, you "
+"need to use particular calls that support this. The sections L</UPLOADING> "
+"and L</DOWNLOADING> document how to do this."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:43
+#. type: textblock
+#: ../src/guestfs.pod:3131
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."
+"You might also consider mounting the disk image using our FUSE filesystem "
+"support (L<guestmount(1)>)."
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: =head2
+#: ../src/guestfs.pod:3134
+msgid "MAXIMUM NUMBER OF DISKS"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3136
+msgid "When using virtio disks (the default) the current limit is B<25> disks."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:53
+#. type: textblock
+#: ../src/guestfs.pod:3139
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."
+"Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
+"slots. However febootstrap only understands disks with names C</dev/vda> "
+"through C</dev/vdz> (26 letters) and it reserves one disk for its own "
+"purposes."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:58
+#. type: textblock
+#: ../src/guestfs.pod:3144
msgid ""
-"You can run virt-rescue on any virtual machine known to libvirt, or directly "
-"on disk image(s):"
+"We are working to substantially raise this limit in future versions but it "
+"requires complex changes to qemu."
msgstr ""
-# type: verbatim
-#: ../tools/virt-rescue.pl:61
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:3147
msgid ""
-" virt-rescue GuestName\n"
-"\n"
+"In future versions of libguestfs it should also be possible to \"hot plug\" "
+"disks (add and remove disks after calling L</guestfs_launch>). This also "
+"requires changes to qemu."
msgstr ""
-# type: verbatim
-#: ../tools/virt-rescue.pl:63
-#, no-wrap
+#. type: =head2
+#: ../src/guestfs.pod:3151
+msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3153
+msgid "Virtio limits the maximum number of partitions per disk to B<15>."
+msgstr ""
+
+#. type: textblock
+#: ../src/guestfs.pod:3155
msgid ""
-" virt-rescue --ro /path/to/disk.img\n"
-"\n"
+"This is because it reserves 4 bits for the minor device number (thus C</dev/"
+"vda>, and C</dev/vda1> through C</dev/vda15>)."
msgstr ""
-# type: verbatim
-#: ../tools/virt-rescue.pl:65
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:3158
msgid ""
-" virt-rescue /dev/sdc\n"
-"\n"
+"If you attach a disk with more than 15 partitions, the extra partitions are "
+"ignored by libguestfs."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:67
-msgid "For live VMs you I<must> use the --ro option."
+#. type: =head2
+#: ../src/guestfs.pod:3161
+msgid "MAXIMUM SIZE OF A DISK"
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:69
-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."
+#. type: textblock
+#: ../src/guestfs.pod:3163
+msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:76
+#. type: textblock
+#: ../src/guestfs.pod:3165
msgid ""
-"In the example below, we list logical volumes, then choose one to mount "
-"under C</sysroot>:"
+"We have tested block devices up to 1 exabyte (2**60 or "
+"1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
+"filesystem."
msgstr ""
-# type: verbatim
-#: ../tools/virt-rescue.pl:79
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:3169
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"
+"Although libguestfs probably does not impose any limit, the underlying host "
+"storage will. If you store disk images on a host ext4 filesystem, then the "
+"maximum size will be limited by the maximum ext4 file size (currently 16 "
+"TB). If you store disk images as host logical volumes then you are limited "
+"by the maximum size of an LV."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:86
+#. type: textblock
+#: ../src/guestfs.pod:3175
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."
+"For the hugest disk image files, we recommend using XFS on the host for "
+"storage."
msgstr ""
-# type: =head1
-#: ../tools/virt-rescue.pl:90 ../tools/virt-resize.pl:1350
-msgid "NOTES"
+#. type: =head2
+#: ../src/guestfs.pod:3178
+msgid "MAXIMUM SIZE OF A PARTITION"
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:92
+#. type: textblock
+#: ../src/guestfs.pod:3180
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."
+"The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
+"numbers. Assuming a 512 byte sector size, this means that MBR cannot "
+"address a partition located beyond 2 TB on the disk."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:98
+#. type: textblock
+#: ../src/guestfs.pod:3184
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)>."
+"It is recommended that you use GPT partitions on disks which are larger than "
+"this size. GPT uses 64 bit sector numbers and so can address partitions "
+"which are theoretically larger than the largest disk we could support."
msgstr ""
-# type: =item
-#: ../tools/virt-rescue.pl:127
-msgid "B<--append kernelopts>"
+#. type: =head2
+#: ../src/guestfs.pod:3189
+msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:129
-msgid "Pass additional options to the rescue kernel."
+#. type: textblock
+#: ../src/guestfs.pod:3191
+msgid ""
+"This depends on the filesystem type. libguestfs itself does not impose any "
+"known limit. Consult Wikipedia or the filesystem documentation to find out "
+"what these limits are."
msgstr ""
-# type: =item
-#: ../tools/virt-rescue.pl:147
-msgid "B<--memsize MB> | B<-m MB>"
+#. type: =head2
+#: ../src/guestfs.pod:3195
+msgid "MAXIMUM UPLOAD AND DOWNLOAD"
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:149
+#. type: textblock
+#: ../src/guestfs.pod:3197
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."
+"The API functions L</guestfs_upload>, L</guestfs_download>, L</"
+"guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
+"uploads and downloads."
msgstr ""
-# type: =item
-#: ../tools/virt-rescue.pl:158
-msgid "B<--ro> | B<-r>"
+#. type: =head2
+#: ../src/guestfs.pod:3201
+msgid "INSPECTION LIMITS"
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:160
-msgid "Open the image read-only."
-msgstr ""
-
-# type: textblock
-#: ../tools/virt-rescue.pl:172
+#. type: textblock
+#: ../src/guestfs.pod:3203
msgid ""
-"Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
-"SELINUX> before using this option."
+"The inspection code has several arbitrary limits on things like the size of "
+"Windows Registry hive it will read, and the length of product name. These "
+"are intended to stop a malicious guest from consuming arbitrary amounts of "
+"memory and disk space on the host, and should not be reached in practice. "
+"See the source code for more information."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:228
+#. type: textblock
+#: ../src/guestfs.pod:3229
msgid ""
-"Several environment variables affect virt-rescue. See L<guestfs(3)/"
-"ENVIRONMENT VARIABLES> for the complete list."
+"Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
+"effect as calling C<guestfs_set_verbose (g, 1)>."
msgstr ""
-# type: textblock
-#: ../tools/virt-rescue.pl:233
+#. type: textblock
+#: ../src/guestfs.pod:3241
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/>."
+"Set the path that libguestfs uses to search for a supermin appliance. See "
+"the discussion of paths in section L</PATH> above."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:42
-msgid "virt-resize - Resize a virtual machine disk"
+#. type: textblock
+#: ../src/guestfs.pod:3250
+msgid "See also L</QEMU WRAPPERS> above."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:46
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:3254
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"
+"Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
+"effect as calling C<guestfs_set_trace (g, 1)>."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:52
+#. type: textblock
+#: ../src/guestfs.pod:3272
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."
+"L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-"
+"ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
+"L<guestfish(1)>, L<guestmount(1)>, L<virt-alignment-scan(1)>, L<virt-cat(1)"
+">, L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
+"L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
+"L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue"
+"(1)>, L<virt-resize(1)>, L<virt-sparsify(1)>, L<virt-sysprep(1)>, L<virt-tar"
+"(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
+"L<febootstrap(1)>, L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<stap(1)"
+">, L<http://libguestfs.org/>."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:56
+#. type: textblock
+#: ../src/guestfs.pod:3308
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."
+"Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
+"(8)>, L<disktype(1)>."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:60
-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."
+#. type: =head1
+#: ../src/guestfs.pod:3315 ../tools/virt-make-fs.pl:571
+#: ../tools/virt-win-reg.pl:772
+msgid "BUGS"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:68
-msgid ""
-"Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
-"fill the extra 5GB of space."
+#. type: textblock
+#: ../src/guestfs.pod:3317
+msgid "To get a list of bugs against libguestfs use this link:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:71
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:3319
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"
+"L<https://bugzilla.redhat.com/buglist.cgi?"
+"component=libguestfs&product=Virtualization+Tools>"
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:"
+#. type: textblock
+#: ../src/guestfs.pod:3321
+msgid "To report a new bug against libguestfs use this link:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:79
-#, no-wrap
+#. type: textblock
+#: ../src/guestfs.pod:3323
msgid ""
-" virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
-"\n"
+"L<https://bugzilla.redhat.com/enter_bug.cgi?"
+"component=libguestfs&product=Virtualization+Tools>"
msgstr ""
-# type: =head1
-#: ../tools/virt-resize.pl:81
-msgid "DETAILED USAGE"
+#. type: textblock
+#: ../src/guestfs.pod:3325
+msgid "When reporting a bug, please check:"
msgstr ""
-# type: =head2
-#: ../tools/virt-resize.pl:83
-msgid "EXPANDING A VIRTUAL MACHINE DISK"
+#. type: textblock
+#: ../src/guestfs.pod:3331
+msgid "That the bug hasn't been reported already."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:87
-msgid "1. Shut down the virtual machine"
+#. type: textblock
+#: ../src/guestfs.pod:3335
+msgid "That you are testing a recent version."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:89
-msgid "2. Locate input disk image"
+#. type: textblock
+#: ../src/guestfs.pod:3339
+msgid "Describe the bug accurately, and give a way to reproduce it."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:91
+#. type: textblock
+#: ../src/guestfs.pod:3343
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:"
+"Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
+"bug report."
+msgstr ""
+
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:5
+msgid "libguestfs-test-tool - Diagnostics for libguestfs"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:95
+#. type: verbatim
+#: ../test-tool/libguestfs-test-tool.pod:9
#, 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"
+" libguestfs-test-tool [--options]\n"
"\n"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:100
-msgid "3. Look at current sizing"
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:13
+msgid ""
+"libguestfs-test-tool is a test program shipped with libguestfs to allow you "
+"to check basic libguestfs functionality is working. This is needed because "
+"libguestfs occasionally breaks for reasons beyond our control: usually "
+"because of changes in the underlying qemu or kernel packages, or the host "
+"environment."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:102
-msgid ""
-"Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:19
+msgid "If you suspect a problem in libguestfs, then just run:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:105
+#. type: verbatim
+#: ../test-tool/libguestfs-test-tool.pod:21
#, 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"
+" libguestfs-test-tool\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:110
-msgid ""
-"(This example is a virtual machine with an 8 GB disk which we would like to "
-"expand up to 10 GB)."
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:23
+msgid "It will print lots of diagnostic messages."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:113
-msgid "4. Create output disk"
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:25
+msgid "If it runs to completion successfully, you will see this near the end:"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:115
+#. type: verbatim
+#: ../test-tool/libguestfs-test-tool.pod:27
+#, no-wrap
msgid ""
-"Virt-resize cannot do in-place disk modifications. You have to have space "
-"to store the resized output disk."
+" ===== TEST FINISHED OK =====\n"
+"\n"
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:"
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:29
+msgid "and the test tool will exit with code 0."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:121
-#, no-wrap
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:31
msgid ""
-" # rm -f outdisk\n"
-" # truncate -s 10G outdisk\n"
-"\n"
+"If it fails (and/or exits with non-zero error code), please paste the "
+"I<complete, unedited> output of the test tool into a bug report. More "
+"information about reporting bugs can be found on the L<http://libguestfs.org/"
+"> website."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:124
-msgid "Or use L<lvcreate(1)> to create a logical volume:"
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:42
+msgid "Display short usage information and exit."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:126
-#, no-wrap
+#. type: =item
+#: ../test-tool/libguestfs-test-tool.pod:44
+msgid "B<--qemu qemu_binary>"
+msgstr ""
+
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:46
msgid ""
-" # lvcreate -L 10G -n lv_name vg_name\n"
-"\n"
+"If you have downloaded another qemu binary, point this option at the full "
+"path of the binary to try it."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:128
-msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
+#. type: =item
+#: ../test-tool/libguestfs-test-tool.pod:49
+msgid "B<--qemudir qemu_source_dir>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:130
-#, no-wrap
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:51
msgid ""
-" # virsh pool-list\n"
-" # virsh vol-create-as poolname newvol 10G\n"
-"\n"
+"If you have compiled qemu from source, point this option at the source "
+"directory to try it."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:133
-msgid "5. Resize"
+#. type: =item
+#: ../test-tool/libguestfs-test-tool.pod:54
+msgid "B<-t N>"
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."
+#. type: =item
+#: ../test-tool/libguestfs-test-tool.pod:56
+msgid "B<--timeout N>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:139
-#, no-wrap
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:58
msgid ""
-" # virt-resize indisk outdisk\n"
-"\n"
+"Set the launch timeout to C<N> seconds. The default is 600 seconds (10 "
+"minutes) which does not usually need to be adjusted."
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."
+#. type: =head1
+#: ../test-tool/libguestfs-test-tool.pod:63
+msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:147
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:65
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)."
+"If you have compiled another version of qemu from source and would like to "
+"try that, then you can use the I<--qemudir> option to point to the qemu "
+"source directory."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:151
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:69
msgid ""
-"L</--expand> is the most useful option. It expands the named partition "
-"within the disk to fill any extra space:"
+"If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
+"option to point to the binary."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:154
-#, no-wrap
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:72
msgid ""
-" # virt-resize --expand /dev/sda2 indisk outdisk\n"
-"\n"
+"Note when using these options, you can ignore the business of qemu wrapper "
+"scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
+"wrapper script for you if one is needed."
+msgstr ""
+
+#. type: =head1
+#: ../test-tool/libguestfs-test-tool.pod:76
+msgid "TRYING OUT A DIFFERENT KERNEL"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:156
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:78
msgid ""
-"(In this case, an extra partition is I<not> created at the end of the disk, "
-"because there will be no unused space)."
+"If you are using febootstrap E<ge> 3.8 then you can select which kernel "
+"libguestfs tries. You do this by setting the environment variables "
+"C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:159
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:82
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:"
+"Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
+"information."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:163
-#, no-wrap
+#. type: =head1
+#: ../test-tool/libguestfs-test-tool.pod:85
+msgid "SELF-DIAGNOSIS"
+msgstr ""
+
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:87
msgid ""
-" # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
-" indisk outdisk\n"
-"\n"
+"Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
+"produced by libguestfs-test-tool and/or possible errors."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:166
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:92
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."
+"libguestfs-test-tool returns I<0> if the tests completed without error, or "
+"I<1> if there was an error."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:175
-msgid "Other options are covered below."
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:97
+msgid ""
+"For the full list of environment variables which may affect libguestfs, "
+"please see the L<guestfs(3)> manual page."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:177
-msgid "6. Test"
+#. type: textblock
+#: ../test-tool/libguestfs-test-tool.pod:102
+msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:179
-msgid "Thoroughly test the new disk image I<before> discarding the old one."
+#. type: textblock
+#: ../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:181
-msgid "If you are using libvirt, edit the XML to point at the new disk:"
+#. type: verbatim
+#: ../tools/virt-list-filesystems.pl:36
+#, no-wrap
+msgid ""
+" virt-list-filesystems [--options] domname\n"
+"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:183
+#. type: verbatim
+#: ../tools/virt-list-filesystems.pl:38
#, no-wrap
msgid ""
-" # virsh edit guestname\n"
+" virt-list-filesystems [--options] disk.img [disk.img ...]\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:185
+#. type: textblock
+#: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
msgid ""
-"Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
-"html#elementsDisks>"
+"This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
+"replacement."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:188
-msgid "Then start up the domain with the new, resized disk:"
+#. type: textblock
+#: ../tools/virt-list-filesystems.pl:45
+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: verbatim
-#: ../tools/virt-resize.pl:190
-#, no-wrap
+#. type: textblock
+#: ../tools/virt-list-filesystems.pl:49
msgid ""
-" # virsh start guestname\n"
-"\n"
+"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:192
+#. type: textblock
+#: ../tools/virt-list-filesystems.pl:112
msgid ""
-"and check that it still works. See also the L</NOTES> section below for "
-"additional information."
+"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:195
-msgid "7. Resize LVs etc inside the guest"
+#. type: =item
+#: ../tools/virt-list-filesystems.pl:119
+msgid "B<-a>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:197
-msgid "(This can also be done offline using L<guestfish(1)>)"
+#. type: textblock
+#: ../tools/virt-list-filesystems.pl:123
+msgid ""
+"Normally we only show mountable filesystems. If this option is given then "
+"swap devices are shown too."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:199
+#. type: textblock
+#: ../tools/virt-list-filesystems.pl:197
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."
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
+"filesystems(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: =head2
-#: ../tools/virt-resize.pl:206
-msgid "SHRINKING A VIRTUAL MACHINE DISK"
+#. type: textblock
+#: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
+msgid "Copyright (C) 2009 Red Hat Inc."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:208
+#. type: textblock
+#: ../tools/virt-list-partitions.pl:32
msgid ""
-"Shrinking is somewhat more complex than expanding, and only an overview is "
-"given here."
+"virt-list-partitions - List partitions in a virtual machine or disk image"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:211
+#. type: verbatim
+#: ../tools/virt-list-partitions.pl:36
+#, no-wrap
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."
+" virt-list-partitions [--options] domname\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:216
-msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
+#. type: verbatim
+#: ../tools/virt-list-partitions.pl:38
+#, no-wrap
+msgid ""
+" virt-list-partitions [--options] disk.img [disk.img ...]\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:218
+#. type: textblock
+#: ../tools/virt-list-partitions.pl:45
msgid ""
-"After shrinking PVs and filesystems, shut down the guest, and proceed with "
-"steps 3 and 4 above to allocate a new disk image."
+"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-resize.pl:221
+#. type: textblock
+#: ../tools/virt-list-partitions.pl:50
msgid ""
-"Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
+"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: =head2
-#: ../tools/virt-resize.pl:224
-msgid "IGNORING OR DELETING PARTITIONS"
+#. type: textblock
+#: ../tools/virt-list-partitions.pl:113
+msgid "Show sizes in human-readable form (eg. \"1G\")."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:226
+#. type: textblock
+#: ../tools/virt-list-partitions.pl:123
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."
+"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: textblock
-#: ../tools/virt-resize.pl:243
-msgid "Display help."
+#. type: =item
+#: ../tools/virt-list-partitions.pl:130
+msgid "B<-t>"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:257
-msgid "B<--resize part=size>"
+#. type: =item
+#: ../tools/virt-list-partitions.pl:132
+msgid "B<--total>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:259
+#. type: textblock
+#: ../tools/virt-list-partitions.pl:134
msgid ""
-"Resize the named partition (expanding or shrinking it) so that it has the "
-"given size."
+"Display the total size of each block device (as a separate row or rows)."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:262
+#. type: textblock
+#: ../tools/virt-list-partitions.pl:267
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-filesystems(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: textblock
+#: ../tools/virt-list-partitions.pl:283
+msgid "Copyright (C) 2009-2010 Red Hat Inc."
+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-resize.pl:267
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:41
#, no-wrap
msgid ""
-" --resize /dev/sda2=10G\n"
+" virt-make-fs [--options] input.tar output.img\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:269
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:43
#, no-wrap
msgid ""
-" --resize /dev/sda4=90%\n"
+" virt-make-fs [--options] input.tar.gz output.img\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:271
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:45
#, no-wrap
msgid ""
-" --resize /dev/sda2=+1G\n"
+" virt-make-fs [--options] directory output.img\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:273
+#. 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)."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-make-fs.pl:57
+msgid "Basic usage is:"
+msgstr ""
+
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:59
#, no-wrap
msgid ""
-" --resize /dev/sda2=-200M\n"
+" virt-make-fs input output.img\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:275
-#, no-wrap
+#. type: textblock
+#: ../tools/virt-make-fs.pl:61
msgid ""
-" --resize /dev/sda1=+128K\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.img> is a disk image. The input type is detected automatically. "
+"The output disk image defaults to a raw ext2 sparse image unless you specify "
+"extra flags (see L</OPTIONS> below)."
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:277
-#, no-wrap
-msgid ""
-" --resize /dev/sda1=+10%\n"
-"\n"
+#. type: =head2
+#: ../tools/virt-make-fs.pl:67
+msgid "FILESYSTEM TYPE"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:279
-#, no-wrap
+#. type: textblock
+#: ../tools/virt-make-fs.pl:69
msgid ""
-" --resize /dev/sda1=-10%\n"
-"\n"
+"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-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)."
+#. type: =item
+#: ../tools/virt-make-fs.pl:75
+msgid "I<ext3>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:285
+#. type: textblock
+#: ../tools/virt-make-fs.pl:77
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>)."
+"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: textblock
-#: ../tools/virt-resize.pl:290 ../tools/virt-resize.pl:382
-#: ../tools/virt-resize.pl:399
-msgid "You can give this option multiple times."
+#. type: =item
+#: ../tools/virt-make-fs.pl:81
+msgid "I<ntfs> or I<vfat>"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:296
-msgid "B<--resize-force part=size>"
+#. type: textblock
+#: ../tools/virt-make-fs.pl:83
+msgid "Useful if exporting data to a Windows guest."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:298
+#. type: textblock
+#: ../tools/virt-make-fs.pl:85
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."
+"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-resize.pl:310
-msgid "B<--expand part>"
+#. type: =item
+#: ../tools/virt-make-fs.pl:90
+msgid "I<minix>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:312
+#. type: textblock
+#: ../tools/virt-make-fs.pl:92
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)."
+"Lower overhead than C<ext2>, but certain limitations on filename length and "
+"total filesystem size."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:315
-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."
+#. type: =head3
+#: ../tools/virt-make-fs.pl:97 ../tools/virt-make-fs.pl:116
+#: ../tools/virt-make-fs.pl:149
+msgid "EXAMPLE"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:320
-msgid "Currently virt-resize can resize:"
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:99
+#, no-wrap
+msgid ""
+" virt-make-fs --type=minix input minixfs.img\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:326
-msgid ""
-"ext2, ext3 and ext4 filesystems when they are contained directly inside a "
-"partition."
+#. type: =head2
+#: ../tools/virt-make-fs.pl:101
+msgid "TO PARTITION OR NOT TO PARTITION"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:331
-msgid ""
-"NTFS filesystems contained directly in a partition, if libguestfs was "
-"compiled with support for NTFS."
+#. type: textblock
+#: ../tools/virt-make-fs.pl:103
+msgid "Optionally virt-make-fs can add a partition table to the output disk."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:334
+#. type: textblock
+#: ../tools/virt-make-fs.pl:105
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."
+"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-resize.pl:341
+#. type: textblock
+#: ../tools/virt-make-fs.pl:110
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."
+"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: textblock
-#: ../tools/virt-resize.pl:347 ../tools/virt-resize.pl:369
-msgid "Note that you cannot use C<--expand> and C<--shrink> together."
+#. type: textblock
+#: ../tools/virt-make-fs.pl:118
+msgid "Add an MBR partition:"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:353
-msgid "B<--shrink part>"
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:120
+#, no-wrap
+msgid ""
+" virt-make-fs --partition -- input disk.img\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:355
+#. type: textblock
+#: ../tools/virt-make-fs.pl:122
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."
+"If the output disk image could be terabyte-sized or larger, it's better to "
+"use an EFI/GPT-compatible partition table:"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:361
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:125
+#, no-wrap
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."
+" virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
+"\n"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:375
-msgid "B<--ignore part>"
+#. type: =head2
+#: ../tools/virt-make-fs.pl:127
+msgid "EXTRA SPACE"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:377
+#. type: textblock
+#: ../tools/virt-make-fs.pl:129
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)."
+"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 I<--size> flag to leave space in the filesystem if you "
+"want it."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:388
-msgid "B<--delete part>"
+#. type: textblock
+#: ../tools/virt-make-fs.pl:137
+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 I<--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 I<--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-resize.pl:390
+#. type: textblock
+#: ../tools/virt-make-fs.pl:145
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."
+"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-fs "
+"to build another image from scratch."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:394
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:151
+#, no-wrap
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."
+" virt-make-fs --format=qcow2 --size=+200M input output.img\n"
+"\n"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:405
-msgid "B<--LV-expand logvol>"
+#. type: textblock
+#: ../tools/virt-make-fs.pl:179
+msgid "Enable debugging information."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:407
-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:"
+#. type: =item
+#: ../tools/virt-make-fs.pl:185
+msgid "B<--size=E<lt>NE<gt>>"
msgstr ""
-# type: verbatim
-#: ../tools/virt-resize.pl:412
-#, no-wrap
-msgid ""
-" virt-resize indisk outdisk \\\n"
-" --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
-"\n"
+#. type: =item
+#: ../tools/virt-make-fs.pl:187
+msgid "B<--size=+E<lt>NE<gt>>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:415
-msgid ""
-"This would first expand the partition (and PV), and then expand the root "
-"device to fill the extra space in the PV."
+#. type: =item
+#: ../tools/virt-make-fs.pl:189
+msgid "B<-s E<lt>NE<gt>>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:418
-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>."
+#. type: =item
+#: ../tools/virt-make-fs.pl:191
+msgid "B<-s +E<lt>NE<gt>>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:422
-msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
+#. type: textblock
+#: ../tools/virt-make-fs.pl:193
+msgid ""
+"Use the I<--size> (or I<-s>) option to choose the size of the output image."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:425
+#. type: textblock
+#: ../tools/virt-make-fs.pl:196
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."
+"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: =item
-#: ../tools/virt-resize.pl:433
-msgid "B<--no-copy-boot-loader>"
+#. type: textblock
+#: ../tools/virt-make-fs.pl:199
+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."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:435
+#. type: textblock
+#: ../tools/virt-make-fs.pl:204
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."
+"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: I<--size=+200M> means enough space for "
+"the input files, and (approximately) an extra 200 MB free space."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:440
+#. type: textblock
+#: ../tools/virt-make-fs.pl:210
msgid ""
-"If you specify this flag, then this initial copy is not done. You may need "
-"to reinstall the boot loader in this case."
+"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: =item
-#: ../tools/virt-resize.pl:448
-msgid "B<--no-extra-partition>"
+#. type: =item
+#: ../tools/virt-make-fs.pl:219
+msgid "B<--format=E<lt>fmtE<gt>>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:450
-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."
+#. type: =item
+#: ../tools/virt-make-fs.pl:221
+msgid "B<-F E<lt>fmtE<gt>>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:456
-msgid ""
-"Note that if the surplus space is smaller than 10 MB, no extra partition "
-"will be created."
+#. type: textblock
+#: ../tools/virt-make-fs.pl:223
+msgid "Choose the output disk image format."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:463
-msgid "B<--no-expand-content>"
+#. type: textblock
+#: ../tools/virt-make-fs.pl:225
+msgid "The default is C<raw> (raw sparse disk image)."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:465
+#. type: textblock
+#: ../tools/virt-make-fs.pl:227
msgid ""
-"By default, virt-resize will try to expand the direct contents of "
-"partitions, if it knows how (see C<--expand> option above)."
+"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: textblock
-#: ../tools/virt-resize.pl:468
-msgid ""
-"If you give the C<--no-expand-content> option then virt-resize will not "
-"attempt this."
+#. type: =item
+#: ../tools/virt-make-fs.pl:234
+msgid "B<--type=E<lt>fsE<gt>>"
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:475
-msgid "B<-d> | B<--debug>"
+#. type: =item
+#: ../tools/virt-make-fs.pl:236
+msgid "B<-t E<lt>fsE<gt>>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:477 ../tools/virt-win-reg.pl:198
-msgid "Enable debugging messages."
+#. type: textblock
+#: ../tools/virt-make-fs.pl:238
+msgid "Choose the output filesystem type."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:483
-msgid "B<-n> | B<--dryrun>"
+#. type: textblock
+#: ../tools/virt-make-fs.pl:240
+msgid "The default is C<ext2>."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:485
-msgid "Print a summary of what would be done, but don't do anything."
+#. type: textblock
+#: ../tools/virt-make-fs.pl:242
+msgid ""
+"Any filesystem which is supported read-write by libguestfs can be used here."
msgstr ""
-# type: =item
-#: ../tools/virt-resize.pl:491
-msgid "B<-q> | B<--quiet>"
+#. type: =item
+#: ../tools/virt-make-fs.pl:249
+msgid "B<--partition>"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:493
-msgid "Don't print the summary."
+#. type: =item
+#: ../tools/virt-make-fs.pl:251
+msgid "B<--partition=E<lt>parttypeE<gt>>"
msgstr ""
-# type: =head2
-#: ../tools/virt-resize.pl:1352
-msgid "\"Partition 1 does not end on cylinder boundary.\""
+#. type: textblock
+#: ../tools/virt-make-fs.pl:253
+msgid ""
+"If specified, this flag adds an MBR partition table to the output disk image."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:1354
+#. type: textblock
+#: ../tools/virt-make-fs.pl:256
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."
+"You can change the partition table type, eg. I<--partition=gpt> for large "
+"disks."
msgstr ""
-# type: =head2
-#: ../tools/virt-resize.pl:1361
-msgid "RESIZING WINDOWS VIRTUAL MACHINES"
+#. type: textblock
+#: ../tools/virt-make-fs.pl:259
+msgid ""
+"Note that if you just use a lonesome I<--partition>, the Perl option parser "
+"might consider the next parameter to be the partition type. For example:"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:1363
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:263
+#, no-wrap
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."
+" virt-make-fs --partition input.tar output.img\n"
+"\n"
+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 I<--> (a double "
+"dash) between options and the input and output arguments:"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:1370
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:269
+#, no-wrap
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."
+" virt-make-fs --partition -- input.tar output.img\n"
+"\n"
msgstr ""
-# type: =head1
-#: ../tools/virt-resize.pl:1374
-msgid "ALTERNATIVE TOOLS"
+#. type: textblock
+#: ../tools/virt-make-fs.pl:271
+msgid "For MBR, virt-make-fs sets the partition type byte automatically."
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:1376
+#. type: textblock
+#: ../tools/virt-make-fs.pl:559
msgid ""
-"There are several proprietary tools for resizing partitions. We won't "
-"mention any here."
+"L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(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: textblock
-#: ../tools/virt-resize.pl:1379
+#. type: textblock
+#: ../tools/virt-make-fs.pl:573 ../tools/virt-win-reg.pl:774
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."
+"When reporting bugs, please enable debugging and capture the I<complete> "
+"output:"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:1384
+#. type: verbatim
+#: ../tools/virt-make-fs.pl:576
+#, no-wrap
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."
+" export LIBGUESTFS_DEBUG=1\n"
+" virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-resize.pl:1392
+#. type: textblock
+#: ../tools/virt-make-fs.pl:579
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/>."
+"Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
+"redhat.com/>"
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:34
+#. type: textblock
+#: ../tools/virt-tar.pl:33
msgid "virt-tar - Extract or upload files to a virtual machine"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:38
+#. type: verbatim
+#: ../tools/virt-tar.pl:37
#, no-wrap
msgid ""
" virt-tar [--options] -x domname directory tarball\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:40
+#. type: verbatim
+#: ../tools/virt-tar.pl:39
#, no-wrap
msgid ""
" virt-tar [--options] -u domname tarball directory\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:42
+#. type: verbatim
+#: ../tools/virt-tar.pl:41
#, no-wrap
msgid ""
" virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:44
+#. type: verbatim
+#: ../tools/virt-tar.pl:43
#, no-wrap
msgid ""
" virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:48
+#. type: =head2
+#: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
+msgid "NOTE"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-tar.pl:47
+msgid ""
+"This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
+"tar-in(1)>, L<virt-tar-out(1)> as replacements."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-tar.pl:52
msgid "Download C</home> from the VM into a local tarball:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:50
+#. type: verbatim
+#: ../tools/virt-tar.pl:54
#, no-wrap
msgid ""
" virt-tar -x domname /home home.tar\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:52
+#. type: verbatim
+#: ../tools/virt-tar.pl:56
#, no-wrap
msgid ""
" virt-tar -zx domname /home home.tar.gz\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:54
+#. type: textblock
+#: ../tools/virt-tar.pl:58
msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:56
+#. type: verbatim
+#: ../tools/virt-tar.pl:60
#, no-wrap
msgid ""
" virt-tar -u domname uploadstuff.tar /tmp\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-tar.pl:58
+#. type: verbatim
+#: ../tools/virt-tar.pl:62
#, no-wrap
msgid ""
" virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:62
+#. type: textblock
+#: ../tools/virt-tar.pl:66
msgid ""
-"You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
+"You must I<not> use C<virt-tar> with the I<-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-tar.pl:67
+#. type: textblock
+#: ../tools/virt-tar.pl:71
msgid ""
-"You can use C<-x> (extract) on live virtual machines, but you might get "
+"You can use I<-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-tar.pl:75
+#. type: textblock
+#: ../tools/virt-tar.pl:79
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, "
"guests, etc."
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:80
+#. type: textblock
+#: ../tools/virt-tar.pl:84
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."
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:84
+#. type: textblock
+#: ../tools/virt-tar.pl:88
msgid ""
-"There are two modes of operation: C<-x> (eXtract) downloads a directory and "
+"There are two modes of operation: I<-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 "
+"I<-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-tar.pl:90
+#. type: textblock
+#: ../tools/virt-tar.pl:94
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 "
+"In addition, you may need to use the I<-z> (gZip) option to enable "
+"compression. When uploading, you have to specify I<-z> if the upload file "
"is compressed because virt-tar won't detect this on its own."
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:94
+#. type: textblock
+#: ../tools/virt-tar.pl:98
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 "
"the L<libguestfs(3)> API)."
msgstr ""
-# type: =item
-#: ../tools/virt-tar.pl:135
-msgid "B<-x> | B<--extract> | B<--download>"
+#. type: =item
+#: ../tools/virt-tar.pl:160
+msgid "B<--extract>"
+msgstr ""
+
+#. type: =item
+#: ../tools/virt-tar.pl:162
+msgid "B<--download>"
msgstr ""
-# type: =item
-#: ../tools/virt-tar.pl:137
-msgid "B<-u> | B<--upload>"
+#. type: =item
+#: ../tools/virt-tar.pl:164
+msgid "B<-u>"
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:139
+#. type: =item
+#: ../tools/virt-tar.pl:166
+msgid "B<--upload>"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-tar.pl:168
msgid ""
-"Use C<-x> to extract (download) a directory from a virtual machine to a "
+"Use I<-x> to extract (download) a directory from a virtual machine to a "
"local tarball."
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:142
+#. type: textblock
+#: ../tools/virt-tar.pl:171
msgid ""
-"Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
+"Use I<-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-tar.pl:146
+#. type: textblock
+#: ../tools/virt-tar.pl:175
msgid "You must specify exactly one of these options."
msgstr ""
-# type: =item
-#: ../tools/virt-tar.pl:152
-msgid "B<-z> | B<--gzip>"
+#. type: =item
+#: ../tools/virt-tar.pl:181
+msgid "B<-z>"
+msgstr ""
+
+#. type: =item
+#: ../tools/virt-tar.pl:183
+msgid "B<--gzip>"
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:154
+#. type: textblock
+#: ../tools/virt-tar.pl:185
msgid "Specify that the input or output tarball is gzip-compressed."
msgstr ""
-# type: textblock
-#: ../tools/virt-tar.pl:259
+#. type: textblock
+#: ../tools/virt-tar.pl:298
msgid ""
-"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
+"L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
+"in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
"Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
"org/>."
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:38
+#. type: textblock
+#: ../tools/virt-win-reg.pl:37
msgid ""
"virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:42
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:41
#, no-wrap
msgid ""
" virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:44
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:43
#, no-wrap
msgid ""
" virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:46
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:45
#, no-wrap
msgid ""
" virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:48
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:47
#, no-wrap
msgid ""
" virt-win-reg --merge domname [input.reg ...]\n"
"\n"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:50
+#. 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-win-reg.pl:54
+#. type: textblock
+#: ../tools/virt-win-reg.pl:53
msgid ""
-"You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
+"You must I<not> use C<virt-win-reg> with the I<--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-win-reg.pl:59
+#. type: textblock
+#: ../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 "
+"system unbootable. Therefore when using the I<--merge> option, make sure "
"you have a reliable backup first."
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:66
+#. 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-win-reg.pl:69
+#. type: textblock
+#: ../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: textblock
-#: ../tools/virt-win-reg.pl:72
+#. type: textblock
+#: ../tools/virt-win-reg.pl:71
msgid ""
-"If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
+"If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
"exported (recursively). For example:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:75
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:74
#, no-wrap
msgid ""
" $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:77
+#. type: textblock
+#: ../tools/virt-win-reg.pl:76
msgid ""
"You can also display single values from within registry keys, for example:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:80
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:79
#, no-wrap
msgid ""
" $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:84
+#. type: textblock
+#: ../tools/virt-win-reg.pl:83
msgid ""
-"With C<--merge>, you can merge a textual regedit file into the Windows "
+"With I<--merge>, you can merge a textual regedit file into the Windows "
"Registry:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:87
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:86
#, no-wrap
msgid ""
" $ virt-win-reg --merge Windows7 changes.reg\n"
"\n"
msgstr ""
-# type: =head2
-#: ../tools/virt-win-reg.pl:89
+#. type: textblock
+#: ../tools/virt-win-reg.pl:90
+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: =item
+#: ../tools/virt-win-reg.pl:159
+msgid "B<--merge>"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:161
+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."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:165
+msgid ""
+"Note that I<--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: =item
+#: ../tools/virt-win-reg.pl:173
+msgid "B<--encoding> UTF-16LE|ASCII"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:175
+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>."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:179
+msgid ""
+"The default is to use UTF-16LE, which should work with recent versions of "
+"Windows."
+msgstr ""
+
+#. type: =item
+#: ../tools/virt-win-reg.pl:186
+msgid "B<--unsafe-printable-strings>"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:188
+msgid ""
+"When exporting (only), assume strings are UTF-16LE and print them as strings "
+"instead of hex sequences. Remove the final zero codepoint from strings if "
+"present."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:192
+msgid ""
+"This is unsafe and does not preserve the fidelity of strings in the original "
+"Registry for various reasons:"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:199
+msgid ""
+"Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
+"other encodings will be corrupted by this transformation."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:204
+msgid ""
+"Assumes that everything which has type 1 or 2 is really a string and that "
+"everything else is not a string, but the type field in real Registries is "
+"not reliable."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:210
+msgid ""
+"Loses information about whether a zero codepoint followed the string in the "
+"Registry or not."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:215
+msgid ""
+"This all happens because the Registry itself contains no information about "
+"how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:219
+msgid ""
+"You should only use this option for quick hacking and debugging of the "
+"Registry contents, and I<never> use it if the output is going to be passed "
+"into another program or stored in another Registry."
+msgstr ""
+
+#. type: =head1
+#: ../tools/virt-win-reg.pl:556
msgid "SUPPORTED SYSTEMS"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:91
+#. type: textblock
+#: ../tools/virt-win-reg.pl:558
msgid ""
"The program currently supports Windows NT-derived guests starting with "
"Windows XP through to at least Windows 7."
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>."
+#. type: textblock
+#: ../tools/virt-win-reg.pl:561
+msgid "The following Registry keys are supported:"
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>."
+#. type: =item
+#: ../tools/virt-win-reg.pl:565
+msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
+msgstr ""
+
+#. type: =item
+#: ../tools/virt-win-reg.pl:567
+msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
+msgstr ""
+
+#. type: =item
+#: ../tools/virt-win-reg.pl:569
+msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
+msgstr ""
+
+#. type: =item
+#: ../tools/virt-win-reg.pl:571
+msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
+msgstr ""
+
+#. type: =item
+#: ../tools/virt-win-reg.pl:573
+msgid "C<HKEY_USERS\\.DEFAULT>"
+msgstr ""
+
+#. type: =item
+#: ../tools/virt-win-reg.pl:575
+msgid "C<HKEY_USERS\\I<SID>>"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:577
+msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
+msgstr ""
+
+#. type: =item
+#: ../tools/virt-win-reg.pl:579
+msgid "C<HKEY_USERS\\I<username>>"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:101
+#. type: textblock
+#: ../tools/virt-win-reg.pl:581
msgid ""
-"C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
-"time."
+"where I<username> is a local user name (this is a libguestfs extension)."
msgstr ""
-# type: =head2
-#: ../tools/virt-win-reg.pl:104
-msgid "NOTE"
+#. type: textblock
+#: ../tools/virt-win-reg.pl:585
+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-win-reg.pl:106
+#. type: textblock
+#: ../tools/virt-win-reg.pl:588
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)>."
+"The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
+"supported (there is no \"current user\")."
msgstr ""
-# type: =head2
-#: ../tools/virt-win-reg.pl:112
+#. type: =head1
+#: ../tools/virt-win-reg.pl:591
msgid "ENCODING"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:114
+#. type: textblock
+#: ../tools/virt-win-reg.pl:593
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-"
"or after processing."
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:120
+#. type: textblock
+#: ../tools/virt-win-reg.pl:599
msgid ""
"To reencode a file from Windows format to Linux (before processing it with "
-"the C<--merge> option), you would do something like this:"
+"the I<--merge> option), you would do something like this:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:123
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:602
#, no-wrap
msgid ""
" iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:125
+#. type: textblock
+#: ../tools/virt-win-reg.pl:604
msgid ""
"To go in the opposite direction, after exporting and before sending the file "
"to a Windows user, do something like this:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:128
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:607
#, no-wrap
msgid ""
" unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:130
+#. type: textblock
+#: ../tools/virt-win-reg.pl:609
msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:132
+#. type: textblock
+#: ../tools/virt-win-reg.pl:611
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-win-reg.pl:136
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:615
#, no-wrap
msgid ""
" $ file software.reg\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
-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."
+#. type: textblock
+#: ../tools/virt-win-reg.pl:619
+msgid "This file would need conversion before you could I<--merge> it."
msgstr ""
-# type: =head2
-#: ../tools/virt-win-reg.pl:150
+#. type: =head1
+#: ../tools/virt-win-reg.pl:621
msgid "CurrentControlSet etc."
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:152
+#. type: textblock
+#: ../tools/virt-win-reg.pl:623
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."
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:156
+#. type: textblock
+#: ../tools/virt-win-reg.pl:627
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:"
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:160
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:631
#, no-wrap
msgid ""
" # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:167
-msgid "\"Default\" is the one which Windows will choose when it boots."
+#. type: textblock
+#: ../tools/virt-win-reg.pl:638
+msgid "\"Current\" is the one which Windows will choose when it boots."
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:169
+#. type: textblock
+#: ../tools/virt-win-reg.pl:640
msgid ""
"Similarly, other C<Current...> keys in the path may need to be replaced."
msgstr ""
-# type: =item
-#: ../tools/virt-win-reg.pl:216
-msgid "B<--merge>"
+#. type: =head1
+#: ../tools/virt-win-reg.pl:643
+msgid "DELETING REGISTRY KEYS AND VALUES"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:645
+msgid "To delete a whole registry key, use the syntax:"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:218
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:647
+#, no-wrap
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."
+" [-HKEY_LOCAL_MACHINE\\Foo]\n"
+"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:222
+#. type: textblock
+#: ../tools/virt-win-reg.pl:649
+msgid "To delete a single value within a key, use the syntax:"
+msgstr ""
+
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:651
+#, no-wrap
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."
+" [HKEY_LOCAL_MACHINE\\Foo]\n"
+" \"Value\"=-\n"
+"\n"
msgstr ""
-# type: =item
-#: ../tools/virt-win-reg.pl:230
-msgid "B<--encoding> UTF-16LE|ASCII"
+#. type: =head1
+#: ../tools/virt-win-reg.pl:654
+msgid "WINDOWS TIPS"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:232
+#. type: textblock
+#: ../tools/virt-win-reg.pl:656
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>."
+"Note that some of these tips modify the guest disk image. The guest I<must> "
+"be shut off, else you will get disk corruption."
+msgstr ""
+
+#. type: =head2
+#: ../tools/virt-win-reg.pl:659
+msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:236
+#. type: textblock
+#: ../tools/virt-win-reg.pl:661
msgid ""
-"The default is to use UTF-16LE, which should work with recent versions of "
-"Windows."
+"Prepare a DOS batch script, VBScript or executable. Upload this using "
+"L<guestfish(1)>. For this example the script is called C<test.bat> and it "
+"is uploaded into C<C:\\>:"
+msgstr ""
+
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:665
+#, no-wrap
+msgid ""
+" guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:667
+msgid "Prepare a regedit file containing the registry change:"
+msgstr ""
+
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:669
+#, no-wrap
+msgid ""
+" cat > test.reg <<'EOF'\n"
+" [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
+" \"Test\"=\"c:\\\\test.bat\"\n"
+" EOF\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:674
+msgid ""
+"In this example we use the key C<RunOnce> which means that the script will "
+"run precisely once when the first user logs in. If you want it to run every "
+"time a user logs in, replace C<RunOnce> with C<Run>."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:678
+msgid "Now update the registry:"
+msgstr ""
+
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:680
+#, no-wrap
+msgid ""
+" virt-win-reg --merge WindowsGuest test.reg\n"
+"\n"
+msgstr ""
+
+#. type: =head2
+#: ../tools/virt-win-reg.pl:682
+msgid "INSTALLING A SERVICE"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:684
+msgid ""
+"This section assumes you are familiar with Windows services, and you either "
+"have a program which handles the Windows Service Control Protocol directly "
+"or you want to run any program using a service wrapper like SrvAny or the "
+"free RHSrvAny."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:689
+msgid ""
+"First upload the program and optionally the service wrapper. In this case "
+"the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
+msgstr ""
+
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:693
+#, no-wrap
+msgid ""
+" guestfish -i -d WindowsGuest <<EOF\n"
+" upload rhsrvany.exe /rhsrvany.exe\n"
+" upload test.exe /test.exe\n"
+" EOF\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:698
+msgid ""
+"Prepare a regedit file containing the registry changes. In this example, "
+"the first registry change is needed for the service itself or the service "
+"wrapper (if used). The second registry change is only needed because I am "
+"using the RHSrvAny service wrapper."
+msgstr ""
+
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:703
+#, no-wrap
+msgid ""
+" cat > service.reg <<'EOF'\n"
+" [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
+" \"Type\"=dword:00000010\n"
+" \"Start\"=dword:00000002\n"
+" \"ErrorControl\"=dword:00000001\n"
+" \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
+" \"DisplayName\"=\"RHSrvAny\"\n"
+" \"ObjectName\"=\"NetworkService\"\n"
+" \n"
+msgstr ""
+
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:712
+#, no-wrap
+msgid ""
+" [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
+" \"CommandLine\"=\"c:\\\\test.exe\"\n"
+" \"PWD\"=\"c:\\\\Temp\"\n"
+" EOF\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:723
+msgid ""
+"For use of C<ControlSet001> see the section above in this manual page. You "
+"may need to adjust this according to the control set that is in use by the "
+"guest."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:729
+msgid ""
+"C<\"ObjectName\"> controls the privileges that the service will have. An "
+"alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
+"privileged account."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:735
+msgid ""
+"For the meaning of the magic numbers, see this Microsoft KB article: "
+"L<http://support.microsoft.com/kb/103000>."
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:740
+msgid "Update the registry:"
+msgstr ""
+
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:742
+#, no-wrap
+msgid ""
+" virt-win-reg --merge WindowsGuest service.reg\n"
+"\n"
+msgstr ""
+
+#. type: textblock
+#: ../tools/virt-win-reg.pl:746
+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:750
+msgid "Paths and value names are case-insensitive."
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:463
+#. type: textblock
+#: ../tools/virt-win-reg.pl:759
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<Sys::Virt(3)>, L<http://libguestfs.org/>."
msgstr ""
-# type: verbatim
-#: ../tools/virt-win-reg.pl:481
+#. type: verbatim
+#: ../tools/virt-win-reg.pl:777
#, no-wrap
msgid ""
" export LIBGUESTFS_DEBUG=1\n"
"\n"
msgstr ""
-# type: textblock
-#: ../tools/virt-win-reg.pl:484
+#. type: textblock
+#: ../tools/virt-win-reg.pl:780
msgid ""
"Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
"redhat.com/>"
git.annexia.org / libguestfs.git / blobdiff