X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Fja.po;h=1d3a473d9f01fcb119977079c3bf8cee7ad07a3a;hp=ace41fbcd9aad15e2c0896040e1078415cb9fd8a;hb=e59e35708b4ad66c99f908c5226cb232931e1791;hpb=6e635ac015d94e1d3c624579984eca9ebd8a4662 diff --git a/po-docs/ja.po b/po-docs/ja.po index ace41fb..1d3a473 100644 --- a/po-docs/ja.po +++ b/po-docs/ja.po @@ -1,33743 +1,39063 @@ -# SOME DESCRIPTIVE TITLE. -# Copyright (C) YEAR Free Software Foundation, Inc. -# FIRST AUTHOR , YEAR. +# SOME DESCRIPTIVE TITLE +# Copyright (C) YEAR Red Hat Inc. +# This file is distributed under the same license as the libguestfs package. # -#, fuzzy +# rjones , 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: 2011-04-12 20:14+0200\n" -"PO-Revision-Date: 2010-09-02 14:46+0100\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" -"Language: \n" +"POT-Creation-Date: 2011-10-05 18:11+0200\n" +"PO-Revision-Date: 2011-07-17 20:50+0000\n" +"Last-Translator: rjones \n" +"Language-Team: Japanese (http://www.transifex.net/projects/p/fedora/team/" +"ja/)\n" +"Language: ja\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=1; plural=0\n" -# type: =head1 #. type: =head1 -#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 -#: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 -#: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 -#: ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 -#: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +#: ../align/virt-alignment-scan.pod:3 ../cat/virt-cat.pod:3 +#: ../cat/virt-filesystems.pod:3 ../cat/virt-ls.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-make-fs.pl:35 ../tools/virt-tar.pl:31 +#: ../tools/virt-win-reg.pl:35 msgid "NAME" msgstr "名前" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:5 -msgid "guestfs - Library for accessing and modifying virtual machine images" +#: ../align/virt-alignment-scan.pod:5 +msgid "virt-alignment-scan - Check alignment of virtual machine partitions" msgstr "" -# type: =head1 #. type: =head1 -#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 -#: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 -#: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 -#: ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 -#: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 +#: ../align/virt-alignment-scan.pod:7 ../cat/virt-cat.pod:7 +#: ../cat/virt-filesystems.pod:7 ../cat/virt-ls.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-make-fs.pl:39 ../tools/virt-tar.pl:35 +#: ../tools/virt-win-reg.pl:39 msgid "SYNOPSIS" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:9 +#: ../align/virt-alignment-scan.pod:9 #, no-wrap msgid "" -" #include \n" -" \n" +" virt-alignment-scan [--options]\n" +"\n" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:11 +#: ../align/virt-alignment-scan.pod:11 #, no-wrap msgid "" -" guestfs_h *g = guestfs_create ();\n" -" guestfs_add_drive (g, \"guest.img\");\n" -" guestfs_launch (g);\n" -" guestfs_mount (g, \"/dev/sda1\", \"/\");\n" -" guestfs_touch (g, \"/hello\");\n" -" guestfs_umount (g, \"/\");\n" -" guestfs_close (g);\n" +" virt-alignment-scan [--options] -d domname\n" "\n" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:19 +#: ../align/virt-alignment-scan.pod:13 #, 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 #. type: =head1 -#: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 -#: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 -#: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 -#: ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 -#: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 +#: ../align/virt-alignment-scan.pod:15 ../cat/virt-cat.pod:19 +#: ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19 ../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-make-fs.pl:47 ../tools/virt-tar.pl:77 +#: ../tools/virt-win-reg.pl:63 msgid "DESCRIPTION" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:25 +#: ../align/virt-alignment-scan.pod:17 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 #. type: textblock -#: ../src/guestfs.pod:33 +#: ../align/virt-alignment-scan.pod:23 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 #. type: textblock -#: ../src/guestfs.pod:38 +#: ../align/virt-alignment-scan.pod:27 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, except to " +"reinstall the operating system. The following NetApp document summarises " +"the problem and possible solutions: L" +msgstr "" + +#. type: =head1 +#: ../align/virt-alignment-scan.pod:32 +msgid "OUTPUT" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:43 +#: ../align/virt-alignment-scan.pod:34 +msgid "To run this tool on a disk image directly, use the I<-a> option:" +msgstr "" + +#. type: verbatim +#: ../align/virt-alignment-scan.pod:36 +#, no-wrap 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." +" $ virt-alignment-scan -a winxp.img\n" +" /dev/sda1 32256 512 bad (alignment < 4K)\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:48 +#. type: verbatim +#: ../align/virt-alignment-scan.pod:39 +#, 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 fedora16.img\n" +" /dev/sda1 1048576 1024K ok\n" +" /dev/sda2 2097152 2048K ok\n" +" /dev/sda3 526385152 2048K ok\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:51 +#: ../align/virt-alignment-scan.pod:44 msgid "" -"Libguestfs is a large API because it can do many things. For a gentle " -"introduction, please read the L section next." +"To run the tool on a guest known to libvirt, use the I<-d> option and " +"possibly the I<-c> option:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:54 +#. type: verbatim +#: ../align/virt-alignment-scan.pod:47 +#, no-wrap msgid "" -"There are also some example programs in the L manual " -"page." +" # 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: =head1 -#. type: =head1 -#: ../src/guestfs.pod:57 -msgid "API OVERVIEW" +#. type: verbatim +#: ../align/virt-alignment-scan.pod:51 +#, 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 #. type: textblock -#: ../src/guestfs.pod:59 +#: ../align/virt-alignment-scan.pod:56 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." +"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: =head2 -#. type: =head2 -#: ../src/guestfs.pod:64 -msgid "HANDLES" +#. type: =item +#: ../align/virt-alignment-scan.pod:62 +msgid "col 1" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:66 +#: ../align/virt-alignment-scan.pod:64 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 for the name of the " -"handle variable, although of course you can use any name you want." +"the device and partition name (eg. C meaning the first partition " +"on the first block device)" +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:67 +msgid "col 2" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:73 -msgid "The general structure of all libguestfs-using programs looks like this:" +#: ../align/virt-alignment-scan.pod:69 +msgid "the start of the partition in bytes" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:76 -#, no-wrap -msgid "" -" guestfs_h *g = guestfs_create ();\n" -" \n" +#. type: =item +#: ../align/virt-alignment-scan.pod:71 +msgid "col 3" msgstr "" -# type: verbatim -#. 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" +#. type: textblock +#: ../align/virt-alignment-scan.pod:73 +msgid "the alignment in bytes or Kbytes (eg. C<512> or C<4K>)" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:83 -#, no-wrap -msgid "" -" /* Most manipulation calls won't work until you've launched\n" -" * the handle 'g'. You have to do this _after_ adding drives\n" -" * and _before_ other commands.\n" -" */\n" -" guestfs_launch (g);\n" -" \n" +#. type: =item +#: ../align/virt-alignment-scan.pod:75 +msgid "col 4" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:89 -#, no-wrap +#. type: textblock +#: ../align/virt-alignment-scan.pod:77 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" +"C if the alignment is best for performance, or C if the alignment " +"can cause performance problems" msgstr "" -# type: verbatim -#. 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" +#. type: =item +#: ../align/virt-alignment-scan.pod:80 +msgid "cols 5+" msgstr "" -#. type: verbatim -#: ../src/guestfs.pod:98 -#, no-wrap +#. type: textblock +#: ../align/virt-alignment-scan.pod:82 +msgid "optional free-text explanation." +msgstr "" + +#. type: textblock +#: ../align/virt-alignment-scan.pod:86 msgid "" -" /* Now you can perform filesystem actions on the guest\n" -" * disk image.\n" -" */\n" -" guestfs_touch (g, \"/hello\");\n" -" \n" +"The exit code from the program changes depending on whether poorly aligned " +"partitions were found. See L below." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:103 -#, no-wrap +#. type: textblock +#: ../align/virt-alignment-scan.pod:89 +msgid "If you just want the exit code with no output, use the I<-q> option." +msgstr "" + +#. type: =head1 +#: ../align/virt-alignment-scan.pod:91 ../cat/virt-cat.pod:62 +#: ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261 ../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:83 ../inspector/virt-inspector.pod:55 +#: ../rescue/virt-rescue.pod:84 ../resize/virt-resize.pod:241 +#: ../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: =item +#: ../align/virt-alignment-scan.pod:95 ../cat/virt-cat.pod:66 +#: ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 +#: ../edit/virt-edit.pod:66 ../fish/guestfish.pod:152 +#: ../fuse/guestmount.pod:151 ../inspector/virt-inspector.pod:59 +#: ../rescue/virt-rescue.pod:88 ../resize/virt-resize.pod:245 +#: ../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 +#: ../align/virt-alignment-scan.pod:97 ../cat/virt-cat.pod:68 +#: ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267 ../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: =item +#: ../align/virt-alignment-scan.pod:99 ../cat/virt-cat.pod:70 +#: ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269 ../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: =item +#: ../align/virt-alignment-scan.pod:101 ../cat/virt-cat.pod:72 +#: ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271 ../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: textblock +#: ../align/virt-alignment-scan.pod:103 +msgid "Add I which should be a disk image from a virtual machine." +msgstr "" + +#. type: textblock +#: ../align/virt-alignment-scan.pod:105 ../cat/virt-cat.pod:78 +#: ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 +#: ../edit/virt-edit.pod:78 ../fish/guestfish.pod:174 +#: ../fuse/guestmount.pod:93 ../inspector/virt-inspector.pod:71 +#: ../rescue/virt-rescue.pod:100 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" +"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 -#. type: verbatim -#: ../src/guestfs.pod:109 -#, no-wrap +#. type: =item +#: ../align/virt-alignment-scan.pod:108 ../cat/virt-cat.pod:81 +#: ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291 ../df/virt-df.pod:78 +#: ../rescue/virt-rescue.pod:107 +msgid "B<-c> URI" +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:110 ../cat/virt-cat.pod:83 +#: ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293 ../df/virt-df.pod:80 +#: ../rescue/virt-rescue.pod:109 +msgid "B<--connect> URI" +msgstr "" + +#. type: textblock +#: ../align/virt-alignment-scan.pod:112 ../cat/virt-cat.pod:85 +#: ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295 ../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 "" -" /* Close the handle 'g'. */\n" -" guestfs_close (g);\n" -"\n" +"If using libvirt, connect to the given I. If omitted, then we connect " +"to the default libvirt hypervisor." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:112 +#: ../align/virt-alignment-scan.pod:115 ../cat/virt-cat.pod:88 +#: ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298 ../df/virt-df.pod:85 +#: ../rescue/virt-rescue.pod:114 msgid "" -"The code above doesn't include any error checking. In real code you should " -"check return values carefully for errors. In general all functions that " -"return integers return C<-1> on error, and all functions that return " -"pointers return C on error. See section L 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 for fully worked examples." +"If you specify guest block devices directly (I<-a>), then libvirt is not " +"used at all." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:121 -msgid "DISK IMAGES" +#. type: =item +#: ../align/virt-alignment-scan.pod:118 ../cat/virt-cat.pod:91 +#: ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307 ../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: =item +#: ../align/virt-alignment-scan.pod:120 ../cat/virt-cat.pod:93 +#: ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309 ../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 #. type: textblock -#: ../src/guestfs.pod:123 +#: ../align/virt-alignment-scan.pod:122 ../cat/virt-cat.pod:95 +#: ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311 ../df/virt-df.pod:98 +#: ../edit/virt-edit.pod:109 ../inspector/virt-inspector.pod:89 +#: ../rescue/virt-rescue.pod:121 msgid "" -"The image filename (C<\"guest.img\"> in the example above) could be a disk " -"image from a virtual machine, a L copy of a physical hard disk, an " -"actual block device, or simply an empty file of zeroes that you have created " -"through L. Libguestfs lets you do useful things to all " -"of these." +"Add all the disks from the named libvirt guest. Domain UUIDs can be used " +"instead of names." +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:125 ../cat/virt-cat.pod:105 +#: ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328 +#: ../df/virt-df.pod:101 ../fish/guestfish.pod:233 ../fuse/guestmount.pod:133 +#: ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:124 +msgid "B<--format=raw|qcow2|..>" +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:127 ../cat/virt-cat.pod:107 +#: ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330 +#: ../df/virt-df.pod:103 ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235 +#: ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:101 +#: ../rescue/virt-rescue.pod:126 +msgid "B<--format>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:129 +#: ../align/virt-alignment-scan.pod:129 ../cat/virt-cat.pod:109 +#: ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332 +#: ../df/virt-df.pod:105 ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237 +#: ../fuse/guestmount.pod:137 ../rescue/virt-rescue.pod:128 msgid "" -"The call you should use in modern code for adding drives is L. To add a disk image, allowing writes, and " -"specifying that the format is raw, do:" +"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 +#: ../align/virt-alignment-scan.pod:134 ../cat/virt-cat.pod:114 +#: ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337 +#: ../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:2791 +msgid "For example:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:133 +#: ../align/virt-alignment-scan.pod:136 #, no-wrap msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n" -" -1);\n" +" virt-alignment-scan --format=raw -a disk.img\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:137 -msgid "You can add a disk read-only using:" +#: ../align/virt-alignment-scan.pod:138 ../cat/virt-cat.pod:118 +#: ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341 +#: ../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." msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:139 +#: ../align/virt-alignment-scan.pod:140 #, no-wrap msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n" -" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" -" -1);\n" +" virt-alignment-scan --format=raw -a disk.img --format -a another.img\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:144 +#: ../align/virt-alignment-scan.pod:142 ../cat/virt-cat.pod:122 +#: ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345 +#: ../df/virt-df.pod:118 ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250 +#: ../rescue/virt-rescue.pod:141 msgid "" -"or by calling the older function L. In either case " -"libguestfs won't modify the file." +"forces raw format (no auto-detection) for C and reverts to auto-" +"detection for C." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:147 +#: ../align/virt-alignment-scan.pod:145 ../cat/virt-cat.pod:125 +#: ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348 +#: ../df/virt-df.pod:121 ../edit/virt-edit.pod:152 +#: ../rescue/virt-rescue.pod:144 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." +"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: =item +#: ../align/virt-alignment-scan.pod:149 ../resize/virt-resize.pod:414 +#: ../sparsify/virt-sparsify.pod:153 +msgid "B<-q>" +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:151 ../resize/virt-resize.pod:416 +#: ../sparsify/virt-sparsify.pod:155 +msgid "B<--quiet>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:151 +#: ../align/virt-alignment-scan.pod:153 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 (for the " -"first one you added), C (for the second one you added), etc." +"Don't produce any output. Just set the exit code (see L " +"below)." +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:156 ../cat/virt-cat.pod:134 +#: ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425 +#: ../df/virt-df.pod:173 ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390 +#: ../fuse/guestmount.pod:257 ../inspector/virt-inspector.pod:119 +#: ../rescue/virt-rescue.pod:182 ../sparsify/virt-sparsify.pod:159 +msgid "B<-v>" +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:158 ../cat/virt-cat.pod:136 +#: ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427 +#: ../df/virt-df.pod:175 ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392 +#: ../fuse/guestmount.pod:259 ../inspector/virt-inspector.pod:121 +#: ../rescue/virt-rescue.pod:184 ../sparsify/virt-sparsify.pod:161 +msgid "B<--verbose>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:156 -msgid "" -"Once L has been called you cannot add any more images. You " -"can call L to get a list of the device names, in the " -"order that you added them. See also L below." +#: ../align/virt-alignment-scan.pod:160 ../cat/virt-cat.pod:138 +#: ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429 +#: ../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 -#. type: =head2 -#: ../src/guestfs.pod:161 -msgid "MOUNTING" +#. type: =item +#: ../align/virt-alignment-scan.pod:162 ../cat/virt-cat.pod:140 +#: ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431 +#: ../df/virt-df.pod:179 ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397 +#: ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pod:125 +#: ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:484 +#: ../sparsify/virt-sparsify.pod:165 +msgid "B<-V>" +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:164 ../cat/virt-cat.pod:142 +#: ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 +#: ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 +#: ../fuse/guestmount.pod:265 ../inspector/virt-inspector.pod:127 +#: ../rescue/virt-rescue.pod:190 ../resize/virt-resize.pod:486 +#: ../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: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 or L. 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:" +#: ../align/virt-alignment-scan.pod:166 ../cat/virt-cat.pod:144 +#: ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435 +#: ../df/virt-df.pod:183 ../edit/virt-edit.pod:171 +#: ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:192 +#: ../resize/virt-resize.pod:488 ../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: verbatim -#: ../src/guestfs.pod:170 -#, no-wrap -msgid "" -" guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n" -"\n" +#. type: =item +#: ../align/virt-alignment-scan.pod:168 ../cat/virt-cat.pod:146 +#: ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 +#: ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 +#: ../fuse/guestmount.pod:278 ../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:172 -msgid "" -"where C means literally the first partition (C<1>) of the first " -"disk image that we added (C). If the disk contains Linux LVM2 " -"logical volumes you could refer to those instead (eg. C). Note " -"that these are libguestfs virtual devices, and are nothing to do with host " -"devices." +#: ../align/virt-alignment-scan.pod:170 ../cat/virt-cat.pod:148 +#: ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439 +#: ../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: =head1 +#: ../align/virt-alignment-scan.pod:174 ../cat/virt-cat.pod:191 +#: ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:483 +#: ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 +#: ../inspector/virt-inspector.pod:352 ../rescue/virt-rescue.pod:266 +#: ../resize/virt-resize.pod:601 ../tools/virt-list-filesystems.pl:188 +#: ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532 +#: ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733 +msgid "SHELL QUOTING" msgstr "" #. type: textblock -#: ../src/guestfs.pod:178 +#: ../align/virt-alignment-scan.pod:176 ../cat/virt-cat.pod:193 +#: ../cat/virt-filesystems.pod:367 ../cat/virt-ls.pod:485 +#: ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 +#: ../inspector/virt-inspector.pod:354 ../rescue/virt-rescue.pod:268 +#: ../resize/virt-resize.pod:603 ../tools/virt-list-filesystems.pl:190 +#: ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534 +#: ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741 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 and L to list possible partitions and " -"LVs, and either try mounting each to see what is mountable, or else examine " -"them with L or L. To list just " -"filesystems, use L." +"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 for details." +msgstr "" + +#. type: =head1 +#: ../align/virt-alignment-scan.pod:181 ../cat/virt-cat.pod:198 +#: ../cat/virt-filesystems.pod:372 ../cat/virt-ls.pod:490 +#: ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1081 +#: ../fuse/guestmount.pod:303 ../inspector/virt-inspector.pod:375 +#: ../resize/virt-resize.pod:608 ../sparsify/virt-sparsify.pod:227 +#: ../test-tool/libguestfs-test-tool.pod:90 +msgid "EXIT STATUS" msgstr "" #. type: textblock -#: ../src/guestfs.pod:186 -msgid "" -"Libguestfs also has a set of APIs for inspection of unknown disk images (see " -"L below). But you might find it easier to look at higher level " -"programs built on top of libguestfs, in particular L." +#: ../align/virt-alignment-scan.pod:183 +msgid "This program returns:" +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:187 +msgid "code 0" msgstr "" #. type: textblock -#: ../src/guestfs.pod:191 +#: ../align/virt-alignment-scan.pod:189 msgid "" -"To mount a filesystem read-only, use L. There are " -"several other variations of the C call." +"successful exit, all partitions are aligned E 64K for best performance" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:194 -msgid "FILESYSTEM ACCESS AND MODIFICATION" +#. type: =item +#: ../align/virt-alignment-scan.pod:191 +msgid "code 1" msgstr "" -# type: textblock #. 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." +#: ../align/virt-alignment-scan.pod:193 +msgid "an error scanning the disk image or guest" +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:195 +msgid "code 2" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:202 +#: ../align/virt-alignment-scan.pod:197 msgid "" -"Specify filenames as full paths, starting with C<\"/\"> and including the " -"mount point." +"successful exit, some partitions have alignment E 64K which can result " +"in poor performance on high end network storage" +msgstr "" + +#. type: =item +#: ../align/virt-alignment-scan.pod:200 +msgid "code 3" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:205 +#: ../align/virt-alignment-scan.pod:202 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:" +"successful exit, some partitions have alignment E 4K which can result in " +"poor performance on most hypervisors" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:208 -#, no-wrap -msgid "" -" char *data = guestfs_cat (g, \"/etc/passwd\");\n" -"\n" +#. type: =head1 +#: ../align/virt-alignment-scan.pod:207 ../cat/virt-cat.pod:203 +#: ../cat/virt-filesystems.pod:377 ../cat/virt-ls.pod:495 +#: ../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:1235 ../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:308 +#: ../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:613 ../ruby/examples/guestfs-ruby.pod:36 +#: ../sparsify/virt-sparsify.pod:251 ../src/guestfs.pod:3179 +#: ../test-tool/libguestfs-test-tool.pod:100 +#: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265 +#: ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296 +#: ../tools/virt-win-reg.pl:746 +msgid "SEE ALSO" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:210 +#: ../align/virt-alignment-scan.pod:209 msgid "" -"This would return C as a newly allocated buffer containing the full " -"content of that file (with some conditions: see also L below), " -"or C if there was an error." +"L, L, L, L." +msgstr "" + +#. type: =head1 +#: ../align/virt-alignment-scan.pod:214 ../cat/virt-cat.pod:212 +#: ../cat/virt-filesystems.pod:388 ../cat/virt-ls.pod:507 +#: ../df/virt-df.pod:235 ../edit/virt-edit.pod:368 +#: ../rescue/virt-rescue.pod:296 ../resize/virt-resize.pod:635 +#: ../sparsify/virt-sparsify.pod:264 ../tools/virt-list-filesystems.pl:208 +#: ../tools/virt-list-partitions.pl:277 ../tools/virt-make-fs.pl:564 +#: ../tools/virt-tar.pl:311 ../tools/virt-win-reg.pl:772 +msgid "AUTHOR" msgstr "" -# type: textblock #. 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:" +#: ../align/virt-alignment-scan.pod:216 ../cat/virt-cat.pod:214 +#: ../cat/virt-filesystems.pod:390 ../cat/virt-ls.pod:509 +#: ../df/virt-df.pod:237 ../edit/virt-edit.pod:370 +#: ../inspector/virt-inspector.pod:395 ../rescue/virt-rescue.pod:298 +#: ../resize/virt-resize.pod:637 ../sparsify/virt-sparsify.pod:266 +#: ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279 +#: ../tools/virt-make-fs.pl:566 ../tools/virt-tar.pl:313 +#: ../tools/virt-win-reg.pl:774 +msgid "Richard W.M. Jones L" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:217 -#, no-wrap -msgid "" -" guestfs_mkdir (g, \"/var\");\n" -"\n" +#. type: =head1 +#: ../align/virt-alignment-scan.pod:218 ../cat/virt-cat.pod:216 +#: ../cat/virt-filesystems.pod:392 ../cat/virt-ls.pod:511 +#: ../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:1266 ../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:323 +#: ../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:639 ../ruby/examples/guestfs-ruby.pod:52 +#: ../sparsify/virt-sparsify.pod:268 ../src/guestfs.pod:3259 +#: ../test-tool/libguestfs-test-tool.pod:110 +#: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281 +#: ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315 +#: ../tools/virt-win-reg.pl:776 +msgid "COPYRIGHT" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:219 -msgid "To create a symlink you could do:" +#: ../align/virt-alignment-scan.pod:220 ../sparsify/virt-sparsify.pod:270 +msgid "Copyright (C) 2011 Red Hat Inc." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:221 -#, no-wrap +#. type: textblock +#: ../align/virt-alignment-scan.pod:222 ../cat/virt-cat.pod:220 +#: ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:515 +#: ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1271 +#: ../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:328 ../inspector/virt-inspector.pod:407 +#: ../rescue/virt-rescue.pod:304 ../resize/virt-resize.pod:643 +#: ../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:572 ../tools/virt-tar.pl:319 +#: ../tools/virt-win-reg.pl:780 msgid "" -" guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" -" \"/etc/rc3.d/S30portmap\");\n" -"\n" +"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: textblock #. type: textblock -#: ../src/guestfs.pod:224 +#: ../align/virt-alignment-scan.pod:227 ../cat/virt-cat.pod:225 +#: ../cat/virt-filesystems.pod:401 ../cat/virt-ls.pod:520 +#: ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1276 +#: ../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:333 ../inspector/virt-inspector.pod:412 +#: ../rescue/virt-rescue.pod:309 ../resize/virt-resize.pod:648 +#: ../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:577 ../tools/virt-tar.pl:324 +#: ../tools/virt-win-reg.pl:785 msgid "" -"Libguestfs will reject attempts to use relative paths and there is no " -"concept of a current working directory." +"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 #. type: textblock -#: ../src/guestfs.pod:227 +#: ../align/virt-alignment-scan.pod:232 ../cat/virt-cat.pod:230 +#: ../cat/virt-filesystems.pod:406 ../cat/virt-ls.pod:525 +#: ../df/virt-df.pod:253 ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1281 +#: ../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:338 ../inspector/virt-inspector.pod:417 +#: ../rescue/virt-rescue.pod:314 ../resize/virt-resize.pod:653 +#: ../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:582 ../tools/virt-tar.pl:329 +#: ../tools/virt-win-reg.pl:790 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)." +"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: textblock #. type: textblock -#: ../src/guestfs.pod:233 -msgid "" -"File writes are affected by the per-handle umask, set by calling L and defaulting to 022. See L." +#: ../cat/virt-cat.pod:5 +msgid "virt-cat - Display files in a virtual machine" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:236 -msgid "PARTITIONING" +#. type: verbatim +#: ../cat/virt-cat.pod:9 +#, no-wrap +msgid "" +" virt-cat [--options] -d domname file [file ...]\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:238 +#. type: verbatim +#: ../cat/virt-cat.pod:11 +#, no-wrap msgid "" -"Libguestfs contains API calls to read, create and modify partition tables on " -"disk images." +" virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n" +"\n" msgstr "" -# type: textblock #. 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 call:" +#: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15 +#: ../inspector/virt-inspector.pod:13 +msgid "Old-style:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:245 +#: ../cat/virt-cat.pod:15 #, 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" +" virt-cat domname file\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:250 +#. type: verbatim +#: ../cat/virt-cat.pod:17 +#, no-wrap msgid "" -"Obviously this effectively wipes anything that was on that disk image before." +" virt-cat disk.img file\n" +"\n" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:253 -msgid "LVM2" +#. type: textblock +#: ../cat/virt-cat.pod:21 +msgid "" +"C is a command line tool to display the contents of C where " +"C exists in the named virtual machine (or disk image)." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:255 +#: ../cat/virt-cat.pod:24 msgid "" -"Libguestfs provides access to a large part of the LVM2 API, such as L and L. It won't make much sense unless " -"you familiarize yourself with the concepts of physical volumes, volume " -"groups and logical volumes." +"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 #. type: textblock -#: ../src/guestfs.pod:260 +#: ../cat/virt-cat.pod:28 msgid "" -"This author strongly recommends reading the LVM HOWTO, online at L." +"C can be used to quickly view a file. To edit a file, use C. For more complex cases you should look at the L tool " +"(see L below)." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:263 -msgid "DOWNLOADING" +#. 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:1018 ../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 -#: ../src/guestfs.pod:265 +#: ../cat/virt-cat.pod:34 msgid "" -"Use L 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." +"Display C file from inside the libvirt VM called C:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:269 +#. type: verbatim +#: ../cat/virt-cat.pod:37 +#, no-wrap msgid "" -"L 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." +" virt-cat -d mydomain /etc/fstab\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:273 -msgid "" -"L can be used to download any file, with no limits on " -"content or size (even files larger than 4 GB)." +#: ../cat/virt-cat.pod:39 +msgid "List syslog messages from a VM disk image file:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:276 +#. type: verbatim +#: ../cat/virt-cat.pod:41 +#, no-wrap msgid "" -"To download multiple files, see L and L." +" virt-cat -a disk.img /var/log/messages | tail\n" +"\n" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:279 -msgid "UPLOADING" +#. type: textblock +#: ../cat/virt-cat.pod:43 +msgid "Find out what DHCP IP address a VM acquired:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:281 +#. type: verbatim +#: ../cat/virt-cat.pod:45 +#, no-wrap msgid "" -"It's often the case that you want to write a file or files to the disk image." +" virt-cat -d mydomain /var/log/messages | \\\n" +" grep 'dhclient: bound to' | tail\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:284 -msgid "" -"To write a small file with fixed content, use L. To create " -"a file of all zeroes, use L (sparse) or L (with all disk blocks allocated). There are a variety " -"of other functions for creating test files, for example L and " -"L." +#: ../cat/virt-cat.pod:48 +msgid "Find out what packages were recently installed:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:290 +#. type: verbatim +#: ../cat/virt-cat.pod:50 +#, no-wrap msgid "" -"To upload a single file, use L. This call has no limits on " -"file content or size (even files larger than 4 GB)." +" virt-cat -d mydomain /var/log/yum.log | tail\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:293 +#: ../cat/virt-cat.pod:52 +msgid "Find out who is logged on inside a virtual machine:" +msgstr "" + +#. type: verbatim +#: ../cat/virt-cat.pod:54 +#, no-wrap msgid "" -"To upload multiple files, see L and L." +" virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n" +" who /tmp/utmp\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:295 -msgid "" -"However the fastest way to upload I is to " -"turn them into a squashfs or CD ISO (see L and L), then attach this using L. 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 and mount it directly " -"using L. 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." +#: ../cat/virt-cat.pod:57 +msgid "or who was logged on:" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:306 -msgid "COPYING" +#. type: verbatim +#: ../cat/virt-cat.pod:59 +#, no-wrap +msgid "" +" virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n" +" last -f /tmp/wtmp\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:308 +#: ../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 "" -"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." +"Add I 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 #. type: =item -#: ../src/guestfs.pod:314 -msgid "B to B" +#: ../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:126 ../inspector/virt-inspector.pod:92 +msgid "B<--echo-keys>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:316 +#: ../cat/virt-cat.pod:100 msgid "" -"Use L to copy a single file, or L to copy " -"directories recursively." +"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: verbatim +#: ../cat/virt-cat.pod:116 +#, no-wrap +msgid "" +" virt-cat --format=raw -a disk.img file\n" +"\n" +msgstr "" + +#. type: verbatim +#: ../cat/virt-cat.pod:120 +#, no-wrap +msgid "" +" virt-cat --format=raw -a disk.img --format -a another.img file\n" +"\n" msgstr "" -# type: =item #. type: =item -#: ../src/guestfs.pod:319 -msgid "B to B" +#: ../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:163 ../inspector/virt-inspector.pod:114 +msgid "B<--keys-from-stdin>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:321 +#: ../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:165 ../inspector/virt-inspector.pod:116 msgid "" -"Use L which efficiently uses L to copy between files and " -"devices in the guest." +"Read key or passphrase parameters from stdin. The default is to try to read " +"passphrases from the user by opening C." +msgstr "" + +#. 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 #. type: textblock -#: ../src/guestfs.pod:324 -msgid "Example: duplicate the contents of an LV:" +#: ../cat/virt-cat.pod:154 +msgid "Previous versions of virt-cat allowed you to write either:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:326 +#: ../cat/virt-cat.pod:156 #, no-wrap msgid "" -" guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" +" virt-cat disk.img [disk.img ...] file\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:328 -msgid "" -"The destination (C) must be at least as large as the source " -"(C). To copy less than the whole source device, use L." +#: ../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: =item -#. type: =item -#: ../src/guestfs.pod:332 -msgid "B to B" +#. type: verbatim +#: ../cat/virt-cat.pod:160 +#, no-wrap +msgid "" +" virt-cat guestname file\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:334 -msgid "Use L. See L above." -msgstr "" - -# type: =item -#. type: =item -#: ../src/guestfs.pod:336 -msgid "B to B" +#: ../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 "" +"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 #. type: textblock -#: ../src/guestfs.pod:338 -msgid "Use L. See L above." +#: ../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: =head2 -#. type: =head2 -#: ../src/guestfs.pod:342 -msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS" +#. type: =head1 +#: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297 +msgid "USING GUESTFISH" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:344 +#: ../cat/virt-cat.pod:170 msgid "" -"Calls like L, L, L, L 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, C, C and C to read and write from stdin, stdout, stderr, " -"and arbitrary file descriptor N." +"L is a more powerful, lower level tool which you can use when " +"C doesn't work." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:352 -msgid "For example, L writes its output to stdout by doing:" +#: ../cat/virt-cat.pod:173 +msgid "Using C is approximately equivalent to doing:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:355 +#: ../cat/virt-cat.pod:175 #, no-wrap msgid "" -" guestfs_download (g, filename, \"/dev/stdout\");\n" +" guestfish --ro -i -d domname download file -\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:357 -msgid "and you can write tar output to a pipe C by doing:" +#: ../cat/virt-cat.pod:177 +msgid "" +"where C is the name of the libvirt guest, and C is the full " +"path to the file. Note the final C<-> (meaning \"output to stdout\")." +msgstr "" + +#. type: textblock +#: ../cat/virt-cat.pod:181 +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 display a file from a disk image " +"directly, use:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:359 +#: ../cat/virt-cat.pod:186 #, no-wrap msgid "" -" char devfd[64];\n" -" snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n" -" guestfs_tar_out (g, \"/\", devfd);\n" +" guestfish --ro -a disk.img -m /dev/sda1 download file -\n" "\n" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:363 -msgid "LISTING FILES" +#. type: textblock +#: ../cat/virt-cat.pod:188 +msgid "" +"where C is the disk image, C is the filesystem within " +"the disk image, and C is the full path to the file." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:365 +#: ../cat/virt-cat.pod:200 ../cat/virt-filesystems.pod:374 +#: ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351 +#: ../fuse/guestmount.pod:305 ../inspector/virt-inspector.pod:377 +#: ../resize/virt-resize.pod:610 ../sparsify/virt-sparsify.pod:229 msgid "" -"L is just designed for humans to read (mainly when using the " -"L-equivalent command C)." +"This program returns 0 if successful, or non-zero if there was an error." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:368 +#: ../cat/virt-cat.pod:205 msgid "" -"L is a quick way to get a list of files in a directory from " -"programs, as a flat list of strings." +"L, L, L, L, L, L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:371 -msgid "" -"L 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 call on a local filesystem." +#: ../cat/virt-cat.pod:218 ../inspector/virt-inspector.pod:405 +#: ../resize/virt-resize.pod:641 +msgid "Copyright (C) 2010-2011 Red Hat Inc." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:375 +#: ../cat/virt-filesystems.pod:5 msgid "" -"L and L can be used to recursively list files." +"virt-filesystems - List filesystems, partitions, block devices, LVM in a " +"virtual machine or disk image" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:378 -msgid "RUNNING COMMANDS" +#. type: verbatim +#: ../cat/virt-filesystems.pod:9 +#, no-wrap +msgid "" +" virt-filesystems [--options] -d domname\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:380 +#. type: verbatim +#: ../cat/virt-filesystems.pod:11 +#, no-wrap msgid "" -"Although libguestfs is primarily an API for manipulating files inside guest " -"images, we also provide some limited facilities for running commands inside " -"guests." +" virt-filesystems [--options] -a disk.img [-a disk.img ...]\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:384 -msgid "There are many limitations to this:" -msgstr "" - -# type: =item -#. type: =item -#: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 -#: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 -#: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1087 -#: ../src/guestfs.pod:1091 ../src/guestfs.pod:1095 ../src/guestfs.pod:1100 -#: ../src/guestfs.pod:1108 ../src/guestfs.pod:1127 ../src/guestfs.pod:1135 -#: ../src/guestfs.pod:1157 ../src/guestfs.pod:1161 ../src/guestfs.pod:1165 -#: ../src/guestfs.pod:1169 ../src/guestfs.pod:1173 ../src/guestfs.pod:1177 -#: ../src/guestfs.pod:1659 ../src/guestfs.pod:1664 ../src/guestfs.pod:1668 -#: ../src/guestfs.pod:1769 ../src/guestfs.pod:1774 ../src/guestfs.pod:1778 -#: ../src/guestfs.pod:1788 ../src/guestfs.pod:2022 ../src/guestfs.pod:2027 -#: ../src/guestfs.pod:2033 ../src/guestfs.pod:2041 ../src/guestfs.pod:2395 -#: ../src/guestfs.pod:2401 ../src/guestfs.pod:2406 ../src/guestfs.pod:2412 -#: ../src/guestfs.pod:2877 ../src/guestfs.pod:2881 ../src/guestfs.pod:2885 -#: ../src/guestfs.pod:2889 ../src/guestfs-actions.pod:15 -#: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:577 -#: ../src/guestfs-actions.pod:585 ../src/guestfs-actions.pod:592 -#: ../src/guestfs-actions.pod:599 ../src/guestfs-actions.pod:1600 -#: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1608 -#: ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1620 -#: ../src/guestfs-actions.pod:1624 ../src/guestfs-actions.pod:1628 -#: ../src/guestfs-actions.pod:1638 ../src/guestfs-actions.pod:1642 -#: ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1784 -#: ../src/guestfs-actions.pod:1788 ../src/guestfs-actions.pod:1793 -#: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1859 -#: ../src/guestfs-actions.pod:1863 ../src/guestfs-actions.pod:1868 -#: ../fish/guestfish.pod:443 ../fish/guestfish.pod:447 -#: ../fish/guestfish.pod:451 ../fish/guestfish.pod:455 -#: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 -#: ../fish/guestfish-actions.pod:380 ../fish/guestfish-actions.pod:388 -#: ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:402 -#: ../fish/guestfish-actions.pod:1072 ../fish/guestfish-actions.pod:1076 -#: ../fish/guestfish-actions.pod:1080 ../fish/guestfish-actions.pod:1084 -#: ../fish/guestfish-actions.pod:1092 ../fish/guestfish-actions.pod:1096 -#: ../fish/guestfish-actions.pod:1100 ../fish/guestfish-actions.pod:1110 -#: ../fish/guestfish-actions.pod:1114 ../fish/guestfish-actions.pod:1118 -#: ../fish/guestfish-actions.pod:1208 ../fish/guestfish-actions.pod:1212 -#: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1222 -#: ../fish/guestfish-actions.pod:1264 ../fish/guestfish-actions.pod:1268 -#: ../fish/guestfish-actions.pod:1273 ../tools/virt-edit.pl:351 -#: ../tools/virt-edit.pl:356 ../tools/virt-edit.pl:361 -#: ../tools/virt-edit.pl:372 ../tools/virt-edit.pl:376 -#: ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 -#: ../tools/virt-win-reg.pl:548 -msgid "*" +#: ../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 and L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:390 +#: ../cat/virt-filesystems.pod:20 msgid "" -"The kernel version that the command runs under will be different from what " -"it expects." +"One use for this tool is from shell scripts to iterate over all filesystems " +"from a disk image:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:395 +#. type: verbatim +#: ../cat/virt-filesystems.pod:23 +#, no-wrap msgid "" -"If the command needs to communicate with daemons, then most likely they " -"won't be running." +" for fs in $(virt-filesystems -a disk.img); do\n" +" # ...\n" +" done\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:400 -msgid "The command will be running in limited memory." +#: ../cat/virt-filesystems.pod:27 +msgid "" +"Another use is to list partitions before using another tool to modify those " +"partitions (such as L). If you are curious about what an " +"unknown disk image contains, use this tool along with L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:404 +#: ../cat/virt-filesystems.pod:32 msgid "" -"The network may not be available unless you enable it (see L)." +"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: textblock -#. type: textblock -#: ../src/guestfs.pod:409 -msgid "Only supports Linux guests (not Windows, BSD, etc)." +#. 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 #. type: textblock -#: ../src/guestfs.pod:413 +#: ../cat/virt-filesystems.pod:41 msgid "" -"Architecture limitations (eg. won't work for a PPC guest on an X86 host)." +"If you add I<-l> or I<--long> then the output includes extra information:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:418 +#. type: verbatim +#: ../cat/virt-filesystems.pod:44 +#, no-wrap msgid "" -"For SELinux guests, you may need to enable SELinux and load policy first. " -"See L in this manpage." +" $ 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: textblock #. type: textblock -#: ../src/guestfs.pod:423 +#: ../cat/virt-filesystems.pod:49 msgid "" -"I 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." +"If you add I<--extra> then non-mountable (swap, unknown) filesystems are " +"shown as well:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:432 +#. type: verbatim +#: ../cat/virt-filesystems.pod:52 +#, no-wrap 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." +" $ 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 #. type: textblock -#: ../src/guestfs.pod:440 +#: ../cat/virt-filesystems.pod:58 msgid "" -"The two main API calls to run commands are L and L (there are also variations)." +"If you add I<--partitions> then partitions are shown instead of filesystems:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:443 +#. type: verbatim +#: ../cat/virt-filesystems.pod:60 +#, no-wrap msgid "" -"The difference is that L runs commands using the shell, so any " -"shell globs, redirections, etc will work." +" $ virt-filesystems -a disk.img --partitions\n" +" /dev/sda1\n" +" /dev/sda2\n" +"\n" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:446 -msgid "CONFIGURATION FILES" +#. type: textblock +#: ../cat/virt-filesystems.pod:64 +msgid "" +"Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-" +"volumes>, I<--block-devices> to list those items." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:448 +#: ../cat/virt-filesystems.pod:67 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." +"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 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: textblock #. type: textblock -#: ../src/guestfs.pod:453 +#: ../cat/virt-filesystems.pod:74 msgid "" -"The main Augeas calls are bound through the C APIs. We don't " -"document Augeas itself here because there is excellent documentation on the " -"L website." +"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 #. type: textblock -#: ../src/guestfs.pod:457 +#: ../cat/virt-filesystems.pod:78 msgid "" -"If you don't want to use Augeas (you fool!) then try calling L to get the file as a list of lines which you can iterate " -"over." +"I<--all --long --uuid> is a useful combination to display all possible " +"information about everything." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:461 -msgid "SELINUX" +#. type: verbatim +#: ../cat/virt-filesystems.pod:81 +#, no-wrap +msgid "" +" $ 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 #. type: textblock -#: ../src/guestfs.pod:463 +#: ../cat/virt-filesystems.pod:89 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:" +"For machine-readable output, use I<--csv> to get Comma-Separated Values." msgstr "" -# type: =item #. type: =item -#: ../src/guestfs.pod:469 ../src/guestfs.pod:1280 ../src/guestfs.pod:1411 -#: ../src/guestfs.pod:2440 -msgid "1." +#: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121 +msgid "B<--all>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:471 -msgid "Before launching, do:" +#: ../cat/virt-filesystems.pod:112 +msgid "" +"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: verbatim -#. type: verbatim -#: ../src/guestfs.pod:473 -#, no-wrap -msgid "" -" guestfs_set_selinux (g, 1);\n" -"\n" +#. type: textblock +#: ../cat/virt-filesystems.pod:117 +msgid "See also I<--long>." msgstr "" -# type: =item #. type: =item -#: ../src/guestfs.pod:475 ../src/guestfs.pod:1284 ../src/guestfs.pod:1415 -#: ../src/guestfs.pod:2465 -msgid "2." +#: ../cat/virt-filesystems.pod:119 +msgid "B<--blkdevs>" +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:121 +msgid "B<--block-devices>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:477 +#: ../cat/virt-filesystems.pod:123 +msgid "Display block devices." +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88 +msgid "B<--csv>" +msgstr "" + +#. type: textblock +#: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90 msgid "" -"After mounting the guest's filesystem(s), load the policy. This is best " -"done by running the L command in the guest itself:" +"Write out the results in CSV format (comma-separated values). This format " +"can be imported easily into databases and spreadsheets, but read L below." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:481 -#, no-wrap +#. type: textblock +#: ../cat/virt-filesystems.pod:150 msgid "" -" guestfs_sh (g, \"/usr/sbin/load_policy\");\n" -"\n" +"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 +#: ../cat/virt-filesystems.pod:155 +msgid "B<--extra>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:483 +#: ../cat/virt-filesystems.pod:157 msgid "" -"(Older versions of C require you to specify the name of the " -"policy file)." +"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: textblock +#: ../cat/virt-filesystems.pod:161 +msgid "This option implies I<--filesystems>." msgstr "" -# type: =item #. type: =item -#: ../src/guestfs.pod:486 ../src/guestfs.pod:1421 -msgid "3." +#: ../cat/virt-filesystems.pod:163 +msgid "B<--filesystems>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:488 +#: ../cat/virt-filesystems.pod:165 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:" +"Display mountable filesystems. If no display option was selected then this " +"option is implied." +msgstr "" + +#. type: textblock +#: ../cat/virt-filesystems.pod:168 +msgid "With I<--extra>, non-mountable filesystems are shown too." msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:492 +#: ../cat/virt-filesystems.pod:181 #, no-wrap msgid "" -" guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" +" virt-filesystems --format=raw -a disk.img\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:496 -msgid "This will work for running commands and editing existing files." +#. type: verbatim +#: ../cat/virt-filesystems.pod:185 +#, no-wrap +msgid "" +" virt-filesystems --format=raw -a disk.img --format -a another.img\n" +"\n" +msgstr "" + +#. 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 +#: ../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 #. type: textblock -#: ../src/guestfs.pod:498 -msgid "" -"When new files are created, you may need to label them explicitly, for " -"example by running the external command C." +#: ../cat/virt-filesystems.pod:198 +msgid "In I<--long> mode, display sizes in human-readable format." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:502 -msgid "UMASK" +#. 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: =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 #. type: textblock -#: ../src/guestfs.pod:504 -msgid "" -"Certain calls are affected by the current file mode creation mask (the " -"\"umask\"). In particular ones which create files or directories, such as " -"L, L or L. This affects " -"either the default mode that the file is created with or modifies the mode " -"that you supply." +#: ../cat/virt-filesystems.pod:209 +msgid "Display extra columns of data (\"long format\")." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:510 +#: ../cat/virt-filesystems.pod:211 +msgid "A title row is added unless you also specify I<--no-title>." +msgstr "" + +#. type: textblock +#: ../cat/virt-filesystems.pod:213 msgid "" -"The default umask is C<022>, so files are created with modes such as C<0644> " -"and directories with C<0755>." +"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 to match columns to data in external " +"programs." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:513 +#: ../cat/virt-filesystems.pod:218 msgid "" -"There are two ways to avoid being affected by umask. Either set umask to 0 " -"(call C early after launching). Or call L after creating each file or directory." +"Use I<-h> if you want sizes to be displayed in human-readable format. The " +"default is to show raw numbers of I." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:517 -msgid "For more information about umask, see L." +#: ../cat/virt-filesystems.pod:221 +msgid "Use I<--uuid> to display UUIDs too." msgstr "" -# type: =head1 -#. type: =head1 -#: ../src/guestfs.pod:519 ../fish/guestfish.pod:765 -msgid "ENCRYPTED DISKS" +#. type: =item +#: ../cat/virt-filesystems.pod:223 +msgid "B<--lvs>" +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:225 +msgid "B<--logvols>" +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:227 +msgid "B<--logical-volumes>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:521 +#: ../cat/virt-filesystems.pod:229 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." +"Display LVM logical volumes. In this mode, these are displayed irrespective " +"of whether the LVs contain filesystems." +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:232 +msgid "B<--no-title>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:527 -msgid "" -"Use L to identify LUKS-encrypted block devices (it " -"returns the string C)." +#: ../cat/virt-filesystems.pod:234 +msgid "In I<--long> mode, don't add a title row." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:530 +#: ../cat/virt-filesystems.pod:236 msgid "" -"Then open these devices by calling L. Obviously you " -"will require the passphrase!" +"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: =item +#: ../cat/virt-filesystems.pod:240 +msgid "B<--parts>" +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:242 +msgid "B<--partitions>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:533 +#: ../cat/virt-filesystems.pod:244 msgid "" -"Opening a LUKS device creates a new device mapper device called C (where C is the string you supply to L). Reads and writes to this mapper device are decrypted " -"from and encrypted to the underlying block device respectively." +"Display partitions. In this mode, these are displayed irrespective of " +"whether the partitions contain filesystems." +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:247 +msgid "B<--pvs>" +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:249 +msgid "B<--physvols>" +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:251 +msgid "B<--physical-volumes>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:539 -msgid "" -"LVM volume groups on the device can be made visible by calling L followed by L. The logical volume" -"(s) can now be mounted in the usual way." +#: ../cat/virt-filesystems.pod:253 +msgid "Display LVM physical volumes." +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163 +msgid "B<--uuid>" +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:257 +msgid "B<--uuids>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:543 -msgid "" -"Use the reverse process to close a LUKS device. Unmount any logical volumes " -"on it, deactivate the volume groups by caling C. Then close the mapper device by calling L on the C device (I the " -"underlying encrypted block device)." +#: ../cat/virt-filesystems.pod:259 +msgid "In I<--long> mode, display UUIDs as well." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:550 -msgid "INSPECTION" +#. type: =item +#: ../cat/virt-filesystems.pod:273 +msgid "B<--vgs>" +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:275 +msgid "B<--volgroups>" +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:277 +msgid "B<--volume-groups>" msgstr "" #. type: textblock -#: ../src/guestfs.pod:552 -msgid "" -"Libguestfs has APIs for inspecting an unknown disk image to find out if it " -"contains operating systems, an install CD or a live CD. (These APIs used to " -"be in a separate Perl-only library called L 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)." +#: ../cat/virt-filesystems.pod:279 +msgid "Display LVM volume groups." +msgstr "" + +#. type: =head1 +#: ../cat/virt-filesystems.pod:287 +msgid "COLUMNS" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:559 +#: ../cat/virt-filesystems.pod:289 msgid "" -"Add all disks belonging to the unknown virtual machine and call L in the usual way." +"Note that columns in the output are subject to reordering and change in " +"future versions of this tool." +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:294 +msgid "B" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:562 -msgid "" -"Then call L. 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.)" +#: ../cat/virt-filesystems.pod:296 +msgid "The filesystem, partition, block device or LVM name." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:571 +#: ../cat/virt-filesystems.pod:298 msgid "" -"For each root, you can then call various C functions " -"to get additional details about that operating system. For example, call L to return the string C or C for " -"Windows and Linux-based operating systems respectively." +"For device and partition names these are displayed as canonical libguestfs " +"names, so that for example C is the second partition on the first " +"device." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:577 +#: ../cat/virt-filesystems.pod:302 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). The inspection rules are able to detect how " -"filesystems correspond to mount points. Call " -"C to get this mapping. It might return a " -"hash table like this example:" +"If the I<--long> option is B specified, then only the name column is " +"shown in the output." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:584 -#, no-wrap -msgid "" -" /boot => /dev/sda1\n" -" / => /dev/vg_guest/lv_root\n" -" /usr => /dev/vg_guest/lv_usr\n" -"\n" +#. type: =item +#: ../cat/virt-filesystems.pod:305 +msgid "B" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:588 -msgid "" -"The caller can then make calls to L to mount the " -"filesystems as suggested." +#: ../cat/virt-filesystems.pod:307 +msgid "The object type, for example C, C, C etc." +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:309 +msgid "B" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:591 +#: ../cat/virt-filesystems.pod:311 msgid "" -"Be careful to mount filesystems in the right order (eg. C before C). Sorting the keys of the hash by length, shortest first, should work." +"If there is a filesystem, then this column displays the filesystem type if " +"one could be detected, eg. C." +msgstr "" + +#. type: =item +#: ../cat/virt-filesystems.pod:314 +msgid "B." +"Myth: Read the file one line at a time. Reality: This does I work " +"reliably. This example has one row:" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:644 +#. type: verbatim +#: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472 +#: ../df/virt-df.pod:204 +#, no-wrap msgid "" -"Drive letter mappings can be found using inspection (see L and " -"L)" +" \"foo\n" +" bar\",baz\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:647 +#: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475 +#: ../df/virt-df.pod:207 msgid "" -"Dealing with separator characters (backslash vs forward slash) is outside " -"the scope of libguestfs, but usually a simple character replacement will " -"work." +"For shell scripts, use C (L also " +"packaged in major Linux distributions)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:651 +#: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478 +#: ../df/virt-df.pod:210 msgid "" -"To resolve the case insensitivity of paths, call L." +"For other languages, use a CSV processing library (eg. C for Perl " +"or Python's built-in csv library)." msgstr "" -# type: =head3 -#. type: =head3 -#: ../src/guestfs.pod:654 -msgid "ACCESSING THE WINDOWS REGISTRY" +#. type: textblock +#: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481 +#: ../df/virt-df.pod:213 +msgid "Most spreadsheets and databases can import CSV directly." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:656 +#: ../cat/virt-filesystems.pod:379 msgid "" -"Libguestfs also provides some help for decoding Windows Registry \"hive\" " -"files, through the library C 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 functions. See also " -"the programs L, L, L and L for more help on this issue." +"L, L, L, L, L, L, L, L." msgstr "" -# type: =head3 -#. type: =head3 -#: ../src/guestfs.pod:664 -msgid "SYMLINKS ON NTFS-3G FILESYSTEMS" +#. type: textblock +#: ../cat/virt-filesystems.pod:394 ../tools/virt-make-fs.pl:570 +#: ../tools/virt-win-reg.pl:778 +msgid "Copyright (C) 2010 Red Hat Inc." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:666 -msgid "" -"Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to " -"provide something which looks like a Linux symlink. The way it tries to do " -"the rewriting is described here:" +#: ../cat/virt-ls.pod:5 +msgid "virt-ls - List files in a virtual machine" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:670 +#. type: verbatim +#: ../cat/virt-ls.pod:9 +#, no-wrap msgid "" -"L" +" virt-ls [--options] -d domname directory [directory ...]\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:672 +#. type: verbatim +#: ../cat/virt-ls.pod:11 +#, no-wrap msgid "" -"The essential problem is that ntfs-3g simply does not have enough " -"information to do a correct job. NTFS links can contain drive letters and " -"references to external device GUIDs that ntfs-3g has no way of resolving. " -"It is almost certainly the case that libguestfs callers should ignore what " -"ntfs-3g does (ie. don't use L on NTFS volumes)." +" virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:679 -msgid "" -"Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L to read the C extended " -"attribute, and read the raw reparse data from that (you can find the format " -"documented in various places around the web)." +#: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13 +msgid "Old style:" msgstr "" -# type: =head3 -#. type: =head3 -#: ../src/guestfs.pod:684 -msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS" +#. type: verbatim +#: ../cat/virt-ls.pod:15 +#, no-wrap +msgid "" +" virt-ls [--options] domname directory\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:686 +#. type: verbatim +#: ../cat/virt-ls.pod:17 +#, no-wrap msgid "" -"There are other useful extended attributes that can be read from ntfs-3g " -"filesystems (using L). See:" +" virt-ls [--options] disk.img [disk.img ...] directory\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:689 +#: ../cat/virt-ls.pod:21 msgid "" -"L" -msgstr "" - -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:691 -msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" +"C lists filenames, file sizes, checksums, extended attributes and " +"more from a virtual machine or disk image." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:693 +#: ../cat/virt-ls.pod:24 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." +"Multiple directory names can be given, in which case the output from each is " +"concatenated." msgstr "" #. type: textblock -#: ../src/guestfs.pod:696 +#: ../cat/virt-ls.pod:27 msgid "" -"The API is broadly identical in all supported languages. This means that " -"the C call C is C<$g-Eadd_drive_ro($file)> " -"in Perl, C in Python, and C in " -"OCaml. In other words, a straightforward, predictable isomorphism between " -"each language." +"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 #. type: textblock -#: ../src/guestfs.pod:702 +#: ../cat/virt-ls.pod:31 msgid "" -"Error messages are automatically transformed into exceptions if the language " -"supports it." +"C can do many simple file listings. For more complicated cases you " +"may need to use L, or write a program directly to the L API." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:705 -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." +#: ../cat/virt-ls.pod:37 +msgid "Get a list of all files and directories in a virtual machine:" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:711 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:39 +#, no-wrap +msgid "" +" virt-ls -R -d guest /\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:713 -msgid "" -"You can use the I header file from C++ programs. The C++ API is " -"identical to the C API. C++ classes and exceptions are not used." +#: ../cat/virt-ls.pod:41 +msgid "List all setuid or setgid programs in a Linux virtual machine:" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:717 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:43 +#, no-wrap +msgid "" +" virt-ls -lR -d guest / | grep '^- [42]'\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:719 -msgid "" -"The C# bindings are highly experimental. Please read the warnings at the " -"top of C." +#: ../cat/virt-ls.pod:45 +msgid "List all public-writable directories in a Linux virtual machine:" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:722 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:47 +#, no-wrap +msgid "" +" virt-ls -lR -d guest / | grep '^d ...7'\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:724 -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." +#: ../cat/virt-ls.pod:49 +msgid "List all Unix domain sockets in a Linux virtual machine:" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:728 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:51 +#, no-wrap +msgid "" +" virt-ls -lR -d guest / | grep '^s'\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:730 -msgid "" -"Full documentation is contained in the Javadoc which is distributed with " -"libguestfs." +#: ../cat/virt-ls.pod:53 +msgid "List all regular files with filenames ending in '.png':" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:733 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:55 +#, no-wrap +msgid "" +" virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:735 -msgid "See L." +#: ../cat/virt-ls.pod:57 +msgid "To display files larger than 10MB in home directories:" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:737 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:59 +#, no-wrap +msgid "" +" virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:739 -msgid "See L and L." +#: ../cat/virt-ls.pod:61 +msgid "Find everything modified in the last 7 days:" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:741 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:63 +#, no-wrap +msgid "" +" virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:743 -msgid "" -"For documentation see C supplied with libguestfs sources or in " -"the php-libguestfs package for your distribution." +#: ../cat/virt-ls.pod:65 +msgid "Find regular files modified in the last 24 hours:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:746 -msgid "The PHP binding only works correctly on 64 bit machines." +#. type: verbatim +#: ../cat/virt-ls.pod:67 +#, no-wrap +msgid "" +" virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n" +"\n" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:748 -msgid "B" +#. type: =head2 +#: ../cat/virt-ls.pod:69 +msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES" msgstr "" #. type: textblock -#: ../src/guestfs.pod:750 -msgid "See L." +#: ../cat/virt-ls.pod:71 +msgid "" +"Find the differences between files in a guest and an earlier snapshot of the " +"same guest." msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:752 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:74 +#, no-wrap +msgid "" +" 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: textblock -#: ../src/guestfs.pod:754 -msgid "See L." +#: ../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 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: =item -#. type: =item -#: ../src/guestfs.pod:756 -msgid "B" +#. type: =head1 +#: ../cat/virt-ls.pod:84 +msgid "OUTPUT MODES" msgstr "" #. type: textblock -#: ../src/guestfs.pod:758 -msgid "See L." +#: ../cat/virt-ls.pod:86 +msgid "" +"C has four output modes, controlled by different combinations of " +"the I<-l> and I<-R> options." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs.pod:762 -msgid "LIBGUESTFS GOTCHAS" +#: ../cat/virt-ls.pod:89 +msgid "SIMPLE LISTING" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:764 -msgid "" -"L: \"A feature of a " -"system [...] that works in the way it is documented but is counterintuitive " -"and almost invites mistakes.\"" +#: ../cat/virt-ls.pod:91 +msgid "A simple listing is like the ordinary L command:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:768 +#. type: verbatim +#: ../cat/virt-ls.pod:93 +#, no-wrap 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." +" $ virt-ls -d guest /\n" +" bin\n" +" boot\n" +" [etc.]\n" +"\n" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:776 -msgid "Autosync / forgetting to sync." +#. type: =head2 +#: ../cat/virt-ls.pod:98 +msgid "LONG LISTING" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:778 +#: ../cat/virt-ls.pod:100 msgid "" -"When modifying a filesystem from C or another language, you B unmount " -"all filesystems and call L explicitly before you close the " -"libguestfs handle. You can also call:" +"With the I<-l> (I<--long>) option, the output is like the C command " +"(more specifically, like the C function)." msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:782 +#: ../cat/virt-ls.pod:103 #, no-wrap msgid "" -" guestfs_set_autosync (g, 1);\n" +" $ 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 #. type: textblock -#: ../src/guestfs.pod:784 +#: ../cat/virt-ls.pod:109 msgid "" -"to have the unmount/sync done automatically for you when the handle 'g' is " -"closed. (This feature is called \"autosync\", L q.v.)" +"Note that while this is useful for displaying a directory, do not try " +"parsing this output in another program. Use L " +"instead." +msgstr "" + +#. type: =head2 +#: ../cat/virt-ls.pod:113 +msgid "RECURSIVE LISTING" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:788 +#: ../cat/virt-ls.pod:115 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." +"With the I<-R> (I<--recursive>) option, C lists the names of files " +"and directories recursively:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:792 +#. type: verbatim +#: ../cat/virt-ls.pod:118 +#, no-wrap msgid "" -"Note that in L 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." +" $ virt-ls -R -d guest /tmp\n" +" foo\n" +" foo/bar\n" +" [etc.]\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:796 +#: ../cat/virt-ls.pod:123 msgid "" -"Update: Autosync is enabled by default for all API users starting from " -"libguestfs 1.5.24." +"To generate this output, C runs the C function and " +"converts C<\\0> characters to C<\\n>." msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:799 -msgid "Mount option C<-o sync> should not be the default." +#. type: =head2 +#: ../cat/virt-ls.pod:126 +msgid "RECURSIVE LONG LISTING" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:801 +#: ../cat/virt-ls.pod:128 msgid "" -"If you use L, 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." +"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 #. type: textblock -#: ../src/guestfs.pod:805 +#: ../cat/virt-ls.pod:132 msgid "" -"The work around is to use L and set the mount " -"options that you actually want to use." +"Most of the interesting features of C are only available when using " +"I<-lR> mode." msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs.pod:808 -msgid "Read-only should be the default." +#. type: textblock +#: ../cat/virt-ls.pod:135 +msgid "" +"The fields are normally space-separated. Filenames are B 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 to analyze the guest, they could play tricks " +"on you by creating filenames with embedded newline characters. To B " +"parse the output in another program, use the I<--csv> (Comma-Separated " +"Values) option." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:810 +#: ../cat/virt-ls.pod:143 msgid "" -"In L, I<--ro> should be the default, and you should have to " -"specify I<--rw> if you want to make changes to the image." +"Note that this output format is completely unrelated to the C " +"command." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:813 -msgid "This would reduce the potential to corrupt live VM images." +#. type: verbatim +#: ../cat/virt-ls.pod:146 +#, no-wrap +msgid "" +" $ 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: textblock #. type: textblock -#: ../src/guestfs.pod:815 -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 to guarantee that the disk is not changed." +#: ../cat/virt-ls.pod:155 +msgid "These basic fields are always shown:" msgstr "" -# type: =item #. type: =item -#: ../src/guestfs.pod:819 -msgid "guestfish command line is hard to use." +#: ../cat/virt-ls.pod:159 +msgid "type" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:821 +#: ../cat/virt-ls.pod:161 msgid "" -"C doesn't do what people expect (open C for " -"examination). It tries to run a guestfish command C 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 to run commands." +"The file type, one of: C<-> (regular file), C (directory), C " +"(character device), C (block device), C

(named pipe), C (symbolic " +"link), C (socket) or C (unknown)." msgstr "" -# type: =item #. type: =item -#: ../src/guestfs.pod:828 -msgid "guestfish megabyte modifiers don't work right on all commands" +#: ../cat/virt-ls.pod:171 +msgid "permissions" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:830 -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)." +#: ../cat/virt-ls.pod:173 +msgid "The Unix permissions, displayed as a 4 digit octal number." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:837 -msgid "The most common is L. The guestfish command:" +#. type: =item +#: ../cat/virt-ls.pod:175 +msgid "size" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:839 -#, no-wrap +#. type: textblock +#: ../cat/virt-ls.pod:177 msgid "" -" lvcreate LV VG 100M\n" -"\n" +"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 -#. type: textblock -#: ../src/guestfs.pod:841 -msgid "" -"does not do what you might expect. Instead because L is " -"already expecting megabytes, this tries to create a 100 I (100 " -"megabytes * megabytes) logical volume. The error message you get from this " -"is also a little obscure." +#. type: =head2 +#: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4245 +msgid "path" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:846 -msgid "" -"This could be fixed in the generator by specially marking parameters and " -"return values which take bytes or other units." +#: ../cat/virt-ls.pod:183 +msgid "The full path of the file or directory." msgstr "" -# type: =item #. type: =item -#: ../src/guestfs.pod:849 -msgid "Ambiguity between devices and paths" +#: ../cat/virt-ls.pod:185 +msgid "link" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:851 -msgid "" -"There is a subtle ambiguity in the API between a device name (eg. C) and a similar pathname. A file might just happen to be called " -"C in the directory C (consider some non-Unix VM image)." +#: ../cat/virt-ls.pod:187 +msgid "For symbolic links only, the link target." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:856 +#: ../cat/virt-ls.pod:191 msgid "" -"In the current API we usually resolve this ambiguity by having two separate " -"calls, for example L and L. " -"Some API calls are ambiguous and (incorrectly) resolve the problem by " -"detecting if the path supplied begins with C." +"In I<-lR> mode, additional command line options enable the display of more " +"fields." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:862 +#: ../cat/virt-ls.pod:194 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), although nobody really likes this " -"aspect of grub. Another way would be to use a structured type, equivalent " -"to this OCaml type:" +"With the I<--uids> flag, these additional fields are displayed before the " +"path:" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:868 -#, no-wrap +#. type: =item +#: ../cat/virt-ls.pod:199 +msgid "uid" +msgstr "" + +#. type: =item +#: ../cat/virt-ls.pod:201 +msgid "gid" +msgstr "" + +#. type: textblock +#: ../cat/virt-ls.pod:203 msgid "" -" type path = Path of string | Device of int | Partition of int * int\n" -"\n" +"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: textblock #. type: textblock -#: ../src/guestfs.pod:870 -msgid "which would allow you to pass arguments like:" +#: ../cat/virt-ls.pod:208 +msgid "With the I<--times> flag, these additional fields are displayed:" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:872 -#, no-wrap -msgid "" -" Path \"/foo/bar\"\n" -" Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n" -" Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n" -" Path \"/dev/sdb2\" (* not a device *)\n" -"\n" +#. type: =item +#: ../cat/virt-ls.pod:212 +msgid "atime" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:877 -msgid "" -"As you can see there are still problems to resolve even with this " -"representation. Also consider how it might work in guestfish." +#: ../cat/virt-ls.pod:214 +msgid "The time of last access." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:882 -msgid "PROTOCOL LIMITS" +#. type: =item +#: ../cat/virt-ls.pod:216 +msgid "mtime" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:884 -msgid "" -"Internally libguestfs uses a message-based protocol to pass API calls and " -"their responses to and from a small \"appliance\" (see L 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." +#: ../cat/virt-ls.pod:218 +msgid "The time of last modification." +msgstr "" + +#. type: =item +#: ../cat/virt-ls.pod:220 +msgid "ctime" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:892 -msgid "" -"A simple call such as L 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." +#: ../cat/virt-ls.pod:222 +msgid "The time of last status change." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:898 +#: ../cat/virt-ls.pod:226 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 " -"and L document how to do this." +"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 #. type: textblock -#: ../src/guestfs.pod:902 -msgid "" -"You might also consider mounting the disk image using our FUSE filesystem " -"support (L)." +#: ../cat/virt-ls.pod:229 +msgid "With the I<--extra-stats> flag, these additional fields are displayed:" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:905 -msgid "KEYS AND PASSPHRASES" +#. type: =item +#: ../cat/virt-ls.pod:233 +msgid "device" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:907 +#: ../cat/virt-ls.pod:235 msgid "" -"Certain libguestfs calls take a parameter that contains sensitive key " -"material, passed in as a C string." +"The device containing the file (displayed as major:minor). This may not " +"match devices as known to the guest." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:910 -msgid "" -"In the future we would hope to change the libguestfs implementation so that " -"keys are L-ed into physical RAM, and thus can never end up in " -"swap. However this is I done at the moment, because of the complexity " -"of such an implementation." +#. type: =item +#: ../cat/virt-ls.pod:238 +msgid "inode" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:915 -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." +#: ../cat/virt-ls.pod:240 +msgid "The inode number." msgstr "" -# type: =head1 -#. type: =head2 -#: ../src/guestfs.pod:920 -msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" +#. type: =item +#: ../cat/virt-ls.pod:242 +msgid "nlink" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:922 -msgid "" -"All high-level libguestfs actions are synchronous. If you want to use " -"libguestfs asynchronously then you must create a thread." +#: ../cat/virt-ls.pod:244 +msgid "The number of hard links." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:925 -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: =item +#: ../cat/virt-ls.pod:246 +msgid "rdev" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:929 +#: ../cat/virt-ls.pod:248 msgid "" -"See the graphical program guestfs-browser for one possible architecture for " -"multithreaded programs using libvirt and libguestfs." +"For block and char special files, the device (displayed as major:minor)." msgstr "" -# type: =head1 -#. type: =head2 -#: ../src/guestfs.pod:932 -msgid "PATH" +#. type: =item +#: ../cat/virt-ls.pod:251 +msgid "blocks" msgstr "" #. type: textblock -#: ../src/guestfs.pod:934 -msgid "" -"Libguestfs needs a supermin appliance, which it finds by looking along an " -"internal path." +#: ../cat/virt-ls.pod:253 +msgid "The number of 512 byte blocks allocated to the file." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:937 +#: ../cat/virt-ls.pod:257 msgid "" -"By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C)." +"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 -#. type: textblock -#: ../src/guestfs.pod:940 -msgid "" -"Use L or set the environment variable L " -"to change the directories that libguestfs will search in. The value is a " -"colon-separated list of paths. The current directory is I searched " -"unless the path contains an empty element or C<.>. For example " -"C would search the current directory and " -"then C." +#. type: =item +#: ../cat/virt-ls.pod:280 +msgid "B<--checksum>" msgstr "" -# type: =head1 -#. type: =head2 -#: ../src/guestfs.pod:947 -msgid "QEMU WRAPPERS" +#. type: =item +#: ../cat/virt-ls.pod:282 +msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:949 +#: ../cat/virt-ls.pod:284 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." +"Display checksum over file contents for regular files. With no argument, " +"this defaults to using I. Using an argument, you can select the " +"checksum type to use." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:953 +#: ../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 "" -"There is one important rule to remember: you I> 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." +"This option only has effect in I<-lR> output mode. See L above." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:958 +#: ../cat/virt-ls.pod:316 msgid "" -"Here is an example of a wrapper, where I have built my own copy of qemu from " -"source:" +"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: verbatim -#. type: verbatim -#: ../src/guestfs.pod:961 -#, 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: =item +#: ../cat/virt-ls.pod:321 +msgid "B<--extra-stats>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:965 -msgid "" -"Save this script as C (or wherever), C, and " -"then use it by setting the LIBGUESTFS_QEMU environment variable. For " -"example:" +#: ../cat/virt-ls.pod:323 +msgid "Display extra stats." msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:969 +#: ../cat/virt-ls.pod:339 #, no-wrap msgid "" -" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" +" virt-ls --format=raw -a disk.img /dir\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:971 +#. type: verbatim +#: ../cat/virt-ls.pod:343 +#, no-wrap msgid "" -"Note that libguestfs also calls qemu with the -help and -version options in " -"order to determine features." -msgstr "" - -#. type: =head2 -#: ../src/guestfs.pod:974 -msgid "ATTACHING TO RUNNING DAEMONS" +" virt-ls --format=raw -a disk.img --format -a another.img /dir\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:976 -msgid "" -"I This is B and has a tendency to eat " -"babies. Use with caution." +#: ../cat/virt-ls.pod:356 +msgid "Display file sizes in human-readable format." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:979 -msgid "" -"I 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 with the I<--live> option will \"just work\"." +#. type: =item +#: ../cat/virt-ls.pod:370 +msgid "B<-R>" msgstr "" -#. type: =head3 -#: ../src/guestfs.pod:983 -msgid "Using guestfs_set_attach_method" +#. type: =item +#: ../cat/virt-ls.pod:372 +msgid "B<--recursive>" msgstr "" #. type: textblock -#: ../src/guestfs.pod:985 +#: ../cat/virt-ls.pod:374 msgid "" -"By calling L you can change how the library " -"connects to the C daemon in L (read L for some background)." +"Select the mode. With neither of these options, C produces a " +"simple, flat list of the files in the named directory. See L." msgstr "" #. type: textblock -#: ../src/guestfs.pod:989 +#: ../cat/virt-ls.pod:378 msgid "" -"The normal attach method is C, where a small appliance is created " -"containing the daemon, and then the library connects to this." +"C produces a \"long listing\", which shows more detail. See L." msgstr "" #. type: textblock -#: ../src/guestfs.pod:992 +#: ../cat/virt-ls.pod:381 msgid "" -"Setting attach method to C> (where I is the path of a " -"Unix domain socket) causes L to connect to an existing " -"daemon over the Unix domain socket." +"C produces a recursive list of files starting at the named " +"directory. See L." msgstr "" #. type: textblock -#: ../src/guestfs.pod:996 +#: ../cat/virt-ls.pod:384 msgid "" -"The normal use for this is to connect to a running virtual machine that " -"contains a C daemon, and send commands so you can read and write " -"files inside the live virtual machine." +"C produces a recursive long listing which can be more easily " +"parsed. See L." msgstr "" -#. type: =head3 -#: ../src/guestfs.pod:1000 -msgid "Using guestfs_add_domain with live flag" +#. type: =item +#: ../cat/virt-ls.pod:387 +msgid "B<--times>" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1002 -msgid "" -"L provides some help for getting the correct attach " -"method. If you pass the C option to this function, then (if the " -"virtual machine is running) it will examine the libvirt XML looking for a " -"virtio-serial channel to connect to:" -msgstr "" - -#. type: verbatim -#: ../src/guestfs.pod:1008 -#, no-wrap -msgid "" -" \n" -" ...\n" -" \n" -" ...\n" -" \n" -" \n" -" \n" -" \n" -" ...\n" -" \n" -" \n" -"\n" +#: ../cat/virt-ls.pod:389 +msgid "Display time fields." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1020 -msgid "" -"L extracts C and sets the attach " -"method to C." +#. type: =item +#: ../cat/virt-ls.pod:394 +msgid "B<--time-days>" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1023 -msgid "" -"Some of the libguestfs tools (including guestfish) support a I<--live> " -"option which is passed through to L thus allowing you " -"to attach to and modify live virtual machines." +#: ../cat/virt-ls.pod:396 +msgid "Display time fields as days before now (negative if in the future)." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1027 +#: ../cat/virt-ls.pod:398 msgid "" -"The virtual machine needs to have been set up beforehand so that it has the " -"virtio-serial channel and so that guestfsd is running inside it." +"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: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1031 -msgid "ABI GUARANTEE" +#. type: =item +#: ../cat/virt-ls.pod:404 +msgid "B<--time-relative>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1033 -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." +#: ../cat/virt-ls.pod:406 +msgid "Display time fields as seconds before now (negative if in the future)." msgstr "" -# type: =head1 -#. type: =head2 -#: ../src/guestfs.pod:1039 -msgid "BLOCK DEVICE NAMING" +#. type: =item +#: ../cat/virt-ls.pod:411 +msgid "B<--time-t>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1041 -msgid "" -"In the kernel there is now quite a profusion of schemata for naming block " -"devices (in this context, by I I mean a physical or virtual " -"hard drive). The original Linux IDE driver used names starting with C. SCSI devices have historically used a different naming scheme, C. When the Linux kernel I driver became a popular replacement " -"for the old IDE driver (particularly for SATA devices) those devices also " -"used the C scheme. Additionally we now have virtual machines with " -"paravirtualized drivers. This has created several different naming systems, " -"such as C for virtio disks and C for Xen PV disks." +#: ../cat/virt-ls.pod:413 +msgid "Display time fields as seconds since the Unix epoch." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1053 -msgid "" -"As discussed above, libguestfs uses a qemu appliance running an embedded " -"Linux kernel to access block devices. We can run a variety of appliances " -"based on a variety of Linux kernels." +#. type: =item +#: ../cat/virt-ls.pod:418 +msgid "B<--uids>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1057 -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." +#: ../cat/virt-ls.pod:420 +msgid "Display UID and GID fields." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1062 -msgid "" -"Therefore libguestfs defines C as the I. " -"Internally C names are translated, if necessary, to other names as " -"required. For example, under RHEL 5 which uses the C scheme, any " -"device parameter C is translated to C transparently." +#: ../cat/virt-ls.pod:445 +msgid "Previous versions of virt-ls allowed you to write either:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1068 +#. type: verbatim +#: ../cat/virt-ls.pod:447 +#, no-wrap msgid "" -"Note that this I applies to parameters. The L, " -"L and similar calls return the true names of the " -"devices and partitions as known to the appliance." -msgstr "" - -# type: =head2 -#. type: =head3 -#: ../src/guestfs.pod:1073 -msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +" virt-ls disk.img [disk.img ...] /dir\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1075 +#. type: verbatim +#: ../cat/virt-ls.pod:451 +#, no-wrap 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 to add a mixture of virtio and IDE devices to the qemu-" -"based appliance, so have a mixture of C and C devices." +" virt-ls guestname /dir\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1081 +#: ../cat/virt-ls.pod:497 msgid "" -"The algorithm is applied only to I which are known to be either " -"device or partition names. Return values from functions such as L are never changed." +"L, L, L, L, L, L, L, L, " +"L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1089 -msgid "Is the string a parameter which is a device or partition name?" +#: ../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 #. type: textblock -#: ../src/guestfs.pod:1093 -msgid "Does the string begin with C?" +#: ../df/virt-df.pod:5 +msgid "virt-df - Display free space on virtual filesystems" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1097 +#. type: verbatim +#: ../df/virt-df.pod:9 +#, no-wrap msgid "" -"Does the named device exist? If so, we use that device. However if I " -"then we continue with this algorithm." +" virt-df [--options]\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1102 -msgid "Replace initial C string with C." +#. type: verbatim +#: ../df/virt-df.pod:11 +#, no-wrap +msgid "" +" virt-df [--options] -d domname\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1104 -msgid "For example, change C to C." +#. type: verbatim +#: ../df/virt-df.pod:13 +#, no-wrap +msgid "" +" virt-df [--options] -a disk.img [-a disk.img ...]\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1106 -msgid "If that named device exists, use it. If not, continue." +#. type: verbatim +#: ../df/virt-df.pod:17 +#, no-wrap +msgid "" +" virt-df [--options] domname\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1110 -msgid "Replace initial C string with C." +#. type: verbatim +#: ../df/virt-df.pod:19 +#, no-wrap +msgid "" +" virt-df [--options] disk.img [disk.img ...]\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1112 -msgid "If that named device exists, use it. If not, return an error." -msgstr "" - -# type: =head3 -#. type: =head3 -#: ../src/guestfs.pod:1116 -msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING" +#: ../df/virt-df.pod:23 +msgid "" +"C 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: textblock #. type: textblock -#: ../src/guestfs.pod:1118 +#: ../df/virt-df.pod:28 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." +"If used without any I<-a> or I<-d> arguments, C checks with libvirt " +"to get a list of all active and inactive guests, and performs a C-type " +"operation on each one in turn, printing out the results." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1122 +#: ../df/virt-df.pod:32 msgid "" -"Where possible for maximum future portability programs using libguestfs " -"should use these future-proof techniques:" +"If any I<-a> or I<-d> arguments are specified, C performs a C-" +"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 will I. If you want to run on multiple guests, then you have to invoke " +"C multiple times." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1129 +#: ../df/virt-df.pod:39 msgid "" -"Use L or L to list actual " -"device names, and then use those names directly." +"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 command." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1132 +#: ../df/virt-df.pod:45 msgid "" -"Since those device names exist by definition, they will never be translated." +"Show disk usage for a single libvirt guest called C. Make the " +"output human-readable:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1137 +#. type: verbatim +#: ../df/virt-df.pod:48 +#, no-wrap msgid "" -"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " -"filesystem labels." +" # 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: =head1 -#. type: =head1 -#: ../src/guestfs.pod:1142 -msgid "SECURITY" +#. type: textblock +#: ../df/virt-df.pod:53 +msgid "Show disk usage for a disk image file called C:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1144 +#. type: verbatim +#: ../df/virt-df.pod:55 +#, no-wrap msgid "" -"This section discusses security implications of using libguestfs, " -"particularly with untrusted or malicious guests or disk images." +" $ 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: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1147 -msgid "GENERAL SECURITY CONSIDERATIONS" +#. type: verbatim +#: ../df/virt-df.pod:112 +#, no-wrap +msgid "" +" virt-df --format=raw -a disk.img\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1149 +#. type: verbatim +#: ../df/virt-df.pod:116 +#, no-wrap msgid "" -"Be careful with any files or data that you download from a guest (by " -"\"download\" we mean not just the L 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:" +" virt-df --format=raw -a disk.img --format -a another.img\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1159 -msgid "the data (file etc) not being present" +#: ../df/virt-df.pod:129 +msgid "Print sizes in human-readable format." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1163 -msgid "being present but empty" +#: ../df/virt-df.pod:131 +msgid "You are not allowed to use I<-h> and I<--csv> at the same time." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1167 -msgid "being much larger than normal" +#. type: =item +#: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155 +msgid "B<-i>" +msgstr "" + +#. type: =item +#: ../df/virt-df.pod:135 +msgid "B<--inodes>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1171 -msgid "containing arbitrary 8 bit data" +#: ../df/virt-df.pod:137 +msgid "Print inodes instead of blocks." +msgstr "" + +#. type: =item +#: ../df/virt-df.pod:139 +msgid "B<--one-per-guest>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1175 -msgid "being in an unexpected character encoding" +#: ../df/virt-df.pod:141 +msgid "" +"Run one libguestfs appliance per guest. Normally C will add the " +"disks from several guests to a single libguestfs appliance." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1179 -msgid "containing homoglyphs." +#: ../df/virt-df.pod:144 +msgid "You might use this option in the following circumstances:" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1183 -msgid "SECURITY OF MOUNTING FILESYSTEMS" +#. type: =item +#: ../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:390 ../fish/guestfish-actions.pod:398 +#: ../fish/guestfish-actions.pod:405 ../fish/guestfish-actions.pod:412 +#: ../fish/guestfish-actions.pod:1139 ../fish/guestfish-actions.pod:1143 +#: ../fish/guestfish-actions.pod:1147 ../fish/guestfish-actions.pod:1151 +#: ../fish/guestfish-actions.pod:1159 ../fish/guestfish-actions.pod:1163 +#: ../fish/guestfish-actions.pod:1167 ../fish/guestfish-actions.pod:1177 +#: ../fish/guestfish-actions.pod:1181 ../fish/guestfish-actions.pod:1185 +#: ../fish/guestfish-actions.pod:1275 ../fish/guestfish-actions.pod:1279 +#: ../fish/guestfish-actions.pod:1284 ../fish/guestfish-actions.pod:1289 +#: ../fish/guestfish-actions.pod:1331 ../fish/guestfish-actions.pod:1335 +#: ../fish/guestfish-actions.pod:1340 ../fish/guestfish-actions.pod:1596 +#: ../fish/guestfish-actions.pod:1603 ../fish/guestfish-actions.pod:1610 +#: ../fish/guestfish-actions.pod:2005 ../fish/guestfish-actions.pod:2011 +#: ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2026 +#: ../fish/guestfish-actions.pod:2033 ../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:282 +#: ../resize/virt-resize.pod:286 ../resize/virt-resize.pod:295 +#: ../resize/virt-resize.pod:301 ../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:588 ../src/guestfs-actions.pod:596 +#: ../src/guestfs-actions.pod:603 ../src/guestfs-actions.pod:610 +#: ../src/guestfs-actions.pod:1778 ../src/guestfs-actions.pod:1782 +#: ../src/guestfs-actions.pod:1786 ../src/guestfs-actions.pod:1790 +#: ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1802 +#: ../src/guestfs-actions.pod:1806 ../src/guestfs-actions.pod:1816 +#: ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1824 +#: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:1966 +#: ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:1976 +#: ../src/guestfs-actions.pod:2037 ../src/guestfs-actions.pod:2041 +#: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2461 +#: ../src/guestfs-actions.pod:2468 ../src/guestfs-actions.pod:2475 +#: ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3018 +#: ../src/guestfs-actions.pod:3026 ../src/guestfs-actions.pod:3033 +#: ../src/guestfs-actions.pod:3040 ../src/guestfs.pod:388 +#: ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 +#: ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 +#: ../src/guestfs.pod:421 ../src/guestfs.pod:1094 ../src/guestfs.pod:1098 +#: ../src/guestfs.pod:1102 ../src/guestfs.pod:1107 ../src/guestfs.pod:1115 +#: ../src/guestfs.pod:1134 ../src/guestfs.pod:1142 ../src/guestfs.pod:1164 +#: ../src/guestfs.pod:1168 ../src/guestfs.pod:1172 ../src/guestfs.pod:1176 +#: ../src/guestfs.pod:1180 ../src/guestfs.pod:1184 ../src/guestfs.pod:1674 +#: ../src/guestfs.pod:1679 ../src/guestfs.pod:1683 ../src/guestfs.pod:1785 +#: ../src/guestfs.pod:1790 ../src/guestfs.pod:1794 ../src/guestfs.pod:1804 +#: ../src/guestfs.pod:2093 ../src/guestfs.pod:2098 ../src/guestfs.pod:2104 +#: ../src/guestfs.pod:2112 ../src/guestfs.pod:2559 ../src/guestfs.pod:2565 +#: ../src/guestfs.pod:2570 ../src/guestfs.pod:2576 ../src/guestfs.pod:2971 +#: ../src/guestfs.pod:2976 ../src/guestfs.pod:2980 ../src/guestfs.pod:2984 +#: ../src/guestfs.pod:2988 ../src/guestfs.pod:3002 ../src/guestfs.pod:3007 +#: ../src/guestfs.pod:3236 ../src/guestfs.pod:3240 ../src/guestfs.pod:3244 +#: ../src/guestfs.pod:3248 ../tools/virt-win-reg.pl:197 +#: ../tools/virt-win-reg.pl:202 ../tools/virt-win-reg.pl:208 +#: ../tools/virt-win-reg.pl:710 ../tools/virt-win-reg.pl:716 +#: ../tools/virt-win-reg.pl:722 +msgid "*" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1185 +#: ../df/virt-df.pod:150 msgid "" -"When you mount a filesystem under Linux, mistakes in the kernel filesystem " -"(VFS) module can sometimes be escalated into exploits by deliberately " -"creating a malicious, malformed filesystem. These exploits are very severe " -"for two reasons. Firstly there are very many filesystem drivers in the " -"kernel, and many of them are infrequently used and not much developer " -"attention has been paid to the code. Linux userspace helps potential " -"crackers by detecting the filesystem type and automatically choosing the " -"right VFS driver, even if that filesystem type is obscure or unexpected for " -"the administrator. Secondly, a kernel-level exploit is like a local root " -"exploit (worse in some ways), giving immediate and total access to the " -"system right down to the hardware level." +"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 #. type: textblock -#: ../src/guestfs.pod:1198 +#: ../df/virt-df.pod:156 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." +"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 #. type: textblock -#: ../src/guestfs.pod:1209 +#: ../df/virt-df.pod:165 msgid "" -"In any case callers can reduce the attack surface by forcing the filesystem " -"type when mounting (use L)." +"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: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1212 -msgid "PROTOCOL SECURITY" +#. 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: textblock #. type: textblock -#: ../src/guestfs.pod:1214 +#: ../df/virt-df.pod:229 msgid "" -"The protocol is designed to be secure, being based on RFC 4506 (XDR) with a " -"defined upper message size. However a program that uses libguestfs must " -"also take care - for example you can write a program that downloads a binary " -"from a disk image and executes it locally, and no amount of protocol " -"security will save you from the consequences." +"L, L, L, L, L." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1220 -msgid "INSPECTION SECURITY" +#. type: textblock +#: ../edit/virt-edit.pod:5 +msgid "virt-edit - Edit a file in a virtual machine" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1222 +#. type: verbatim +#: ../edit/virt-edit.pod:9 +#, no-wrap msgid "" -"Parts of the inspection API (see L) 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)." +" virt-edit [--options] -d domname file [file ...]\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1228 +#. type: verbatim +#: ../edit/virt-edit.pod:11 +#, no-wrap 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 that we find in the " -"guest, but the guest administrator can easily manipulate these files to " -"provide the wrong hostname." +" virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1236 -msgid "" -"The inspection API parses guest configuration using two external libraries: " -"Augeas (Linux configuration) and hivex (Windows Registry). Both are " -"designed to be robust in the face of malicious data, although denial of " -"service attacks are still possible, for example with oversized configuration " -"files." +#. type: verbatim +#: ../edit/virt-edit.pod:13 +#, no-wrap +msgid "" +" virt-edit [-d domname|-a disk.img] file -e 'expr'\n" +"\n" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1242 -msgid "RUNNING UNTRUSTED GUEST COMMANDS" +#. type: verbatim +#: ../edit/virt-edit.pod:17 +#, no-wrap +msgid "" +" virt-edit domname file\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1244 +#. type: verbatim +#: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183 +#, no-wrap 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." +" virt-edit disk.img [disk.img ...] file\n" +"\n" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1250 -msgid "CVE-2010-3851" +#. 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 #. type: textblock -#: ../src/guestfs.pod:1252 -msgid "https://bugzilla.redhat.com/642934" +#: ../edit/virt-edit.pod:23 +msgid "" +"You must I use C on live virtual machines. If you do this, " +"you risk disk corruption in the VM. C tries to stop you from " +"doing this, but doesn't catch all cases." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1254 +#: ../edit/virt-edit.pod:29 msgid "" -"This security bug concerns the automatic disk format detection that qemu " -"does on disk images." +"C is a command line tool to edit C where each C " +"exists in the named virtual machine (or disk image)." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1257 +#: ../edit/virt-edit.pod:32 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." +"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 #. type: textblock -#: ../src/guestfs.pod:1262 -msgid "" -"This allows a guest which has been given a raw disk image to write some " -"other header. At next boot (or when the disk image is accessed by " -"libguestfs) qemu would do autodetection and think the disk image format was, " -"say, qcow2 based on the header written by the guest." +#: ../edit/virt-edit.pod:36 +msgid "If you want to just view a file, use L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1267 +#: ../edit/virt-edit.pod:38 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." +"For more complex cases you should look at the L tool (see L below)." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1275 +#: ../edit/virt-edit.pod:41 msgid "" -"In libguestfs this is rather hard to exploit except under two circumstances:" +"C cannot be used to create a new file. L can do " +"that and much more." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1282 -msgid "You have enabled the network or have opened the disk in write mode." +#: ../edit/virt-edit.pod:46 +msgid "Edit the named files interactively:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1286 +#. type: verbatim +#: ../edit/virt-edit.pod:48 +#, no-wrap msgid "" -"You are also running untrusted code from the guest (see L)." +" virt-edit -d mydomain /boot/grub/grub.conf\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1291 +#. type: verbatim +#: ../edit/virt-edit.pod:50 +#, no-wrap msgid "" -"The way to avoid this is to specify the expected disk format when adding " -"disks (the optional C option to L). You " -"should always do this if the disk is raw format, and it's a good idea for " -"other cases too." +" virt-edit -d mydomain /etc/passwd\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1296 +#: ../edit/virt-edit.pod:52 +msgid "For Windows guests, some Windows paths are understood:" +msgstr "" + +#. type: verbatim +#: ../edit/virt-edit.pod:54 +#, no-wrap msgid "" -"For disks added from libvirt using calls like L, the " -"format is fetched from libvirt and passed through." +" virt-edit -d mywindomain 'c:\\autoexec.bat'\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1299 +#: ../edit/virt-edit.pod:56 msgid "" -"For libguestfs tools, use the I<--format> command line parameter as " -"appropriate." +"If Perl is installed, you can also edit files non-interactively (see L below). To change the init default level to 5:" msgstr "" -# type: =head1 -#. type: =head1 -#: ../src/guestfs.pod:1302 -msgid "CONNECTION MANAGEMENT" +#. 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: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1304 -msgid "guestfs_h *" +#. type: =item +#: ../edit/virt-edit.pod:81 +msgid "B<-b> extension" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1306 -msgid "" -"C is the opaque type representing a connection handle. Create a " -"handle by calling L. Call L to free the " -"handle and release all resources used." +#. type: =item +#: ../edit/virt-edit.pod:83 +msgid "B<--backup> extension" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1310 +#: ../edit/virt-edit.pod:85 msgid "" -"For information on using multiple handles and threads, see the section L below." +"Create a backup of the original file I. The backup " +"has the original filename with C added." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1313 -msgid "guestfs_create" +#. type: textblock +#: ../edit/virt-edit.pod:88 +msgid "" +"Usually the first character of C would be a dot C<.> so you would " +"write:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1315 +#: ../edit/virt-edit.pod:91 #, no-wrap msgid "" -" guestfs_h *guestfs_create (void);\n" +" virt-edit -b .orig [etc]\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1317 -msgid "Create a connection handle." +#: ../edit/virt-edit.pod:93 +msgid "By default, no backup file is made." +msgstr "" + +#. type: =item +#: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 +#: ../fuse/guestmount.pod:96 ../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: =item +#: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 +#: ../fuse/guestmount.pod:98 ../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: textblock #. type: textblock -#: ../src/guestfs.pod:1319 +#: ../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 "" -"You have to call L (or one of the equivalent calls) " -"on the handle at least once." +"If you specify guest block devices directly, then libvirt is not used at all." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1322 +#: ../edit/virt-edit.pod:114 msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." +"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: =item +#: ../edit/virt-edit.pod:119 +msgid "B<-e> EXPR" +msgstr "" + +#. type: =item +#: ../edit/virt-edit.pod:121 +msgid "B<--expr> EXPR" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1325 -msgid "After configuring the handle, you have to call L." +#: ../edit/virt-edit.pod:123 +msgid "" +"Instead of launching the external editor, non-interactively apply the Perl " +"expression C to each line in the file. See L below." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1327 +#: ../edit/virt-edit.pod:127 msgid "" -"You may also want to configure error handling for the handle. See L section below." +"Be careful to properly quote the expression to prevent it from being altered " +"by the shell." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1330 -msgid "guestfs_close" +#. type: textblock +#: ../edit/virt-edit.pod:130 +msgid "Note that this option is only available when Perl 5 is installed." +msgstr "" + +#. type: =item +#: ../edit/virt-edit.pod:132 +msgid "B<--format> raw|qcow2|..." msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1332 +#: ../edit/virt-edit.pod:143 #, no-wrap msgid "" -" void guestfs_close (guestfs_h *g);\n" +" virt-edit --format=raw -a disk.img file\n" +"\n" +msgstr "" + +#. type: verbatim +#: ../edit/virt-edit.pod:147 +#, no-wrap +msgid "" +" virt-edit --format=raw -a disk.img --format -a another.img file\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1334 -msgid "This closes the connection handle and frees up all resources used." +#: ../edit/virt-edit.pod:181 +msgid "Previous versions of virt-edit allowed you to write either:" +msgstr "" + +#. type: verbatim +#: ../edit/virt-edit.pod:187 +#, no-wrap +msgid "" +" virt-edit guestname file\n" +"\n" msgstr "" -# type: =head1 #. type: =head1 -#: ../src/guestfs.pod:1336 -msgid "ERROR HANDLING" +#: ../edit/virt-edit.pod:195 +msgid "NON-INTERACTIVE EDITING" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1338 +#: ../edit/virt-edit.pod:197 msgid "" -"API functions can return errors. For example, almost all functions that " -"return C will return C<-1> to indicate an error." +"C normally calls out to C<$EDITOR> (or vi) so the system " +"administrator can interactively edit the file." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1341 +#: ../edit/virt-edit.pod:200 msgid "" -"Additional information is available for errors: an error message string and " -"optionally an error number (errno) if the thing that failed was a system " -"call." +"There are two ways also to use C from scripts in order to make " +"automated edits to files. (Note that although you I use C " +"like this, it's less error-prone to write scripts directly using the " +"libguestfs API and Augeas for configuration file editing.)" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1345 +#: ../edit/virt-edit.pod:206 msgid "" -"You can get at the additional information about the last error on the handle " -"by calling L, L, and/or by setting " -"up an error handler with L." +"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 in place however it likes." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1350 +#: ../edit/virt-edit.pod:210 msgid "" -"When the handle is created, a default error handler is installed which " -"prints the error message string to C. For small short-running " -"command line programs it is sufficient to do:" +"The second method is to use the I<-e> parameter of C to run a " +"short Perl snippet in the style of L. For example to replace all " +"instances of C with C in a file:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1354 +#: ../edit/virt-edit.pod:214 #, no-wrap msgid "" -" if (guestfs_launch (g) == -1)\n" -" exit (EXIT_FAILURE);\n" +" virt-edit -d domname filename -e 's/foo/bar/'\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1357 +#: ../edit/virt-edit.pod:216 msgid "" -"since the default error handler will ensure that an error message has been " -"printed to C before the program exits." +"The full power of Perl regular expressions can be used (see L). " +"For example to delete root's password you could do:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1360 +#. type: verbatim +#: ../edit/virt-edit.pod:219 +#, no-wrap msgid "" -"For other programs the caller will almost certainly want to install an " -"alternate error handler or do error handling in-line like this:" +" virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n" +"\n" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1363 -#, no-wrap +#. type: textblock +#: ../edit/virt-edit.pod:221 msgid "" -" g = guestfs_create ();\n" -" \n" +"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: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1365 -#, no-wrap +#. type: textblock +#: ../edit/virt-edit.pod:226 msgid "" -" /* This disables the default behaviour of printing errors\n" -" on stderr. */\n" -" guestfs_set_error_handler (g, NULL, NULL);\n" -" \n" +"To delete a line, set C<$_> to the empty string. For example, to delete the " +"C user account from the password file you can do:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1369 +#: ../edit/virt-edit.pod:229 #, no-wrap msgid "" -" if (guestfs_launch (g) == -1) {\n" -" /* Examine the error message and print it etc. */\n" -" char *msg = guestfs_last_error (g);\n" -" int errnum = guestfs_last_errno (g);\n" -" fprintf (stderr, \"%s\\n\", msg);\n" -" /* ... */\n" -" }\n" +" virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1377 +#: ../edit/virt-edit.pod:231 msgid "" -"Out of memory errors are handled differently. The default action is to call " -"L. If this is undesirable, then you can set a handler using L." +"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 #. type: textblock -#: ../src/guestfs.pod:1381 +#: ../edit/virt-edit.pod:237 msgid "" -"L returns C 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 is supposed to be a " -"lightweight operation which can only fail because of insufficient memory (it " -"returns NULL in this case)." +"The variable C<$lineno> contains the current line number. As is " +"traditional, the first line in the file is number C<1>." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1387 -msgid "guestfs_last_error" +#. type: textblock +#: ../edit/virt-edit.pod:240 +msgid "" +"The return value from the expression is ignored, but the expression may call " +"C in order to abort the whole program, leaving the original file " +"untouched." +msgstr "" + +#. type: textblock +#: ../edit/virt-edit.pod:244 +msgid "" +"Remember when matching the end of a line that C<$_> may contain the final C<" +"\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a " +"newline then neither of these. Thus to match or substitute some text at the " +"end of a line, use this regular expression:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1389 +#: ../edit/virt-edit.pod:249 #, no-wrap msgid "" -" const char *guestfs_last_error (guestfs_h *g);\n" +" /some text(\\r?\\n)?$/\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1391 +#: ../edit/virt-edit.pod:251 msgid "" -"This returns the last error message that happened on C. If there has not " -"been an error since the handle was created, then this returns C." +"Alternately, use the perl C function, being careful not to chomp C<" +"$_> itself (since that would remove all newlines from the file):" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1395 +#. type: verbatim +#: ../edit/virt-edit.pod:255 +#, no-wrap msgid "" -"The lifetime of the returned string is until the next error occurs, or L is called." +" my $m = $_; chomp $m; $m =~ /some text$/\n" +"\n" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1398 -msgid "guestfs_last_errno" +#. type: =head1 +#: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858 +msgid "WINDOWS PATHS" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1400 -#, no-wrap +#. type: textblock +#: ../edit/virt-edit.pod:259 msgid "" -" int guestfs_last_errno (guestfs_h *g);\n" -"\n" +"C has a limited ability to understand Windows drive letters and " +"paths (eg. C)." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1402 -msgid "This returns the last error number (errno) that happened on C." +#: ../edit/virt-edit.pod:262 +msgid "If and only if the guest is running Windows then:" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1404 -msgid "If successful, an errno integer not equal to zero is returned." +#: ../edit/virt-edit.pod:268 +msgid "" +"Drive letter prefixes like C are resolved against the Windows Registry " +"to the correct filesystem." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1406 +#: ../edit/virt-edit.pod:273 msgid "" -"If no error, this returns 0. This call can return 0 in three situations:" +"Any backslash (C<\\>) characters in the path are replaced with forward " +"slashes so that libguestfs can process it." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1413 -msgid "There has not been any error on the handle." +#: ../edit/virt-edit.pod:278 +msgid "" +"The path is resolved case insensitively to locate the file that should be " +"edited." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1417 -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." +#: ../edit/virt-edit.pod:283 +msgid "There are some known shortcomings:" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1423 -msgid "" -"There was an error from a failed system call, but for some reason the errno " -"was not captured and returned. This usually indicates a bug in libguestfs." +#: ../edit/virt-edit.pod:289 +msgid "Some NTFS symbolic links may not be followed correctly." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1429 +#: ../edit/virt-edit.pod:293 +msgid "NTFS junction points that cross filesystems are not followed." +msgstr "" + +#. type: textblock +#: ../edit/virt-edit.pod:299 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. In practice this should " -"only happen in very rare circumstances." +"L is a more powerful, lower level tool which you can use when " +"C doesn't work." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1437 -msgid "guestfs_set_error_handler" +#. type: textblock +#: ../edit/virt-edit.pod:302 +msgid "Using C is approximately equivalent to doing:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1439 +#: ../edit/virt-edit.pod:304 #, 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" +" guestfish --rw -i -d domname edit /file\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1446 +#: ../edit/virt-edit.pod:306 msgid "" -"The callback C will be called if there is an error. The parameters " -"passed to the callback are an opaque data pointer and the error message " -"string." +"where C is the name of the libvirt guest, and C is the full " +"path to the file." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1450 +#: ../edit/virt-edit.pod:309 msgid "" -"C is not passed to the callback. To get that the callback must call " -"L." +"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: textblock -#. type: textblock -#: ../src/guestfs.pod:1453 +#. type: verbatim +#: ../edit/virt-edit.pod:314 +#, no-wrap msgid "" -"Note that the message string C is freed as soon as the callback " -"function returns, so if you want to stash it somewhere you must make your " -"own copy." +" guestfish --rw -a disk.img -m /dev/sda1 edit /file\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1457 -msgid "The default handler prints messages on C." +#: ../edit/virt-edit.pod:316 +msgid "" +"where C is the disk image, C is the filesystem within " +"the disk image to edit, and C is the full path to the file." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1459 -msgid "If you set C to C then I handler is called." -msgstr "" - -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1461 -msgid "guestfs_get_error_handler" +#: ../edit/virt-edit.pod:320 +msgid "" +"C cannot create new files. Use the guestfish commands C, " +"C or C instead:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1463 +#: ../edit/virt-edit.pod:323 #, no-wrap msgid "" -" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" -" void **opaque_rtn);\n" +" guestfish --rw -i -d domname touch /newfile\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1466 -msgid "Returns the current error handler callback." -msgstr "" - -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1468 -msgid "guestfs_set_out_of_memory_handler" +#. type: verbatim +#: ../edit/virt-edit.pod:325 +#, no-wrap +msgid "" +" guestfish --rw -i -d domname write /newfile \"new content\"\n" +"\n" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1470 +#: ../edit/virt-edit.pod:327 #, no-wrap msgid "" -" typedef void (*guestfs_abort_cb) (void);\n" -" int guestfs_set_out_of_memory_handler (guestfs_h *g,\n" -" guestfs_abort_cb);\n" +" guestfish --rw -i -d domname upload localfile /newfile\n" "\n" msgstr "" -# type: textblock +#. type: =head1 +#: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086 +#: ../rescue/virt-rescue.pod:261 ../sparsify/virt-sparsify.pod:232 +#: ../src/guestfs.pod:3118 ../test-tool/libguestfs-test-tool.pod:95 +msgid "ENVIRONMENT VARIABLES" +msgstr "" + +#. type: =item +#: ../edit/virt-edit.pod:333 +msgid "C" +msgstr "" + #. type: textblock -#: ../src/guestfs.pod:1474 +#: ../edit/virt-edit.pod:335 msgid "" -"The callback C will be called if there is an out of memory situation. " -"I." +"If set, this string is used as the editor. It may contain arguments, eg. C<" +"\"emacs -nw\">" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1477 -msgid "The default is to call L." +#: ../edit/virt-edit.pod:338 +msgid "If not set, C is used." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1479 +#: ../edit/virt-edit.pod:356 msgid "" -"You cannot set C to C. You can't ignore out of memory situations." +"L, L, L, L, L, L, L, L, " +"L, L, L." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1482 -msgid "guestfs_get_out_of_memory_handler" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:5 +msgid "guestfs-erlang - How to use libguestfs from Erlang" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1484 +#: ../erlang/examples/guestfs-erlang.pod:9 #, no-wrap msgid "" -" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\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 #. type: textblock -#: ../src/guestfs.pod:1486 -msgid "This returns the current out of memory handler." +#: ../erlang/examples/guestfs-erlang.pod:18 +msgid "" +"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." msgstr "" -# type: =head1 -#. type: =head1 -#: ../src/guestfs.pod:1488 -msgid "API CALLS" +#. type: =head2 +#: ../erlang/examples/guestfs-erlang.pod:23 +msgid "OPENING AND CLOSING THE HANDLE" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1490 ../fish/guestfish.pod:1008 -msgid "@ACTIONS@" -msgstr "" - -# type: =head1 -#. type: =head1 -#: ../src/guestfs.pod:1492 -msgid "STRUCTURES" +#: ../erlang/examples/guestfs-erlang.pod:25 +msgid "" +"The Erlang bindings are implemented using an external program called C. This program must be on the current PATH, or else you should " +"specify the full path to the program:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1494 -msgid "@STRUCTS@" +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:29 +#, no-wrap +msgid "" +" {ok, G} = guestfs:create().\n" +"\n" msgstr "" -# type: =head1 -#. type: =head1 -#: ../src/guestfs.pod:1496 -msgid "AVAILABILITY" +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:31 +#, no-wrap +msgid "" +" {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n" +"\n" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1498 -msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:33 +msgid "C is the libguestfs handle which you should pass to other functions." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1500 -msgid "" -"Using L 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." +#: ../erlang/examples/guestfs-erlang.pod:36 +msgid "To close the handle:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1505 -msgid "@AVAILABILITY@" +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:38 +#, no-wrap +msgid "" +" ok = guestfs:close(G).\n" +"\n" msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs.pod:1507 -msgid "GUESTFISH supported COMMAND" +#: ../erlang/examples/guestfs-erlang.pod:40 +msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1509 +#: ../erlang/examples/guestfs-erlang.pod:42 msgid "" -"In L there is a handy interactive command C which " -"prints out the available groups and whether they are supported by this build " -"of libguestfs. Note however that you have to do C first." +"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: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1514 -msgid "SINGLE CALLS AT COMPILE TIME" +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:46 +#, no-wrap +msgid "" +" ok = guestfs:add_drive_opts(G, Disk,\n" +" [{format, \"raw\"}, {readonly, true}]).\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1516 -msgid "" -"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " -"function, such as:" +#: ../erlang/examples/guestfs-erlang.pod:49 +msgid "If the last argument would be an empty list, you can also omit it:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1519 +#: ../erlang/examples/guestfs-erlang.pod:51 #, no-wrap msgid "" -" #define LIBGUESTFS_HAVE_DD 1\n" +" ok = guestfs:add_drive_opts(G, Disk).\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1521 -msgid "if L is available." +#. type: =head2 +#: ../erlang/examples/guestfs-erlang.pod:53 +msgid "RETURN VALUES AND ERRORS" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1523 +#: ../erlang/examples/guestfs-erlang.pod:55 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:" +"On success, most functions return a C term (which could be a list, " +"string, tuple etc.). If there is nothing for the function to return, then " +"the atom C is returned." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1528 -#, no-wrap -msgid "" -" AC_CHECK_LIB([guestfs],[guestfs_create])\n" -" AC_CHECK_FUNCS([guestfs_dd])\n" -"\n" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:59 +msgid "On error, you would see one of the following tuples:" +msgstr "" + +#. type: =item +#: ../erlang/examples/guestfs-erlang.pod:63 +msgid "C<{error, Msg, Errno}>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1531 +#: ../erlang/examples/guestfs-erlang.pod:65 +msgid "This indicates an ordinary error from the function." +msgstr "" + +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:67 msgid "" -"which would result in C being either defined or not defined " -"in your program." +"C is the error message (string) and C is the Unix error " +"(integer)." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1534 -msgid "SINGLE CALLS AT RUN TIME" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:70 +msgid "C can be zero. See L." +msgstr "" + +#. type: =item +#: ../erlang/examples/guestfs-erlang.pod:72 +msgid "C<{unknown, Function}>" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1536 +#: ../erlang/examples/guestfs-erlang.pod:74 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 (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." +"This indicates that the function you called is not known. Generally this " +"means you are mixing C from another version of libguestfs, " +"which you should not do." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1543 -msgid "" -"You can use L 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):" +#: ../erlang/examples/guestfs-erlang.pod:78 +msgid "C is the name of the unknown function." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1547 -#, no-wrap -msgid "" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" \n" +#. type: =item +#: ../erlang/examples/guestfs-erlang.pod:80 +msgid "C<{unknownarg, Arg}>" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1553 -#, no-wrap +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:82 msgid "" -" main ()\n" -" {\n" -" #ifdef LIBGUESTFS_HAVE_DD\n" -" void *dl;\n" -" int has_function;\n" -" \n" +"This indicates that you called a function with optional arguments, with an " +"unknown argument name." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1559 -#, 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" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:85 +msgid "C is the name of the unknown argument." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1568 -#, no-wrap -msgid "" -" if (!has_function)\n" -" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n" -" else {\n" -" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n" -" /* Now it's safe to call\n" -" guestfs_dd (g, \"foo\", \"bar\");\n" -" */\n" -" }\n" -" #else\n" -" printf (\"guestfs_dd function was not found at compile time\\n\");\n" -" #endif\n" -" }\n" -"\n" +#. type: =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 #. type: textblock -#: ../src/guestfs.pod:1581 -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 -#. type: verbatim -#: ../src/guestfs.pod:1586 -#, no-wrap -msgid "" -" Requires: libguestfs >= 1.0.80\n" -"\n" +#: ../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: =head1 #. type: =head1 -#: ../src/guestfs.pod:1588 -msgid "CALLS WITH OPTIONAL ARGUMENTS" +#: ../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 #. type: textblock -#: ../src/guestfs.pod:1590 -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:" +#: ../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: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1595 -#, no-wrap +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:99 msgid "" -" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" -"\n" +"L, L, L, L, L, L, L, " +"L, L. L." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1597 -msgid "" -"Call this with a list of optional arguments, terminated by C<-1>. So to " -"call with no optional arguments specified:" +#. type: =head1 +#: ../erlang/examples/guestfs-erlang.pod:110 +#: ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397 +#: ../fish/guestfish.pod:1262 ../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:319 +#: ../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:3255 +#: ../test-tool/libguestfs-test-tool.pod:106 +msgid "AUTHORS" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1600 -#, no-wrap -msgid "" -" guestfs_add_drive_opts (g, filename, -1);\n" -"\n" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:112 +#: ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399 +#: ../fish/guestfish.pod:1264 ../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:321 +#: ../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:3257 +#: ../test-tool/libguestfs-test-tool.pod:108 +msgid "Richard W.M. Jones (C)" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1602 -msgid "With a single optional argument:" +#: ../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" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1604 -#, 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 "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" -" -1);\n" -"\n" +"The examples in this manual page may be freely copied, modified and " +"distributed without any restrictions." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1608 -msgid "With two:" +#: ../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:3264 +msgid "" +"This library is free software; you can redistribute it and/or modify it " +"under the terms of the GNU Lesser General Public License as published by the " +"Free Software Foundation; either version 2 of the License, or (at your " +"option) any later version." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1610 -#, no-wrap +#. 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:3269 msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" -" GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n" -" -1);\n" -"\n" +"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 #. type: textblock -#: ../src/guestfs.pod:1615 +#: ../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:3274 msgid "" -"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " -"happen!" +"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 -#. type: =head2 -#: ../src/guestfs.pod:1618 -msgid "USING va_list FOR OPTIONAL ARGUMENTS" +#. type: textblock +#: ../examples/guestfs-examples.pod:5 +msgid "guestfs-examples - Examples of using libguestfs from C" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:1620 +#. type: verbatim +#: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9 +#, no-wrap msgid "" -"The second variant has the same name with the suffix C<_va>, which works the " -"same way but takes a C. See the C manual for details. For the " -"example function, this is declared:" +" #include \n" +" \n" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1624 +#: ../examples/guestfs-examples.pod:11 #, no-wrap msgid "" -" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" -" va_list args);\n" +" guestfs_h *g = guestfs_create ();\n" +" guestfs_add_drive_ro (g, \"disk.img\");\n" +" guestfs_launch (g);\n" "\n" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1627 -msgid "CONSTRUCTING OPTIONAL ARGUMENTS" +#. type: verbatim +#: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19 +#, no-wrap +msgid "" +" cc prog.c -o prog -lguestfs\n" +"or:\n" +" cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1629 +#: ../examples/guestfs-examples.pod:21 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:" +"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." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1635 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-examples.pod:35 msgid "" -" struct guestfs_add_drive_opts_argv {\n" -" uint64_t bitmask;\n" -" int readonly;\n" -" const char *format;\n" -" /* ... */\n" -" };\n" -" int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n" -" const struct guestfs_add_drive_opts_argv *optargs);\n" -"\n" +"L, L, L, L, L, L, L, " +"L, L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1644 -msgid "You could call it like this:" +#: ../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" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1646 -#, no-wrap +#. type: =end +#: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12 +msgid "comment" +msgstr "" + +#. type: textblock +#: ../examples/guestfs-recipes.pod:5 msgid "" -" struct guestfs_add_drive_opts_argv optargs = {\n" -" .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n" -" .readonly = 1,\n" -" .format = \"qcow2\"\n" -" };\n" -" \n" +"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: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1653 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:9 msgid "" -" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" -"\n" +"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 #. type: textblock -#: ../src/guestfs.pod:1655 ../src/guestfs-actions.pod:11 -#: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:9 -#: ../fish/guestfish-actions.pod:1260 ../tools/virt-win-reg.pl:532 -msgid "Notes:" +#: ../examples/guestfs-recipes.pod:16 +msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1661 -msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." +#: ../examples/guestfs-recipes.pod:20 +msgid "" +"This page contains recipes for and links to things you can do using " +"libguestfs, L and the virt tools." +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:23 +msgid "Audit a virtual machine for setuid files" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1666 -msgid "You do not need to fill in all fields of the structure." +#: ../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 #. type: textblock -#: ../src/guestfs.pod:1670 +#: ../examples/guestfs-recipes.pod:28 msgid "" -"There must be a one-to-one correspondence between fields of the structure " -"that are filled in, and bits set in the bitmask." +"https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-" +"files/#content" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1675 -msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:30 +msgid "Change the background image in a Windows XP VM" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1677 +#: ../examples/guestfs-recipes.pod:32 msgid "" -"In other languages, optional arguments are expressed in the way that is " -"natural for that language. We refer you to the language-specific " -"documentation for more details on that." +"The links below explain how to use L 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 #. type: textblock -#: ../src/guestfs.pod:1681 -msgid "For guestfish, see L." +#: ../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: =head2 -#. type: =head2 -#: ../src/guestfs.pod:1683 -msgid "SETTING CALLBACKS TO HANDLE EVENTS" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:40 +msgid "Cloning a virtual machine (Linux)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1685 +#: ../examples/guestfs-recipes.pod:42 msgid "" -"B 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, " -"C, " -"C, C and " -"C are no longer documented in this manual " -"page." +"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: textblock -#: ../src/guestfs.pod:1693 +#: ../examples/guestfs-recipes.pod:46 msgid "" -"Handles generate events when certain things happen, such as log messages " -"being generated, progress messages during long-running operations, or the " -"handle being closed. The API calls described below let you register a " -"callback to be called when events happen. You can register multiple " -"callbacks (for the same, different or overlapping sets of events), and " -"individually remove callbacks. If callbacks are not removed, then they " -"remain in force until the handle is closed." +"https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-" +"vm/#content" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1701 +#: ../examples/guestfs-recipes.pod:48 msgid "" -"In the current implementation, events are only generated synchronously: that " -"means that events (and hence callbacks) can only happen while you are in the " -"middle of making another libguestfs call. The callback is called in the " -"same thread." +"Avoid L. Currently what to do about virt-clone is under " +"discussion." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1706 -msgid "" -"Events may contain a payload, usually nothing (void), an array of 64 bit " -"unsigned integers, or a message buffer. Payloads are discussed later on." -msgstr "" - -#. type: =head3 -#: ../src/guestfs.pod:1710 -msgid "CLASSES OF EVENTS" +#: ../examples/guestfs-recipes.pod:51 +msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html" msgstr "" -#. type: =item -#: ../src/guestfs.pod:1714 -msgid "GUESTFS_EVENT_CLOSE (payload type: void)" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:53 +msgid "Cloning a virtual machine (Windows)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1717 +#: ../examples/guestfs-recipes.pod:55 msgid "" -"The callback function will be called while the handle is being closed " -"(synchronously from L)." +"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 #. type: textblock -#: ../src/guestfs.pod:1720 +#: ../examples/guestfs-recipes.pod:60 msgid "" -"Note that libguestfs installs an L 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, 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)." +"https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-" +"list/2011-May/msg00019.html" +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:63 +msgid "Convert a CD-ROM / DVD / ISO to a tarball" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1727 -msgid "" -"If no callback is registered: the handle is closed without any callback " -"being invoked." +#: ../examples/guestfs-recipes.pod:65 +msgid "This converts input C to output C:" msgstr "" -#. type: =item -#: ../src/guestfs.pod:1730 -msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)" +#. type: verbatim +#: ../examples/guestfs-recipes.pod:67 +#, no-wrap +msgid "" +" guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1733 +#: ../examples/guestfs-recipes.pod:69 +msgid "To export just a subdirectory, eg. C, do:" +msgstr "" + +#. type: verbatim +#: ../examples/guestfs-recipes.pod:71 +#, no-wrap msgid "" -"The callback function will be called when the child process quits, either " -"asynchronously or if killed by L. (This " -"corresponds to a transition from any state to the CONFIG state)." +" guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n" +"\n" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1737 ../src/guestfs.pod:1746 -msgid "If no callback is registered: the event is ignored." +#. type: =head1 +#: ../examples/guestfs-recipes.pod:73 +msgid "Create empty disk images" msgstr "" -#. type: =item -#: ../src/guestfs.pod:1739 -msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)" +#. type: textblock +#: ../examples/guestfs-recipes.pod:75 +msgid "" +"You can use the L I<-N> option to create empty disk images. " +"The useful guide below explains the options available." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1742 +#: ../examples/guestfs-recipes.pod:78 msgid "" -"The callback function will be called when the child process becomes ready " -"first time after it has been launched. (This corresponds to a transition " -"from LAUNCHING to the READY state)." +"https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/" +"#content" msgstr "" -#. type: =item -#: ../src/guestfs.pod:1748 -msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:80 +msgid "Dump raw filesystem content from inside a disk image or VM" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1751 +#: ../examples/guestfs-recipes.pod:82 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)." +"You can use the L C 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: textblock -#: ../src/guestfs.pod:1757 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:86 +#, no-wrap msgid "" -"The callback receives in the payload four unsigned 64 bit numbers which are " -"(in order): C, C, C, C." +" guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n" +"\n" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1760 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:88 +#, no-wrap msgid "" -"The units of C are not defined, although for some operations C " -"may relate in some way to the amount of data to be transferred (eg. in bytes " -"or megabytes), and C may be the portion which has been transferred." +" guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1765 -msgid "The only defined and stable parts of the API are:" +#: ../examples/guestfs-recipes.pod:90 +msgid "To list the filesystems in a disk image, use L." +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:92 +msgid "Edit grub configuration in a VM" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1771 -msgid "" -"The callback can display to the user some type of progress bar or indicator " -"which shows the ratio of C:C." +#: ../examples/guestfs-recipes.pod:94 +msgid "You can use this to:" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1776 -msgid "0 E= C E= C" +#: ../examples/guestfs-recipes.pod:100 +msgid "Fix a virtual machine that does not boot." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1780 -msgid "" -"If any progress notification is sent during a call, then a final progress " -"notification is always sent when C = C (I the call " -"fails with an error)." +#: ../examples/guestfs-recipes.pod:104 +msgid "Change which kernel is used to boot the VM." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1784 -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." +#: ../examples/guestfs-recipes.pod:108 +msgid "Change kernel command line options." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1790 +#: ../examples/guestfs-recipes.pod:112 +msgid "Use L to edit the grub configuration:" +msgstr "" + +#. type: verbatim +#: ../examples/guestfs-recipes.pod:114 +#, no-wrap 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)." +" virt-edit -d BrokenGuest /boot/grub/grub.conf\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1795 +#: ../examples/guestfs-recipes.pod:116 msgid "" -"For these calls, zero or more progress messages are generated with " -"C and C, followed by a final message with " -"C." +"or for general tinkering inside an unbootable VM use L like " +"this:" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1799 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:119 +#, no-wrap msgid "" -"As noted above, if the call fails with an error then the final message may " -"not be generated." +" virt-rescue -d BrokenGuest\n" +"\n" +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:121 +msgid "Export any directory from a VM" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1804 +#: ../examples/guestfs-recipes.pod:123 msgid "" -"The callback also receives the procedure number (C) and serial " -"number (C) 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." +"To export C from a VM into a local directory use L:" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1810 -msgid "If no callback is registered: progress messages are discarded." +#. type: verbatim +#: ../examples/guestfs-recipes.pod:126 +#, no-wrap +msgid "" +" virt-copy-out -d Guest /home .\n" +"\n" msgstr "" -#. type: =item -#: ../src/guestfs.pod:1812 -msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)" +#. type: textblock +#: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 +#: ../fish/guestfish-actions.pod:1327 ../fish/guestfish-actions.pod:1592 +#: ../fish/guestfish-actions.pod:2001 ../src/guestfs-actions.pod:18 +#: ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:2457 +#: ../src/guestfs-actions.pod:3008 ../src/guestfs.pod:1670 +#: ../tools/virt-win-reg.pl:706 +msgid "Notes:" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1815 +#: ../examples/guestfs-recipes.pod:134 msgid "" -"The callback function is called whenever a log message is generated by qemu, " -"the appliance kernel, guestfsd (daemon), or utility programs." +"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.pod:1818 -msgid "" -"If the verbose flag (L) is set before launch (L) then additional debug messages are generated." +#: ../examples/guestfs-recipes.pod:139 +msgid "This creates a directory called C under the current directory." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1821 ../src/guestfs.pod:1835 +#: ../examples/guestfs-recipes.pod:143 msgid "" -"If no callback is registered: the messages are discarded unless the verbose " -"flag is set in which case they are sent to stderr. You can override the " -"printing of verbose messages to stderr by setting up a callback." +"If the guest is a Windows guest then you can use drive letters and " +"backslashes, but you must prefix the path with C and quote it to " +"protect it from the shell, like this:" msgstr "" -#. type: =item -#: ../src/guestfs.pod:1826 -msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)" +#. type: verbatim +#: ../examples/guestfs-recipes.pod:147 +#, no-wrap +msgid "" +" virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1829 +#: ../examples/guestfs-recipes.pod:149 +msgid "To get the output as a compressed tarball, do:" +msgstr "" + +#. type: verbatim +#: ../examples/guestfs-recipes.pod:151 +#, no-wrap msgid "" -"The callback function is called whenever a log message is generated by the " -"library part of libguestfs." +" virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1832 +#: ../examples/guestfs-recipes.pod:153 msgid "" -"If the verbose flag (L) is set then additional debug " -"messages are generated." +"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: =item -#: ../src/guestfs.pod:1840 -msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:157 +msgid "Find out which user is using the most space" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1843 +#: ../examples/guestfs-recipes.pod:159 msgid "" -"The callback function is called whenever a trace message is generated. This " -"only applies if the trace flag (L) is set." +"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.pod:1846 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:162 +#, no-wrap 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." +" #!/bin/sh -\n" +" \n" msgstr "" -#. type: =head3 -#: ../src/guestfs.pod:1852 -msgid "guestfs_set_event_callback" +#. type: verbatim +#: ../examples/guestfs-recipes.pod:164 +#, no-wrap +msgid "" +" set -e\n" +" \n" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1854 +#: ../examples/guestfs-recipes.pod:166 #, no-wrap msgid "" -" int guestfs_set_event_callback (guestfs_h *g,\n" -" guestfs_event_callback cb,\n" -" uint64_t event_bitmask,\n" -" int flags,\n" -" void *opaque);\n" -"\n" +" vm=\"$1\"\n" +" dir=/home\n" +" \n" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1860 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:169 +#, no-wrap msgid "" -"This function registers a callback (C) for all event classes in the " -"C." +" eval $(guestfish --ro -d \"$vm\" -i --listen)\n" +" \n" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1863 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:171 +#, no-wrap msgid "" -"For example, to register for all log message events, you could call this " -"function with the bitmask C. " -"To register a single callback for all possible classes of events, use " -"C." +" 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: textblock -#: ../src/guestfs.pod:1869 -msgid "C should always be passed as 0." +#. type: verbatim +#: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941 +#, no-wrap +msgid "" +" guestfish --remote exit\n" +"\n" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1871 -msgid "" -"C is an opaque pointer which is passed to the callback. You can use " -"it for any purpose." +#. type: =head1 +#: ../examples/guestfs-recipes.pod:179 +msgid "Get DHCP address from a VM" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1874 +#: ../examples/guestfs-recipes.pod:181 msgid "" -"The return value is the event handle (an integer) which you can use to " -"delete the callback (see below)." +"The link below explains the many different possible techniques for getting " +"the last assigned DHCP address of a virtual machine." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1877 +#: ../examples/guestfs-recipes.pod:184 msgid "" -"If there is an error, this function returns C<-1>, and sets the error in the " -"handle in the usual way (see L etc.)" +"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.pod:1880 +#: ../examples/guestfs-recipes.pod:186 msgid "" -"Callbacks remain in effect until they are deleted, or until the handle is " -"closed." +"In the libguestfs source examples directory you will find the latest version " +"of the C program." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:1883 -msgid "" -"In the case where multiple callbacks are registered for a particular event " -"class, all of the callbacks are called. The order in which multiple " -"callbacks are called is not defined." +#. type: =head1 +#: ../examples/guestfs-recipes.pod:189 +msgid "Get the operating system product name string" msgstr "" -#. type: =head3 -#: ../src/guestfs.pod:1887 -msgid "guestfs_delete_event_callback" +#. type: textblock +#: ../examples/guestfs-recipes.pod:191 +msgid "Save the following script into a file called C:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1889 +#: ../examples/guestfs-recipes.pod:193 #, no-wrap msgid "" -" void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\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.pod:1891 +#: ../examples/guestfs-recipes.pod:200 +msgid "Make the script executable and run it on a named guest:" +msgstr "" + +#. type: verbatim +#: ../examples/guestfs-recipes.pod:202 +#, no-wrap msgid "" -"Delete a callback that was previously registered. C should be " -"the integer that was returned by a previous call to " -"C on the same handle." +" # product-name.sh RHEL60x64\n" +" Red Hat Enterprise Linux Server release 6.0 (Santiago)\n" +"\n" msgstr "" -#. type: =head3 -#: ../src/guestfs.pod:1895 -msgid "guestfs_event_callback" +#. type: textblock +#: ../examples/guestfs-recipes.pod:205 +msgid "" +"You can also use an XPath query on the L XML using the " +"C command line tool or from your favourite programming language:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1897 +#: ../examples/guestfs-recipes.pod:209 #, 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" +" # virt-inspector RHEL60x64 > xml\n" +" # xpath '//product_name' < xml\n" +" Found 1 nodes:\n" +" -- NODE --\n" +" Red Hat Enterprise Linux Server release 6.0 (Santiago)\n" "\n" msgstr "" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:215 +msgid "Get the default boot kernel for a Linux VM" +msgstr "" + #. type: textblock -#: ../src/guestfs.pod:1906 +#: ../examples/guestfs-recipes.pod:217 msgid "" -"This is the type of the event callback function that you have to provide." +"The link below contains a program to print the default boot kernel for a " +"Linux VM." msgstr "" #. type: textblock -#: ../src/guestfs.pod:1909 +#: ../examples/guestfs-recipes.pod:220 msgid "" -"The basic parameters are: the handle (C), the opaque user pointer " -"(C), the event class (eg. C), the event " -"handle, and C which in the current API you should ignore." +"https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-" +"kernel-for-a-vm/#content" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1913 +#: ../examples/guestfs-recipes.pod:222 msgid "" -"The remaining parameters contain the event payload (if any). Each event may " -"contain a payload, which usually relates to the event class, but for future " -"proofing your code should be written to handle any payload for any event " -"class." +"It uses Augeas, and the technique is generally applicable for many different " +"tasks, such as:" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1918 -msgid "" -"C and C contain a message buffer (if C, then " -"there is no message buffer). Note that this message buffer can contain " -"arbitrary 8 bit data, including NUL bytes." +#: ../examples/guestfs-recipes.pod:229 +msgid "listing the user accounts in the guest" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1922 -msgid "" -"C and C is an array of 64 bit unsigned integers. At the " -"moment this is only used for progress messages." +#: ../examples/guestfs-recipes.pod:233 +msgid "what repositories is it configured to use" msgstr "" -#. type: =head3 -#: ../src/guestfs.pod:1925 -msgid "EXAMPLE: CAPTURING LOG MESSAGES" +#. type: textblock +#: ../examples/guestfs-recipes.pod:237 +msgid "what NTP servers does it connect to" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1927 -msgid "" -"One motivation for the generic event API was to allow GUI programs to " -"capture debug and other messages. In libguestfs E 1.8 these were sent " -"unconditionally to C." +#: ../examples/guestfs-recipes.pod:241 +msgid "what were the boot messages last time it booted" +msgstr "" + +#. type: textblock +#: ../examples/guestfs-recipes.pod:245 +msgid "listing who was logged in recently" +msgstr "" + +#. type: textblock +#: ../examples/guestfs-recipes.pod:249 +msgid "http://augeas.net/" +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:251 +msgid "Install RPMs in a guest" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1931 +#: ../examples/guestfs-recipes.pod:253 msgid "" -"Events associated with log messages are: C, " -"C and C. (Note that error " -"messages are not events; you must capture error messages separately)." +"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.pod:1936 +#: ../examples/guestfs-recipes.pod:259 msgid "" -"Programs have to set up a callback to capture the classes of events of " -"interest:" +"https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content" +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:261 +msgid "List applications installed in a VM" +msgstr "" + +#. type: textblock +#: ../examples/guestfs-recipes.pod:263 +msgid "Save the following to a file C:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1939 +#: ../examples/guestfs-recipes.pod:265 #, no-wrap msgid "" -" int eh =\n" -" guestfs_set_event_callback\n" -" (g, message_callback,\n" -" GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n" -" GUESTFS_EVENT_TRACE,\n" -" 0, NULL) == -1)\n" -" if (eh == -1) {\n" -" // handle error in the usual way\n" -" }\n" +" #!/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.pod:1949 +#: ../examples/guestfs-recipes.pod:272 msgid "" -"The callback can then direct messages to the appropriate place. In this " -"example, messages are directed to syslog:" +"Make the file executable and then you can run it on any named virtual " +"machine:" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:1952 +#: ../examples/guestfs-recipes.pod:275 #, no-wrap msgid "" -" static void\n" -" message_callback (\n" -" guestfs_h *g,\n" -" void *opaque,\n" -" uint64_t event,\n" -" int event_handle,\n" -" int flags,\n" -" const char *buf, size_t buf_len,\n" -" const uint64_t *array, size_t array_len)\n" -" {\n" -" const int priority = LOG_USER|LOG_INFO;\n" -" if (buf_len > 0)\n" -" syslog (priority, \"event 0x%lx: %s\", event, buf);\n" +" # 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: =head1 -#. type: =head1 -#: ../src/guestfs.pod:1967 -msgid "PRIVATE DATA AREA" -msgstr "" - #. type: textblock -#: ../src/guestfs.pod:1969 +#: ../examples/guestfs-recipes.pod:305 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." +"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." +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:309 +msgid "List files and directories in a VM" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1974 -msgid "To attach a named piece of data, use the following call:" +#: ../examples/guestfs-recipes.pod:311 +msgid "This involves using the L C command like this:" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:1976 +#: ../examples/guestfs-recipes.pod:313 #, no-wrap msgid "" -" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +" guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n" "\n" msgstr "" -# type: textblock +#. type: =head1 +#: ../examples/guestfs-recipes.pod:315 +msgid "List services in a Windows VM" +msgstr "" + #. type: textblock -#: ../src/guestfs.pod:1978 +#: ../examples/guestfs-recipes.pod:317 msgid "" -"C is the name to associate with this data, and C is an arbitrary " -"pointer (which can be C). Any previous item with the same name is " -"overwritten." +"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 #. type: textblock -#: ../src/guestfs.pod:1982 +#: ../examples/guestfs-recipes.pod:321 msgid "" -"You can use any C 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." +"https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/" +"#content" +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:323 +msgid "Make a disk image sparse" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:1987 -msgid "To retrieve the pointer, use:" +#: ../examples/guestfs-recipes.pod:325 +msgid "" +"The link below contains some guides for making a disk image sparse (or " +"reintroducing sparseness)." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:1989 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:328 msgid "" -" void *guestfs_get_private (guestfs_h *g, const char *key);\n" -"\n" +"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 #. type: textblock -#: ../src/guestfs.pod:1991 +#: ../examples/guestfs-recipes.pod:332 msgid "" -"This function returns C if either no data is found associated with " -"C, or if the user previously set the C's C pointer to " -"C." +"You can use L to monitor disk usage of your guests over time. " +"The link below contains a guide." +msgstr "" + +#. type: textblock +#: ../examples/guestfs-recipes.pod:335 +msgid "http://virt-tools.org/learning/advanced-virt-df/" +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:337 +msgid "Reading the Windows Event Log from Windows Vista (or later)" msgstr "" #. type: textblock -#: ../src/guestfs.pod:1995 +#: ../examples/guestfs-recipes.pod:339 msgid "" -"Libguestfs does not try to look at or interpret the C pointer in any " -"way. As far as libguestfs is concerned, it need not be a valid pointer at " -"all. In particular, libguestfs does I 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 or must set up a close callback to " -"do it (see L)." +"L 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.pod:2002 -msgid "To walk over all entries, use these two functions:" +#: ../examples/guestfs-recipes.pod:343 +msgid "" +"https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-" +"guestfish/#content" msgstr "" -#. type: verbatim -#: ../src/guestfs.pod:2004 -#, no-wrap +#. type: =head1 +#: ../examples/guestfs-recipes.pod:345 +msgid "Remove root password (Linux)" +msgstr "" + +#. type: textblock +#: ../examples/guestfs-recipes.pod:347 msgid "" -" void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n" -"\n" +"Using the L 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.pod:2006 +#: ../examples/guestfs-recipes.pod:350 #, no-wrap msgid "" -" void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n" +" virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n" "\n" msgstr "" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:352 +msgid "Remove Administrator password (Windows)" +msgstr "" + #. type: textblock -#: ../src/guestfs.pod:2008 +#: ../examples/guestfs-recipes.pod:354 msgid "" -"C 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 is " -"returned if there are no keys stored in the handle." +"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: textblock -#: ../src/guestfs.pod:2014 +#: ../examples/guestfs-recipes.pod:359 msgid "" -"C returns the next key, pointer pair. The return " -"value of this function is also C is there are no further entries to " -"return." +"https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-" +"administrator-password-with-guestfish/" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2018 -msgid "Notes about walking over entries:" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:361 +msgid "Unpack a live CD" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2024 +#: ../examples/guestfs-recipes.pod:363 msgid "" -"You must not call C while walking over the entries." +"Linux live CDs often contain multiple layers of disk images wrapped like a " +"Russian doll. You can use L to look inside these multiple " +"layers, as outlined in the guide below." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2029 +#: ../examples/guestfs-recipes.pod:367 msgid "" -"The handle maintains an internal iterator which is reset when you call " -"C. This internal iterator is invalidated when you " -"call C." +"https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-" +"cd/#content" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2035 -msgid "If you have set the data pointer associated with a key to C, ie:" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:369 +msgid "Uploading and downloading files" msgstr "" -#. type: verbatim -#: ../src/guestfs.pod:2037 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:371 msgid "" -" guestfs_set_private (g, key, NULL);\n" -"\n" +"The link below contains general tips on uploading (copying in) and " +"downloading (copying out) files from VMs." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2039 -msgid "then that C is not returned when walking." +#: ../examples/guestfs-recipes.pod:374 +msgid "" +"https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content" +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:376 +msgid "Use libguestfs tools on VMware ESX guests" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2043 +#: ../examples/guestfs-recipes.pod:378 msgid "" -"C<*key_rtn> is only valid until the next call to C, " -"C or C." +"The link below explains how to use libguestfs, L and the virt " +"tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2049 +#: ../examples/guestfs-recipes.pod:382 msgid "" -"The following example code shows how to print all keys and data pointers " -"that are associated with the handle C:" +"https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-" +"guests/#content" msgstr "" -#. type: verbatim -#: ../src/guestfs.pod:2052 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:386 msgid "" -" const char *key;\n" -" void *data = guestfs_first_private (g, &key);\n" -" while (data != NULL)\n" -" {\n" -" printf (\"key = %s, data = %p\\n\", key, data);\n" -" data = guestfs_next_private (g, &key);\n" -" }\n" -"\n" +"L, L, L, L, L, L, L, L, L, L." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2060 -msgid "" -"More commonly you are only interested in keys that begin with an application-" -"specific prefix C. Modify the loop like so:" +#: ../examples/guestfs-recipes.pod:403 +msgid "Copyright (C) 2009-2011 Red Hat Inc. L" +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1 +msgid "add-cdrom" msgstr "" #. type: verbatim -#: ../src/guestfs.pod:2063 +#: ../fish/guestfish-actions.pod:3 #, 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" +" add-cdrom filename\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2072 -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:" +#: ../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: verbatim -#: ../src/guestfs.pod:2076 -#, no-wrap +#. 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 "" -" 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" +"This call checks for the existence of C. This stops you from " +"specifying other types of drive which are supported by qemu such as C " +"and C URLs. To specify those, use the general L call " +"instead." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2092 +#: ../fish/guestfish-actions.pod:22 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." +"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 instead." msgstr "" -# type: =end -#. type: =end -#: ../src/guestfs.pod:2097 ../src/guestfs.pod:2102 -msgid "html" +#. type: textblock +#: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 +#: ../fish/guestfish-actions.pod:177 +msgid "" +"I In new code, use the L call " +"instead." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2099 +#: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 +#: ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:1026 +#: ../fish/guestfish-actions.pod:1386 ../fish/guestfish-actions.pod:1400 +#: ../fish/guestfish-actions.pod:3157 ../fish/guestfish-actions.pod:3468 +#: ../fish/guestfish-actions.pod:3516 ../fish/guestfish-actions.pod:4429 +#: ../fish/guestfish-actions.pod:4452 ../fish/guestfish-actions.pod:4474 +#: ../fish/guestfish-actions.pod:4512 ../fish/guestfish-actions.pod:5161 +#: ../fish/guestfish-actions.pod:5267 ../src/guestfs-actions.pod:10 +#: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273 +#: ../src/guestfs-actions.pod:1619 ../src/guestfs-actions.pod:2118 +#: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:4771 +#: ../src/guestfs-actions.pod:5293 ../src/guestfs-actions.pod:5393 +#: ../src/guestfs-actions.pod:6675 ../src/guestfs-actions.pod:6719 +#: ../src/guestfs-actions.pod:6753 ../src/guestfs-actions.pod:6816 +#: ../src/guestfs-actions.pod:7748 ../src/guestfs-actions.pod:7857 +#: ../src/guestfs-actions.pod:8040 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: =head1 -#. type: =head1 -#: ../src/guestfs.pod:2104 -msgid "ARCHITECTURE" +#. type: =head2 +#: ../fish/guestfish-actions.pod:35 +msgid "add-domain" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2106 -msgid "" -"Internally, libguestfs is implemented by running an appliance (a special " -"type of small virtual machine) using L. Qemu runs as a child " -"process of the main program." +#. type: =head2 +#: ../fish/guestfish-actions.pod:37 +msgid "domain" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:2110 +#: ../fish/guestfish-actions.pod:39 #, 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" +" add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2130 +#: ../fish/guestfish-actions.pod:41 msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +"This function adds the disk(s) attached to the named libvirt domain C. " +"It works by connecting to libvirt, requesting the domain and domain XML from " +"libvirt, parsing it for disks, and calling L on each one." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2133 +#: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64 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. The library talks to L 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." +"The number of disks added is returned. This operation is atomic: if an " +"error is returned, then no disks are added." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2142 +#: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67 msgid "" -"A common misunderstanding is that the appliance \"is\" the virtual machine. " -"Although the disk image you are attached to might also be used by some " -"virtual machine, libguestfs doesn't know or care about this. (But you will " -"care if both libguestfs's qemu process and your virtual machine are trying " -"to update the disk image at the same time, since these usually results in " -"massive disk corruption)." +"This function does some minimal checks to make sure the libvirt domain is " +"not running (unless C is true). In a future version we will try " +"to acquire the libvirt lock on each disk." msgstr "" -# type: =head1 -#. type: =head1 -#: ../src/guestfs.pod:2149 -msgid "STATE MACHINE" +#. type: textblock +#: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71 +msgid "" +"Disks must be accessible locally. This often means that adding disks from a " +"remote libvirt connection (see L) will fail " +"unless those disks are accessible via the same device path locally too." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2151 -msgid "libguestfs uses a state machine to model the child process:" +#: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76 +msgid "" +"The optional C parameter sets the libvirt URI (see L). 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: verbatim -#. type: verbatim -#: ../src/guestfs.pod:2153 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82 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" +"The optional C flag controls whether this call will try to connect to " +"a running virtual machine C process if it sees a suitable " +"EchannelE element in the libvirt XML definition. The default (if " +"the flag is omitted) is never to try. See L for more information." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2175 +#: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89 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." +"If the C flag is true (default is false) then a UUID I be " +"passed instead of the domain name. The C string is treated as a UUID " +"first and looked up, and if that lookup fails then we treat C as a name " +"as usual." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2180 +#: ../fish/guestfish-actions.pod:76 msgid "" -"The guest may be killed by L, or may die " -"asynchronously at any time (eg. due to some internal error), and that causes " -"the state to transition back to CONFIG." +"The other optional parameters are passed directly through to L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2184 +#: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 +#: ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:784 +#: ../fish/guestfish-actions.pod:805 ../fish/guestfish-actions.pod:2040 +#: ../fish/guestfish-actions.pod:3206 ../fish/guestfish-actions.pod:3369 +#: ../fish/guestfish-actions.pod:3504 msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +"This command has one or more optional arguments. See L." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2187 +#. type: =head2 +#: ../fish/guestfish-actions.pod:81 +msgid "add-drive" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:83 +#, no-wrap msgid "" -"The API offers one call that goes from CONFIG through LAUNCHING to READY. " -"L blocks until the child process is READY to accept " -"commands (or until some failure or timeout). L internally " -"moves the state from CONFIG to LAUNCHING while it is running." +" add-drive filename\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2193 +#: ../fish/guestfish-actions.pod:85 msgid "" -"API actions such as L 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." +"This function is the equivalent of calling L with no " +"optional parameters, so the disk is added writable, with the format being " +"detected automatically." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2199 +#: ../fish/guestfish-actions.pod:89 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." +"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, and specifying the format." msgstr "" -# type: =head1 -#. type: =head1 -#: ../src/guestfs.pod:2203 -msgid "INTERNALS" +#. type: =head2 +#: ../fish/guestfish-actions.pod:96 +msgid "add-drive-opts" msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs.pod:2205 -msgid "COMMUNICATION PROTOCOL" +#: ../fish/guestfish-actions.pod:98 +msgid "add" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2207 +#. type: verbatim +#: ../fish/guestfish-actions.pod:100 +#, no-wrap msgid "" -"Don't rely on using this protocol directly. This section documents how it " -"currently works, but it may change at any time." +" add-drive-opts filename [readonly:..] [format:..] [iface:..]\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2210 +#: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160 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)." +"This function adds a virtual machine disk image C to libguestfs. " +"The first time you call this function, the disk appears as C, the " +"second time as C, and so on." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2214 +#: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165 msgid "" -"The detailed format of structures is in C (note: " -"this file is automatically generated)." +"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: textblock #. type: textblock -#: ../src/guestfs.pod:2217 -msgid "" -"There are two broad cases, ordinary functions that don't have any C " -"and C parameters, which are handled with very simple request/reply " -"messages. Then there are functions that have any C or C " -"parameters, which use the same request and reply messages, but they may also " -"be followed by files sent using a chunked encoding." -msgstr "" - -# type: =head3 -#. type: =head3 -#: ../src/guestfs.pod:2224 -msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +#: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171 +msgid "This call checks that C exists." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2226 -msgid "For ordinary functions, the request message is:" +#: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3168 +#: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4808 +msgid "The optional arguments are:" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:2228 -#, 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__args (encoded as XDR)\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2233 +#: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179 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 bytes (currently 4MB), which means the " -"effective size of any request is limited to somewhere under this size." +"If true then the image is treated as read-only. Writes are still allowed, " +"but they are stored in a temporary snapshot overlay which is discarded at " +"the end. The disk that you add is not modified." +msgstr "" + +#. type: =item +#: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2239 +#: ../fish/guestfish-actions.pod:127 msgid "" -"Note also that many functions don't take any arguments, in which case the " -"C_args> is completely omitted." +"This forces the image format. If you omit this (or use L or L) then the format is automatically detected. Possible formats " +"include C and C." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2242 +#: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189 msgid "" -"The header contains the procedure number (C) which is how the " -"receiver knows what type of args structure to expect, or none at all." +"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: =item +#: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2246 +#: ../fish/guestfish-actions.pod:138 msgid "" -"For functions that take optional arguments, the optional arguments are " -"encoded in the C_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." +"This rarely-used option lets you emulate the behaviour of the deprecated L call (q.v.)" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2254 -msgid "The reply message for ordinary functions is:" +#. type: =head2 +#: ../fish/guestfish-actions.pod:145 +msgid "add-drive-ro" +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:147 +msgid "add-ro" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:2256 +#: ../fish/guestfish-actions.pod:149 #, 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__ret (encoded as XDR)\n" +" add-drive-ro filename\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2261 +#: ../fish/guestfish-actions.pod:151 msgid "" -"As above the C_ret> structure may be completely omitted for " -"functions that return no formal return values." +"This function is the equivalent of calling L with the " +"optional parameter C set to 1, so the disk " +"is added read-only, with the format being detected automatically." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2264 +#. type: =head2 +#: ../fish/guestfish-actions.pod:156 +msgid "add-drive-ro-with-if" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:158 +#, no-wrap msgid "" -"As above the total length of the reply is limited to C." +" add-drive-ro-with-if filename iface\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2267 +#: ../fish/guestfish-actions.pod:160 msgid "" -"In the case of an error, a flag is set in the header, and the reply message " -"is slightly changed:" +"This is the same as L but it allows you to specify the QEMU " +"interface emulation to use at run time." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:170 +msgid "add-drive-with-if" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:2270 +#: ../fish/guestfish-actions.pod:172 #, 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" +" add-drive-with-if filename iface\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2275 +#: ../fish/guestfish-actions.pod:174 msgid "" -"The C structure contains the error message as a " -"string." +"This is the same as L but it allows you to specify the QEMU " +"interface emulation to use at run time." msgstr "" -# type: =head3 -#. type: =head3 -#: ../src/guestfs.pod:2278 -msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +#. type: =head2 +#: ../fish/guestfish-actions.pod:184 +msgid "aug-clear" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:186 +#, no-wrap +msgid "" +" aug-clear augpath\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2280 +#: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290 msgid "" -"A C parameter indicates that we transfer a file I the guest. " -"The normal request message is sent (see above). However this is followed by " -"a sequence of file chunks." +"Set the value associated with C to C. This is the same as the " +"L C command." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:191 +msgid "aug-close" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:2284 +#: ../fish/guestfish-actions.pod:193 #, no-wrap msgid "" -" total length (header + arguments,\n" -" but not including the length word itself,\n" -" and not including the chunks)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs__args (encoded as XDR)\n" -" sequence of chunks for FileIn param #0\n" -" sequence of chunks for FileIn param #1 etc.\n" +" aug-close\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2292 -msgid "The \"sequence of chunks\" is:" +#: ../fish/guestfish-actions.pod:195 +msgid "" +"Close the current Augeas handle and free up any resources used by it. After " +"calling this, you have to call L again before you can use any " +"other Augeas functions." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:200 +msgid "aug-defnode" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:2294 +#: ../fish/guestfish-actions.pod:202 #, no-wrap msgid "" -" length of chunk (not including length word itself)\n" -" struct guestfs_chunk (encoded as XDR)\n" -" length of chunk\n" -" struct guestfs_chunk (encoded as XDR)\n" -" ...\n" -" length of chunk\n" -" struct guestfs_chunk (with data.data_len == 0)\n" +" aug-defnode name expr val\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2302 +#: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319 msgid "" -"The final chunk has the C field set to zero. Additionally a flag " -"is set in the final chunk to indicate either successful completion or early " -"cancellation." +"Defines a variable C whose value is the result of evaluating C." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2306 +#: ../fish/guestfish-actions.pod:207 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)." +"If C evaluates to an empty nodeset, a node is created, equivalent to " +"calling L C, C. C will be the nodeset " +"containing that single node." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2311 +#: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326 msgid "" -"Both the library (sender) I 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 send any reply, and goes back to reading the next request." +"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 -#. type: textblock -#: ../src/guestfs.pod:2317 -msgid "" -"The daemon may also cancel. It does this by writing a special word " -"C 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." +#. type: =head2 +#: ../fish/guestfish-actions.pod:215 +msgid "aug-defvar" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2326 +#. type: verbatim +#: ../fish/guestfish-actions.pod:217 +#, no-wrap 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), so that neither the library nor the daemon need " -"to keep much in memory." +" aug-defvar name expr\n" +"\n" msgstr "" -# type: =head3 -#. type: =head3 -#: ../src/guestfs.pod:2332 -msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +#. type: textblock +#: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343 +msgid "" +"Defines an Augeas variable C whose value is the result of evaluating " +"C. If C is NULL, then C is undefined." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2334 +#: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347 msgid "" -"The protocol for FileOut parameters is exactly the same as for FileIn " -"parameters, but with the roles of daemon and library reversed." +"On success this returns the number of nodes in C, or C<0> if C " +"evaluates to something which is not a nodeset." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:226 +msgid "aug-get" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs.pod:2337 +#: ../fish/guestfish-actions.pod:228 #, 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__ret (encoded as XDR)\n" -" sequence of chunks for FileOut param #0\n" -" sequence of chunks for FileOut param #1 etc.\n" +" aug-get augpath\n" "\n" msgstr "" -# type: =head3 -#. type: =head3 -#: ../src/guestfs.pod:2345 -msgid "INITIAL MESSAGE" -msgstr "" - -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2347 +#: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360 msgid "" -"When the daemon launches it sends an initial word (C) " -"which indicates that the guest and daemon is alive. This is what L waits for." +"Look up the value associated with C. If C matches exactly one " +"node, the C is returned." msgstr "" -# type: =head3 -#. type: =head3 -#: ../src/guestfs.pod:2351 -msgid "PROGRESS NOTIFICATION MESSAGES" +#. type: =head2 +#: ../fish/guestfish-actions.pod:233 +msgid "aug-init" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2353 +#. type: verbatim +#: ../fish/guestfish-actions.pod:235 +#, no-wrap msgid "" -"The daemon may send progress notification messages at any time. These are " -"distinguished by the normal length word being replaced by " -"C, followed by a fixed size progress message." +" aug-init root flags\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2357 +#: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375 msgid "" -"The library turns them into progress callbacks (see L) if there is a callback registered, or discards them " -"if not." +"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 #. type: textblock -#: ../src/guestfs.pod:2361 -msgid "" -"The daemon self-limits the frequency of progress messages it sends (see " -"C). Not all calls generate progress " -"messages." +#: ../fish/guestfish-actions.pod:241 +msgid "You must call this before using any other L commands." msgstr "" -# type: =head1 -#. type: =head1 -#: ../src/guestfs.pod:2365 -msgid "LIBGUESTFS VERSION NUMBERS" +#. type: textblock +#: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382 +msgid "" +"C is the filesystem root. C must not be NULL, use C instead." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2367 +#: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385 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 flags are the same as the flags defined in Eaugeas.hE, the " +"logical I of the following integers:" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs.pod:2372 -#, 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" +#. type: =item +#: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391 +msgid "C = 1" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2383 -msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." +#: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393 +msgid "Keep the original file with a C<.augsave> extension." +msgstr "" + +#. type: =item +#: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395 +msgid "C = 2" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2385 +#: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397 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." +"Save changes into a file with extension C<.augnew>, and do not overwrite " +"original. Overrides C." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2391 -msgid "Our criteria for backporting changes are:" +#. type: =item +#: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400 +msgid "C = 4" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2397 -msgid "" -"Documentation changes which don't affect any code are backported unless the " -"documentation refers to a future feature which is not in stable." +#: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402 +msgid "Typecheck lenses." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2403 +#: ../fish/guestfish-actions.pod:266 msgid "" -"Bug fixes which are not controversial, fix obvious problems, and have been " -"well tested are backported." +"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 environment variable or call L." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2408 -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." +#. type: =item +#: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409 +msgid "C = 8" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs.pod:2414 -msgid "" -"We I 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." +#: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411 +msgid "Do not use standard load path for modules." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs.pod:2420 -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." +#. type: =item +#: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413 +msgid "C = 16" msgstr "" -#. type: =head1 -#: ../src/guestfs.pod:2428 -msgid "EXTENDING LIBGUESTFS" +#. type: textblock +#: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415 +msgid "Make save a no-op, just record what would have been changed." msgstr "" -#. type: =head2 -#: ../src/guestfs.pod:2430 -msgid "ADDING A NEW API ACTION" +#. type: =item +#: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417 +msgid "C = 32" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2432 -msgid "" -"Large amounts of boilerplate code in libguestfs (RPC, bindings, " -"documentation) are generated, and this makes it easy to extend the " -"libguestfs API." +#: ../fish/guestfish-actions.pod:281 +msgid "Do not load the tree in L." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2436 -msgid "To add a new API action there are two changes:" +#: ../fish/guestfish-actions.pod:285 +msgid "To close the handle, you can call L." msgstr "" #. type: textblock -#: ../src/guestfs.pod:2442 -msgid "" -"You need to add a description of the call (name, parameters, return type, " -"tests, documentation) to C." +#: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425 +msgid "To find out more about Augeas, see L." msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2445 -msgid "" -"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 above). L is an example of the " -"former, since the sync is done in the appliance. L is " -"an example of the latter, since a trace flag is maintained in the handle and " -"all tracing is done on the library side." +#. type: =head2 +#: ../fish/guestfish-actions.pod:289 +msgid "aug-insert" msgstr "" -#. type: textblock -#: ../src/guestfs.pod:2453 +#. type: verbatim +#: ../fish/guestfish-actions.pod:291 +#, no-wrap msgid "" -"Most new actions are of the first type, and get added to the " -"C 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." +" aug-insert augpath label true|false\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs.pod:2459 +#: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439 msgid "" -"For library-only actions of the second type, add to the " -"C 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>." +"Create a new sibling C

etc." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1068 -msgid "The function works on at least the following types of files:" +#: ../fish/guestfish-actions.pod:1908 ../src/guestfs-actions.pod:2873 +msgid "" +"For Windows guests, currently only hard drive mappings are returned. " +"Removable disks (eg. DVD-ROMs) are ignored." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1074 -msgid "many types of Un*x and Linux binary" +#: ../fish/guestfish-actions.pod:1911 ../src/guestfs-actions.pod:2876 +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 #. type: textblock -#: ../src/guestfs-actions.pod:1606 ../fish/guestfish-actions.pod:1078 -msgid "many types of Un*x and Linux shared library" +#: ../fish/guestfish-actions.pod:1914 +msgid "" +"Please read L for more details. See also L, L." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1082 -msgid "Windows Win32 and Win64 binaries" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1918 +msgid "inspect-get-filesystems" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1614 ../fish/guestfish-actions.pod:1086 -msgid "Windows Win32 and Win64 DLLs" +#. type: verbatim +#: ../fish/guestfish-actions.pod:1920 +#, no-wrap +msgid "" +" inspect-get-filesystems root\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1616 ../fish/guestfish-actions.pod:1088 -msgid "Win32 binaries and DLLs return C." +#: ../fish/guestfish-actions.pod:1922 ../src/guestfs-actions.pod:2897 +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." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1090 -msgid "Win64 binaries and DLLs return C." +#: ../fish/guestfish-actions.pod:1927 ../src/guestfs-actions.pod:2902 +msgid "" +"In the case of a multi-boot virtual machine, it is possible for a filesystem " +"to be shared between operating systems." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1622 ../fish/guestfish-actions.pod:1094 -msgid "Linux kernel modules" +#: ../fish/guestfish-actions.pod:1930 +msgid "" +"Please read L for more details. See also L." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1626 ../fish/guestfish-actions.pod:1098 -msgid "Linux new-style initrd images" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1933 +msgid "inspect-get-format" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1102 -msgid "some non-x86 Linux vmlinuz kernels" +#. type: verbatim +#: ../fish/guestfish-actions.pod:1935 +#, no-wrap +msgid "" +" inspect-get-format root\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1106 -msgid "What it can't do currently:" +#: ../fish/guestfish-actions.pod:1937 ../src/guestfs-actions.pod:2920 +msgid "" +"This returns the format of the inspected operating system. You can use it " +"to detect install images, live CDs and similar." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1112 -msgid "static libraries (libfoo.a)" +#: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:2923 +msgid "Currently defined formats are:" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1116 -msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)" +#. type: =item +#: ../fish/guestfish-actions.pod:1944 ../src/guestfs-actions.pod:2927 +msgid "\"installed\"" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1120 -msgid "x86 Linux vmlinuz kernels" +#: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2929 +msgid "This is an installed operating system." +msgstr "" + +#. type: =item +#: ../fish/guestfish-actions.pod:1948 ../src/guestfs-actions.pod:2931 +msgid "\"installer\"" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1122 +#: ../fish/guestfish-actions.pod:1950 ../src/guestfs-actions.pod:2933 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." +"The disk image being inspected is not an installed operating system, but a " +"I install disk, live CD, or similar." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823 -#: ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:2531 -#: ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2686 -#: ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2795 -#: ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2922 -#: ../src/guestfs-actions.pod:3019 ../src/guestfs-actions.pod:3266 -#: ../src/guestfs-actions.pod:3398 -msgid "(Added in 1.5.3)" +#: ../fish/guestfish-actions.pod:1955 ../src/guestfs-actions.pod:2938 +msgid "The format of this disk image is not known." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1662 -msgid "guestfs_filesize" +#: ../fish/guestfish-actions.pod:1964 +msgid "inspect-get-hostname" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1664 +#: ../fish/guestfish-actions.pod:1966 #, no-wrap msgid "" -" int64_t\n" -" guestfs_filesize (guestfs_h *g,\n" -" const char *file);\n" +" inspect-get-hostname root\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1133 -msgid "This command returns the size of C in bytes." -msgstr "" - -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1670 +#: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2958 msgid "" -"To get other stats about a file, use C, C, " -"C, C etc. To get the size of block " -"devices, use C." +"This function returns the hostname of the operating system as found by " +"inspection of the guest's configuration files." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1676 -msgid "(Added in 1.0.82)" +#: ../fish/guestfish-actions.pod:1971 ../src/guestfs-actions.pod:2961 +msgid "" +"If the hostname could not be determined, then the string C is " +"returned." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1678 -msgid "guestfs_fill" +#: ../fish/guestfish-actions.pod:1976 +msgid "inspect-get-icon" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1680 +#: ../fish/guestfish-actions.pod:1978 #, no-wrap msgid "" -" int\n" -" guestfs_fill (guestfs_h *g,\n" -" int c,\n" -" int len,\n" -" const char *path);\n" +" inspect-get-icon root [favicon:..] [highquality:..]\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1686 ../fish/guestfish-actions.pod:1143 +#: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:2987 msgid "" -"This command creates a new file called C. The initial content of the " -"file is C octets of C, where C must be a number in the range C<" -"[0..255]>." +"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: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1690 +#: ../fish/guestfish-actions.pod:1984 ../src/guestfs-actions.pod:2991 msgid "" -"To fill a file with zero bytes (sparsely), it is much more efficient to use " -"C. To create a file with a pattern of repeating " -"bytes use C." +"If it was not possible to get an icon this function returns a zero-length " +"(non-NULL) buffer. I." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1702 -msgid "(Added in 1.0.79)" +#: ../fish/guestfish-actions.pod:1987 ../src/guestfs-actions.pod:2994 +msgid "" +"Libguestfs will start by looking for a file called C or " +"C and if it has the correct format, the contents of " +"this file will be returned. You can disable favicons by passing the " +"optional C boolean as false (default is true)." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:1704 -msgid "guestfs_fill_pattern" +#. type: textblock +#: ../fish/guestfish-actions.pod:1993 ../src/guestfs-actions.pod:3000 +msgid "" +"If finding the favicon fails, then we look in other places in the guest for " +"a suitable icon." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:1706 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1996 ../src/guestfs-actions.pod:3003 msgid "" -" int\n" -" guestfs_fill_pattern (guestfs_h *g,\n" -" const char *pattern,\n" -" int len,\n" -" const char *path);\n" -"\n" +"If the optional C 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: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1712 +#: ../fish/guestfish-actions.pod:2007 ../src/guestfs-actions.pod:3014 msgid "" -"This function is like C except that it creates a new file of " -"length C containing the repeating pattern of bytes in C. The " -"pattern is truncated if necessary to ensure the length of the file is " -"exactly C bytes." +"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: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1724 -msgid "(Added in 1.3.12)" +#: ../fish/guestfish-actions.pod:2013 ../src/guestfs-actions.pod:3020 +msgid "" +"B 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: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:1726 -msgid "guestfs_find" +#. type: textblock +#: ../fish/guestfish-actions.pod:2021 ../src/guestfs-actions.pod:3028 +msgid "" +"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: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:1728 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2028 ../src/guestfs-actions.pod:3035 msgid "" -" char **\n" -" guestfs_find (guestfs_h *g,\n" -" const char *directory);\n" -"\n" +"Extracting icons from Windows guests requires the external C " +"program from the C package, and several programs (C, " +"C, C) from the C package. These must be " +"installed separately." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1732 ../fish/guestfish-actions.pod:1165 +#: ../fish/guestfish-actions.pod:2035 ../src/guestfs-actions.pod:3042 msgid "" -"This command lists out all files and directories, recursively, starting at " -"C. It is essentially equivalent to running the shell command " -"C but some post-processing happens on the output, " -"described below." +"Operating system icons are usually trademarks. Seek legal advice before " +"using trademarks in applications." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1737 ../fish/guestfish-actions.pod:1170 -msgid "" -"This returns a list of strings I. Thus if the directory " -"structure was:" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2042 +msgid "inspect-get-major-version" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1173 +#: ../fish/guestfish-actions.pod:2044 #, no-wrap msgid "" -" /tmp/a\n" -" /tmp/b\n" -" /tmp/c/d\n" +" inspect-get-major-version root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1744 +#: ../fish/guestfish-actions.pod:2046 ../src/guestfs-actions.pod:3083 msgid "" -"then the returned list from C C would be 4 elements:" +"This returns the major version number of the inspected operating system." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:1747 ../fish/guestfish-actions.pod:1180 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3086 msgid "" -" a\n" -" b\n" -" c\n" -" c/d\n" -"\n" +"Windows uses a consistent versioning scheme which is I 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 #. type: textblock -#: ../src/guestfs-actions.pod:1752 ../fish/guestfish-actions.pod:1185 -msgid "If C is not a directory, then this command returns an error." +#: ../fish/guestfish-actions.pod:2056 ../fish/guestfish-actions.pod:2067 +#: ../src/guestfs-actions.pod:3093 ../src/guestfs-actions.pod:3110 +msgid "If the version could not be determined, then C<0> is returned." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1188 -msgid "The returned list is sorted." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2060 +msgid "inspect-get-minor-version" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2062 +#, no-wrap +msgid "" +" inspect-get-minor-version root\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1757 -msgid "See also C." +#: ../fish/guestfish-actions.pod:2064 ../src/guestfs-actions.pod:3107 +msgid "" +"This returns the minor version number of the inspected operating system." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:4092 -#: ../src/guestfs-actions.pod:5635 -msgid "(Added in 1.0.27)" +#: ../fish/guestfish-actions.pod:2069 +msgid "" +"Please read L for more details. See also L." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1768 -msgid "guestfs_find0" +#: ../fish/guestfish-actions.pod:2072 +msgid "inspect-get-mountpoints" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1770 +#: ../fish/guestfish-actions.pod:2074 #, no-wrap msgid "" -" int\n" -" guestfs_find0 (guestfs_h *g,\n" -" const char *directory,\n" -" const char *files);\n" +" inspect-get-mountpoints root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1199 +#: ../fish/guestfish-actions.pod:2076 ../src/guestfs-actions.pod:3125 msgid "" -"This command lists out all files and directories, recursively, starting at " -"C, placing the resulting list in the external file called " -"C." +"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. I 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 #. type: textblock -#: ../src/guestfs-actions.pod:1779 +#: ../fish/guestfish-actions.pod:2085 ../src/guestfs-actions.pod:3134 msgid "" -"This command works the same way as C with the following " -"exceptions:" -msgstr "" - -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1786 ../fish/guestfish-actions.pod:1210 -msgid "The resulting list is written to an external file." +"Each element in the returned hashtable has a key which is the path of the " +"mountpoint (eg. C) and a value which is the filesystem that would be " +"mounted there (eg. C)." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1214 +#: ../fish/guestfish-actions.pod:2090 ../src/guestfs-actions.pod:3139 msgid "" -"Items (filenames) in the result are separated by C<\\0> characters. See " -"L option I<-print0>." -msgstr "" - -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1795 ../fish/guestfish-actions.pod:1219 -msgid "This command is not limited in the number of names that it can return." +"Non-mounted devices such as swap devices are I returned in this list." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1800 ../fish/guestfish-actions.pod:1224 -msgid "The result list is not sorted." +#: ../fish/guestfish-actions.pod:2093 +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 L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1806 -msgid "(Added in 1.0.74)" +#: ../fish/guestfish-actions.pod:2099 +msgid "" +"Please read L for more details. See also L." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1808 -msgid "guestfs_findfs_label" +#: ../fish/guestfish-actions.pod:2102 +msgid "inspect-get-package-format" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1810 +#: ../fish/guestfish-actions.pod:2104 #, no-wrap msgid "" -" char *\n" -" guestfs_findfs_label (guestfs_h *g,\n" -" const char *label);\n" +" inspect-get-package-format root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1234 +#: ../fish/guestfish-actions.pod:2106 msgid "" -"This command searches the filesystems and returns the one which has the " -"given label. An error is returned if no such filesystem can be found." +"This function and L return the package " +"format and package management tool used by the inspected operating system. " +"For example for Fedora these functions would return C (package format) " +"and C (package management)." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1818 -msgid "To find the label of a filesystem, use C." +#: ../fish/guestfish-actions.pod:2112 ../src/guestfs-actions.pod:3171 +msgid "" +"This returns the string C if we could not determine the package " +"format I if the operating system does not have a real packaging system " +"(eg. Windows)." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:2116 ../src/guestfs-actions.pod:3175 +msgid "" +"Possible strings include: C, C, C, C, C. " +"Future versions of libguestfs may return other strings." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1825 -msgid "guestfs_findfs_uuid" +#: ../fish/guestfish-actions.pod:2121 +msgid "inspect-get-package-management" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1827 +#: ../fish/guestfish-actions.pod:2123 #, no-wrap msgid "" -" char *\n" -" guestfs_findfs_uuid (guestfs_h *g,\n" -" const char *uuid);\n" +" inspect-get-package-management root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1831 ../fish/guestfish-actions.pod:1244 +#: ../fish/guestfish-actions.pod:2125 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." +"L 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 (package format) and " +"C (package management)." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1835 -msgid "To find the UUID of a filesystem, use C." +#: ../fish/guestfish-actions.pod:2131 ../src/guestfs-actions.pod:3197 +msgid "" +"This returns the string C if we could not determine the package " +"management tool I if the operating system does not have a real packaging " +"system (eg. Windows)." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:2135 ../src/guestfs-actions.pod:3201 +msgid "" +"Possible strings include: C, C, C (for all Debian " +"derivatives), C, C, C, C. Future versions of " +"libguestfs may return other strings." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1842 -msgid "guestfs_fsck" +#: ../fish/guestfish-actions.pod:2142 +msgid "inspect-get-product-name" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1844 +#: ../fish/guestfish-actions.pod:2144 #, no-wrap msgid "" -" int\n" -" guestfs_fsck (guestfs_h *g,\n" -" const char *fstype,\n" -" const char *device);\n" +" inspect-get-product-name root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1849 ../fish/guestfish-actions.pod:1254 +#: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3219 msgid "" -"This runs the filesystem checker (fsck) on C which should have " -"filesystem type C." +"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 #. type: textblock -#: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1257 +#: ../fish/guestfish-actions.pod:2151 ../src/guestfs-actions.pod:3224 msgid "" -"The returned integer is the status. See L for the list of status " -"codes from C." +"If the product name could not be determined, then the string C is " +"returned." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:2156 +msgid "inspect-get-product-variant" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2158 +#, no-wrap +msgid "" +" inspect-get-product-variant root\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1861 ../fish/guestfish-actions.pod:1266 -msgid "Multiple status codes can be summed together." +#: ../fish/guestfish-actions.pod:2160 ../src/guestfs-actions.pod:3240 +msgid "This returns the product variant of the inspected operating system." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1865 ../fish/guestfish-actions.pod:1270 +#: ../fish/guestfish-actions.pod:2163 ../src/guestfs-actions.pod:3243 msgid "" -"A non-zero return code can mean \"success\", for example if errors have been " -"corrected on the filesystem." +"For Windows guests, this returns the contents of the Registry key C C which " +"is usually a string such as C or C (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 and " +"the latter is C)." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1870 ../fish/guestfish-actions.pod:1275 -msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)." +#: ../fish/guestfish-actions.pod:2172 ../src/guestfs-actions.pod:3252 +msgid "" +"For enterprise Linux guests, in future we intend this to return the product " +"variant such as C, C and so on. But this is not " +"implemented at present." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1280 +#: ../fish/guestfish-actions.pod:2176 ../src/guestfs-actions.pod:3256 msgid "" -"This command is entirely equivalent to running C." +"If the product variant could not be determined, then the string C " +"is returned." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1879 ../src/guestfs-actions.pod:7331 -msgid "(Added in 1.0.16)" +#: ../fish/guestfish-actions.pod:2179 +msgid "" +"Please read L for more details. See also L, L." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1881 -msgid "guestfs_get_append" +#: ../fish/guestfish-actions.pod:2183 +msgid "inspect-get-roots" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1883 +#: ../fish/guestfish-actions.pod:2185 #, no-wrap msgid "" -" const char *\n" -" guestfs_get_append (guestfs_h *g);\n" +" inspect-get-roots\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1286 +#: ../fish/guestfish-actions.pod:2187 msgid "" -"Return the additional kernel options which are added to the guest kernel " -"command line." -msgstr "" - -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1289 -msgid "If C then no options are added." +"This function is a convenient way to get the list of root devices, as " +"returned from a previous call to L, but without redoing the " +"whole inspection process." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1891 +#: ../fish/guestfish-actions.pod:2191 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 be freed." -msgstr "" - -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:5313 -#: ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:6193 -#: ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6228 -#: ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:7002 -#: ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7374 -msgid "(Added in 1.0.26)" +"This returns an empty list if either no root devices were found or the " +"caller has not called L." msgstr "" #. type: =head2 -#: ../src/guestfs-actions.pod:1897 -msgid "guestfs_get_attach_method" +#: ../fish/guestfish-actions.pod:2196 +msgid "inspect-get-type" msgstr "" #. type: verbatim -#: ../src/guestfs-actions.pod:1899 +#: ../fish/guestfish-actions.pod:2198 #, no-wrap msgid "" -" char *\n" -" guestfs_get_attach_method (guestfs_h *g);\n" +" inspect-get-type root\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:1902 -msgid "Return the current attach method. See C." -msgstr "" - -# type: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:1907 -msgid "guestfs_get_autosync" +#: ../fish/guestfish-actions.pod:2200 ../src/guestfs-actions.pod:3294 +msgid "" +"This returns the type of the inspected operating system. Currently defined " +"types are:" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:1909 -#, no-wrap -msgid "" -" int\n" -" guestfs_get_autosync (guestfs_h *g);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:2205 ../src/guestfs-actions.pod:3299 +msgid "\"linux\"" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1301 -msgid "Get the autosync flag." +#: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3301 +msgid "Any Linux-based operating system." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:1918 -msgid "guestfs_get_direct" +#. type: textblock +#: ../fish/guestfish-actions.pod:2211 ../src/guestfs-actions.pod:3305 +msgid "Any Microsoft Windows operating system." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:1920 -#, no-wrap -msgid "" -" int\n" -" guestfs_get_direct (guestfs_h *g);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:2213 ../src/guestfs-actions.pod:3307 +msgid "\"freebsd\"" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1307 -msgid "Return the direct appliance mode flag." +#: ../fish/guestfish-actions.pod:2215 ../src/guestfs-actions.pod:3309 +msgid "FreeBSD." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:5862 -msgid "(Added in 1.0.72)" +#: ../fish/guestfish-actions.pod:2219 ../src/guestfs-actions.pod:3313 +msgid "The operating system type could not be determined." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1929 -msgid "guestfs_get_e2label" +#: ../fish/guestfish-actions.pod:2228 +msgid "inspect-get-windows-current-control-set" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1931 +#: ../fish/guestfish-actions.pod:2230 #, no-wrap msgid "" -" char *\n" -" guestfs_get_e2label (guestfs_h *g,\n" -" const char *device);\n" +" inspect-get-windows-current-control-set root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1313 +#: ../fish/guestfish-actions.pod:2232 ../src/guestfs-actions.pod:3333 msgid "" -"This returns the ext2/3/4 filesystem label of the filesystem on C." +"This returns the Windows CurrentControlSet of the inspected guest. The " +"CurrentControlSet is a registry key name such as C." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1316 +#: ../fish/guestfish-actions.pod:2235 ../src/guestfs-actions.pod:3336 msgid "" -"This function is deprecated. In new code, use the C call instead." -msgstr "" - -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:1969 -#: ../src/guestfs-actions.pod:5880 ../src/guestfs-actions.pod:5899 -msgid "(Added in 1.0.15)" +"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: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1950 -msgid "guestfs_get_e2uuid" +#: ../fish/guestfish-actions.pod:2241 +msgid "inspect-get-windows-systemroot" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1952 +#: ../fish/guestfish-actions.pod:2243 #, no-wrap msgid "" -" char *\n" -" guestfs_get_e2uuid (guestfs_h *g,\n" -" const char *device);\n" +" inspect-get-windows-systemroot root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1956 ../fish/guestfish-actions.pod:1327 +#: ../fish/guestfish-actions.pod:2245 ../src/guestfs-actions.pod:3353 msgid "" -"This returns the ext2/3/4 filesystem UUID of the filesystem on C." +"This returns the Windows systemroot of the inspected guest. The systemroot " +"is a directory path such as C." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1962 ../fish/guestfish-actions.pod:1330 +#: ../fish/guestfish-actions.pod:2248 ../src/guestfs-actions.pod:3356 msgid "" -"This function is deprecated. In new code, use the C call instead." +"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: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1971 -msgid "guestfs_get_memsize" +#: ../fish/guestfish-actions.pod:2254 +msgid "inspect-is-live" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1973 +#: ../fish/guestfish-actions.pod:2256 #, no-wrap msgid "" -" int\n" -" guestfs_get_memsize (guestfs_h *g);\n" +" inspect-is-live root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1341 +#: ../fish/guestfish-actions.pod:2258 msgid "" -"This gets the memory size in megabytes allocated to the qemu subprocess." +"If L returns C (this is an install disk), " +"then this returns true if a live image was detected on the disk." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1979 -msgid "" -"If C was not called on this handle, and if " -"C was not set, then this returns the compiled-in default " -"value for memsize." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2264 +msgid "inspect-is-multipart" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:2064 -#: ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:6022 -#: ../fish/guestfish-actions.pod:1348 ../fish/guestfish-actions.pod:1399 -#: ../fish/guestfish-actions.pod:3985 ../fish/guestfish-actions.pod:4072 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2266 +#, no-wrap msgid "" -"For more information on the architecture of libguestfs, see L." +" inspect-is-multipart root\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:4383 -#: ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:4599 -#: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4630 -#: ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4660 -#: ../src/guestfs-actions.pod:5538 ../src/guestfs-actions.pod:5920 -#: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6768 -msgid "(Added in 1.0.55)" +#: ../fish/guestfish-actions.pod:2268 +msgid "" +"If L returns C (this is an install disk), " +"then this returns true if the disk is part of a set." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:1990 -msgid "guestfs_get_network" +#: ../fish/guestfish-actions.pod:2274 +msgid "inspect-is-netinst" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:1992 +#: ../fish/guestfish-actions.pod:2276 #, no-wrap msgid "" -" int\n" -" guestfs_get_network (guestfs_h *g);\n" +" inspect-is-netinst root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:1995 ../fish/guestfish-actions.pod:1355 -msgid "This returns the enable network flag." -msgstr "" - -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:1999 ../src/guestfs-actions.pod:5939 -msgid "(Added in 1.5.4)" +#: ../fish/guestfish-actions.pod:2278 +msgid "" +"If L returns C (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 #. type: =head2 -#: ../src/guestfs-actions.pod:2001 -msgid "guestfs_get_path" +#: ../fish/guestfish-actions.pod:2286 +msgid "inspect-list-applications" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2003 +#: ../fish/guestfish-actions.pod:2288 #, no-wrap msgid "" -" const char *\n" -" guestfs_get_path (guestfs_h *g);\n" +" inspect-list-applications root\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2006 ../fish/guestfish-actions.pod:1361 -msgid "Return the current search path." +#: ../fish/guestfish-actions.pod:2290 ../src/guestfs-actions.pod:3423 +msgid "Return the list of applications installed in the operating system." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2008 ../fish/guestfish-actions.pod:1363 +#: ../fish/guestfish-actions.pod:2292 msgid "" -"This is always non-NULL. If it wasn't set already, then this will return " -"the default path." +"I This call works differently from other parts of the inspection " +"API. You have to call L, then L, " +"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 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 #. type: textblock -#: ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2040 +#: ../fish/guestfish-actions.pod:2302 ../src/guestfs-actions.pod:3435 msgid "" -"This function returns a string, or NULL on error. The string is owned by " -"the guest handle and must I be freed." +"This returns an empty list if the inspection code was not able to determine " +"the list of applications." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:2016 -msgid "guestfs_get_pid" +#. type: textblock +#: ../fish/guestfish-actions.pod:2305 ../src/guestfs-actions.pod:3438 +msgid "The application structure contains the following fields:" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:2018 -#, no-wrap -msgid "" -" int\n" -" guestfs_get_pid (guestfs_h *g);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:2309 ../src/guestfs-actions.pod:3442 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2021 ../fish/guestfish-actions.pod:1372 +#: ../fish/guestfish-actions.pod:2311 ../src/guestfs-actions.pod:3444 msgid "" -"Return the process ID of the qemu subprocess. If there is no qemu " -"subprocess, then this will return an error." +"The name of the application. For Red Hat-derived and Debian-derived Linux " +"guests, this is the package name." +msgstr "" + +#. type: =item +#: ../fish/guestfish-actions.pod:2314 ../src/guestfs-actions.pod:3447 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1375 -msgid "This is an internal call used for debugging and testing." +#: ../fish/guestfish-actions.pod:2316 ../src/guestfs-actions.pod:3449 +msgid "" +"The display name of the application, sometimes localized to the install " +"language of the guest operating system." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2028 -msgid "(Added in 1.0.56)" +#: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3452 +msgid "" +"If unavailable this is returned as an empty string C<\"\">. Callers needing " +"to display something can use C instead." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:2030 -msgid "guestfs_get_qemu" +#. type: =item +#: ../fish/guestfish-actions.pod:2322 ../src/guestfs-actions.pod:3455 +msgid "C" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:2032 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2324 ../src/guestfs-actions.pod:3457 msgid "" -" const char *\n" -" guestfs_get_qemu (guestfs_h *g);\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 -#. type: textblock -#: ../src/guestfs-actions.pod:2035 ../fish/guestfish-actions.pod:1381 -msgid "Return the current qemu binary." +#. type: =item +#: ../fish/guestfish-actions.pod:2327 ../src/guestfs-actions.pod:3460 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2037 ../fish/guestfish-actions.pod:1383 +#: ../fish/guestfish-actions.pod:2329 ../src/guestfs-actions.pod:3462 msgid "" -"This is always non-NULL. If it wasn't set already, then this will return " -"the default qemu binary name." +"The version string of the application or package. If unavailable this is " +"returned as an empty string C<\"\">." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5984 -msgid "(Added in 1.0.6)" +#. type: =item +#: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3465 +msgid "C" msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:2045 -msgid "guestfs_get_recovery_proc" +#. type: textblock +#: ../fish/guestfish-actions.pod:2334 ../src/guestfs-actions.pod:3467 +msgid "" +"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: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:2047 -#, no-wrap -msgid "" -" int\n" -" guestfs_get_recovery_proc (guestfs_h *g);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:2338 ../src/guestfs-actions.pod:3471 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2050 ../fish/guestfish-actions.pod:1390 -msgid "Return the recovery process enabled flag." +#: ../fish/guestfish-actions.pod:2340 ../src/guestfs-actions.pod:3473 +msgid "" +"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: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2054 ../src/guestfs-actions.pod:3493 -#: ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:4190 -#: ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:5243 -#: ../src/guestfs-actions.pod:5586 ../src/guestfs-actions.pod:6008 -#: ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:6691 -#: ../src/guestfs-actions.pod:6883 -msgid "(Added in 1.0.77)" +#: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3478 +msgid "If unavailable this is returned as an empty string C<\"\">." msgstr "" -# type: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:2056 -msgid "guestfs_get_selinux" +#. type: =item +#: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3480 +msgid "C" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:2058 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3482 msgid "" -" int\n" -" guestfs_get_selinux (guestfs_h *g);\n" -"\n" +"The install path translated into a libguestfs path. If unavailable this is " +"returned as an empty string C<\"\">." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2061 -msgid "" -"This returns the current setting of the selinux flag which is passed to the " -"appliance at boot time. See C." +#. type: =item +#: ../fish/guestfish-actions.pod:2352 ../src/guestfs-actions.pod:3485 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2132 -#: ../src/guestfs-actions.pod:6027 ../src/guestfs-actions.pod:6085 -msgid "(Added in 1.0.67)" +#: ../fish/guestfish-actions.pod:2354 ../src/guestfs-actions.pod:3487 +msgid "" +"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: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:2071 -msgid "guestfs_get_state" +#. type: =item +#: ../fish/guestfish-actions.pod:2358 ../src/guestfs-actions.pod:3491 +msgid "C" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:2073 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2360 ../src/guestfs-actions.pod:3493 msgid "" -" int\n" -" guestfs_get_state (guestfs_h *g);\n" -"\n" +"The URL (eg. upstream URL) of the application. If unavailable this is " +"returned as an empty string C<\"\">." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2076 ../fish/guestfish-actions.pod:1406 -msgid "" -"This returns the current state as an opaque integer. This is only useful " -"for printing debug and internal error messages." +#. type: =item +#: ../fish/guestfish-actions.pod:2363 ../src/guestfs-actions.pod:3496 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2079 ../src/guestfs-actions.pod:3291 -#: ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3381 -#: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:1409 -#: ../fish/guestfish-actions.pod:2315 ../fish/guestfish-actions.pod:2333 -#: ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2387 -msgid "For more information on states, see L." +#: ../fish/guestfish-actions.pod:2365 ../src/guestfs-actions.pod:3498 +msgid "" +"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 -#. type: =head2 -#: ../src/guestfs-actions.pod:2085 -msgid "guestfs_get_trace" +#. type: =item +#: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3501 +msgid "C" msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:2087 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2370 ../src/guestfs-actions.pod:3503 msgid "" -" int\n" -" guestfs_get_trace (guestfs_h *g);\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: =item +#: ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:3506 +msgid "C" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415 -msgid "Return the command trace flag." +#: ../fish/guestfish-actions.pod:2375 ../src/guestfs-actions.pod:3508 +msgid "" +"A longer description of the application or package. If unavailable this is " +"returned as an empty string C<\"\">." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2096 -msgid "guestfs_get_umask" +#: ../fish/guestfish-actions.pod:2382 +msgid "inspect-os" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2098 +#: ../fish/guestfish-actions.pod:2384 #, no-wrap msgid "" -" int\n" -" guestfs_get_umask (guestfs_h *g);\n" +" inspect-os\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2101 +#: ../fish/guestfish-actions.pod:2386 ../src/guestfs-actions.pod:3526 msgid "" -"Return the current umask. By default the umask is C<022> unless it has been " -"set by calling C." +"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 -#. type: =head2 -#: ../src/guestfs-actions.pod:2108 -msgid "guestfs_get_verbose" +#. type: textblock +#: ../fish/guestfish-actions.pod:2390 ../src/guestfs-actions.pod:3530 +msgid "The list returned is empty if no operating systems were found." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:2110 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2392 ../src/guestfs-actions.pod:3532 msgid "" -" int\n" -" guestfs_get_verbose (guestfs_h *g);\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 #. type: textblock -#: ../src/guestfs-actions.pod:2113 ../fish/guestfish-actions.pod:1428 -msgid "This returns the verbose messages flag." -msgstr "" - -# type: =head2 -#. type: =head2 -#: ../src/guestfs-actions.pod:2119 -msgid "guestfs_getcon" +#: ../fish/guestfish-actions.pod:2399 +msgid "" +"You can pass the root string(s) returned to other L " +"functions in order to query further information about each operating system, " +"such as the name and version." msgstr "" -# type: verbatim -#. type: verbatim -#: ../src/guestfs-actions.pod:2121 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2404 msgid "" -" char *\n" -" guestfs_getcon (guestfs_h *g);\n" -"\n" +"This function uses other libguestfs features such as L and L in order to mount and unmount filesystems and look at the " +"contents. This should be called with no disks currently mounted. The " +"function may also use Augeas, so any existing Augeas handle will be closed." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2124 ../fish/guestfish-actions.pod:1434 -msgid "This gets the SELinux security context of the daemon." +#: ../fish/guestfish-actions.pod:2410 ../src/guestfs-actions.pod:3550 +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 #. type: textblock -#: ../src/guestfs-actions.pod:2126 -msgid "" -"See the documentation about SELINUX in L, and C" +#: ../fish/guestfish-actions.pod:2416 ../fish/guestfish-actions.pod:2614 +#: ../fish/guestfish-actions.pod:2673 +msgid "See also L." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2134 -msgid "guestfs_getxattr" +#: ../fish/guestfish-actions.pod:2418 +msgid "is-blockdev" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2136 +#: ../fish/guestfish-actions.pod:2420 #, no-wrap msgid "" -" char *\n" -" guestfs_getxattr (guestfs_h *g,\n" -" const char *path,\n" -" const char *name,\n" -" size_t *size_r);\n" +" is-blockdev path\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2142 -msgid "" -"Get a single extended attribute from file C named C. This call " -"follows symlinks. If you want to lookup an extended attribute for the " -"symlink itself, use C." -msgstr "" - -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2146 ../src/guestfs-actions.pod:3507 +#: ../fish/guestfish-actions.pod:2422 ../src/guestfs-actions.pod:3570 msgid "" -"Normally it is better to get all extended attributes from a file in one go " -"by calling C. 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." +"This returns C if and only if there is a block device with the given " +"C name." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2153 ../src/guestfs-actions.pod:3514 -#: ../fish/guestfish-actions.pod:1454 ../fish/guestfish-actions.pod:2452 -msgid "" -"Extended attribute values are blobs of binary data. If there is no extended " -"attribute named C, this returns an error." +#: ../fish/guestfish-actions.pod:2425 ../fish/guestfish-actions.pod:2443 +#: ../fish/guestfish-actions.pod:2462 ../fish/guestfish-actions.pod:2471 +#: ../fish/guestfish-actions.pod:2481 ../fish/guestfish-actions.pod:2515 +#: ../fish/guestfish-actions.pod:2524 +msgid "See also L." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2156 -msgid "See also: C, C, L." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2427 +msgid "is-busy" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:2349 -#: ../src/guestfs-actions.pod:3519 ../src/guestfs-actions.pod:5236 -#: ../src/guestfs-actions.pod:5262 ../src/guestfs-actions.pod:5443 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2429 +#, no-wrap msgid "" -"This function returns a buffer, or NULL on error. The size of the returned " -"buffer is written to C<*size_r>. I." +" is-busy\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:3523 -msgid "(Added in 1.7.24)" +#: ../fish/guestfish-actions.pod:2431 ../src/guestfs-actions.pod:3584 +msgid "" +"This returns true iff this handle is busy processing a command (in the " +"C state)." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2164 -msgid "guestfs_getxattrs" +#: ../fish/guestfish-actions.pod:2436 +msgid "is-chardev" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2166 +#: ../fish/guestfish-actions.pod:2438 #, no-wrap msgid "" -" struct guestfs_xattr_list *\n" -" guestfs_getxattrs (guestfs_h *g,\n" -" const char *path);\n" +" is-chardev path\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2170 ../fish/guestfish-actions.pod:1463 -msgid "" -"This call lists the extended attributes of the file or directory C." -msgstr "" - -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1466 +#: ../fish/guestfish-actions.pod:2440 ../src/guestfs-actions.pod:3599 msgid "" -"At the system call level, this is a combination of the L and " -"L calls." +"This returns C if and only if there is a character device with the " +"given C name." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2176 -msgid "See also: C, L." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2445 +msgid "is-config" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:3535 -#: ../src/guestfs-actions.pod:4186 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2447 +#, no-wrap msgid "" -"This function returns a C, or NULL if there was " -"an error. I after use>." +" is-config\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:3539 -#: ../src/guestfs-actions.pod:3704 ../src/guestfs-actions.pod:3740 -#: ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:6104 -#: ../src/guestfs-actions.pod:7439 -msgid "(Added in 1.0.59)" +#: ../fish/guestfish-actions.pod:2449 ../src/guestfs-actions.pod:3613 +msgid "" +"This returns true iff this handle is being configured (in the C " +"state)." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2184 -msgid "guestfs_glob_expand" +#: ../fish/guestfish-actions.pod:2454 +msgid "is-dir" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2186 +#: ../fish/guestfish-actions.pod:2456 #, no-wrap msgid "" -" char **\n" -" guestfs_glob_expand (guestfs_h *g,\n" -" const char *pattern);\n" +" is-dir path\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2190 ../fish/guestfish-actions.pod:1475 +#: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3628 msgid "" -"This command searches for all the pathnames matching C according to " -"the wildcard expansion rules used by the shell." +"This returns C if and only if there is a directory with the given " +"C name. Note that it returns false for other objects like files." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2194 ../fish/guestfish-actions.pod:1479 -msgid "" -"If no paths match, then this returns an empty list (note: not an error)." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2464 +msgid "is-fifo" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1482 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2466 +#, no-wrap msgid "" -"It is just a wrapper around the C L function with flags C. See that manual page for more details." +" is-fifo path\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6269 -#: ../src/guestfs-actions.pod:6286 -msgid "(Added in 1.0.50)" +#: ../fish/guestfish-actions.pod:2468 ../src/guestfs-actions.pod:3644 +msgid "" +"This returns C if and only if there is a FIFO (named pipe) with the " +"given C name." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2207 -msgid "guestfs_grep" +#: ../fish/guestfish-actions.pod:2473 +msgid "is-file" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2209 +#: ../fish/guestfish-actions.pod:2475 #, no-wrap msgid "" -" char **\n" -" guestfs_grep (guestfs_h *g,\n" -" const char *regex,\n" -" const char *path);\n" +" is-file path\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2214 ../fish/guestfish-actions.pod:1490 -msgid "This calls the external C program and returns the matching lines." +#: ../fish/guestfish-actions.pod:2477 ../src/guestfs-actions.pod:3659 +msgid "" +"This returns C if and only if there is a regular file with the given " +"C name. Note that it returns false for other objects like directories." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2226 -msgid "guestfs_grepi" +#: ../fish/guestfish-actions.pod:2483 +msgid "is-launching" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2228 +#: ../fish/guestfish-actions.pod:2485 #, no-wrap msgid "" -" char **\n" -" guestfs_grepi (guestfs_h *g,\n" -" const char *regex,\n" -" const char *path);\n" +" is-launching\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2233 ../fish/guestfish-actions.pod:1500 +#: ../fish/guestfish-actions.pod:2487 ../src/guestfs-actions.pod:3674 msgid "" -"This calls the external C program and returns the matching lines." +"This returns true iff this handle is launching the subprocess (in the " +"C state)." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2245 -msgid "guestfs_grub_install" +#: ../fish/guestfish-actions.pod:2492 +msgid "is-lv" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2247 +#: ../fish/guestfish-actions.pod:2494 #, no-wrap msgid "" -" int\n" -" guestfs_grub_install (guestfs_h *g,\n" -" const char *root,\n" -" const char *device);\n" +" is-lv device\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2252 ../fish/guestfish-actions.pod:1510 +#: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3689 msgid "" -"This command installs GRUB (the Grand Unified Bootloader) on C, with " -"the root directory being C." +"This command tests whether C is a logical volume, and returns true " +"iff this is the case." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1513 -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 file first that contains the mapping between grub device names " -"and Linux device names. It is usually sufficient to create a file " -"containing:" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2499 +msgid "is-ready" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2262 ../fish/guestfish-actions.pod:1520 +#: ../fish/guestfish-actions.pod:2501 #, no-wrap msgid "" -" (hd0) /dev/vda\n" +" is-ready\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2264 ../fish/guestfish-actions.pod:1522 -msgid "replacing C with the name of the installation device." -msgstr "" - -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2268 -msgid "(Added in 1.0.17)" +#: ../fish/guestfish-actions.pod:2503 ../src/guestfs-actions.pod:3701 +msgid "" +"This returns true iff this handle is ready to accept commands (in the " +"C state)." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2270 -msgid "guestfs_head" +#: ../fish/guestfish-actions.pod:2508 +msgid "is-socket" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2272 +#: ../fish/guestfish-actions.pod:2510 #, no-wrap msgid "" -" char **\n" -" guestfs_head (guestfs_h *g,\n" -" const char *path);\n" +" is-socket path\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1528 +#: ../fish/guestfish-actions.pod:2512 ../src/guestfs-actions.pod:3716 msgid "" -"This command returns up to the first 10 lines of a file as a list of strings." +"This returns C if and only if there is a Unix domain socket with the " +"given C name." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2288 -msgid "guestfs_head_n" +#: ../fish/guestfish-actions.pod:2517 +msgid "is-symlink" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2290 +#: ../fish/guestfish-actions.pod:2519 #, no-wrap msgid "" -" char **\n" -" guestfs_head_n (guestfs_h *g,\n" -" int nrlines,\n" -" const char *path);\n" +" is-symlink path\n" "\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1538 -msgid "" -"If the parameter C is a positive number, this returns the first " -"C lines of the file C." -msgstr "" - -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1541 +#: ../fish/guestfish-actions.pod:2521 ../src/guestfs-actions.pod:3731 msgid "" -"If the parameter C is a negative number, this returns lines from " -"the file C, excluding the last C lines." -msgstr "" - -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:6566 -#: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:4422 -msgid "If the parameter C is zero, this returns an empty list." +"This returns C if and only if there is a symbolic link with the given " +"C name." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2312 -msgid "guestfs_hexdump" +#: ../fish/guestfish-actions.pod:2526 +msgid "is-zero" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2314 +#: ../fish/guestfish-actions.pod:2528 #, no-wrap msgid "" -" char *\n" -" guestfs_hexdump (guestfs_h *g,\n" -" const char *path);\n" +" is-zero path\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1553 +#: ../fish/guestfish-actions.pod:2530 ../src/guestfs-actions.pod:3746 msgid "" -"This runs C on the given C. The result is the human-" -"readable, canonical hex dump of the file." -msgstr "" - -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:6350 -#: ../src/guestfs-actions.pod:6405 -msgid "(Added in 1.0.22)" +"This returns true iff the file exists and the file is empty or it contains " +"all zero bytes." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2329 -msgid "guestfs_initrd_cat" +#: ../fish/guestfish-actions.pod:2533 +msgid "is-zero-device" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2331 +#: ../fish/guestfish-actions.pod:2535 #, 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" +" is-zero-device device\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1563 -msgid "" -"This command unpacks the file C from the initrd file called " -"C. The filename must be given I the initial C " -"character." +#: ../fish/guestfish-actions.pod:2537 ../src/guestfs-actions.pod:3759 +msgid "This returns true iff the device exists and contains all zero bytes." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1567 -msgid "" -"For example, in guestfish you could use the following command to examine the " -"boot script (usually called C) contained in a Linux initrd or " -"initramfs image:" +#: ../fish/guestfish-actions.pod:2539 ../src/guestfs-actions.pod:3761 +msgid "Note that for large devices this can take a long time to run." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:2541 +msgid "kill-subprocess" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1571 +#: ../fish/guestfish-actions.pod:2543 #, no-wrap msgid "" -" initrd-cat /boot/initrd-.img init\n" +" kill-subprocess\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2347 -msgid "See also C." +#: ../fish/guestfish-actions.pod:2545 ../src/guestfs-actions.pod:3772 +msgid "This kills the qemu subprocess. You should never need to call this." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2358 -msgid "guestfs_initrd_list" +#: ../fish/guestfish-actions.pod:2547 +msgid "launch" +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:2549 +msgid "run" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2360 +#: ../fish/guestfish-actions.pod:2551 #, no-wrap msgid "" -" char **\n" -" guestfs_initrd_list (guestfs_h *g,\n" -" const char *path);\n" +" launch\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1582 -msgid "This command lists out files contained in an initrd." -msgstr "" - -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1584 +#: ../fish/guestfish-actions.pod:2553 ../src/guestfs-actions.pod:3783 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." +"Internally libguestfs is implemented by running a virtual machine using " +"L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1588 +#: ../fish/guestfish-actions.pod:2556 ../src/guestfs-actions.pod:3786 msgid "" -"Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as " -"initrd. We I support the newer initramfs format (compressed cpio " -"files)." +"You should call this after configuring the handle (eg. adding drives) but " +"before performing any actions." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2380 -msgid "guestfs_inotify_add_watch" +#: ../fish/guestfish-actions.pod:2559 +msgid "lchown" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2382 +#: ../fish/guestfish-actions.pod:2561 #, no-wrap msgid "" -" int64_t\n" -" guestfs_inotify_add_watch (guestfs_h *g,\n" -" const char *path,\n" -" int mask);\n" +" lchown owner group path\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1596 -msgid "Watch C for the events listed in C." +#: ../fish/guestfish-actions.pod:2563 +msgid "" +"Change the file owner to C and group to C. This is like L but if C is a symlink then the link itself is changed, not the " +"target." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2389 ../fish/guestfish-actions.pod:1598 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2571 +msgid "lgetxattr" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2573 +#, no-wrap msgid "" -"Note that if C is a directory then events within that directory are " -"watched, but this does I happen recursively (in subdirectories)." +" lgetxattr path name\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2393 ../fish/guestfish-actions.pod:1602 +#: ../fish/guestfish-actions.pod:2575 ../src/guestfs-actions.pod:3826 msgid "" -"Note for non-C or non-Linux callers: the inotify events are defined by the " -"Linux kernel ABI and are listed in C." +"Get a single extended attribute from file C named C. If C " +"is a symlink, then this call returns an extended attribute from the symlink." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:2589 +msgid "See also: L, L, L." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2401 -msgid "guestfs_inotify_close" +#: ../fish/guestfish-actions.pod:2591 +msgid "lgetxattrs" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2403 +#: ../fish/guestfish-actions.pod:2593 #, no-wrap msgid "" -" int\n" -" guestfs_inotify_close (guestfs_h *g);\n" +" lgetxattrs path\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2406 ../fish/guestfish-actions.pod:1610 +#: ../fish/guestfish-actions.pod:2595 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." +"This is the same as L, but if C is a symbolic link, then " +"it returns the extended attributes of the link itself." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2414 -msgid "guestfs_inotify_files" +#: ../fish/guestfish-actions.pod:2599 +msgid "list-9p" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2416 +#: ../fish/guestfish-actions.pod:2601 #, no-wrap msgid "" -" char **\n" -" guestfs_inotify_files (guestfs_h *g);\n" +" list-9p\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2419 +#: ../fish/guestfish-actions.pod:2603 ../src/guestfs-actions.pod:3869 msgid "" -"This function is a helpful wrapper around C which just " -"returns a list of pathnames of objects that were touched. The returned " -"pathnames are sorted and deduplicated." +"List all 9p filesystems attached to the guest. A list of mount tags is " +"returned." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2429 -msgid "guestfs_inotify_init" +#: ../fish/guestfish-actions.pod:2606 +msgid "list-devices" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2431 +#: ../fish/guestfish-actions.pod:2608 #, no-wrap msgid "" -" int\n" -" guestfs_inotify_init (guestfs_h *g,\n" -" int maxevents);\n" +" list-devices\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1626 -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." +#: ../fish/guestfish-actions.pod:2610 ../src/guestfs-actions.pod:3883 +msgid "List all the block devices." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2439 -msgid "" -"C is the maximum number of events which will be queued up between " -"calls to C or C. 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 the returned structure list (see " -"C)." +#: ../fish/guestfish-actions.pod:2612 ../src/guestfs-actions.pod:3885 +msgid "The full block device names are returned, eg. C." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2449 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2616 +msgid "list-dm-devices" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2618 +#, no-wrap msgid "" -"Before any events are generated, you have to add some watches to the " -"internal watch list. See: C, " -"C and C." +" list-dm-devices\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2455 -msgid "" -"Queued up events should be read periodically by calling " -"C (or C which is just a helpful " -"wrapper around C). If you don't read the events out " -"often enough then you risk the internal queue overflowing." +#: ../fish/guestfish-actions.pod:2620 ../src/guestfs-actions.pod:3900 +msgid "List all device mapper devices." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2462 +#: ../fish/guestfish-actions.pod:2622 msgid "" -"The handle should be closed after use by calling C. " -"This also removes any watches automatically." +"The returned list contains C devices, eg. ones created by a " +"previous call to L." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1657 +#: ../fish/guestfish-actions.pod:2625 msgid "" -"See also L 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." +"Device mapper devices which correspond to logical volumes are I " +"returned in this list. Call L if you want to list logical volumes." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2475 -msgid "guestfs_inotify_read" +#: ../fish/guestfish-actions.pod:2629 +msgid "list-filesystems" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2477 +#: ../fish/guestfish-actions.pod:2631 #, no-wrap msgid "" -" struct guestfs_inotify_event_list *\n" -" guestfs_inotify_read (guestfs_h *g);\n" +" list-filesystems\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1666 +#: ../fish/guestfish-actions.pod:2633 ../src/guestfs-actions.pod:3920 msgid "" -"Return the complete queue of events that have happened since the previous " -"read call." +"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 #. type: textblock -#: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1669 -msgid "If no events have happened, this returns an empty list." +#: ../fish/guestfish-actions.pod:2637 ../src/guestfs-actions.pod:3924 +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: verbatim +#: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3928 +#, no-wrap +msgid "" +" \"/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 #. type: textblock -#: ../src/guestfs-actions.pod:2485 ../fish/guestfish-actions.pod:1671 +#: ../fish/guestfish-actions.pod:2646 ../src/guestfs-actions.pod:3933 msgid "" -"I: 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." +"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 #. type: textblock -#: ../src/guestfs-actions.pod:2491 +#: ../fish/guestfish-actions.pod:2650 msgid "" -"This function returns a C, or NULL if " -"there was an error. I after use>." +"This command runs other libguestfs commands, which might include L " +"and L, and therefore you should use this soon after launch and only " +"when nothing is mounted." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:2654 +msgid "" +"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 to look for OSes)." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2497 -msgid "guestfs_inotify_rm_watch" +#: ../fish/guestfish-actions.pod:2662 +msgid "list-partitions" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2499 +#: ../fish/guestfish-actions.pod:2664 #, no-wrap msgid "" -" int\n" -" guestfs_inotify_rm_watch (guestfs_h *g,\n" -" int wd);\n" +" list-partitions\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2503 +#: ../fish/guestfish-actions.pod:2666 ../src/guestfs-actions.pod:3962 +msgid "List all the partitions detected on all block devices." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:2668 ../src/guestfs-actions.pod:3964 +msgid "The full partition device names are returned, eg. C" +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:2670 msgid "" -"Remove a previously defined inotify watch. See C." +"This does not return logical volumes. For that you will need to call L." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2510 -msgid "guestfs_inspect_get_arch" +#: ../fish/guestfish-actions.pod:2675 +msgid "ll" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2512 +#: ../fish/guestfish-actions.pod:2677 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_arch (guestfs_h *g,\n" -" const char *root);\n" +" ll directory\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2539 -#: ../src/guestfs-actions.pod:2624 ../src/guestfs-actions.pod:2668 -#: ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2733 -#: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2782 -#: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2846 -#: ../src/guestfs-actions.pod:2875 ../src/guestfs-actions.pod:2906 -#: ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:2985 -#: ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3048 -#: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3088 -#: ../src/guestfs-actions.pod:3105 ../src/guestfs-actions.pod:3124 +#: ../fish/guestfish-actions.pod:2679 ../src/guestfs-actions.pod:3983 msgid "" -"This function should only be called with a root device string as returned by " -"C." +"List the files in C (relative to the root directory, there is no " +"cwd) in the format of 'ls -la'." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2519 +#: ../fish/guestfish-actions.pod:2682 ../src/guestfs-actions.pod:3986 msgid "" -"This returns the architecture of the inspected operating system. The " -"possible return values are listed under C." +"This command is mostly useful for interactive sessions. It is I " +"intended that you try to parse the output string." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1695 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2685 +msgid "ln" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2687 +#, no-wrap msgid "" -"If the architecture could not be determined, then the string C is " -"returned." +" ln target linkname\n" +"\n" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2611 -#: ../src/guestfs-actions.pod:2722 ../src/guestfs-actions.pod:2742 -#: ../src/guestfs-actions.pod:2770 ../src/guestfs-actions.pod:2862 -#: ../src/guestfs-actions.pod:2893 ../src/guestfs-actions.pod:2917 -#: ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:3014 -#: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3058 -#: ../src/guestfs-actions.pod:3078 ../src/guestfs-actions.pod:3095 -#: ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3217 -#: ../src/guestfs-actions.pod:3258 ../fish/guestfish-actions.pod:1698 -#: ../fish/guestfish-actions.pod:1776 ../fish/guestfish-actions.pod:1864 -#: ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1900 -#: ../fish/guestfish-actions.pod:1970 ../fish/guestfish-actions.pod:1994 -#: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2054 -#: ../fish/guestfish-actions.pod:2089 ../fish/guestfish-actions.pod:2105 -#: ../fish/guestfish-actions.pod:2121 ../fish/guestfish-actions.pod:2134 -#: ../fish/guestfish-actions.pod:2147 ../fish/guestfish-actions.pod:2162 -#: ../fish/guestfish-actions.pod:2261 ../fish/guestfish-actions.pod:2295 -msgid "Please read L for more details." +#. type: textblock +#: ../fish/guestfish-actions.pod:2689 ../src/guestfs-actions.pod:4001 +msgid "This command creates a hard link using the C command." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2533 -msgid "guestfs_inspect_get_distro" +#: ../fish/guestfish-actions.pod:2691 +msgid "ln-f" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2535 +#: ../fish/guestfish-actions.pod:2693 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_distro (guestfs_h *g,\n" -" const char *root);\n" +" ln-f target linkname\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1707 +#: ../fish/guestfish-actions.pod:2695 ../src/guestfs-actions.pod:4014 msgid "" -"This returns the distro (distribution) of the inspected operating system." +"This command creates a hard link using the C command. The I<-f> " +"option removes the link (C) if it exists already." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2545 ../fish/guestfish-actions.pod:1710 -msgid "Currently defined distros are:" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2698 +msgid "ln-s" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2549 ../fish/guestfish-actions.pod:1714 -msgid "\"archlinux\"" +#. type: verbatim +#: ../fish/guestfish-actions.pod:2700 +#, no-wrap +msgid "" +" ln-s target linkname\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2551 ../fish/guestfish-actions.pod:1716 -msgid "Arch Linux." +#: ../fish/guestfish-actions.pod:2702 ../src/guestfs-actions.pod:4028 +msgid "This command creates a symbolic link using the C command." msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1718 -msgid "\"debian\"" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2704 +msgid "ln-sf" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2555 ../fish/guestfish-actions.pod:1720 -msgid "Debian." +#. type: verbatim +#: ../fish/guestfish-actions.pod:2706 +#, no-wrap +msgid "" +" ln-sf target linkname\n" +"\n" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2557 ../fish/guestfish-actions.pod:1722 -msgid "\"fedora\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:2708 ../src/guestfs-actions.pod:4041 +msgid "" +"This command creates a symbolic link using the C command, The I<-f> " +"option removes the link (C) if it exists already." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2559 ../fish/guestfish-actions.pod:1724 -msgid "Fedora." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2711 +msgid "lremovexattr" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2561 ../fish/guestfish-actions.pod:1726 -msgid "\"gentoo\"" +#. type: verbatim +#: ../fish/guestfish-actions.pod:2713 +#, no-wrap +msgid "" +" lremovexattr xattr path\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2563 ../fish/guestfish-actions.pod:1728 -msgid "Gentoo." +#: ../fish/guestfish-actions.pod:2715 +msgid "" +"This is the same as L, but if C is a symbolic link, then " +"it removes an extended attribute of the link itself." msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2565 ../fish/guestfish-actions.pod:1730 -msgid "\"linuxmint\"" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2719 +msgid "ls" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2567 ../fish/guestfish-actions.pod:1732 -msgid "Linux Mint." -msgstr "" - -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2569 ../fish/guestfish-actions.pod:1734 -msgid "\"mandriva\"" +#. type: verbatim +#: ../fish/guestfish-actions.pod:2721 +#, no-wrap +msgid "" +" ls directory\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2571 ../fish/guestfish-actions.pod:1736 -msgid "Mandriva." -msgstr "" - -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2573 ../fish/guestfish-actions.pod:1738 -msgid "\"meego\"" +#: ../fish/guestfish-actions.pod:2723 ../src/guestfs-actions.pod:4069 +msgid "" +"List the files in C (relative to the root directory, there is no " +"cwd). The '.' and '..' entries are not returned, but hidden files are shown." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1740 -msgid "MeeGo." -msgstr "" - -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1742 -msgid "\"pardus\"" +#: ../fish/guestfish-actions.pod:2727 +msgid "" +"This command is mostly useful for interactive sessions. Programs should " +"probably use L instead." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2579 ../fish/guestfish-actions.pod:1744 -msgid "Pardus." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2730 +msgid "lsetxattr" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:1746 -msgid "\"redhat-based\"" +#. type: verbatim +#: ../fish/guestfish-actions.pod:2732 +#, no-wrap +msgid "" +" lsetxattr xattr val vallen path\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2583 ../fish/guestfish-actions.pod:1748 -msgid "Some Red Hat-derived distro." -msgstr "" - -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2585 ../fish/guestfish-actions.pod:1750 -msgid "\"rhel\"" +#: ../fish/guestfish-actions.pod:2734 +msgid "" +"This is the same as L, but if C is a symbolic link, then it " +"sets an extended attribute of the link itself." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2587 ../fish/guestfish-actions.pod:1752 -msgid "Red Hat Enterprise Linux and some derivatives." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2738 +msgid "lstat" msgstr "" -#. type: =item -#: ../src/guestfs-actions.pod:2589 ../fish/guestfish-actions.pod:1754 -msgid "\"slackware\"" +#. type: verbatim +#: ../fish/guestfish-actions.pod:2740 +#, no-wrap +msgid "" +" lstat path\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2591 ../fish/guestfish-actions.pod:1756 -msgid "Slackware." +#: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:4552 +#: ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:6890 +msgid "Returns file information for the given C." msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1758 -msgid "\"ubuntu\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:2744 +msgid "" +"This is the same as L except that if C is a symbolic link, then " +"the link is stat-ed, not the file it refers to." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2595 ../fish/guestfish-actions.pod:1760 -msgid "Ubuntu." +#: ../fish/guestfish-actions.pod:2748 ../src/guestfs-actions.pod:4111 +msgid "This is the same as the C system call." msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2713 -#: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:1762 -#: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:2080 -msgid "\"unknown\"" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2750 +msgid "lstatlist" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1764 -msgid "The distro could not be determined." +#. type: verbatim +#: ../fish/guestfish-actions.pod:2752 +#, no-wrap +msgid "" +" lstatlist path 'names ...'\n" +"\n" msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2997 -#: ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:2072 -msgid "\"windows\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:2754 +msgid "" +"This call allows you to perform the L operation on multiple files, " +"where all files are in the directory C. C is the list of files " +"from this directory." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2603 ../fish/guestfish-actions.pod:1768 +#: ../fish/guestfish-actions.pod:2758 ../src/guestfs-actions.pod:4130 msgid "" -"Windows does not have distributions. This string is returned if the OS type " -"is Windows." +"On return you get a list of stat structs, with a one-to-one correspondence " +"to the C list. If any name did not exist or could not be lstat'd, " +"then the C field of that structure is set to C<-1>." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2719 -#: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:1773 -#: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:2086 +#: ../fish/guestfish-actions.pod:2763 msgid "" -"Future versions of libguestfs may return other strings here. The caller " -"should be prepared to handle any string." +"This call is intended for programs that want to efficiently list a directory " +"contents without making many round-trips. See also L 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:2618 -msgid "guestfs_inspect_get_drive_mappings" +#: ../fish/guestfish-actions.pod:2771 +msgid "luks-add-key" msgstr "" #. type: verbatim -#: ../src/guestfs-actions.pod:2620 +#: ../fish/guestfish-actions.pod:2773 #, no-wrap msgid "" -" char **\n" -" guestfs_inspect_get_drive_mappings (guestfs_h *g,\n" -" const char *root);\n" +" luks-add-key device keyslot\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2627 ../fish/guestfish-actions.pod:1785 +#: ../fish/guestfish-actions.pod:2775 ../src/guestfs-actions.pod:4158 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:" +"This command adds a new key on LUKS device C. C is any " +"existing key, and is used to access the device. C is the new key to " +"add. C is the key slot that will be replaced." msgstr "" -#. type: verbatim -#: ../src/guestfs-actions.pod:2633 ../fish/guestfish-actions.pod:1791 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2780 msgid "" -" C => /dev/vda2\n" -" E => /dev/vdb1\n" -" F => /dev/vdc1\n" -"\n" +"Note that if C already contains a key, then this command will " +"fail. You have to use L first to remove that key." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2637 ../fish/guestfish-actions.pod:1795 +#: ../fish/guestfish-actions.pod:2784 ../fish/guestfish-actions.pod:2806 +#: ../fish/guestfish-actions.pod:2819 ../fish/guestfish-actions.pod:2833 +#: ../fish/guestfish-actions.pod:2859 ../fish/guestfish-actions.pod:2869 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." +"This command has one or more key or passphrase parameters. Guestfish will " +"prompt for these separately." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:2641 ../fish/guestfish-actions.pod:1799 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2787 +msgid "luks-close" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2789 +#, no-wrap 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, " -"C

etc." +" luks-close device\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1804 +#: ../fish/guestfish-actions.pod:2791 msgid "" -"For Windows guests, currently only hard drive mappings are returned. " -"Removable disks (eg. DVD-ROMs) are ignored." +"This closes a LUKS device that was created earlier by L or L. The C parameter must be the name of the LUKS mapping " +"device (ie. C) and I the name of the underlying " +"block device." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:2649 ../fish/guestfish-actions.pod:1807 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2797 +msgid "luks-format" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2799 +#, no-wrap msgid "" -"For guests that do not use drive mappings, or if the drive mappings could " -"not be determined, this returns an empty hash table." +" luks-format device keyslot\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2652 +#: ../fish/guestfish-actions.pod:2801 ../src/guestfs-actions.pod:4199 msgid "" -"Please read L for more details. See also " -"C, C." +"This command erases existing data on C and formats the device as a " +"LUKS encrypted device. C is the initial key, which is added to key " +"slot C. (LUKS supports 8 key slots, numbered 0-7)." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2656 ../src/guestfs-actions.pod:2832 -#: ../src/guestfs-actions.pod:3592 ../src/guestfs-actions.pod:4802 -#: ../src/guestfs-actions.pod:6707 +#: ../fish/guestfish-actions.pod:2809 ../fish/guestfish-actions.pod:2822 +#: ../fish/guestfish-actions.pod:2909 ../fish/guestfish-actions.pod:3560 +#: ../fish/guestfish-actions.pod:4086 ../fish/guestfish-actions.pod:4423 +#: ../fish/guestfish-actions.pod:4446 ../fish/guestfish-actions.pod:4468 +#: ../fish/guestfish-actions.pod:5214 ../src/guestfs-actions.pod:4206 +#: ../src/guestfs-actions.pod:4229 ../src/guestfs-actions.pod:4372 +#: ../src/guestfs-actions.pod:5465 ../src/guestfs-actions.pod:6253 +#: ../src/guestfs-actions.pod:6704 ../src/guestfs-actions.pod:6734 +#: ../src/guestfs-actions.pod:6767 ../src/guestfs-actions.pod:7966 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 keys and values alternate, followed by the trailing NULL entry. I." +"B." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2662 -msgid "guestfs_inspect_get_filesystems" +#: ../fish/guestfish-actions.pod:2812 +msgid "luks-format-cipher" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2664 +#: ../fish/guestfish-actions.pod:2814 #, no-wrap msgid "" -" char **\n" -" guestfs_inspect_get_filesystems (guestfs_h *g,\n" -" const char *root);\n" +" luks-format-cipher device keyslot cipher\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:1821 +#: ../fish/guestfish-actions.pod:2816 msgid "" -"This returns a list of all the filesystems that we think are associated with " -"this operating system. This includes the root filesystem, other ordinary " -"filesystems, and non-mounted devices like swap partitions." +"This command is the same as L but it also allows you to set " +"the C used." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2676 ../fish/guestfish-actions.pod:1826 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2825 +msgid "luks-kill-slot" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2827 +#, no-wrap msgid "" -"In the case of a multi-boot virtual machine, it is possible for a filesystem " -"to be shared between operating systems." +" luks-kill-slot device keyslot\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2679 +#: ../fish/guestfish-actions.pod:2829 ../src/guestfs-actions.pod:4246 msgid "" -"Please read L for more details. See also " -"C." +"This command deletes the key in key slot C from the encrypted LUKS " +"device C. C must be one of the I keys." msgstr "" #. type: =head2 -#: ../src/guestfs-actions.pod:2688 -msgid "guestfs_inspect_get_format" +#: ../fish/guestfish-actions.pod:2836 +msgid "luks-open" msgstr "" #. type: verbatim -#: ../src/guestfs-actions.pod:2690 +#: ../fish/guestfish-actions.pod:2838 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_format (guestfs_h *g,\n" -" const char *root);\n" +" luks-open device mapname\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2697 ../fish/guestfish-actions.pod:1839 +#: ../fish/guestfish-actions.pod:2840 ../src/guestfs-actions.pod:4266 msgid "" -"This returns the format of the inspected operating system. You can use it " -"to detect install images, live CDs and similar." +"This command opens a block device which has been encrypted according to the " +"Linux Unified Key Setup (LUKS) standard." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1842 -msgid "Currently defined formats are:" -msgstr "" - -#. type: =item -#: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1846 -msgid "\"installed\"" +#: ../fish/guestfish-actions.pod:2843 ../src/guestfs-actions.pod:4269 +msgid "C is the encrypted block device or partition." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1848 -msgid "This is an installed operating system." +#: ../fish/guestfish-actions.pod:2845 ../src/guestfs-actions.pod:4271 +msgid "" +"The caller must supply one of the keys associated with the LUKS block " +"device, in the C parameter." msgstr "" -#. type: =item -#: ../src/guestfs-actions.pod:2708 ../fish/guestfish-actions.pod:1850 -msgid "\"installer\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:2848 ../src/guestfs-actions.pod:4274 +msgid "" +"This creates a new block device called C. Reads and " +"writes to this block device are decrypted from and encrypted to the " +"underlying C respectively." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2710 ../fish/guestfish-actions.pod:1852 +#: ../fish/guestfish-actions.pod:2852 msgid "" -"The disk image being inspected is not an installed operating system, but a " -"I install disk, live CD, or similar." +"If this block device contains LVM volume groups, then calling L " +"followed by L will make them visible." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2715 ../fish/guestfish-actions.pod:1857 -msgid "The format of this disk image is not known." +#: ../fish/guestfish-actions.pod:2856 +msgid "Use L to list all device mapper devices." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2727 -msgid "guestfs_inspect_get_hostname" +#: ../fish/guestfish-actions.pod:2862 +msgid "luks-open-ro" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2729 +#: ../fish/guestfish-actions.pod:2864 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_hostname (guestfs_h *g,\n" -" const char *root);\n" +" luks-open-ro device mapname\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1873 +#: ../fish/guestfish-actions.pod:2866 msgid "" -"This function returns the hostname of the operating system as found by " -"inspection of the guest's configuration files." +"This is the same as L except that a read-only mapping is created." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1876 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2872 +msgid "lvcreate" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2874 +#, no-wrap msgid "" -"If the hostname could not be determined, then the string C is " -"returned." +" lvcreate logvol volgroup mbytes\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2747 -msgid "(Added in 1.7.9)" +#: ../fish/guestfish-actions.pod:2876 ../src/guestfs-actions.pod:4320 +msgid "" +"This creates an LVM logical volume called C on the volume group " +"C, with C megabytes." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2749 -msgid "guestfs_inspect_get_major_version" +#: ../fish/guestfish-actions.pod:2879 +msgid "lvm-canonical-lv-name" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2751 +#: ../fish/guestfish-actions.pod:2881 #, no-wrap msgid "" -" int\n" -" guestfs_inspect_get_major_version (guestfs_h *g,\n" -" const char *root);\n" +" lvm-canonical-lv-name lvname\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1888 +#: ../fish/guestfish-actions.pod:2883 ../src/guestfs-actions.pod:4333 msgid "" -"This returns the major version number of the inspected operating system." -msgstr "" - -# type: textblock +"This converts alternative naming schemes for LVs that you might find to the " +"canonical name. For example, C is converted to C." +msgstr "" + #. type: textblock -#: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1891 +#: ../fish/guestfish-actions.pod:2887 ../src/guestfs-actions.pod:4337 msgid "" -"Windows uses a consistent versioning scheme which is I reflected in the " -"popular public names used by the operating system. Notably the operating " -"system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = " -"1). You can find out the real versions corresponding to releases of Windows " -"by consulting Wikipedia or MSDN." +"This command returns an error if the C parameter does not refer to a " +"logical volume." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2768 ../src/guestfs-actions.pod:2788 -#: ../fish/guestfish-actions.pod:1898 ../fish/guestfish-actions.pod:1912 -msgid "If the version could not be determined, then C<0> is returned." +#: ../fish/guestfish-actions.pod:2890 +msgid "See also L." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2776 -msgid "guestfs_inspect_get_minor_version" +#: ../fish/guestfish-actions.pod:2892 +msgid "lvm-clear-filter" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2778 +#: ../fish/guestfish-actions.pod:2894 #, no-wrap msgid "" -" int\n" -" guestfs_inspect_get_minor_version (guestfs_h *g,\n" -" const char *root);\n" +" lvm-clear-filter\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1909 +#: ../fish/guestfish-actions.pod:2896 msgid "" -"This returns the minor version number of the inspected operating system." +"This undoes the effect of L. LVM will be able to see every " +"block device." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2790 +#: ../fish/guestfish-actions.pod:2899 ../fish/guestfish-actions.pod:2930 +#: ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4397 msgid "" -"Please read L for more details. See also " -"C." +"This command also clears the LVM cache and performs a volume group scan." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2797 -msgid "guestfs_inspect_get_mountpoints" +#: ../fish/guestfish-actions.pod:2902 +msgid "lvm-remove-all" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2799 +#: ../fish/guestfish-actions.pod:2904 #, no-wrap msgid "" -" char **\n" -" guestfs_inspect_get_mountpoints (guestfs_h *g,\n" -" const char *root);\n" +" lvm-remove-all\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1924 +#: ../fish/guestfish-actions.pod:2906 ../src/guestfs-actions.pod:4367 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. I 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." +"This command removes all LVM logical volumes, volume groups and physical " +"volumes." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2815 ../fish/guestfish-actions.pod:1933 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2912 +msgid "lvm-set-filter" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2914 +#, no-wrap msgid "" -"Each element in the returned hashtable has a key which is the path of the " -"mountpoint (eg. C) and a value which is the filesystem that would be " -"mounted there (eg. C)." +" lvm-set-filter 'devices ...'\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1938 +#: ../fish/guestfish-actions.pod:2916 ../src/guestfs-actions.pod:4383 msgid "" -"Non-mounted devices such as swap devices are I returned in this list." +"This sets the LVM device filter so that LVM will only be able to \"see\" the " +"block devices in the list C, and will ignore all other attached " +"block devices." msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2823 +#: ../fish/guestfish-actions.pod:2920 ../src/guestfs-actions.pod:4387 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." +"Where disk image(s) contain duplicate PVs or VGs, this command is useful to " +"get LVM to ignore the duplicates, otherwise LVM can get confused. Note also " +"there are two types of duplication possible: either cloned PVs/VGs which " +"have identical UUIDs; or VGs that are not cloned but just happen to have the " +"same name. In normal operation you cannot create this situation, but you " +"can do it outside LVM, eg. by cloning disk images or by bit twiddling " +"inside the LVM metadata." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:2933 ../src/guestfs-actions.pod:4400 +msgid "You can filter whole block devices or individual partitions." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2829 +#: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4402 msgid "" -"Please read L for more details. See also " -"C." +"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 #. type: =head2 -#: ../src/guestfs-actions.pod:2840 -msgid "guestfs_inspect_get_package_format" +#: ../fish/guestfish-actions.pod:2939 +msgid "lvremove" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2842 +#: ../fish/guestfish-actions.pod:2941 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_package_format (guestfs_h *g,\n" -" const char *root);\n" +" lvremove device\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2849 +#: ../fish/guestfish-actions.pod:2943 ../src/guestfs-actions.pod:4416 msgid "" -"This function and C return the " -"package format and package management tool used by the inspected operating " -"system. For example for Fedora these functions would return C (package " -"format) and C (package management)." +"Remove an LVM logical volume C, where C is the path to the " +"LV, such as C." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1963 +#: ../fish/guestfish-actions.pod:2946 ../src/guestfs-actions.pod:4419 msgid "" -"This returns the string C if we could not determine the package " -"format I if the operating system does not have a real packaging system " -"(eg. Windows)." +"You can also remove all LVs in a volume group by specifying the VG name, C." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1967 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2949 +msgid "lvrename" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2951 +#, no-wrap msgid "" -"Possible strings include: C, C, C, C, C. " -"Future versions of libguestfs may return other strings." +" lvrename logvol newlogvol\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2898 -msgid "(Added in 1.7.5)" +#: ../fish/guestfish-actions.pod:2953 ../src/guestfs-actions.pod:4433 +msgid "Rename a logical volume C with the new name C." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2869 -msgid "guestfs_inspect_get_package_management" +#: ../fish/guestfish-actions.pod:2955 +msgid "lvresize" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2871 +#: ../fish/guestfish-actions.pod:2957 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_package_management (guestfs_h *g,\n" -" const char *root);\n" +" lvresize device mbytes\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2878 +#: ../fish/guestfish-actions.pod:2959 ../src/guestfs-actions.pod:4446 msgid "" -"C 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 (package format) " -"and C (package management)." +"This resizes (expands or shrinks) an existing LVM logical volume to " +"C. When reducing, data in the reduced part is lost." msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1985 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2963 +msgid "lvresize-free" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2965 +#, no-wrap msgid "" -"This returns the string C if we could not determine the package " -"management tool I if the operating system does not have a real packaging " -"system (eg. Windows)." +" lvresize-free lv percent\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2888 ../fish/guestfish-actions.pod:1989 +#: ../fish/guestfish-actions.pod:2967 ../src/guestfs-actions.pod:4461 msgid "" -"Possible strings include: C, C, C (for all Debian " -"derivatives), C, C, C, C. Future versions of " -"libguestfs may return other strings." +"This expands an existing logical volume C so that it fills C% 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 #. type: =head2 -#: ../src/guestfs-actions.pod:2900 -msgid "guestfs_inspect_get_product_name" +#: ../fish/guestfish-actions.pod:2973 +msgid "lvs" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2902 +#: ../fish/guestfish-actions.pod:2975 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_product_name (guestfs_h *g,\n" -" const char *root);\n" +" lvs\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2003 +#: ../fish/guestfish-actions.pod:2977 ../src/guestfs-actions.pod:4476 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." +"List all the logical volumes detected. This is the equivalent of the L command." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2008 +#: ../fish/guestfish-actions.pod:2980 ../src/guestfs-actions.pod:4479 msgid "" -"If the product name could not be determined, then the string C is " -"returned." +"This returns a list of the logical volume device names (eg. C)." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:2983 +msgid "See also L, L." msgstr "" #. type: =head2 -#: ../src/guestfs-actions.pod:2924 -msgid "guestfs_inspect_get_product_variant" +#: ../fish/guestfish-actions.pod:2985 +msgid "lvs-full" msgstr "" #. type: verbatim -#: ../src/guestfs-actions.pod:2926 +#: ../fish/guestfish-actions.pod:2987 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_product_variant (guestfs_h *g,\n" -" const char *root);\n" +" lvs-full\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2020 -msgid "This returns the product variant of the inspected operating system." -msgstr "" - -#. type: textblock -#: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2023 +#: ../fish/guestfish-actions.pod:2989 ../src/guestfs-actions.pod:4495 msgid "" -"For Windows guests, this returns the contents of the Registry key C C which " -"is usually a string such as C or C (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 and " -"the latter is C)." +"List all the logical volumes detected. This is the equivalent of the L command. The \"full\" version includes all fields." msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2032 -msgid "" -"For enterprise Linux guests, in future we intend this to return the product " -"variant such as C, C and so on. But this is not " -"implemented at present." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2992 +msgid "lvuuid" msgstr "" -#. type: textblock -#: ../src/guestfs-actions.pod:2949 ../fish/guestfish-actions.pod:2036 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2994 +#, no-wrap msgid "" -"If the product variant could not be determined, then the string C " -"is returned." +" lvuuid device\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:2952 -msgid "" -"Please read L for more details. See also " -"C, C." +#: ../fish/guestfish-actions.pod:2996 ../src/guestfs-actions.pod:4510 +msgid "This command returns the UUID of the LVM LV C." msgstr "" -# type: =head2 #. type: =head2 -#: ../src/guestfs-actions.pod:2959 -msgid "guestfs_inspect_get_roots" +#: ../fish/guestfish-actions.pod:2998 +msgid "lxattrlist" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2961 +#: ../fish/guestfish-actions.pod:3000 #, no-wrap msgid "" -" char **\n" -" guestfs_inspect_get_roots (guestfs_h *g);\n" +" lxattrlist path 'names ...'\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2964 +#: ../fish/guestfish-actions.pod:3002 ../src/guestfs-actions.pod:4524 msgid "" -"This function is a convenient way to get the list of root devices, as " -"returned from a previous call to C, but without redoing " -"the whole inspection process." +"This call allows you to get the extended attributes of multiple files, where " +"all files are in the directory C. C is the list of files from " +"this directory." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2968 +#: ../fish/guestfish-actions.pod:3006 ../src/guestfs-actions.pod:4528 msgid "" -"This returns an empty list if either no root devices were found or the " -"caller has not called C." +"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. " +"C in this struct is zero-length to indicate there was an error " +"doing C for this file, I is a C string which is a decimal " +"number (the number of following attributes for this file, which could be C<" +"\"0\">). Then after the first xattr struct are the zero or more attributes " +"for the first named file. This repeats for the second and subsequent files." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2977 -msgid "(Added in 1.7.3)" +#: ../fish/guestfish-actions.pod:3016 +msgid "" +"This call is intended for programs that want to efficiently list a directory " +"contents without making many round-trips. See also L 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 #. type: =head2 -#: ../src/guestfs-actions.pod:2979 -msgid "guestfs_inspect_get_type" +#: ../fish/guestfish-actions.pod:3024 +msgid "mkdir" msgstr "" -# type: verbatim #. type: verbatim -#: ../src/guestfs-actions.pod:2981 +#: ../fish/guestfish-actions.pod:3026 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_type (guestfs_h *g,\n" -" const char *root);\n" +" mkdir path\n" "\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2063 -msgid "" -"This returns the type of the inspected operating system. Currently defined " -"types are:" +#: ../fish/guestfish-actions.pod:3028 ../src/guestfs-actions.pod:4558 +msgid "Create a directory named C." msgstr "" -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2068 -msgid "\"linux\"" +#. type: =head2 +#: ../fish/guestfish-actions.pod:3030 +msgid "mkdir-mode" msgstr "" -# type: textblock -#. type: textblock -#: ../src/guestfs-actions.pod:2995 ../fish/guestfish-actions.pod:2070 -msgid "Any Linux-based operating system." +#. type: verbatim +#: ../fish/guestfish-actions.pod:3032 +#, no-wrap +msgid "" +" mkdir-mode path mode\n" +"\n" msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:2999 ../fish/guestfish-actions.pod:2074 -msgid "Any Microsoft Windows operating system." -msgstr "" - -# type: =item -#. type: =item -#: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2076 -msgid "\"freebsd\"" +#: ../fish/guestfish-actions.pod:3034 ../src/guestfs-actions.pod:4571 +msgid "" +"This command creates a directory, setting the initial permissions of the " +"directory to C." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:3003 ../fish/guestfish-actions.pod:2078 -msgid "FreeBSD." +#: ../fish/guestfish-actions.pod:3037 ../src/guestfs-actions.pod:4574 +msgid "" +"For common Linux filesystems, the actual mode which is set will be C. Non-native-Linux filesystems may interpret the mode in " +"other ways." msgstr "" -# type: textblock #. type: textblock -#: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2082 -msgid "The operating system type could not be determined." +#: ../fish/guestfish-actions.pod:3041 +msgid "See also L, L" msgstr "" #. type: =head2 -#: ../src/guestfs-actions.pod:3021 -msgid "guestfs_inspect_get_windows_current_control_set" +#: ../fish/guestfish-actions.pod:3043 +msgid "mkdir-p" msgstr "" #. type: verbatim -#: ../src/guestfs-actions.pod:3023 +#: ../fish/guestfish-actions.pod:3045 #, no-wrap msgid "" -" char *\n" -" guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n" -" const char *root);\n" +" mkdir-p path\n" "\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:3030 ../fish/guestfish-actions.pod:2098 +#: ../fish/guestfish-actions.pod:3047 ../src/guestfs-actions.pod:4590 msgid "" -"This returns the Windows CurrentControlSet of the inspected guest. The " -"CurrentControlSet is a registry key name such as C." +"Create a directory named C, creating any parent directories as " +"necessary. This is like the C shell command." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:3050 +msgid "mkdtemp" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:3052 +#, no-wrap +msgid "" +" mkdtemp template\n" +"\n" msgstr "" #. type: textblock -#: ../src/guestfs-actions.pod:3033 ../fish/guestfish-actions.pod:2101 +#: ../fish/guestfish-actions.pod:3054 ../src/guestfs-actions.pod:4603 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." +"This command creates a temporary directory. The C