X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=po-docs%2Fja.po;h=c5c65aa41c2279bfda4219438c25db4882f86bc5;hp=e6ad7e49fe2c4fb61c223c2e6a45352558ccf04c;hb=4abb239dcc7b1d235783bb0b5e417c4b88b00fea;hpb=0e896a490c46825e2ef998143d338dda5736223e diff --git a/po-docs/ja.po b/po-docs/ja.po index e6ad7e4..c5c65aa 100644 --- a/po-docs/ja.po +++ b/po-docs/ja.po @@ -1,27040 +1,38838 @@ -# 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: 2010-10-27 12:50+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-04 19:22+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" - -# type: =encoding -#: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 -#: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 -#: ../inspector/virt-inspector.pl:36 ../tools/virt-edit.pl:31 -#: ../tools/virt-win-reg.pl:34 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:31 -#: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 -#: ../tools/virt-cat.pl:30 ../tools/virt-tar.pl:30 ../tools/virt-rescue.pl:29 -#: ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28 -msgid "utf8" -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 -#: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 -#: ../inspector/virt-inspector.pl:38 ../tools/virt-edit.pl:33 -#: ../tools/virt-win-reg.pl:36 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:33 -#: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 -#: ../tools/virt-cat.pl:32 ../tools/virt-tar.pl:32 ../tools/virt-rescue.pl:31 -#: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30 +"Plural-Forms: nplurals=1; plural=0\n" + +#. type: =head1 +#: ../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 -#: ../src/guestfs.pod:5 -msgid "guestfs - Library for accessing and modifying virtual machine images" +#. type: textblock +#: ../cat/virt-cat.pod:5 +msgid "virt-cat - Display files in a virtual machine" +msgstr "" + +#. type: =head1 +#: ../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: =head1 -#: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 -#: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 -#: ../inspector/virt-inspector.pl:42 ../tools/virt-edit.pl:37 -#: ../tools/virt-win-reg.pl:40 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:37 -#: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 -#: ../tools/virt-cat.pl:36 ../tools/virt-tar.pl:36 ../tools/virt-rescue.pl:35 -#: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34 -msgid "SYNOPSIS" +#. type: verbatim +#: ../cat/virt-cat.pod:9 +#, no-wrap +msgid "" +" virt-cat [--options] -d domname file [file ...]\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:9 +#. type: verbatim +#: ../cat/virt-cat.pod:11 #, no-wrap msgid "" -" #include \n" -" \n" +" virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:11 +#. type: textblock +#: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15 +#: ../inspector/virt-inspector.pod:13 +msgid "Old-style:" +msgstr "" + +#. type: verbatim +#: ../cat/virt-cat.pod:15 #, no-wrap msgid "" -" guestfs_h *g = guestfs_create ();\n" -" guestfs_add_drive (g, \"guest.img\");\n" -" guestfs_launch (g);\n" -" guestfs_mount (g, \"/dev/sda1\", \"/\");\n" -" guestfs_touch (g, \"/hello\");\n" -" guestfs_umount (g, \"/\");\n" -" guestfs_sync (g);\n" -" guestfs_close (g);\n" +" virt-cat domname file\n" "\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:20 +#. type: verbatim +#: ../cat/virt-cat.pod:17 #, no-wrap msgid "" -" cc prog.c -o prog -lguestfs\n" -"or:\n" -" cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n" +" virt-cat disk.img file\n" "\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 -#: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 -#: ../inspector/virt-inspector.pl:48 ../tools/virt-edit.pl:51 -#: ../tools/virt-win-reg.pl:64 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:43 -#: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 -#: ../tools/virt-cat.pl:42 ../tools/virt-tar.pl:73 ../tools/virt-rescue.pl:51 -#: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40 +#. type: =head1 +#: ../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 -#: ../src/guestfs.pod:26 +#. type: textblock +#: ../cat/virt-cat.pod:21 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." +"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 -#: ../src/guestfs.pod:34 +#. type: textblock +#: ../cat/virt-cat.pod:24 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." +"Multiple filenames can be given, in which case they are concatenated " +"together. Each filename must be a full path, starting at the root directory " +"(starting with '/')." msgstr "" -# type: textblock -#: ../src/guestfs.pod:39 +#. type: textblock +#: ../cat/virt-cat.pod:28 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." +"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: textblock -#: ../src/guestfs.pod:44 -msgid "" -"Libguestfs is a library that can be linked with C and C++ management " -"programs (or management programs written in OCaml, Perl, Python, Ruby, Java, " -"PHP, Haskell or C#). You can also use it from shell scripts or the command " -"line." +#. type: =head1 +#: ../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:49 +#. type: textblock +#: ../cat/virt-cat.pod:34 msgid "" -"You don't need to be root to use libguestfs, although obviously you do need " -"enough permissions to access the disk images." +"Display C file from inside the libvirt VM called C:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:52 +#. type: verbatim +#: ../cat/virt-cat.pod:37 +#, no-wrap msgid "" -"Libguestfs is a large API because it can do many things. For a gentle " -"introduction, please read the L section next." +" virt-cat -d mydomain /etc/fstab\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:55 -msgid "API OVERVIEW" +#. type: textblock +#: ../cat/virt-cat.pod:39 +msgid "List syslog messages from a VM disk image file:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:57 +#. type: verbatim +#: ../cat/virt-cat.pod:41 +#, no-wrap msgid "" -"This section provides a gentler overview of the libguestfs API. We also try " -"to group API calls together, where that may not be obvious from reading " -"about the individual calls in the main section of this manual." +" virt-cat -a disk.img /var/log/messages | tail\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:62 -msgid "HANDLES" +#. type: textblock +#: ../cat/virt-cat.pod:43 +msgid "Find out what DHCP IP address a VM acquired:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:64 +#. type: verbatim +#: ../cat/virt-cat.pod:45 +#, no-wrap 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." +" virt-cat -d mydomain /var/log/messages | \\\n" +" grep 'dhclient: bound to' | tail\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:71 -msgid "The general structure of all libguestfs-using programs looks like this:" +#. type: textblock +#: ../cat/virt-cat.pod:48 +msgid "Find out what packages were recently installed:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:74 +#. type: verbatim +#: ../cat/virt-cat.pod:50 #, no-wrap msgid "" -" guestfs_h *g = guestfs_create ();\n" -" \n" +" virt-cat -d mydomain /var/log/yum.log | tail\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:76 -#, no-wrap -msgid "" -" /* Call guestfs_add_drive additional times if there are\n" -" * multiple disk images.\n" -" */\n" -" guestfs_add_drive (g, \"guest.img\");\n" -" \n" +#. type: textblock +#: ../cat/virt-cat.pod:52 +msgid "Find out who is logged on inside a virtual machine:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:81 +#. type: verbatim +#: ../cat/virt-cat.pod:54 #, 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" +" virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n" +" who /tmp/utmp\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:87 +#. type: textblock +#: ../cat/virt-cat.pod:57 +msgid "or who was logged on:" +msgstr "" + +#. type: verbatim +#: ../cat/virt-cat.pod:59 #, no-wrap msgid "" -" /* Now you can examine what partitions, LVs etc are available.\n" -" */\n" -" char **partitions = guestfs_list_partitions (g);\n" -" char **logvols = guestfs_lvs (g);\n" -" \n" +" virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n" +" last -f /tmp/wtmp\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:92 -#, no-wrap +#. type: =head1 +#: ../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 +#: ../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 +#: ../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 +#: ../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 +#: ../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 +#: ../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 "" -" /* To access a filesystem in the image, you must mount it.\n" -" */\n" -" guestfs_mount (g, \"/dev/sda1\", \"/\");\n" -" \n" +"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: verbatim -#: ../src/guestfs.pod:96 -#, no-wrap +#. type: textblock +#: ../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 "" -" /* Now you can perform filesystem actions on the guest\n" -" * disk image.\n" -" */\n" -" guestfs_touch (g, \"/hello\");\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 -#: ../src/guestfs.pod:101 -#, no-wrap +#. type: =item +#: ../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 +#: ../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 +#: ../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 "" -" /* You only need to call guestfs_sync if you have made\n" -" * changes to the guest image. (But if you've made changes\n" -" * then you *must* sync). See also: guestfs_umount and\n" -" * guestfs_umount_all calls.\n" -" */\n" -" guestfs_sync (g);\n" -" \n" +"If using libvirt, connect to the given I. If omitted, then we connect " +"to the default libvirt hypervisor." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:108 -#, no-wrap +#. type: textblock +#: ../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 "" -" /* Close the handle 'g'. */\n" -" guestfs_close (g);\n" -"\n" +"If you specify guest block devices directly (I<-a>), then libvirt is not " +"used at all." msgstr "" -# type: textblock -#: ../src/guestfs.pod:111 +#. type: =item +#: ../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 +#: ../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 +#: ../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 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." +"Add all the disks from the named libvirt guest. Domain UUIDs can be used " +"instead of names." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:119 -msgid "DISK IMAGES" +#. type: =item +#: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148 +#: ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217 +#: ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92 +msgid "B<--echo-keys>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:121 +#. type: textblock +#: ../cat/virt-cat.pod:100 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." +"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: =item +#: ../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 +#: ../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 -#: ../src/guestfs.pod:127 +#. type: textblock +#: ../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: verbatim -#: ../src/guestfs.pod:131 +#. type: textblock +#: ../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 +#: ../cat/virt-cat.pod:116 #, no-wrap msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n" -" -1);\n" +" virt-cat --format=raw -a disk.img file\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:135 -msgid "You can add a disk read-only using:" +#. type: textblock +#: ../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 -#: ../src/guestfs.pod:137 +#. type: verbatim +#: ../cat/virt-cat.pod:120 #, 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-cat --format=raw -a disk.img --format -a another.img file\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:142 +#. type: textblock +#: ../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 -#: ../src/guestfs.pod:145 +#. type: textblock +#: ../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: textblock -#: ../src/guestfs.pod:149 -msgid "" -"You must add at least one disk image, and you may add multiple disk images. " -"In the API, the disk images are usually referred to as C (for the " -"first one you added), C (for the second one you added), etc." +#. type: =item +#: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200 +#: ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289 +#: ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114 +msgid "B<--keys-from-stdin>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:154 +#. type: textblock +#: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202 +#: ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291 +#: ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116 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." +"Read key or passphrase parameters from stdin. The default is to try to read " +"passphrases from the user by opening C." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:159 -msgid "MOUNTING" +#. type: =item +#: ../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 +#: ../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 +#: ../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: =item +#: ../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 +#: ../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:161 -msgid "" -"Before you can read or write files, create directories and so on in a disk " -"image that contains filesystems, you have to mount those filesystems using " -"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:" +#. type: textblock +#: ../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: =item +#: ../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: verbatim -#: ../src/guestfs.pod:167 +#. type: textblock +#: ../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 +#: ../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 +#: ../cat/virt-cat.pod:154 +msgid "Previous versions of virt-cat allowed you to write either:" +msgstr "" + +#. type: verbatim +#: ../cat/virt-cat.pod:156 #, no-wrap msgid "" -" guestfs_mount (g, \"/dev/sda1\", \"/\");\n" +" virt-cat disk.img [disk.img ...] file\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:169 -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)." +#. type: textblock +#: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185 +#: ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:215 +msgid "or" msgstr "" -# type: textblock -#: ../src/guestfs.pod:173 +#. type: verbatim +#: ../cat/virt-cat.pod:160 +#, no-wrap 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. Libguestfs also has a " -"set of APIs for inspection of 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." +" virt-cat guestname file\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:183 +#. type: textblock +#: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189 +#: ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:219 msgid "" -"To mount a disk image read-only, use L. There are " -"several other variations of the C call." +"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: =head2 -#: ../src/guestfs.pod:186 -msgid "FILESYSTEM ACCESS AND MODIFICATION" +#. type: textblock +#: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193 +#: ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:223 +msgid "For compatibility the old style is still supported." msgstr "" -# type: textblock -#: ../src/guestfs.pod:188 -msgid "" -"The majority of the libguestfs API consists of fairly low-level calls for " -"accessing and modifying the files, directories, symlinks etc on mounted " -"filesystems. There are over a hundred such calls which you can find listed " -"in detail below in this man page, and we don't even pretend to cover them " -"all in this overview." +#. type: =head1 +#: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297 +msgid "USING GUESTFISH" msgstr "" -# type: textblock -#: ../src/guestfs.pod:194 +#. type: textblock +#: ../cat/virt-cat.pod:170 msgid "" -"Specify filenames as full paths, starting with C<\"/\"> and including the " -"mount point." +"L is a more powerful, lower level tool which you can use when " +"C doesn't work." msgstr "" -# type: textblock -#: ../src/guestfs.pod:197 -msgid "" -"For example, if you mounted a filesystem at C<\"/\"> and you want to read " -"the file called C<\"etc/passwd\"> then you could do:" +#. type: textblock +#: ../cat/virt-cat.pod:173 +msgid "Using C is approximately equivalent to doing:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:200 +#. type: verbatim +#: ../cat/virt-cat.pod:175 #, no-wrap msgid "" -" char *data = guestfs_cat (g, \"/etc/passwd\");\n" +" guestfish --ro -i -d domname download file -\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:202 +#. type: textblock +#: ../cat/virt-cat.pod:177 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." +"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 -#: ../src/guestfs.pod:206 +#. type: textblock +#: ../cat/virt-cat.pod:181 msgid "" -"As another example, to create a top-level directory on that filesystem " -"called C<\"var\"> you would do:" +"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:209 +#. type: verbatim +#: ../cat/virt-cat.pod:186 #, no-wrap msgid "" -" guestfs_mkdir (g, \"/var\");\n" +" guestfish --ro -a disk.img -m /dev/sda1 download file -\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:211 -msgid "To create a symlink you could do:" +#. 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: verbatim -#: ../src/guestfs.pod:213 -#, no-wrap -msgid "" -" guestfs_ln_s (g, \"/etc/init.d/portmap\",\n" -" \"/etc/rc3.d/S30portmap\");\n" -"\n" +#. type: =head1 +#: ../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:216 +#. type: textblock +#: ../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 "" -"Libguestfs will reject attempts to use relative paths and there is no " -"concept of a current working directory." +"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: textblock -#: ../src/guestfs.pod:219 -msgid "" -"Libguestfs can return errors in many situations: for example if the " -"filesystem isn't writable, or if a file or directory that you requested " -"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)." +#. type: =head1 +#: ../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 +#: ../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 "" +"This program returns 0 if successful, or non-zero if there was an error." +msgstr "" + +#. type: =head1 +#: ../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:3167 +#: ../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 -#: ../src/guestfs.pod:225 +#. type: textblock +#: ../cat/virt-cat.pod:205 msgid "" -"File writes are affected by the per-handle umask, set by calling L and defaulting to 022. See L." +"L, L, L, L, L, L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:228 -msgid "PARTITIONING" +#. type: =head1 +#: ../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 -#: ../src/guestfs.pod:230 -msgid "" -"Libguestfs contains API calls to read, create and modify partition tables on " -"disk images." +#. type: textblock +#: ../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: textblock -#: ../src/guestfs.pod:233 -msgid "" -"In the common case where you want to create a single partition covering the " -"whole disk, you should use the L call:" +#. type: =head1 +#: ../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:1265 ../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:3246 +#: ../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: verbatim -#: ../src/guestfs.pod:237 -#, no-wrap -msgid "" -" const char *parttype = \"mbr\";\n" -" if (disk_is_larger_than_2TB)\n" -" parttype = \"gpt\";\n" -" guestfs_part_disk (g, \"/dev/sda\", parttype);\n" -"\n" +#. type: textblock +#: ../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 -#: ../src/guestfs.pod:242 +#. type: textblock +#: ../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:1270 ../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 "" -"Obviously this effectively wipes anything that was on that disk image before." +"This program is free software; you can redistribute it and/or modify it " +"under the terms of the GNU General Public License as published by the Free " +"Software Foundation; either version 2 of the License, or (at your option) " +"any later version." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:245 -msgid "LVM2" +#. type: textblock +#: ../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:1275 ../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 "" +"This program is distributed in the hope that it will be useful, but WITHOUT " +"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " +"FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for " +"more details." msgstr "" -# type: textblock -#: ../src/guestfs.pod:247 +#. type: textblock +#: ../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:1280 ../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 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." +"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 -#: ../src/guestfs.pod:252 +#. type: textblock +#: ../cat/virt-filesystems.pod:5 msgid "" -"This author strongly recommends reading the LVM HOWTO, online at L." +"virt-filesystems - List filesystems, partitions, block devices, LVM in a " +"virtual machine or disk image" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:255 -msgid "DOWNLOADING" +#. type: verbatim +#: ../cat/virt-filesystems.pod:9 +#, no-wrap +msgid "" +" virt-filesystems [--options] -d domname\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:257 +#. type: verbatim +#: ../cat/virt-filesystems.pod:11 +#, no-wrap 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 it has a very simple to use API." +" virt-filesystems [--options] -a disk.img [-a disk.img ...]\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:262 +#. type: textblock +#: ../cat/virt-filesystems.pod:15 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." +"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 -#: ../src/guestfs.pod:266 +#. type: textblock +#: ../cat/virt-filesystems.pod:20 msgid "" -"L can be used to download any file, with no limits on " -"content or size (even files larger than 4 GB)." +"One use for this tool is from shell scripts to iterate over all filesystems " +"from a disk image:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:269 +#. type: verbatim +#: ../cat/virt-filesystems.pod:23 +#, no-wrap msgid "" -"To download multiple files, see L and L." +" for fs in $(virt-filesystems -a disk.img); do\n" +" # ...\n" +" done\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:272 -msgid "UPLOADING" +#. type: textblock +#: ../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 -#: ../src/guestfs.pod:274 +#. type: textblock +#: ../cat/virt-filesystems.pod:32 msgid "" -"It's often the case that you want to write a file or files to the disk image." +"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 -#: ../src/guestfs.pod:277 +#. type: verbatim +#: ../cat/virt-filesystems.pod:37 +#, no-wrap 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." +" $ virt-filesystems -a disk.img\n" +" /dev/sda1\n" +" /dev/vg_guest/lv_root\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:283 +#. type: textblock +#: ../cat/virt-filesystems.pod:41 msgid "" -"To upload a single file, use L. This call has no limits on " -"file content or size (even files larger than 4 GB)." +"If you add I<-l> or I<--long> then the output includes extra information:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:286 +#. type: verbatim +#: ../cat/virt-filesystems.pod:44 +#, no-wrap msgid "" -"To upload multiple files, see L and L." +" $ 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 -#: ../src/guestfs.pod:288 +#. type: textblock +#: ../cat/virt-filesystems.pod:49 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." +"If you add I<--extra> then non-mountable (swap, unknown) filesystems are " +"shown as well:" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:299 -msgid "COPYING" +#. type: verbatim +#: ../cat/virt-filesystems.pod:52 +#, no-wrap +msgid "" +" $ virt-filesystems -a disk.img --extra\n" +" /dev/sda1\n" +" /dev/vg_guest/lv_root\n" +" /dev/vg_guest/lv_swap\n" +" /dev/vg_guest/lv_data\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:301 +#. type: textblock +#: ../cat/virt-filesystems.pod:58 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." +"If you add I<--partitions> then partitions are shown instead of filesystems:" msgstr "" -# type: =item -#: ../src/guestfs.pod:307 -msgid "B to B" +#. type: verbatim +#: ../cat/virt-filesystems.pod:60 +#, no-wrap +msgid "" +" $ virt-filesystems -a disk.img --partitions\n" +" /dev/sda1\n" +" /dev/sda2\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:309 +#. type: textblock +#: ../cat/virt-filesystems.pod:64 msgid "" -"Use L to copy a single file, or L to copy " -"directories recursively." +"Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-" +"volumes>, I<--block-devices> to list those items." msgstr "" -# type: =item -#: ../src/guestfs.pod:312 -msgid "B to B" +#. type: textblock +#: ../cat/virt-filesystems.pod:67 +msgid "" +"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 -#: ../src/guestfs.pod:314 +#. type: textblock +#: ../cat/virt-filesystems.pod:74 msgid "" -"Use L which efficiently uses L to copy between files and " -"devices in the guest." +"UUIDs (because they are quite long) are not shown by default. Add the I<--" +"uuid> option to display device and filesystem UUIDs in the long output." msgstr "" -# type: textblock -#: ../src/guestfs.pod:317 -msgid "Example: duplicate the contents of an LV:" +#. type: textblock +#: ../cat/virt-filesystems.pod:78 +msgid "" +"I<--all --long --uuid> is a useful combination to display all possible " +"information about everything." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:319 +#. type: verbatim +#: ../cat/virt-filesystems.pod:81 #, no-wrap msgid "" -" guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n" +" $ virt-filesystems -a win.img --all --long --uuid -h\n" +" Name Type VFS Label Size Parent UUID\n" +" /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n" +" /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n" +" /dev/sda1 partition - - 100M /dev/sda -\n" +" /dev/sda2 partition - - 20G /dev/sda -\n" +" /dev/sda device - - 20G - -\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:321 +#. type: textblock +#: ../cat/virt-filesystems.pod:89 msgid "" -"The destination (C) must be at least as large as the source " -"(C). To copy less than the whole source device, use L." +"For machine-readable output, use I<--csv> to get Comma-Separated Values." msgstr "" -# type: =item -#: ../src/guestfs.pod:325 -msgid "B to B" +#. type: =item +#: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121 +msgid "B<--all>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:327 -msgid "Use L. See L above." +#. type: textblock +#: ../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: =item -#: ../src/guestfs.pod:329 -msgid "B to B" +#. type: textblock +#: ../cat/virt-filesystems.pod:117 +msgid "See also I<--long>." msgstr "" -# type: textblock -#: ../src/guestfs.pod:331 -msgid "Use L. See L above." +#. type: =item +#: ../cat/virt-filesystems.pod:119 +msgid "B<--blkdevs>" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:335 -msgid "LISTING FILES" +#. type: =item +#: ../cat/virt-filesystems.pod:121 +msgid "B<--block-devices>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:337 -msgid "" -"L is just designed for humans to read (mainly when using the " -"L-equivalent command C)." +#. type: textblock +#: ../cat/virt-filesystems.pod:123 +msgid "Display block devices." msgstr "" -# type: textblock -#: ../src/guestfs.pod:340 -msgid "" -"L is a quick way to get a list of files in a directory from " -"programs, as a flat list of strings." +#. type: =item +#: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88 +msgid "B<--csv>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:343 +#. type: textblock +#: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90 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." +"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: textblock -#: ../src/guestfs.pod:347 +#. type: textblock +#: ../cat/virt-filesystems.pod:150 msgid "" -"L and L can be used to recursively list files." +"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: =head2 -#: ../src/guestfs.pod:350 -msgid "RUNNING COMMANDS" +#. type: =item +#: ../cat/virt-filesystems.pod:155 +msgid "B<--extra>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:352 +#. type: textblock +#: ../cat/virt-filesystems.pod:157 msgid "" -"Although libguestfs is primarily an API for manipulating files inside guest " -"images, we also provide some limited facilities for running commands inside " -"guests." +"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 -#: ../src/guestfs.pod:356 -msgid "There are many limitations to this:" +#. type: textblock +#: ../cat/virt-filesystems.pod:161 +msgid "This option implies I<--filesystems>." msgstr "" -# type: =item -#: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 -#: ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 -#: ../src/guestfs.pod:388 ../src/guestfs.pod:1143 ../src/guestfs.pod:1148 -#: ../src/guestfs.pod:1152 ../src/guestfs.pod:1368 ../src/guestfs.pod:1373 -#: ../src/guestfs.pod:1377 ../src/guestfs.pod:1479 ../src/guestfs.pod:1483 -#: ../src/guestfs.pod:1487 ../src/guestfs.pod:1492 ../src/guestfs.pod:1500 -#: ../src/guestfs.pod:1519 ../src/guestfs.pod:1527 ../src/guestfs.pod:1757 -#: ../src/guestfs.pod:1763 ../src/guestfs.pod:1768 ../src/guestfs.pod:1774 -#: ../src/guestfs.pod:1881 ../src/guestfs.pod:1885 ../src/guestfs.pod:1889 -#: ../src/guestfs.pod:1893 ../src/guestfs-actions.pod:14 -#: ../src/guestfs-actions.pod:21 ../src/guestfs-actions.pod:438 -#: ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:453 -#: ../src/guestfs-actions.pod:460 ../src/guestfs-actions.pod:1351 -#: ../src/guestfs-actions.pod:1355 ../src/guestfs-actions.pod:1359 -#: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1371 -#: ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1379 -#: ../src/guestfs-actions.pod:1389 ../src/guestfs-actions.pod:1393 -#: ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1520 -#: ../src/guestfs-actions.pod:1524 ../src/guestfs-actions.pod:1529 -#: ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1586 -#: ../src/guestfs-actions.pod:1590 ../src/guestfs-actions.pod:1595 -#: ../fish/guestfish.pod:364 ../fish/guestfish.pod:368 -#: ../fish/guestfish.pod:372 ../fish/guestfish.pod:376 -#: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 -#: ../fish/guestfish-actions.pod:339 ../fish/guestfish-actions.pod:347 -#: ../fish/guestfish-actions.pod:354 ../fish/guestfish-actions.pod:361 -#: ../fish/guestfish-actions.pod:1056 ../fish/guestfish-actions.pod:1060 -#: ../fish/guestfish-actions.pod:1064 ../fish/guestfish-actions.pod:1068 -#: ../fish/guestfish-actions.pod:1076 ../fish/guestfish-actions.pod:1080 -#: ../fish/guestfish-actions.pod:1084 ../fish/guestfish-actions.pod:1094 -#: ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 -#: ../fish/guestfish-actions.pod:1192 ../fish/guestfish-actions.pod:1196 -#: ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1206 -#: ../fish/guestfish-actions.pod:1248 ../fish/guestfish-actions.pod:1252 -#: ../fish/guestfish-actions.pod:1257 ../tools/virt-df.pl:161 -#: ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 -#: ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363 -msgid "*" +#. type: =item +#: ../cat/virt-filesystems.pod:163 +msgid "B<--filesystems>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:362 +#. type: textblock +#: ../cat/virt-filesystems.pod:165 msgid "" -"The kernel version that the command runs under will be different from what " -"it expects." +"Display mountable filesystems. If no display option was selected then this " +"option is implied." msgstr "" -# type: textblock -#: ../src/guestfs.pod:367 -msgid "" -"If the command needs to communicate with daemons, then most likely they " -"won't be running." +#. type: textblock +#: ../cat/virt-filesystems.pod:168 +msgid "With I<--extra>, non-mountable filesystems are shown too." msgstr "" -# type: textblock -#: ../src/guestfs.pod:372 -msgid "The command will be running in limited memory." +#. type: verbatim +#: ../cat/virt-filesystems.pod:181 +#, no-wrap +msgid "" +" virt-filesystems --format=raw -a disk.img\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:376 +#. type: verbatim +#: ../cat/virt-filesystems.pod:185 +#, no-wrap msgid "" -"The network may not be available unless you enable it (see L)." +" virt-filesystems --format=raw -a disk.img --format -a another.img\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:381 -msgid "Only supports Linux guests (not Windows, BSD, etc)." +#. 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: textblock -#: ../src/guestfs.pod:385 -msgid "" -"Architecture limitations (eg. won't work for a PPC guest on an X86 host)." +#. type: =item +#: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 +#: ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111 +msgid "B<--human-readable>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:390 -msgid "" -"For SELinux guests, you may need to enable SELinux and load policy first. " -"See L in this manpage." +#. type: textblock +#: ../cat/virt-filesystems.pod:198 +msgid "In I<--long> mode, display sizes in human-readable format." msgstr "" -# type: textblock -#: ../src/guestfs.pod:395 -msgid "" -"The two main API calls to run commands are L and L (there are also variations)." +#. 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: textblock -#: ../src/guestfs.pod:398 -msgid "" -"The difference is that L runs commands using the shell, so any " -"shell globs, redirections, etc will work." +#. 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: =head2 -#: ../src/guestfs.pod:401 -msgid "CONFIGURATION FILES" +#. type: textblock +#: ../cat/virt-filesystems.pod:209 +msgid "Display extra columns of data (\"long format\")." msgstr "" -# type: textblock -#: ../src/guestfs.pod:403 -msgid "" -"To read and write configuration files in Linux guest filesystems, we " -"strongly recommend using Augeas. For example, Augeas understands how to " -"read and write, say, a Linux shadow password file or X.org configuration " -"file, and so avoids you having to write that code." +#. type: textblock +#: ../cat/virt-filesystems.pod:211 +msgid "A title row is added unless you also specify I<--no-title>." msgstr "" -# type: textblock -#: ../src/guestfs.pod:408 +#. type: textblock +#: ../cat/virt-filesystems.pod:213 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." +"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 -#: ../src/guestfs.pod:412 +#. type: textblock +#: ../cat/virt-filesystems.pod:218 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." +"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: =head2 -#: ../src/guestfs.pod:416 -msgid "SELINUX" +#. type: textblock +#: ../cat/virt-filesystems.pod:221 +msgid "Use I<--uuid> to display UUIDs too." msgstr "" -# type: textblock -#: ../src/guestfs.pod:418 -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:" +#. type: =item +#: ../cat/virt-filesystems.pod:223 +msgid "B<--lvs>" msgstr "" -# type: =item -#: ../src/guestfs.pod:424 -msgid "1." +#. type: =item +#: ../cat/virt-filesystems.pod:225 +msgid "B<--logvols>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:426 -msgid "Before launching, do:" +#. type: =item +#: ../cat/virt-filesystems.pod:227 +msgid "B<--logical-volumes>" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:428 -#, no-wrap +#. type: textblock +#: ../cat/virt-filesystems.pod:229 msgid "" -" guestfs_set_selinux (g, 1);\n" -"\n" +"Display LVM logical volumes. In this mode, these are displayed irrespective " +"of whether the LVs contain filesystems." msgstr "" -# type: =item -#: ../src/guestfs.pod:430 -msgid "2." +#. type: =item +#: ../cat/virt-filesystems.pod:232 +msgid "B<--no-title>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:432 -msgid "" -"After mounting the guest's filesystem(s), load the policy. This is best " -"done by running the L command in the guest itself:" +#. type: textblock +#: ../cat/virt-filesystems.pod:234 +msgid "In I<--long> mode, don't add a title row." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:436 -#, no-wrap +#. type: textblock +#: ../cat/virt-filesystems.pod:236 msgid "" -" guestfs_sh (g, \"/usr/sbin/load_policy\");\n" -"\n" +"Note that the order of the columns is not fixed, and may change in future " +"versions of virt-filesystems, so using this option may give you unexpected " +"surprises." msgstr "" -# type: textblock -#: ../src/guestfs.pod:438 -msgid "" -"(Older versions of C require you to specify the name of the " -"policy file)." +#. type: =item +#: ../cat/virt-filesystems.pod:240 +msgid "B<--parts>" msgstr "" -# type: =item -#: ../src/guestfs.pod:441 -msgid "3." +#. type: =item +#: ../cat/virt-filesystems.pod:242 +msgid "B<--partitions>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:443 +#. type: textblock +#: ../cat/virt-filesystems.pod:244 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 partitions. In this mode, these are displayed irrespective of " +"whether the partitions contain filesystems." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:447 -#, no-wrap -msgid "" -" guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n" -"\n" +#. type: =item +#: ../cat/virt-filesystems.pod:247 +msgid "B<--pvs>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:451 -msgid "This will work for running commands and editing existing files." +#. type: =item +#: ../cat/virt-filesystems.pod:249 +msgid "B<--physvols>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:453 -msgid "" -"When new files are created, you may need to label them explicitly, for " -"example by running the external command C." +#. type: =item +#: ../cat/virt-filesystems.pod:251 +msgid "B<--physical-volumes>" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:457 -msgid "UMASK" +#. type: textblock +#: ../cat/virt-filesystems.pod:253 +msgid "Display LVM physical volumes." msgstr "" -# type: textblock -#: ../src/guestfs.pod:459 -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." +#. type: =item +#: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163 +msgid "B<--uuid>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:465 -msgid "" -"The default umask is C<022>, so files are created with modes such as C<0644> " -"and directories with C<0755>." +#. type: =item +#: ../cat/virt-filesystems.pod:257 +msgid "B<--uuids>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:468 -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." +#. type: textblock +#: ../cat/virt-filesystems.pod:259 +msgid "In I<--long> mode, display UUIDs as well." msgstr "" -# type: textblock -#: ../src/guestfs.pod:472 -msgid "For more information about umask, see L." +#. type: =item +#: ../cat/virt-filesystems.pod:273 +msgid "B<--vgs>" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:474 ../fish/guestfish.pod:630 -msgid "ENCRYPTED DISKS" +#. type: =item +#: ../cat/virt-filesystems.pod:275 +msgid "B<--volgroups>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:476 -msgid "" -"Libguestfs allows you to access Linux guests which have been encrypted using " -"whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) " -"standard. This includes nearly all whole disk encryption systems used by " -"modern Linux guests." +#. type: =item +#: ../cat/virt-filesystems.pod:277 +msgid "B<--volume-groups>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:482 -msgid "" -"Use L to identify LUKS-encrypted block devices (it " -"returns the string C)." +#. type: textblock +#: ../cat/virt-filesystems.pod:279 +msgid "Display LVM volume groups." msgstr "" -# type: textblock -#: ../src/guestfs.pod:485 -msgid "" -"Then open these devices by calling L. Obviously you " -"will require the passphrase!" +#. type: =head1 +#: ../cat/virt-filesystems.pod:287 +msgid "COLUMNS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:488 +#. type: textblock +#: ../cat/virt-filesystems.pod:289 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." +"Note that columns in the output are subject to reordering and change in " +"future versions of this tool." msgstr "" -# type: textblock -#: ../src/guestfs.pod:494 -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." +#. type: =item +#: ../cat/virt-filesystems.pod:294 +msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:498 -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)." +#. type: textblock +#: ../cat/virt-filesystems.pod:296 +msgid "The filesystem, partition, block device or LVM name." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:505 -msgid "INSPECTION" +#. type: textblock +#: ../cat/virt-filesystems.pod:298 +msgid "" +"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 -#: ../src/guestfs.pod:507 +#. type: textblock +#: ../cat/virt-filesystems.pod:302 msgid "" -"Libguestfs has APIs for inspecting an unknown disk image to find out if it " -"contains operating systems. (These APIs used to be in a separate Perl-only " -"library called L 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)." +"If the I<--long> option is B specified, then only the name column is " +"shown in the output." msgstr "" -# type: textblock -#: ../src/guestfs.pod:513 -msgid "" -"Add all disks belonging to the unknown virtual machine and call L in the usual way." +#. type: =item +#: ../cat/virt-filesystems.pod:305 +msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:516 -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.)" +#. type: textblock +#: ../cat/virt-filesystems.pod:307 +msgid "The object type, for example C, C, C etc." msgstr "" -# type: textblock -#: ../src/guestfs.pod:525 -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." +#. type: =item +#: ../cat/virt-filesystems.pod:309 +msgid "B" msgstr "" -# type: textblock -#: ../src/guestfs.pod:531 +#. type: textblock +#: ../cat/virt-filesystems.pod:311 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 there is a filesystem, then this column displays the filesystem type if " +"one could be detected, eg. C." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:538 -#, 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:314 +msgid "B." +#. type: textblock +#: ../cat/virt-filesystems.pod:337 +msgid "The UUID is only displayed if the I<--uuid> option is given." msgstr "" -# type: textblock -#: ../src/guestfs.pod:575 -msgid "" -"Drive letter mappings are outside the scope of libguestfs. You have to use " -"libguestfs to read the appropriate Windows Registry and configuration files, " -"to determine yourself how drives are mapped (see also L and L)." +#. type: =head1 +#: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459 +#: ../df/virt-df.pod:191 +msgid "NOTE ABOUT CSV FORMAT" msgstr "" -# type: textblock -#: ../src/guestfs.pod:580 +#. type: textblock +#: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461 +#: ../df/virt-df.pod:193 msgid "" -"Replacing backslash characters with forward slash characters is also outside " -"the scope of libguestfs, but something that you can easily do." +"Comma-separated values (CSV) is a deceptive format. It I like it " +"should be easy to parse, but it is definitely not easy to parse." msgstr "" -# type: textblock -#: ../src/guestfs.pod:583 +#. type: textblock +#: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464 +#: ../df/virt-df.pod:196 msgid "" -"Where we can help is in resolving the case insensitivity of paths. For " -"this, call L." +"Myth: Just split fields at commas. Reality: This does I work " +"reliably. This example has two columns:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:586 +#. type: verbatim +#: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467 +#: ../df/virt-df.pod:199 +#, no-wrap 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." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:594 -msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES" +" \"foo,bar\",baz\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:596 +#. type: textblock +#: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469 +#: ../df/virt-df.pod:201 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." +"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:599 +#. type: verbatim +#: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472 +#: ../df/virt-df.pod:204 +#, no-wrap msgid "" -"The API is broadly identical in all supported languages. This means that " -"the C call C is C<$g-Emount($path)> in Perl, C in Python, and C in OCaml. In other " -"words, a straightforward, predictable isomorphism between each language." +" \"foo\n" +" bar\",baz\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:605 +#. type: textblock +#: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475 +#: ../df/virt-df.pod:207 msgid "" -"Error messages are automatically transformed into exceptions if the language " -"supports it." +"For shell scripts, use C (L also " +"packaged in major Linux distributions)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:608 +#. type: textblock +#: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478 +#: ../df/virt-df.pod:210 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." +"For other languages, use a CSV processing library (eg. C for Perl " +"or Python's built-in csv library)." msgstr "" -# type: =item -#: ../src/guestfs.pod:614 -msgid "B" +#. 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 -#: ../src/guestfs.pod:616 +#. type: textblock +#: ../cat/virt-filesystems.pod:379 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." +"L, L, L, L, L, L, L, L." msgstr "" -# type: =item -#: ../src/guestfs.pod:620 -msgid "B" +#. 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 -#: ../src/guestfs.pod:622 -msgid "" -"The C# bindings are highly experimental. Please read the warnings at the " -"top of C." +#. type: textblock +#: ../cat/virt-ls.pod:5 +msgid "virt-ls - List files in a virtual machine" msgstr "" -# type: =item -#: ../src/guestfs.pod:625 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:9 +#, no-wrap +msgid "" +" virt-ls [--options] -d domname directory [directory ...]\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:627 +#. type: verbatim +#: ../cat/virt-ls.pod:11 +#, no-wrap 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." +" virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:631 -msgid "B" +#. type: textblock +#: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13 +msgid "Old style:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:633 +#. type: verbatim +#: ../cat/virt-ls.pod:15 +#, no-wrap msgid "" -"Full documentation is contained in the Javadoc which is distributed with " -"libguestfs." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:636 -msgid "B" +" virt-ls [--options] domname directory\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:638 -msgid "For documentation see the file C." +#. type: verbatim +#: ../cat/virt-ls.pod:17 +#, no-wrap +msgid "" +" virt-ls [--options] disk.img [disk.img ...] directory\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:640 -msgid "B" +#. type: textblock +#: ../cat/virt-ls.pod:21 +msgid "" +"C lists filenames, file sizes, checksums, extended attributes and " +"more from a virtual machine or disk image." msgstr "" -# type: textblock -#: ../src/guestfs.pod:642 -msgid "For documentation see L." +#. type: textblock +#: ../cat/virt-ls.pod:24 +msgid "" +"Multiple directory names can be given, in which case the output from each is " +"concatenated." msgstr "" -# type: =item -#: ../src/guestfs.pod:644 -msgid "B" +#. type: textblock +#: ../cat/virt-ls.pod:27 +msgid "" +"To list directories from a libvirt guest use the I<-d> option to specify the " +"name of the guest. For a disk image, use the I<-a> option." msgstr "" -# type: textblock -#: ../src/guestfs.pod:646 +#. type: textblock +#: ../cat/virt-ls.pod:31 msgid "" -"For documentation see C supplied with libguestfs sources or in " -"the php-libguestfs package for your distribution." +"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 -#: ../src/guestfs.pod:649 -msgid "The PHP binding only works correctly on 64 bit machines." +#. type: textblock +#: ../cat/virt-ls.pod:37 +msgid "Get a list of all files and directories in a virtual machine:" msgstr "" -# type: =item -#: ../src/guestfs.pod:651 -msgid "B" +#. type: verbatim +#: ../cat/virt-ls.pod:39 +#, no-wrap +msgid "" +" virt-ls -R -d guest /\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:653 -msgid "For documentation do:" +#. type: textblock +#: ../cat/virt-ls.pod:41 +msgid "List all setuid or setgid programs in a Linux virtual machine:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:655 +#. type: verbatim +#: ../cat/virt-ls.pod:43 #, no-wrap msgid "" -" $ python\n" -" >>> import guestfs\n" -" >>> help (guestfs)\n" +" virt-ls -lR -d guest / | grep '^- [42]'\n" "\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:659 -msgid "B" +#. type: textblock +#: ../cat/virt-ls.pod:45 +msgid "List all public-writable directories in a Linux virtual machine:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:661 +#. type: verbatim +#: ../cat/virt-ls.pod:47 +#, no-wrap msgid "" -"Use the Guestfs module. There is no Ruby-specific documentation, but you " -"can find examples written in Ruby in the libguestfs source." +" virt-ls -lR -d guest / | grep '^d ...7'\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:664 -msgid "B" +#. type: textblock +#: ../cat/virt-ls.pod:49 +msgid "List all Unix domain sockets in a Linux virtual machine:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:666 -msgid "For documentation see L." +#. type: verbatim +#: ../cat/virt-ls.pod:51 +#, no-wrap +msgid "" +" virt-ls -lR -d guest / | grep '^s'\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:670 -msgid "LIBGUESTFS GOTCHAS" +#. type: textblock +#: ../cat/virt-ls.pod:53 +msgid "List all regular files with filenames ending in '.png':" msgstr "" -# type: textblock -#: ../src/guestfs.pod:672 +#. type: verbatim +#: ../cat/virt-ls.pod:55 +#, no-wrap msgid "" -"L: \"A feature of a " -"system [...] that works in the way it is documented but is counterintuitive " -"and almost invites mistakes.\"" +" virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:676 +#. type: textblock +#: ../cat/virt-ls.pod:57 +msgid "To display files larger than 10MB in home directories:" +msgstr "" + +#. type: verbatim +#: ../cat/virt-ls.pod:59 +#, 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 -lR -d guest /home | awk '$3 > 10*1024*1024'\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:684 -msgid "Autosync / forgetting to sync." +#. type: textblock +#: ../cat/virt-ls.pod:61 +msgid "Find everything modified in the last 7 days:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:686 +#. type: verbatim +#: ../cat/virt-ls.pod:63 +#, no-wrap 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:" +" virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:690 +#. type: textblock +#: ../cat/virt-ls.pod:65 +msgid "Find regular files modified in the last 24 hours:" +msgstr "" + +#. type: verbatim +#: ../cat/virt-ls.pod:67 #, no-wrap msgid "" -" guestfs_set_autosync (g, 1);\n" +" virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:692 -msgid "" -"to have the unmount/sync done automatically for you when the handle 'g' is " -"closed. (This feature is called \"autosync\", L q.v.)" +#. type: =head2 +#: ../cat/virt-ls.pod:69 +msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:696 +#. type: textblock +#: ../cat/virt-ls.pod:71 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." +"Find the differences between files in a guest and an earlier snapshot of the " +"same guest." msgstr "" -# type: textblock -#: ../src/guestfs.pod:700 +#. type: verbatim +#: ../cat/virt-ls.pod:74 +#, 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 -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:704 +#. type: textblock +#: ../cat/virt-ls.pod:78 msgid "" -"Update: Autosync is enabled by default for all API users starting from " -"libguestfs 1.5.24." +"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 -#: ../src/guestfs.pod:707 -msgid "Mount option C<-o sync> should not be the default." +#. type: =head1 +#: ../cat/virt-ls.pod:84 +msgid "OUTPUT MODES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:709 +#. type: textblock +#: ../cat/virt-ls.pod:86 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." +"C has four output modes, controlled by different combinations of " +"the I<-l> and I<-R> options." msgstr "" -# type: textblock -#: ../src/guestfs.pod:713 -msgid "" -"The work around is to use L and set the mount " -"options that you actually want to use." +#. type: =head2 +#: ../cat/virt-ls.pod:89 +msgid "SIMPLE LISTING" msgstr "" -# type: =item -#: ../src/guestfs.pod:716 -msgid "Read-only should be the default." +#. type: textblock +#: ../cat/virt-ls.pod:91 +msgid "A simple listing is like the ordinary L command:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:718 +#. type: verbatim +#: ../cat/virt-ls.pod:93 +#, no-wrap 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." +" $ virt-ls -d guest /\n" +" bin\n" +" boot\n" +" [etc.]\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:721 -msgid "This would reduce the potential to corrupt live VM images." +#. type: =head2 +#: ../cat/virt-ls.pod:98 +msgid "LONG LISTING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:723 +#. type: textblock +#: ../cat/virt-ls.pod:100 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." +"With the I<-l> (I<--long>) option, the output is like the C command " +"(more specifically, like the C function)." msgstr "" -# type: =item -#: ../src/guestfs.pod:727 -msgid "guestfish command line is hard to use." +#. type: verbatim +#: ../cat/virt-ls.pod:103 +#, no-wrap +msgid "" +" $ virt-ls -l -d guest /\n" +" total 204\n" +" dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n" +" dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n" +" [etc.]\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:729 +#. type: textblock +#: ../cat/virt-ls.pod:109 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." +"Note that while this is useful for displaying a directory, do not try " +"parsing this output in another program. Use L " +"instead." msgstr "" -# type: =item -#: ../src/guestfs.pod:736 -msgid "guestfish megabyte modifiers don't work right on all commands" +#. type: =head2 +#: ../cat/virt-ls.pod:113 +msgid "RECURSIVE LISTING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:738 +#. type: textblock +#: ../cat/virt-ls.pod:115 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)." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:745 -msgid "The most common is L. The guestfish command:" +"With the I<-R> (I<--recursive>) option, C lists the names of files " +"and directories recursively:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:747 +#. type: verbatim +#: ../cat/virt-ls.pod:118 #, no-wrap msgid "" -" lvcreate LV VG 100M\n" +" $ virt-ls -R -d guest /tmp\n" +" foo\n" +" foo/bar\n" +" [etc.]\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:749 -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." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:754 +#. type: textblock +#: ../cat/virt-ls.pod:123 msgid "" -"This could be fixed in the generator by specially marking parameters and " -"return values which take bytes or other units." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:757 -msgid "Library should return errno with error messages." +"To generate this output, C runs the C function and " +"converts C<\\0> characters to C<\\n>." msgstr "" -# type: textblock -#: ../src/guestfs.pod:759 -msgid "" -"It would be a nice-to-have to be able to get the original value of 'errno' " -"from inside the appliance along error paths (where set). Currently " -"L goes through hoops to try to reverse the error message " -"string into an errno, see the function error() in fuse/guestmount.c." +#. type: =head2 +#: ../cat/virt-ls.pod:126 +msgid "RECURSIVE LONG LISTING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:765 +#. type: textblock +#: ../cat/virt-ls.pod:128 msgid "" -"In libguestfs 1.5.4, the protocol was changed so that the Linux errno is " -"sent back from the daemon." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:768 -msgid "Ambiguity between devices and paths" +"Using I<-lR> options together changes the output to display directories " +"recursively, with file stats, and optionally other features such as " +"checksums and extended attributes." msgstr "" -# type: textblock -#: ../src/guestfs.pod:770 +#. type: textblock +#: ../cat/virt-ls.pod:132 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)." +"Most of the interesting features of C are only available when using " +"I<-lR> mode." msgstr "" -# type: textblock -#: ../src/guestfs.pod:775 +#. type: textblock +#: ../cat/virt-ls.pod:135 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." +"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 -#: ../src/guestfs.pod:781 +#. type: textblock +#: ../cat/virt-ls.pod:143 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:" +"Note that this output format is completely unrelated to the C " +"command." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:787 +#. type: verbatim +#: ../cat/virt-ls.pod:146 #, no-wrap msgid "" -" type path = Path of string | Device of int | Partition of int * int\n" +" $ 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 -#: ../src/guestfs.pod:789 -msgid "which would allow you to pass arguments like:" +#. type: textblock +#: ../cat/virt-ls.pod:155 +msgid "These basic fields are always shown:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:791 -#, 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:159 +msgid "type" msgstr "" -# type: textblock -#: ../src/guestfs.pod:796 +#. type: textblock +#: ../cat/virt-ls.pod:161 msgid "" -"As you can see there are still problems to resolve even with this " -"representation. Also consider how it might work in guestfish." +"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: =head2 -#: ../src/guestfs.pod:801 -msgid "PROTOCOL LIMITS" +#. type: =item +#: ../cat/virt-ls.pod:171 +msgid "permissions" msgstr "" -# type: textblock -#: ../src/guestfs.pod:803 -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." +#. type: textblock +#: ../cat/virt-ls.pod:173 +msgid "The Unix permissions, displayed as a 4 digit octal number." msgstr "" -# type: textblock -#: ../src/guestfs.pod:811 -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." +#. type: =item +#: ../cat/virt-ls.pod:175 +msgid "size" msgstr "" -# type: textblock -#: ../src/guestfs.pod:817 +#. type: textblock +#: ../cat/virt-ls.pod:177 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 size of the file. This is shown in bytes unless I<-h> or I<--human-" +"readable> option is given, in which case this is shown as a human-readable " +"number." msgstr "" -# type: textblock -#: ../src/guestfs.pod:821 -msgid "" -"You might also consider mounting the disk image using our FUSE filesystem " -"support (L)." +#. type: =head2 +#: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4245 +msgid "path" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:824 -msgid "KEYS AND PASSPHRASES" +#. type: textblock +#: ../cat/virt-ls.pod:183 +msgid "The full path of the file or directory." msgstr "" -# type: textblock -#: ../src/guestfs.pod:826 -msgid "" -"Certain libguestfs calls take a parameter that contains sensitive key " -"material, passed in as a C string." +#. type: =item +#: ../cat/virt-ls.pod:185 +msgid "link" msgstr "" -# type: textblock -#: ../src/guestfs.pod:829 +#. type: textblock +#: ../cat/virt-ls.pod:187 +msgid "For symbolic links only, the link target." +msgstr "" + +#. type: textblock +#: ../cat/virt-ls.pod:191 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." +"In I<-lR> mode, additional command line options enable the display of more " +"fields." msgstr "" -# type: textblock -#: ../src/guestfs.pod:834 +#. type: textblock +#: ../cat/virt-ls.pod:194 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." +"With the I<--uids> flag, these additional fields are displayed before the " +"path:" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:839 -msgid "CONNECTION MANAGEMENT" +#. type: =item +#: ../cat/virt-ls.pod:199 +msgid "uid" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:841 -msgid "guestfs_h *" +#. type: =item +#: ../cat/virt-ls.pod:201 +msgid "gid" msgstr "" -# type: textblock -#: ../src/guestfs.pod:843 +#. type: textblock +#: ../cat/virt-ls.pod:203 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." +"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 -#: ../src/guestfs.pod:847 -msgid "" -"For information on using multiple handles and threads, see the section L below." +#. type: textblock +#: ../cat/virt-ls.pod:208 +msgid "With the I<--times> flag, these additional fields are displayed:" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:850 -msgid "guestfs_create" +#. type: =item +#: ../cat/virt-ls.pod:212 +msgid "atime" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:852 -#, no-wrap -msgid "" -" guestfs_h *guestfs_create (void);\n" -"\n" +#. type: textblock +#: ../cat/virt-ls.pod:214 +msgid "The time of last access." msgstr "" -# type: textblock -#: ../src/guestfs.pod:854 -msgid "Create a connection handle." +#. type: =item +#: ../cat/virt-ls.pod:216 +msgid "mtime" msgstr "" -# type: textblock -#: ../src/guestfs.pod:856 -msgid "" -"You have to call L (or one of the equivalent calls) " -"on the handle at least once." +#. type: textblock +#: ../cat/virt-ls.pod:218 +msgid "The time of last modification." msgstr "" -# type: textblock -#: ../src/guestfs.pod:859 -msgid "" -"This function returns a non-NULL pointer to a handle on success or NULL on " -"error." +#. type: =item +#: ../cat/virt-ls.pod:220 +msgid "ctime" msgstr "" -# type: textblock -#: ../src/guestfs.pod:862 -msgid "After configuring the handle, you have to call L." +#. type: textblock +#: ../cat/virt-ls.pod:222 +msgid "The time of last status change." msgstr "" -# type: textblock -#: ../src/guestfs.pod:864 +#. type: textblock +#: ../cat/virt-ls.pod:226 msgid "" -"You may also want to configure error handling for the handle. See L section below." +"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: =head2 -#: ../src/guestfs.pod:867 -msgid "guestfs_close" +#. type: textblock +#: ../cat/virt-ls.pod:229 +msgid "With the I<--extra-stats> flag, these additional fields are displayed:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:869 -#, no-wrap -msgid "" -" void guestfs_close (guestfs_h *g);\n" -"\n" +#. type: =item +#: ../cat/virt-ls.pod:233 +msgid "device" msgstr "" -# type: textblock -#: ../src/guestfs.pod:871 -msgid "This closes the connection handle and frees up all resources used." +#. type: textblock +#: ../cat/virt-ls.pod:235 +msgid "" +"The device containing the file (displayed as major:minor). This may not " +"match devices as known to the guest." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:873 -msgid "ERROR HANDLING" +#. type: =item +#: ../cat/virt-ls.pod:238 +msgid "inode" msgstr "" -# type: textblock -#: ../src/guestfs.pod:875 -msgid "" -"The convention in all functions that return C is that they return C<-1> " -"to indicate an error. You can get additional information on errors by " -"calling L and/or by setting up an error handler with L." +#. type: textblock +#: ../cat/virt-ls.pod:240 +msgid "The inode number." msgstr "" -# type: textblock -#: ../src/guestfs.pod:880 -msgid "The default error handler prints the information string to C." +#. type: =item +#: ../cat/virt-ls.pod:242 +msgid "nlink" msgstr "" -# type: textblock -#: ../src/guestfs.pod:882 -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." +#. type: textblock +#: ../cat/virt-ls.pod:244 +msgid "The number of hard links." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:886 -msgid "guestfs_last_error" +#. type: =item +#: ../cat/virt-ls.pod:246 +msgid "rdev" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:888 -#, no-wrap +#. type: textblock +#: ../cat/virt-ls.pod:248 msgid "" -" const char *guestfs_last_error (guestfs_h *g);\n" -"\n" +"For block and char special files, the device (displayed as major:minor)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:890 -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." +#. type: =item +#: ../cat/virt-ls.pod:251 +msgid "blocks" msgstr "" -# type: textblock -#: ../src/guestfs.pod:894 -msgid "" -"The lifetime of the returned string is until the next error occurs, or L is called." +#. type: textblock +#: ../cat/virt-ls.pod:253 +msgid "The number of 512 byte blocks allocated to the file." msgstr "" -# type: textblock -#: ../src/guestfs.pod:897 +#. type: textblock +#: ../cat/virt-ls.pod:257 msgid "" -"The error string is not localized (ie. is always in English), because this " -"makes searching for error messages in search engines give the largest number " -"of results." +"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: =head2 -#: ../src/guestfs.pod:901 -msgid "guestfs_set_error_handler" +#. type: =item +#: ../cat/virt-ls.pod:280 +msgid "B<--checksum>" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:903 -#, no-wrap -msgid "" -" typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n" -" void *opaque,\n" -" const char *msg);\n" -" void guestfs_set_error_handler (guestfs_h *g,\n" -" guestfs_error_handler_cb cb,\n" -" void *opaque);\n" -"\n" +#. type: =item +#: ../cat/virt-ls.pod:282 +msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:910 +#. type: textblock +#: ../cat/virt-ls.pod:284 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." +"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 -#: ../src/guestfs.pod:914 +#. type: textblock +#: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358 +#: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408 +#: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422 msgid "" -"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." +"This option only has effect in I<-lR> output mode. See L above." msgstr "" -# type: textblock -#: ../src/guestfs.pod:918 -msgid "The default handler prints messages on C." +#. type: textblock +#: ../cat/virt-ls.pod:316 +msgid "" +"When prompting for keys and passphrases, virt-ls normally turns echoing off " +"so you cannot see what you are typing. If you are not worried about Tempest " +"attacks and there is no one else in the room you can specify this flag to " +"see what you are typing." msgstr "" -# type: textblock -#: ../src/guestfs.pod:920 -msgid "If you set C to C then I handler is called." +#. type: =item +#: ../cat/virt-ls.pod:321 +msgid "B<--extra-stats>" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:922 -msgid "guestfs_get_error_handler" +#. type: textblock +#: ../cat/virt-ls.pod:323 +msgid "Display extra stats." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:924 +#. type: verbatim +#: ../cat/virt-ls.pod:339 #, no-wrap msgid "" -" guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n" -" void **opaque_rtn);\n" +" virt-ls --format=raw -a disk.img /dir\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:927 -msgid "Returns the current error handler callback." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:929 -msgid "guestfs_set_out_of_memory_handler" -msgstr "" - -# type: verbatim -#: ../src/guestfs.pod:931 +#. type: verbatim +#: ../cat/virt-ls.pod:343 #, 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" +" virt-ls --format=raw -a disk.img --format -a another.img /dir\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:935 -msgid "" -"The callback C will be called if there is an out of memory situation. " -"I." +#. type: textblock +#: ../cat/virt-ls.pod:356 +msgid "Display file sizes in human-readable format." msgstr "" -# type: textblock -#: ../src/guestfs.pod:938 -msgid "The default is to call L." +#. type: =item +#: ../cat/virt-ls.pod:370 +msgid "B<-R>" +msgstr "" + +#. type: =item +#: ../cat/virt-ls.pod:372 +msgid "B<--recursive>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:940 +#. type: textblock +#: ../cat/virt-ls.pod:374 msgid "" -"You cannot set C to C. You can't ignore out of memory situations." +"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: =head2 -#: ../src/guestfs.pod:943 -msgid "guestfs_get_out_of_memory_handler" +#. type: textblock +#: ../cat/virt-ls.pod:378 +msgid "" +"C produces a \"long listing\", which shows more detail. See L." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:945 -#, no-wrap +#. type: textblock +#: ../cat/virt-ls.pod:381 msgid "" -" guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n" -"\n" +"C produces a recursive list of files starting at the named " +"directory. See L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:947 -msgid "This returns the current out of memory handler." +#. type: textblock +#: ../cat/virt-ls.pod:384 +msgid "" +"C produces a recursive long listing which can be more easily " +"parsed. See L." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:949 -msgid "PATH" +#. type: =item +#: ../cat/virt-ls.pod:387 +msgid "B<--times>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:951 -msgid "" -"Libguestfs needs a kernel and initrd.img, which it finds by looking along an " -"internal path." +#. type: textblock +#: ../cat/virt-ls.pod:389 +msgid "Display time fields." msgstr "" -# type: textblock -#: ../src/guestfs.pod:954 -msgid "" -"By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C)." +#. type: =item +#: ../cat/virt-ls.pod:394 +msgid "B<--time-days>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:957 -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: textblock +#: ../cat/virt-ls.pod:396 +msgid "Display time fields as days before now (negative if in the future)." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:964 -msgid "HIGH-LEVEL API ACTIONS" +#. type: textblock +#: ../cat/virt-ls.pod:398 +msgid "" +"Note that C<0> in output means \"up to 1 day before now\", or that the age " +"of the file is between 0 and 86399 seconds." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:966 -msgid "ABI GUARANTEE" +#. type: =item +#: ../cat/virt-ls.pod:404 +msgid "B<--time-relative>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:968 -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." +#. type: textblock +#: ../cat/virt-ls.pod:406 +msgid "Display time fields as seconds before now (negative if in the future)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:974 ../fish/guestfish.pod:860 -msgid "@ACTIONS@" +#. type: =item +#: ../cat/virt-ls.pod:411 +msgid "B<--time-t>" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:976 -msgid "STRUCTURES" +#. type: textblock +#: ../cat/virt-ls.pod:413 +msgid "Display time fields as seconds since the Unix epoch." msgstr "" -# type: textblock -#: ../src/guestfs.pod:978 -msgid "@STRUCTS@" +#. type: =item +#: ../cat/virt-ls.pod:418 +msgid "B<--uids>" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:980 -msgid "AVAILABILITY" +#. type: textblock +#: ../cat/virt-ls.pod:420 +msgid "Display UID and GID fields." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:982 -msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE" +#. type: textblock +#: ../cat/virt-ls.pod:445 +msgid "Previous versions of virt-ls allowed you to write either:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:984 +#. type: verbatim +#: ../cat/virt-ls.pod:447 +#, no-wrap 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." +" virt-ls disk.img [disk.img ...] /dir\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:989 -msgid "@AVAILABILITY@" +#. type: verbatim +#: ../cat/virt-ls.pod:451 +#, no-wrap +msgid "" +" virt-ls guestname /dir\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:991 -msgid "GUESTFISH supported COMMAND" +#. type: textblock +#: ../cat/virt-ls.pod:497 +msgid "" +"L, L, L, L, L, L, L, L, " +"L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:993 -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." +#. type: textblock +#: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374 +#: ../rescue/virt-rescue.pod:302 +msgid "Copyright (C) 2009-2011 Red Hat Inc." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:998 -msgid "SINGLE CALLS AT COMPILE TIME" +#. type: textblock +#: ../df/virt-df.pod:5 +msgid "virt-df - Display free space on virtual filesystems" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1000 +#. type: verbatim +#: ../df/virt-df.pod:9 +#, no-wrap msgid "" -"Since version 1.5.8, Cguestfs.hE> defines symbols for each C API " -"function, such as:" +" virt-df [--options]\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1003 +#. type: verbatim +#: ../df/virt-df.pod:11 #, no-wrap msgid "" -" #define LIBGUESTFS_HAVE_DD 1\n" +" virt-df [--options] -d domname\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1005 -msgid "if L is available." +#. type: verbatim +#: ../df/virt-df.pod:13 +#, no-wrap +msgid "" +" virt-df [--options] -a disk.img [-a disk.img ...]\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1007 +#. type: verbatim +#: ../df/virt-df.pod:17 +#, no-wrap msgid "" -"Before version 1.5.8, if you needed to test whether a single libguestfs " -"function is available at compile time, we recommended using build tools such " -"as autoconf or cmake. For example in autotools you could use:" +" virt-df [--options] domname\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1012 +#. type: verbatim +#: ../df/virt-df.pod:19 #, no-wrap msgid "" -" AC_CHECK_LIB([guestfs],[guestfs_create])\n" -" AC_CHECK_FUNCS([guestfs_dd])\n" +" virt-df [--options] disk.img [disk.img ...]\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1015 +#. type: textblock +#: ../df/virt-df.pod:23 msgid "" -"which would result in C being either defined or not defined " -"in your program." +"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: =head2 -#: ../src/guestfs.pod:1018 -msgid "SINGLE CALLS AT RUN TIME" +#. type: textblock +#: ../df/virt-df.pod:28 +msgid "" +"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 -#: ../src/guestfs.pod:1020 +#. type: textblock +#: ../df/virt-df.pod:32 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." +"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 -#: ../src/guestfs.pod:1027 +#. type: textblock +#: ../df/virt-df.pod:39 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):" +"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: verbatim -#: ../src/guestfs.pod:1031 -#, no-wrap +#. type: textblock +#: ../df/virt-df.pod:45 msgid "" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" #include \n" -" \n" +"Show disk usage for a single libvirt guest called C. Make the " +"output human-readable:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1037 +#. type: verbatim +#: ../df/virt-df.pod:48 #, no-wrap msgid "" -" main ()\n" -" {\n" -" #ifdef LIBGUESTFS_HAVE_DD\n" -" void *dl;\n" -" int has_function;\n" -" \n" +" # virt-df -d F14x64 -h\n" +" Filesystem Size Used Available Use%\n" +" F14x64:/dev/sda1 484M 66M 393M 14%\n" +" F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1043 -#, 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 +#: ../df/virt-df.pod:53 +msgid "Show disk usage for a disk image file called C:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1052 +#. type: verbatim +#: ../df/virt-df.pod:55 #, no-wrap msgid "" -" if (!has_function)\n" -" printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n" -" else {\n" -" printf (\"this libguestfs.so has guestfs_dd function\\n\");\n" -" /* Now it's safe to call\n" -" guestfs_dd (g, \"foo\", \"bar\");\n" -" */\n" -" }\n" -" #else\n" -" printf (\"guestfs_dd function was not found at compile time\\n\");\n" -" #endif\n" -" }\n" +" $ virt-df -a test1.img\n" +" Filesystem 1K-blocks Used Available Use%\n" +" test1.img:/dev/sda1 99099 1551 92432 2%\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1065 +#. type: verbatim +#: ../df/virt-df.pod:112 +#, no-wrap 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:" +" virt-df --format=raw -a disk.img\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1070 +#. type: verbatim +#: ../df/virt-df.pod:116 #, no-wrap msgid "" -" Requires: libguestfs >= 1.0.80\n" +" virt-df --format=raw -a disk.img --format -a another.img\n" "\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1072 -msgid "CALLS WITH OPTIONAL ARGUMENTS" +#. type: textblock +#: ../df/virt-df.pod:129 +msgid "Print sizes in human-readable format." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1074 -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:" +#. type: textblock +#: ../df/virt-df.pod:131 +msgid "You are not allowed to use I<-h> and I<--csv> at the same time." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1079 -#, no-wrap -msgid "" -" int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n" -"\n" +#. type: =item +#: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155 +msgid "B<-i>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1081 -msgid "" -"Call this with a list of optional arguments, terminated by C<-1>. So to " -"call with no optional arguments specified:" +#. type: =item +#: ../df/virt-df.pod:135 +msgid "B<--inodes>" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1084 -#, no-wrap -msgid "" -" guestfs_add_drive_opts (g, filename, -1);\n" -"\n" +#. type: textblock +#: ../df/virt-df.pod:137 +msgid "Print inodes instead of blocks." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1086 -msgid "With a single optional argument:" +#. type: =item +#: ../df/virt-df.pod:139 +msgid "B<--one-per-guest>" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1088 -#, no-wrap +#. type: textblock +#: ../df/virt-df.pod:141 msgid "" -" guestfs_add_drive_opts (g, filename,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n" -" -1);\n" -"\n" +"Run one libguestfs appliance per guest. Normally C will add the " +"disks from several guests to a single libguestfs appliance." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1092 -msgid "With two:" +#. type: textblock +#: ../df/virt-df.pod:144 +msgid "You might use this option in the following circumstances:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1094 -#, no-wrap +#. 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:2959 +#: ../src/guestfs.pod:2964 ../src/guestfs.pod:2968 ../src/guestfs.pod:2972 +#: ../src/guestfs.pod:2976 ../src/guestfs.pod:2990 ../src/guestfs.pod:2995 +#: ../src/guestfs.pod:3223 ../src/guestfs.pod:3227 ../src/guestfs.pod:3231 +#: ../src/guestfs.pod:3235 ../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 +#: ../df/virt-df.pod:150 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" +"If you think an untrusted guest might actively try to exploit the libguestfs " +"appliance kernel, then this prevents one guest from interfering with the " +"stats printed for another guest." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1099 +#. type: textblock +#: ../df/virt-df.pod:156 msgid "" -"and so forth. Don't forget the terminating C<-1> otherwise Bad Things will " -"happen!" +"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: =head2 -#: ../src/guestfs.pod:1102 -msgid "USING va_list FOR OPTIONAL ARGUMENTS" +#. type: textblock +#: ../df/virt-df.pod:165 +msgid "" +"Print UUIDs instead of names. This is useful for following a guest even " +"when the guest is migrated or renamed, or when two guests happen to have the " +"same name." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1104 +#. type: textblock +#: ../df/virt-df.pod:169 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:" +"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: verbatim -#: ../src/guestfs.pod:1108 -#, no-wrap +#. type: textblock +#: ../df/virt-df.pod:229 msgid "" -" int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n" -" va_list args);\n" -"\n" +"L, L, L, L, L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1111 -msgid "CONSTRUCTING OPTIONAL ARGUMENTS" +#. type: textblock +#: ../edit/virt-edit.pod:5 +msgid "virt-edit - Edit a file in a virtual machine" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1113 +#. type: verbatim +#: ../edit/virt-edit.pod:9 +#, no-wrap 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:" +" virt-edit [--options] -d domname file [file ...]\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1119 +#. type: verbatim +#: ../edit/virt-edit.pod:11 #, no-wrap 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" +" virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1128 -msgid "You could call it like this:" +#. type: verbatim +#: ../edit/virt-edit.pod:13 +#, no-wrap +msgid "" +" virt-edit [-d domname|-a disk.img] file -e 'expr'\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1130 +#. type: verbatim +#: ../edit/virt-edit.pod:17 #, no-wrap 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" +" virt-edit domname file\n" +"\n" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1137 +#. type: verbatim +#: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183 #, no-wrap msgid "" -" guestfs_add_drive_opts_argv (g, filename, &optargs);\n" +" virt-edit disk.img [disk.img ...] file\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1139 ../src/guestfs-actions.pod:10 -#: ../src/guestfs-actions.pod:1582 ../fish/guestfish-actions.pod:9 -#: ../fish/guestfish-actions.pod:1244 -msgid "Notes:" +#. type: =head1 +#: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23 +#: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15 +#: ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19 +#: ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51 +msgid "WARNING" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1145 -msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask." +#. type: textblock +#: ../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 -#: ../src/guestfs.pod:1150 -msgid "You do not need to fill in all fields of the structure." +#. type: textblock +#: ../edit/virt-edit.pod:29 +msgid "" +"C is a command line tool to edit C where each C " +"exists in the named virtual machine (or disk image)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1154 +#. type: textblock +#: ../edit/virt-edit.pod:32 msgid "" -"There must be a one-to-one correspondence between fields of the structure " -"that are filled in, and bits set in the bitmask." +"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: =head2 -#: ../src/guestfs.pod:1159 -msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES" +#. type: textblock +#: ../edit/virt-edit.pod:36 +msgid "If you want to just view a file, use L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1161 +#. type: textblock +#: ../edit/virt-edit.pod:38 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." +"For more complex cases you should look at the L tool (see L below)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1165 -msgid "For guestfish, see L." +#. type: textblock +#: ../edit/virt-edit.pod:41 +msgid "" +"C cannot be used to create a new file. L can do " +"that and much more." msgstr "" -# type: =end -#: ../src/guestfs.pod:1167 ../src/guestfs.pod:1172 -msgid "html" +#. type: textblock +#: ../edit/virt-edit.pod:46 +msgid "Edit the named files interactively:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1169 +#. type: verbatim +#: ../edit/virt-edit.pod:48 +#, no-wrap msgid "" -" " +" virt-edit -d mydomain /boot/grub/grub.conf\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1174 -msgid "ARCHITECTURE" +#. type: verbatim +#: ../edit/virt-edit.pod:50 +#, no-wrap +msgid "" +" virt-edit -d mydomain /etc/passwd\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1176 -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: textblock +#: ../edit/virt-edit.pod:52 +msgid "For Windows guests, some Windows paths are understood:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1180 +#. type: verbatim +#: ../edit/virt-edit.pod:54 #, no-wrap msgid "" -" ___________________\n" -" / \\\n" -" | main program |\n" -" | |\n" -" | | child process / appliance\n" -" | | __________________________\n" -" | | / qemu \\\n" -" +-------------------+ RPC | +-----------------+ |\n" -" | libguestfs <--------------------> guestfsd | |\n" -" | | | +-----------------+ |\n" -" \\___________________/ | | Linux kernel | |\n" -" | +--^--------------+ |\n" -" \\_________|________________/\n" -" |\n" -" _______v______\n" -" / \\\n" -" | Device or |\n" -" | disk image |\n" -" \\______________/\n" +" virt-edit -d mywindomain 'c:\\autoexec.bat'\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1200 +#. type: textblock +#: ../edit/virt-edit.pod:56 msgid "" -"The library, linked to the main program, creates the child process and hence " -"the appliance in the L function." +"If Perl is installed, you can also edit files non-interactively (see L below). To change the init default level to 5:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1203 +#. type: verbatim +#: ../edit/virt-edit.pod:60 +#, no-wrap msgid "" -"Inside the appliance is a Linux kernel and a complete stack of userspace " -"tools (such as LVM and ext2 programs) and a small controlling daemon called " -"L. 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." +" virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1212 -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)." +#. type: =item +#: ../edit/virt-edit.pod:81 +msgid "B<-b> extension" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1219 -msgid "STATE MACHINE" +#. type: =item +#: ../edit/virt-edit.pod:83 +msgid "B<--backup> extension" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1221 -msgid "libguestfs uses a state machine to model the child process:" +#. type: textblock +#: ../edit/virt-edit.pod:85 +msgid "" +"Create a backup of the original file I. The backup " +"has the original filename with C added." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1223 -#, no-wrap +#. type: textblock +#: ../edit/virt-edit.pod:88 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" +"Usually the first character of C would be a dot C<.> so you would " +"write:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1245 +#. type: verbatim +#: ../edit/virt-edit.pod:91 +#, no-wrap 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." +" virt-edit -b .orig [etc]\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1250 -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." +#. type: textblock +#: ../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 -#: ../src/guestfs.pod:1254 +#. type: textblock +#: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84 +#: ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134 +#: ../tools/virt-win-reg.pl:135 msgid "" -"Configuration commands for qemu such as L can only be " -"issued when in the CONFIG state." +"If you specify guest block devices directly, then libvirt is not used at all." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1257 +#. type: textblock +#: ../edit/virt-edit.pod:114 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." +"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 -#: ../src/guestfs.pod:1263 +#. type: textblock +#: ../edit/virt-edit.pod:123 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." +"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 -#: ../src/guestfs.pod:1269 +#. type: textblock +#: ../edit/virt-edit.pod:127 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." +"Be careful to properly quote the expression to prevent it from being altered " +"by the shell." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1273 -msgid "SETTING CALLBACKS TO HANDLE EVENTS" +#. type: textblock +#: ../edit/virt-edit.pod:130 +msgid "Note that this option is only available when Perl 5 is installed." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1275 -msgid "" -"The child process generates events in some situations. Current events " -"include: receiving a log message, the child process exits." +#. type: =item +#: ../edit/virt-edit.pod:132 +msgid "B<--format> raw|qcow2|..." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1278 +#. type: verbatim +#: ../edit/virt-edit.pod:143 +#, no-wrap msgid "" -"Use the C functions to set a callback for different " -"types of events." +" virt-edit --format=raw -a disk.img file\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1281 +#. type: verbatim +#: ../edit/virt-edit.pod:147 +#, no-wrap msgid "" -"Only I can be registered for each handle. " -"Calling C again overwrites the previous callback of " -"that type. Cancel all callbacks of this type by calling this function with " -"C set to C." +" virt-edit --format=raw -a disk.img --format -a another.img file\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1286 -msgid "guestfs_set_log_message_callback" +#. type: textblock +#: ../edit/virt-edit.pod:181 +msgid "Previous versions of virt-edit allowed you to write either:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1288 +#. type: verbatim +#: ../edit/virt-edit.pod:187 #, no-wrap msgid "" -" typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n" -" char *buf, int len);\n" -" void guestfs_set_log_message_callback (guestfs_h *g,\n" -" guestfs_log_message_cb cb,\n" -" void *opaque);\n" +" virt-edit guestname file\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1294 +#. type: =head1 +#: ../edit/virt-edit.pod:195 +msgid "NON-INTERACTIVE EDITING" +msgstr "" + +#. type: textblock +#: ../edit/virt-edit.pod:197 msgid "" -"The callback function C will be called whenever qemu or the guest writes " -"anything to the console." +"C normally calls out to C<$EDITOR> (or vi) so the system " +"administrator can interactively edit the file." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1297 -msgid "Use this function to capture kernel messages and similar." +#. type: textblock +#: ../edit/virt-edit.pod:200 +msgid "" +"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 -#: ../src/guestfs.pod:1299 +#. type: textblock +#: ../edit/virt-edit.pod:206 msgid "" -"Normally there is no log message handler, and log messages are just " -"discarded." +"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: =head2 -#: ../src/guestfs.pod:1302 -msgid "guestfs_set_subprocess_quit_callback" +#. type: textblock +#: ../edit/virt-edit.pod:210 +msgid "" +"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 -#: ../src/guestfs.pod:1304 +#. type: verbatim +#: ../edit/virt-edit.pod:214 #, no-wrap msgid "" -" typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n" -" guestfs_subprocess_quit_cb cb,\n" -" void *opaque);\n" +" virt-edit -d domname filename -e 's/foo/bar/'\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1309 +#. type: textblock +#: ../edit/virt-edit.pod:216 msgid "" -"The callback function C 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)." -msgstr "" - -# type: =head2 -#: ../src/guestfs.pod:1314 -msgid "guestfs_set_launch_done_callback" +"The full power of Perl regular expressions can be used (see L). " +"For example to delete root's password you could do:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1316 +#. type: verbatim +#: ../edit/virt-edit.pod:219 #, no-wrap msgid "" -" typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_launch_done_callback (guestfs_h *g,\n" -" guestfs_launch_done_cb cb,\n" -" void *opaque);\n" +" virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1321 +#. type: textblock +#: ../edit/virt-edit.pod:221 msgid "" -"The callback function C 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)." +"What really happens is that the snippet is evaluated as a Perl expression " +"for each line of the file. The line, including the final C<\\n>, is passed " +"in C<$_> and the expression should update C<$_> or leave it unchanged." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1325 -msgid "guestfs_set_close_callback" +#. type: textblock +#: ../edit/virt-edit.pod:226 +msgid "" +"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 -#: ../src/guestfs.pod:1327 +#. type: verbatim +#: ../edit/virt-edit.pod:229 #, no-wrap msgid "" -" typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n" -" void guestfs_set_close_callback (guestfs_h *g,\n" -" guestfs_close_cb cb,\n" -" void *opaque);\n" +" virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1332 +#. type: textblock +#: ../edit/virt-edit.pod:231 msgid "" -"The callback function C will be called while the handle is being closed " -"(synchronously from 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 -#: ../src/guestfs.pod:1335 +#. type: textblock +#: ../edit/virt-edit.pod:237 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)." +"The variable C<$lineno> contains the current line number. As is " +"traditional, the first line in the file is number C<1>." +msgstr "" + +#. type: textblock +#: ../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: =head2 -#: ../src/guestfs.pod:1343 -msgid "guestfs_set_progress_callback" +#. 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 -#: ../src/guestfs.pod:1345 +#. type: verbatim +#: ../edit/virt-edit.pod:249 #, no-wrap msgid "" -" typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n" -" int proc_nr, int serial,\n" -" uint64_t position, uint64_t total);\n" -" void guestfs_set_progress_callback (guestfs_h *g,\n" -" guestfs_progress_cb cb,\n" -" void *opaque);\n" +" /some text(\\r?\\n)?$/\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1352 +#. type: textblock +#: ../edit/virt-edit.pod:251 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)." +"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 -#: ../src/guestfs.pod:1358 +#. type: verbatim +#: ../edit/virt-edit.pod:255 +#, no-wrap msgid "" -"The callback receives two numbers: C and C. 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." +" my $m = $_; chomp $m; $m =~ /some text$/\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1364 -msgid "The only defined and stable parts of the API are:" +#. type: =head1 +#: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858 +msgid "WINDOWS PATHS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1370 +#. type: textblock +#: ../edit/virt-edit.pod:259 msgid "" -"The callback can display to the user some type of progress bar or indicator " -"which shows the ratio of C:C." +"C has a limited ability to understand Windows drive letters and " +"paths (eg. C)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1375 -msgid "0 E= C E= C" +#. type: textblock +#: ../edit/virt-edit.pod:262 +msgid "If and only if the guest is running Windows then:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1379 +#. type: textblock +#: ../edit/virt-edit.pod:268 msgid "" -"If any progress notification is sent during a call, then a final progress " -"notification is always sent when C = C." +"Drive letter prefixes like C are resolved against the Windows Registry " +"to the correct filesystem." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1382 +#. type: textblock +#: ../edit/virt-edit.pod:273 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." +"Any backslash (C<\\>) characters in the path are replaced with forward " +"slashes so that libguestfs can process it." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1388 +#. type: textblock +#: ../edit/virt-edit.pod:278 msgid "" -"The callback also receives the procedure number and serial number of the " -"call. These are only useful for debugging protocol issues, and the callback " -"can normally ignore them. The callback may want to print these numbers in " -"error messages or debugging messages." +"The path is resolved case insensitively to locate the file that should be " +"edited." msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1393 -msgid "PRIVATE DATA AREA" +#. type: textblock +#: ../edit/virt-edit.pod:283 +msgid "There are some known shortcomings:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1395 +#. type: textblock +#: ../edit/virt-edit.pod:289 +msgid "Some NTFS symbolic links may not be followed correctly." +msgstr "" + +#. type: textblock +#: ../edit/virt-edit.pod:293 +msgid "NTFS junction points that cross filesystems are not followed." +msgstr "" + +#. type: textblock +#: ../edit/virt-edit.pod:299 msgid "" -"You can attach named pieces of private data to the libguestfs handle, and " -"fetch them by name for the lifetime of the handle. This is called the " -"private data area and is only available from the C API." +"L is a more powerful, lower level tool which you can use when " +"C doesn't work." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1399 -msgid "To attach a named piece of data, use the following call:" +#. type: textblock +#: ../edit/virt-edit.pod:302 +msgid "Using C is approximately equivalent to doing:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1401 +#. type: verbatim +#: ../edit/virt-edit.pod:304 #, no-wrap msgid "" -" void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n" +" guestfish --rw -i -d domname edit /file\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1403 +#. type: textblock +#: ../edit/virt-edit.pod:306 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." +"where C is the name of the libvirt guest, and C is the full " +"path to the file." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1407 +#. type: textblock +#: ../edit/virt-edit.pod:309 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." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1412 -msgid "To retrieve the pointer, use:" +"The command above uses libguestfs's guest inspection feature and so does not " +"work on guests that libguestfs cannot inspect, or on things like arbitrary " +"disk images that don't contain guests. To edit a file on a disk image " +"directly, use:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1414 +#. type: verbatim +#: ../edit/virt-edit.pod:314 #, no-wrap msgid "" -" void *guestfs_get_private (guestfs_h *g, const char *key);\n" +" guestfish --rw -a disk.img -m /dev/sda1 edit /file\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1416 +#. type: textblock +#: ../edit/virt-edit.pod:316 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." +"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 -#: ../src/guestfs.pod:1420 +#. type: textblock +#: ../edit/virt-edit.pod:320 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, and note that only one callback " -"can be registered for a handle)." +"C cannot create new files. Use the guestfish commands C, " +"C or C instead:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1428 +#. type: verbatim +#: ../edit/virt-edit.pod:323 +#, no-wrap msgid "" -"The private data area is implemented using a hash table, and should be " -"reasonably efficient for moderate numbers of keys." +" guestfish --rw -i -d domname touch /newfile\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1431 -msgid "BLOCK DEVICE NAMING" +#. type: verbatim +#: ../edit/virt-edit.pod:325 +#, no-wrap +msgid "" +" guestfish --rw -i -d domname write /newfile \"new content\"\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1433 +#. type: verbatim +#: ../edit/virt-edit.pod:327 +#, no-wrap 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." +" guestfish --rw -i -d domname upload localfile /newfile\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1445 -msgid "" -"As discussed above, libguestfs uses a qemu appliance running an embedded " -"Linux kernel to access block devices. We can run a variety of appliances " -"based on a variety of Linux kernels." +#. type: =head1 +#: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086 +#: ../rescue/virt-rescue.pod:261 ../sparsify/virt-sparsify.pod:232 +#: ../src/guestfs.pod:3106 ../test-tool/libguestfs-test-tool.pod:95 +msgid "ENVIRONMENT VARIABLES" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1449 -msgid "" -"This causes a problem for libguestfs because many API calls use device or " -"partition names. Working scripts and the recipe (example) scripts that we " -"make available over the internet could fail if the naming scheme changes." +#. type: =item +#: ../edit/virt-edit.pod:333 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1454 +#. type: textblock +#: ../edit/virt-edit.pod:335 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." +"If set, this string is used as the editor. It may contain arguments, eg. C<" +"\"emacs -nw\">" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1460 +#. type: textblock +#: ../edit/virt-edit.pod:338 +msgid "If not set, C is used." +msgstr "" + +#. type: textblock +#: ../edit/virt-edit.pod:356 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." +"L, L, L, L, L, L, L, L, " +"L, L, L." msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1465 -msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:5 +msgid "guestfs-erlang - How to use libguestfs from Erlang" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1467 +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:9 +#, 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." +" {ok, G} = guestfs:create(),\n" +" ok = guestfs:add_drive_opts(G, Disk,\n" +" [{format, \"raw\"}, {readonly, true}]),\n" +" ok = guestfs:launch(G),\n" +" [Device] = guestfs:list_devices(G),\n" +" ok = guestfs:close(G).\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1473 +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:18 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." +"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: textblock -#: ../src/guestfs.pod:1481 -msgid "Is the string a parameter which is a device or partition name?" +#. type: =head2 +#: ../erlang/examples/guestfs-erlang.pod:23 +msgid "OPENING AND CLOSING THE HANDLE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1485 -msgid "Does the string begin with C?" +#. type: textblock +#: ../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 -#: ../src/guestfs.pod:1489 +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:29 +#, no-wrap msgid "" -"Does the named device exist? If so, we use that device. However if I " -"then we continue with this algorithm." +" {ok, G} = guestfs:create().\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1494 -msgid "Replace initial C string with C." +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:31 +#, no-wrap +msgid "" +" {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1496 -msgid "For example, change C to C." +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:33 +msgid "C is the libguestfs handle which you should pass to other functions." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1498 -msgid "If that named device exists, use it. If not, continue." +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:36 +msgid "To close the handle:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1502 -msgid "Replace initial C string with C." +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:38 +#, no-wrap +msgid "" +" ok = guestfs:close(G).\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1504 -msgid "If that named device exists, use it. If not, return an error." +#. type: =head2 +#: ../erlang/examples/guestfs-erlang.pod:40 +msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1508 -msgid "PORTABILITY CONCERNS" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:42 +msgid "" +"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: textblock -#: ../src/guestfs.pod:1510 +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:46 +#, no-wrap msgid "" -"Although the standard naming scheme and automatic translation is useful for " -"simple programs and guestfish scripts, for larger programs it is best not to " -"rely on this mechanism." +" ok = guestfs:add_drive_opts(G, Disk,\n" +" [{format, \"raw\"}, {readonly, true}]).\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1514 -msgid "" -"Where possible for maximum future portability programs using libguestfs " -"should use these future-proof techniques:" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:49 +msgid "If the last argument would be an empty list, you can also omit it:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1521 +#. type: verbatim +#: ../erlang/examples/guestfs-erlang.pod:51 +#, no-wrap msgid "" -"Use L or L to list actual " -"device names, and then use those names directly." +" ok = guestfs:add_drive_opts(G, Disk).\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1524 -msgid "" -"Since those device names exist by definition, they will never be translated." +#. type: =head2 +#: ../erlang/examples/guestfs-erlang.pod:53 +msgid "RETURN VALUES AND ERRORS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1529 +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:55 msgid "" -"Use higher level ways to identify filesystems, such as LVM names, UUIDs and " -"filesystem labels." +"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: =head1 -#: ../src/guestfs.pod:1534 -msgid "INTERNALS" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:59 +msgid "On error, you would see one of the following tuples:" msgstr "" -# type: =head2 -#: ../src/guestfs.pod:1536 -msgid "COMMUNICATION PROTOCOL" +#. type: =item +#: ../erlang/examples/guestfs-erlang.pod:63 +msgid "C<{error, Msg, Errno}>" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1538 -msgid "" -"Don't rely on using this protocol directly. This section documents how it " -"currently works, but it may change at any time." +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:65 +msgid "This indicates an ordinary error from the function." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1541 +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:67 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)." +"C is the error message (string) and C is the Unix error " +"(integer)." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1545 -msgid "" -"The detailed format of structures is in C (note: " -"this file is automatically generated)." +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:70 +msgid "C can be zero. See L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1548 +#. type: =item +#: ../erlang/examples/guestfs-erlang.pod:72 +msgid "C<{unknown, Function}>" +msgstr "" + +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:74 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." +"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: =head3 -#: ../src/guestfs.pod:1555 -msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:78 +msgid "C is the name of the unknown function." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1557 -msgid "For ordinary functions, the request message is:" +#. type: =item +#: ../erlang/examples/guestfs-erlang.pod:80 +msgid "C<{unknownarg, Arg}>" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1559 -#, no-wrap +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:82 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" +"This indicates that you called a function with optional arguments, with an " +"unknown argument name." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1564 -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." +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:85 +msgid "C is the name of the unknown argument." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1570 -msgid "" -"Note also that many functions don't take any arguments, in which case the " -"C_args> is completely omitted." +#. type: =head1 +#: ../erlang/examples/guestfs-erlang.pod:89 +#: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37 +#: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31 +#: ../python/examples/guestfs-python.pod:34 +#: ../ruby/examples/guestfs-ruby.pod:28 +msgid "EXAMPLE 1: CREATE A DISK IMAGE" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1573 -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." +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:91 +#: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39 +#: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33 +#: ../python/examples/guestfs-python.pod:36 +#: ../ruby/examples/guestfs-ruby.pod:30 +msgid "@EXAMPLE1@" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1577 -msgid "The reply message for ordinary functions is:" +#. type: =head1 +#: ../erlang/examples/guestfs-erlang.pod:93 +#: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41 +#: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35 +#: ../python/examples/guestfs-python.pod:38 +#: ../ruby/examples/guestfs-ruby.pod:32 +msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1579 -#, 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" -"\n" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:95 +#: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43 +#: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37 +#: ../python/examples/guestfs-python.pod:40 +#: ../ruby/examples/guestfs-ruby.pod:34 +msgid "@EXAMPLE2@" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1584 +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:99 msgid "" -"As above the C_ret> structure may be completely omitted for " -"functions that return no formal return values." +"L, L, L, L, L, L, L, " +"L, L. L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1587 -msgid "" -"As above the total length of the reply is limited to C." +#. type: =head1 +#: ../erlang/examples/guestfs-erlang.pod:110 +#: ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397 +#: ../fish/guestfish.pod:1261 ../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:3242 +#: ../test-tool/libguestfs-test-tool.pod:106 +msgid "AUTHORS" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1590 -msgid "" -"In the case of an error, a flag is set in the header, and the reply message " -"is slightly changed:" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:112 +#: ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399 +#: ../fish/guestfish.pod:1263 ../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:3244 +#: ../test-tool/libguestfs-test-tool.pod:108 +msgid "Richard W.M. Jones (C)" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1593 -#, no-wrap -msgid "" -" total length (header + error,\n" -" but not including the length word itself)\n" -" struct guestfs_message_header (encoded as XDR)\n" -" struct guestfs_message_error (encoded as XDR)\n" -"\n" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:116 +#: ../java/examples/guestfs-java.pod:64 ../perl/examples/guestfs-perl.pod:58 +msgid "Copyright (C) 2011 Red Hat Inc. L" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1598 +#. 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 "" -"The C structure contains the error message as a " -"string." +"The examples in this manual page may be freely copied, modified and " +"distributed without any restrictions." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1601 -msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS" +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:121 +#: ../examples/guestfs-examples.pod:56 ../examples/guestfs-recipes.pod:408 +#: ../java/examples/guestfs-java.pod:69 +#: ../ocaml/examples/guestfs-ocaml.pod:102 +#: ../perl/examples/guestfs-perl.pod:63 +#: ../python/examples/guestfs-python.pod:65 +#: ../ruby/examples/guestfs-ruby.pod:59 ../src/guestfs.pod:3251 +msgid "" +"This library is free software; you can redistribute it and/or modify it " +"under the terms of the GNU Lesser General Public License as published by the " +"Free Software Foundation; either version 2 of the License, or (at your " +"option) any later version." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1603 +#. 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:3256 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." +"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: verbatim -#: ../src/guestfs.pod:1607 -#, no-wrap +#. type: textblock +#: ../erlang/examples/guestfs-erlang.pod:131 +#: ../examples/guestfs-examples.pod:66 ../examples/guestfs-recipes.pod:418 +#: ../java/examples/guestfs-java.pod:79 +#: ../ocaml/examples/guestfs-ocaml.pod:112 +#: ../perl/examples/guestfs-perl.pod:73 +#: ../python/examples/guestfs-python.pod:75 +#: ../ruby/examples/guestfs-ruby.pod:69 ../src/guestfs.pod:3261 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" -"\n" +"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: textblock -#: ../src/guestfs.pod:1615 -msgid "The \"sequence of chunks\" is:" +#. type: textblock +#: ../examples/guestfs-examples.pod:5 +msgid "guestfs-examples - Examples of using libguestfs from C" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1617 +#. type: verbatim +#: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9 #, no-wrap msgid "" -" length of chunk (not including length word itself)\n" -" struct guestfs_chunk (encoded as XDR)\n" -" length of chunk\n" -" struct guestfs_chunk (encoded as XDR)\n" -" ...\n" -" length of chunk\n" -" struct guestfs_chunk (with data.data_len == 0)\n" -"\n" +" #include \n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1625 +#. type: verbatim +#: ../examples/guestfs-examples.pod:11 +#, no-wrap 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." +" guestfs_h *g = guestfs_create ();\n" +" guestfs_add_drive_ro (g, \"disk.img\");\n" +" guestfs_launch (g);\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1629 +#. type: verbatim +#: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19 +#, no-wrap msgid "" -"At time of writing there are no functions that have more than one FileIn " -"parameter. However this is (theoretically) supported, by sending the " -"sequence of chunks for each FileIn parameter one after another (from left to " -"right)." +" cc prog.c -o prog -lguestfs\n" +"or:\n" +" cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1634 +#. type: textblock +#: ../examples/guestfs-examples.pod:21 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." +"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: textblock -#: ../src/guestfs.pod:1640 +#. type: textblock +#: ../examples/guestfs-examples.pod:35 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." +"L, L, L, L, L, L, L, " +"L, L." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1649 -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." +#. type: textblock +#: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97 +#: ../python/examples/guestfs-python.pod:60 +#: ../ruby/examples/guestfs-ruby.pod:54 +msgid "Copyright (C) 2010 Red Hat Inc. L" msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1655 -msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS" +#. type: =end +#: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12 +msgid "comment" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1657 +#. type: textblock +#: ../examples/guestfs-recipes.pod:5 msgid "" -"The protocol for FileOut parameters is exactly the same as for FileIn " -"parameters, but with the roles of daemon and library reversed." +"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 -#: ../src/guestfs.pod:1660 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:9 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" -"\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: =head3 -#: ../src/guestfs.pod:1668 -msgid "INITIAL MESSAGE" +#. type: textblock +#: ../examples/guestfs-recipes.pod:16 +msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1670 +#. type: textblock +#: ../examples/guestfs-recipes.pod:20 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." +"This page contains recipes for and links to things you can do using " +"libguestfs, L and the virt tools." msgstr "" -# type: =head3 -#: ../src/guestfs.pod:1674 -msgid "PROGRESS NOTIFICATION MESSAGES" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1676 -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." +#. type: =head1 +#: ../examples/guestfs-recipes.pod:23 +msgid "Audit a virtual machine for setuid files" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1680 +#. type: textblock +#: ../examples/guestfs-recipes.pod:25 msgid "" -"The library turns them into progress callbacks (see " -"C) if there is a callback registered, or " -"discards them if not." +"The link below contains a small program which can be used to audit a Linux " +"virtual machine to see what setuid and setgid files it contains." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1684 +#. type: textblock +#: ../examples/guestfs-recipes.pod:28 msgid "" -"The daemon self-limits the frequency of progress messages it sends (see " -"C). Not all calls generate progress " -"messages." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1688 -msgid "MULTIPLE HANDLES AND MULTIPLE THREADS" +"https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-" +"files/#content" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1690 -msgid "" -"All high-level libguestfs actions are synchronous. If you want to use " -"libguestfs asynchronously then you must create a thread." +#. type: =head1 +#: ../examples/guestfs-recipes.pod:30 +msgid "Change the background image in a Windows XP VM" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1693 +#. type: textblock +#: ../examples/guestfs-recipes.pod:32 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." +"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 -#: ../src/guestfs.pod:1697 +#. type: textblock +#: ../examples/guestfs-recipes.pod:37 msgid "" -"See the graphical program guestfs-browser for one possible architecture for " -"multithreaded programs using libvirt and libguestfs." +"https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://" +"lists.fedoraproject.org/pipermail/virt/2011-May/002658.html" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1700 -msgid "QEMU WRAPPERS" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:40 +msgid "Cloning a virtual machine (Linux)" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1702 +#. type: textblock +#: ../examples/guestfs-recipes.pod:42 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." +"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:1706 +#. type: textblock +#: ../examples/guestfs-recipes.pod:46 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." +"https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-" +"vm/#content" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1711 +#. type: textblock +#: ../examples/guestfs-recipes.pod:48 msgid "" -"Here is an example of a wrapper, where I have built my own copy of qemu from " -"source:" +"Avoid L. Currently what to do about virt-clone is under " +"discussion." msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1714 -#, no-wrap -msgid "" -" #!/bin/sh -\n" -" qemudir=/home/rjones/d/qemu\n" -" exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n" -"\n" +#. type: textblock +#: ../examples/guestfs-recipes.pod:51 +msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1718 -msgid "" -"Save this script as C (or wherever), C, and " -"then use it by setting the LIBGUESTFS_QEMU environment variable. For " -"example:" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:53 +msgid "Cloning a virtual machine (Windows)" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1722 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:55 msgid "" -" LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n" -"\n" +"It is possible to do a \"sysprep\" using libguestfs alone, although not " +"straightforward. Currently there is code in the Aeolus Oz project which " +"does this (using libguestfs). As part of our review of the virt-clone tool, " +"we may add sysprepping ability." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1724 +#. type: textblock +#: ../examples/guestfs-recipes.pod:60 msgid "" -"Note that libguestfs also calls qemu with the -help and -version options in " -"order to determine features." +"https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-" +"list/2011-May/msg00019.html" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1727 -msgid "LIBGUESTFS VERSION NUMBERS" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:63 +msgid "Convert a CD-ROM / DVD / ISO to a tarball" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1729 -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:" +#. type: textblock +#: ../examples/guestfs-recipes.pod:65 +msgid "This converts input C to output C:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1734 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:67 #, 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" +" guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1745 -msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"." +#. type: textblock +#: ../examples/guestfs-recipes.pod:69 +msgid "To export just a subdirectory, eg. C, do:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1747 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:71 +#, no-wrap 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." +" guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1753 -msgid "Our criteria for backporting changes are:" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:73 +msgid "Create empty disk images" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1759 +#. type: textblock +#: ../examples/guestfs-recipes.pod:75 msgid "" -"Documentation changes which don't affect any code are backported unless the " -"documentation refers to a future feature which is not in stable." +"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:1765 +#. type: textblock +#: ../examples/guestfs-recipes.pod:78 msgid "" -"Bug fixes which are not controversial, fix obvious problems, and have been " -"well tested are backported." +"https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/" +"#content" +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:80 +msgid "Dump raw filesystem content from inside a disk image or VM" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1770 +#. type: textblock +#: ../examples/guestfs-recipes.pod:82 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." +"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:1776 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:86 +#, no-wrap 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." +" guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1782 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:88 +#, no-wrap 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." +" guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1790 ../fish/guestfish.pod:867 -#: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 -#: ../tools/virt-rescue.pl:255 -msgid "ENVIRONMENT VARIABLES" +#. type: textblock +#: ../examples/guestfs-recipes.pod:90 +msgid "To list the filesystems in a disk image, use L." msgstr "" -# type: =item -#: ../src/guestfs.pod:1794 ../fish/guestfish.pod:893 -msgid "LIBGUESTFS_APPEND" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:92 +msgid "Edit grub configuration in a VM" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1796 ../fish/guestfish.pod:895 -msgid "Pass additional options to the guest kernel." +#. type: textblock +#: ../examples/guestfs-recipes.pod:94 +msgid "You can use this to:" msgstr "" -# type: =item -#: ../src/guestfs.pod:1798 ../fish/guestfish.pod:897 -msgid "LIBGUESTFS_DEBUG" +#. type: textblock +#: ../examples/guestfs-recipes.pod:100 +msgid "Fix a virtual machine that does not boot." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1800 -msgid "" -"Set C to enable verbose messages. This has the same " -"effect as calling C." +#. type: textblock +#: ../examples/guestfs-recipes.pod:104 +msgid "Change which kernel is used to boot the VM." msgstr "" -# type: =item -#: ../src/guestfs.pod:1803 ../fish/guestfish.pod:902 -msgid "LIBGUESTFS_MEMSIZE" +#. type: textblock +#: ../examples/guestfs-recipes.pod:108 +msgid "Change kernel command line options." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1805 ../fish/guestfish.pod:904 -msgid "" -"Set the memory allocated to the qemu process, in megabytes. For example:" +#. type: textblock +#: ../examples/guestfs-recipes.pod:112 +msgid "Use L to edit the grub configuration:" msgstr "" -# type: verbatim -#: ../src/guestfs.pod:1808 ../fish/guestfish.pod:907 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:114 #, no-wrap msgid "" -" LIBGUESTFS_MEMSIZE=700\n" +" virt-edit -d BrokenGuest /boot/grub/grub.conf\n" "\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:1810 ../fish/guestfish.pod:909 -msgid "LIBGUESTFS_PATH" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1812 +#. type: textblock +#: ../examples/guestfs-recipes.pod:116 msgid "" -"Set the path that libguestfs uses to search for kernel and initrd.img. See " -"the discussion of paths in section PATH above." +"or for general tinkering inside an unbootable VM use L like " +"this:" msgstr "" -# type: =item -#: ../src/guestfs.pod:1815 ../fish/guestfish.pod:914 -msgid "LIBGUESTFS_QEMU" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1817 ../fish/guestfish.pod:916 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:119 +#, no-wrap msgid "" -"Set the default qemu binary that libguestfs uses. If not set, then the qemu " -"which was found at compile time by the configure script is used." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1821 -msgid "See also L above." +" virt-rescue -d BrokenGuest\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs.pod:1823 ../fish/guestfish.pod:920 -msgid "LIBGUESTFS_TRACE" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:121 +msgid "Export any directory from a VM" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1825 +#. type: textblock +#: ../examples/guestfs-recipes.pod:123 msgid "" -"Set C to enable command traces. This has the same " -"effect as calling C." -msgstr "" - -# type: =item -#: ../src/guestfs.pod:1828 ../fish/guestfish.pod:929 -msgid "TMPDIR" +"To export C from a VM into a local directory use L:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1830 ../fish/guestfish.pod:931 -msgid "Location of temporary directory, defaults to C." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1832 ../fish/guestfish.pod:933 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:126 +#, no-wrap msgid "" -"If libguestfs was compiled to use the supermin appliance then the real " -"appliance is cached in this directory, shared between all handles belonging " -"to the same EUID. You can use C<$TMPDIR> to configure another directory to " -"use in case C is not large enough." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1840 ../fish/guestfish.pod:991 -#: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:214 -#: ../inspector/virt-inspector.pl:884 ../tools/virt-edit.pl:350 -#: ../tools/virt-win-reg.pl:487 ../tools/virt-df.pl:640 -#: ../tools/virt-ls.pl:235 ../tools/virt-resize.pl:1486 -#: ../tools/virt-list-filesystems.pl:216 ../tools/virt-cat.pl:188 -#: ../tools/virt-tar.pl:283 ../tools/virt-rescue.pl:267 -#: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254 -msgid "SEE ALSO" +" virt-copy-out -d Guest /home .\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1842 -msgid "" -"L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, " -"L." +#. 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:1860 +#. type: textblock +#: ../examples/guestfs-recipes.pod:134 msgid "" -"Tools with a similar purpose: L, L, L, L, L." -msgstr "" - -# type: =head1 -#: ../src/guestfs.pod:1867 ../tools/virt-win-reg.pl:502 -#: ../tools/virt-make-fs.pl:548 -msgid "BUGS" +"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:1869 -msgid "To get a list of bugs against libguestfs use this link:" +#. type: textblock +#: ../examples/guestfs-recipes.pod:139 +msgid "This creates a directory called C under the current directory." msgstr "" -# type: textblock -#: ../src/guestfs.pod:1871 +#. type: textblock +#: ../examples/guestfs-recipes.pod:143 msgid "" -"L" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1873 -msgid "To report a new bug against libguestfs use this link:" +"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: textblock -#: ../src/guestfs.pod:1875 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:147 +#, no-wrap msgid "" -"L" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1877 -msgid "When reporting a bug, please check:" -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1883 -msgid "That the bug hasn't been reported already." -msgstr "" - -# type: textblock -#: ../src/guestfs.pod:1887 -msgid "That you are testing a recent version." +" virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1891 -msgid "Describe the bug accurately, and give a way to reproduce it." +#. type: textblock +#: ../examples/guestfs-recipes.pod:149 +msgid "To get the output as a compressed tarball, do:" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1895 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:151 +#, no-wrap msgid "" -"Run libguestfs-test-tool and paste the B output into the " -"bug report." +" virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n" +"\n" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1900 ../fish/guestfish.pod:1008 -#: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:225 -#: ../inspector/virt-inspector.pl:893 -msgid "AUTHORS" +#. type: textblock +#: ../examples/guestfs-recipes.pod:153 +msgid "" +"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: textblock -#: ../src/guestfs.pod:1902 ../fish/guestfish.pod:1010 -#: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:227 -msgid "Richard W.M. Jones (C)" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:157 +msgid "Find out which user is using the most space" msgstr "" -# type: =head1 -#: ../src/guestfs.pod:1904 ../fish/guestfish.pod:1012 -#: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:229 -#: ../inspector/virt-inspector.pl:899 ../tools/virt-edit.pl:366 -#: ../tools/virt-win-reg.pl:517 ../tools/virt-df.pl:653 -#: ../tools/virt-ls.pl:250 ../tools/virt-resize.pl:1512 -#: ../tools/virt-list-filesystems.pl:232 ../tools/virt-cat.pl:202 -#: ../tools/virt-tar.pl:298 ../tools/virt-rescue.pl:281 -#: ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269 -msgid "COPYRIGHT" +#. type: textblock +#: ../examples/guestfs-recipes.pod:159 +msgid "" +"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:1906 ../fish/guestfish.pod:1014 -#: ../fuse/guestmount.pod:231 -msgid "Copyright (C) 2009-2010 Red Hat Inc. L" +#. type: verbatim +#: ../examples/guestfs-recipes.pod:162 +#, no-wrap +msgid "" +" #!/bin/sh -\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1909 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:164 +#, no-wrap msgid "" -"This library is free software; you can redistribute it and/or modify it " -"under the terms of the GNU Lesser General Public License as published by the " -"Free Software Foundation; either version 2 of the License, or (at your " -"option) any later version." +" set -e\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1914 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:166 +#, no-wrap msgid "" -"This library is distributed in the hope that it will be useful, but WITHOUT " -"ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or " -"FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License " -"for more details." +" vm=\"$1\"\n" +" dir=/home\n" +" \n" msgstr "" -# type: textblock -#: ../src/guestfs.pod:1919 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:169 +#, no-wrap msgid "" -"You should have received a copy of the GNU Lesser General Public License " -"along with this library; if not, write to the Free Software Foundation, " -"Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA" +" eval $(guestfish --ro -d \"$vm\" -i --listen)\n" +" \n" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1 -msgid "guestfs_add_cdrom" +#. type: verbatim +#: ../examples/guestfs-recipes.pod:171 +#, no-wrap +msgid "" +" for d in $(guestfish --remote ls \"$dir\"); do\n" +" echo -n \"$dir/$d\"\n" +" echo -ne '\\t'\n" +" guestfish --remote du \"$dir/$d\";\n" +" done | sort -nr -k 2\n" +" \n" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941 #, no-wrap msgid "" -" int guestfs_add_cdrom (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" guestfish --remote exit\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:6 ../fish/guestfish-actions.pod:5 -msgid "This function adds a virtual CD-ROM disk image to the guest." +#. type: =head1 +#: ../examples/guestfs-recipes.pod:179 +msgid "Get DHCP address from a VM" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:8 ../fish/guestfish-actions.pod:7 -msgid "This is equivalent to the qemu parameter C<-cdrom filename>." +#. type: textblock +#: ../examples/guestfs-recipes.pod:181 +msgid "" +"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-actions.pod:16 +#. type: textblock +#: ../examples/guestfs-recipes.pod:184 msgid "" -"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 C call " -"instead." +"https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-" +"a-virtual-machine-disk-image/#content" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:23 +#. type: textblock +#: ../examples/guestfs-recipes.pod:186 msgid "" -"If you just want to add an ISO file (often you use this as an efficient way " -"to transfer large files into the guest), then you should probably use " -"C instead." +"In the libguestfs source examples directory you will find the latest version " +"of the C program." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:54 -#: ../src/guestfs-actions.pod:112 ../src/guestfs-actions.pod:144 -#: ../src/guestfs-actions.pod:155 ../src/guestfs-actions.pod:173 -#: ../src/guestfs-actions.pod:190 ../src/guestfs-actions.pod:201 -#: ../src/guestfs-actions.pod:304 ../src/guestfs-actions.pod:321 -#: ../src/guestfs-actions.pod:332 ../src/guestfs-actions.pod:368 -#: ../src/guestfs-actions.pod:390 ../src/guestfs-actions.pod:405 -#: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:496 -#: ../src/guestfs-actions.pod:507 ../src/guestfs-actions.pod:519 -#: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:615 -#: ../src/guestfs-actions.pod:626 ../src/guestfs-actions.pod:637 -#: ../src/guestfs-actions.pod:783 ../src/guestfs-actions.pod:800 -#: ../src/guestfs-actions.pod:815 ../src/guestfs-actions.pod:890 -#: ../src/guestfs-actions.pod:905 ../src/guestfs-actions.pod:921 -#: ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:949 -#: ../src/guestfs-actions.pod:982 ../src/guestfs-actions.pod:1040 -#: ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1090 -#: ../src/guestfs-actions.pod:1121 ../src/guestfs-actions.pod:1209 -#: ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:1440 -#: ../src/guestfs-actions.pod:1459 ../src/guestfs-actions.pod:1540 -#: ../src/guestfs-actions.pod:1888 ../src/guestfs-actions.pod:2011 -#: ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2096 -#: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2517 -#: ../src/guestfs-actions.pod:2534 ../src/guestfs-actions.pod:2642 -#: ../src/guestfs-actions.pod:2653 ../src/guestfs-actions.pod:2663 -#: ../src/guestfs-actions.pod:2674 ../src/guestfs-actions.pod:2686 -#: ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:2780 -#: ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2811 -#: ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2851 -#: ../src/guestfs-actions.pod:2880 ../src/guestfs-actions.pod:2896 -#: ../src/guestfs-actions.pod:2912 ../src/guestfs-actions.pod:2941 -#: ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2983 -#: ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3006 -#: ../src/guestfs-actions.pod:3018 ../src/guestfs-actions.pod:3032 -#: ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3129 -#: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3184 -#: ../src/guestfs-actions.pod:3199 ../src/guestfs-actions.pod:3214 -#: ../src/guestfs-actions.pod:3227 ../src/guestfs-actions.pod:3238 -#: ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:3263 -#: ../src/guestfs-actions.pod:3275 ../src/guestfs-actions.pod:3292 -#: ../src/guestfs-actions.pod:3338 ../src/guestfs-actions.pod:3366 -#: ../src/guestfs-actions.pod:3382 ../src/guestfs-actions.pod:3398 -#: ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3421 -#: ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3443 -#: ../src/guestfs-actions.pod:3455 ../src/guestfs-actions.pod:3487 -#: ../src/guestfs-actions.pod:3499 ../src/guestfs-actions.pod:3516 -#: ../src/guestfs-actions.pod:3527 ../src/guestfs-actions.pod:3541 -#: ../src/guestfs-actions.pod:3581 ../src/guestfs-actions.pod:3612 -#: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3648 -#: ../src/guestfs-actions.pod:3662 ../src/guestfs-actions.pod:3677 -#: ../src/guestfs-actions.pod:3799 ../src/guestfs-actions.pod:3851 -#: ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:3885 -#: ../src/guestfs-actions.pod:3911 ../src/guestfs-actions.pod:3968 -#: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:3992 -#: ../src/guestfs-actions.pod:4003 ../src/guestfs-actions.pod:4258 -#: ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:4285 -#: ../src/guestfs-actions.pod:4294 ../src/guestfs-actions.pod:4305 -#: ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4325 -#: ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4356 -#: ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4388 -#: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4423 -#: ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4454 -#: ../src/guestfs-actions.pod:4472 ../src/guestfs-actions.pod:4488 -#: ../src/guestfs-actions.pod:4502 ../src/guestfs-actions.pod:4527 -#: ../src/guestfs-actions.pod:4548 ../src/guestfs-actions.pod:4564 -#: ../src/guestfs-actions.pod:4585 ../src/guestfs-actions.pod:4597 -#: ../src/guestfs-actions.pod:4609 ../src/guestfs-actions.pod:4625 -#: ../src/guestfs-actions.pod:4659 ../src/guestfs-actions.pod:4679 -#: ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4792 -#: ../src/guestfs-actions.pod:4898 ../src/guestfs-actions.pod:4907 -#: ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4927 -#: ../src/guestfs-actions.pod:4946 ../src/guestfs-actions.pod:4956 -#: ../src/guestfs-actions.pod:4966 ../src/guestfs-actions.pod:4976 -#: ../src/guestfs-actions.pod:4988 ../src/guestfs-actions.pod:5038 -#: ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:5065 -#: ../src/guestfs-actions.pod:5078 ../src/guestfs-actions.pod:5092 -#: ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5119 -#: ../src/guestfs-actions.pod:5149 ../src/guestfs-actions.pod:5160 -#: ../src/guestfs-actions.pod:5195 ../src/guestfs-actions.pod:5205 -#: ../src/guestfs-actions.pod:5220 ../src/guestfs-actions.pod:5246 -#: ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5378 -#: ../src/guestfs-actions.pod:5393 ../src/guestfs-actions.pod:5404 -#: ../src/guestfs-actions.pod:5450 ../src/guestfs-actions.pod:5460 -#: ../src/guestfs-actions.pod:5497 ../src/guestfs-actions.pod:5524 -#: ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:5589 -#: ../src/guestfs-actions.pod:5646 ../src/guestfs-actions.pod:5662 -#: ../src/guestfs-actions.pod:5688 -msgid "This function returns 0 on success or -1 on error." +#. type: =head1 +#: ../examples/guestfs-recipes.pod:189 +msgid "Get the operating system product name string" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:31 ../src/guestfs-actions.pod:157 -#: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:28 -#: ../fish/guestfish-actions.pod:117 ../fish/guestfish-actions.pod:131 -msgid "" -"This function is deprecated. In new code, use the C call " -"instead." +#. type: textblock +#: ../examples/guestfs-recipes.pod:191 +msgid "Save the following script into a file called C:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:34 ../src/guestfs-actions.pod:160 -#: ../src/guestfs-actions.pod:178 ../src/guestfs-actions.pod:1214 -#: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1667 -#: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5742 -#: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:120 -#: ../fish/guestfish-actions.pod:134 ../fish/guestfish-actions.pod:940 -#: ../fish/guestfish-actions.pod:1297 ../fish/guestfish-actions.pod:1311 -#: ../fish/guestfish-actions.pod:4317 ../fish/guestfish-actions.pod:4414 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:193 +#, no-wrap 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." +" #!/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: =head2 -#: ../src/guestfs-actions.pod:38 -msgid "guestfs_add_drive" +#. type: textblock +#: ../examples/guestfs-recipes.pod:200 +msgid "Make the script executable and run it on a named guest:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:40 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:202 #, no-wrap msgid "" -" int guestfs_add_drive (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" # product-name.sh RHEL60x64\n" +" Red Hat Enterprise Linux Server release 6.0 (Santiago)\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:43 +#. type: textblock +#: ../examples/guestfs-recipes.pod:205 msgid "" -"This function is the equivalent of calling C with no " -"optional parameters, so the disk is added writable, with the format being " -"detected automatically." +"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: textblock -#: ../src/guestfs-actions.pod:47 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:209 +#, no-wrap msgid "" -"Automatic detection of the format opens you up to a potential security hole " -"when dealing with untrusted raw-format images. See CVE-2010-3851 and " -"RHBZ#642934. Specifying the format closes this security hole. Therefore " -"you should think about replacing calls to this function with calls to " -"C, and specifying the format." +" # 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: =head2 -#: ../src/guestfs-actions.pod:56 -msgid "guestfs_add_drive_opts" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:215 +msgid "Get the default boot kernel for a Linux VM" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:58 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:217 msgid "" -" int guestfs_add_drive_opts (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\t...);\n" -"\n" +"The link below contains a program to print the default boot kernel for a " +"Linux VM." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:62 +#. type: textblock +#: ../examples/guestfs-recipes.pod:220 msgid "" -"You may supply a list of optional arguments to this call. Use zero or more " -"of the following pairs of parameters, and terminate the list with C<-1> on " -"its own. See L." +"https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-" +"kernel-for-a-vm/#content" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:67 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:222 msgid "" -" GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n" -" GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n" -" GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n" -"\n" +"It uses Augeas, and the technique is generally applicable for many different " +"tasks, such as:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:56 -msgid "" -"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." +#. type: textblock +#: ../examples/guestfs-recipes.pod:229 +msgid "listing the user accounts in the guest" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:61 -msgid "" -"You don't necessarily need to be root when using libguestfs. However you " -"obviously do need sufficient permissions to access the filename for whatever " -"operations you want to perform (ie. read access if you just want to read the " -"image or write access if you want to modify the image)." +#. type: textblock +#: ../examples/guestfs-recipes.pod:233 +msgid "what repositories is it configured to use" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:67 -msgid "This call checks that C exists." +#. type: textblock +#: ../examples/guestfs-recipes.pod:237 +msgid "what NTP servers does it connect to" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:84 ../fish/guestfish-actions.pod:69 -msgid "The optional arguments are:" +#. type: textblock +#: ../examples/guestfs-recipes.pod:241 +msgid "what were the boot messages last time it booted" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:88 ../fish/guestfish-actions.pod:73 -msgid "C" +#. type: textblock +#: ../examples/guestfs-recipes.pod:245 +msgid "listing who was logged in recently" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:90 ../fish/guestfish-actions.pod:75 -msgid "" -"If true then the image is treated as read-only. Writes are still allowed, " -"but they are stored in a temporary snapshot overlay which is discarded at " -"the end. The disk that you add is not modified." +#. type: textblock +#: ../examples/guestfs-recipes.pod:249 +msgid "http://augeas.net/" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:94 ../fish/guestfish-actions.pod:79 -msgid "C" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:251 +msgid "Install RPMs in a guest" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:96 +#. type: textblock +#: ../examples/guestfs-recipes.pod:253 msgid "" -"This forces the image format. If you omit this (or use C " -"or C) then the format is automatically detected. " -"Possible formats include C and C." +"The link below contains a method to install RPMs in a guest. In fact the " +"RPMs are just uploaded to the guest along with a \"firstboot\" script that " +"installs them next time the guest is booted. You could use this technique " +"to install vital security updates in an offline guest." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:100 ../fish/guestfish-actions.pod:85 +#. type: textblock +#: ../examples/guestfs-recipes.pod:259 msgid "" -"Automatic detection of the format opens you up to a potential security hole " -"when dealing with untrusted raw-format images. See CVE-2010-3851 and " -"RHBZ#642934. Specifying the format closes this security hole." +"https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:105 ../fish/guestfish-actions.pod:90 -msgid "C" +#. 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: textblock -#: ../src/guestfs-actions.pod:107 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:265 +#, no-wrap msgid "" -"This rarely-used option lets you emulate the behaviour of the deprecated " -"C call (q.v.)" +" #!/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: =head2 -#: ../src/guestfs-actions.pod:114 -msgid "guestfs_add_drive_opts_va" +#. type: textblock +#: ../examples/guestfs-recipes.pod:272 +msgid "" +"Make the file executable and then you can run it on any named virtual " +"machine:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:116 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:275 #, no-wrap msgid "" -" int guestfs_add_drive_opts_va (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tva_list args);\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: textblock -#: ../src/guestfs-actions.pod:120 -msgid "This is the \"va_list variant\" of L." +#. type: textblock +#: ../examples/guestfs-recipes.pod:305 +msgid "" +"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: textblock -#: ../src/guestfs-actions.pod:122 ../src/guestfs-actions.pod:132 -msgid "See L." +#. type: =head1 +#: ../examples/guestfs-recipes.pod:309 +msgid "List files and directories in a VM" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:124 -msgid "guestfs_add_drive_opts_argv" +#. type: textblock +#: ../examples/guestfs-recipes.pod:311 +msgid "This involves using the L C command like this:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:126 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:313 #, no-wrap msgid "" -" int guestfs_add_drive_opts_argv (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst struct guestfs_add_drive_opts_argv *optargs);\n" +" guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:130 -msgid "This is the \"argv variant\" of L." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:134 -msgid "guestfs_add_drive_ro" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:315 +msgid "List services in a Windows VM" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:136 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:317 msgid "" -" int guestfs_add_drive_ro (guestfs_h *g,\n" -"\t\tconst char *filename);\n" -"\n" +"The link below contains a script that can be used to list out the services " +"from a Windows VM, and whether those services run at boot time or are loaded " +"on demand." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:139 +#. type: textblock +#: ../examples/guestfs-recipes.pod:321 msgid "" -"This function is the equivalent of calling C with " -"the optional parameter C set to 1, so the " -"disk is added read-only, with the format being detected automatically." +"https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/" +"#content" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:146 -msgid "guestfs_add_drive_ro_with_if" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:323 +msgid "Make a disk image sparse" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:148 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:325 msgid "" -" int guestfs_add_drive_ro_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" -"\n" +"The link below contains some guides for making a disk image sparse (or " +"reintroducing sparseness)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:152 +#. type: textblock +#: ../examples/guestfs-recipes.pod:328 msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +"https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:164 -msgid "guestfs_add_drive_with_if" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:330 +msgid "Monitor disk usage over time" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:166 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:332 msgid "" -" int guestfs_add_drive_with_if (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *iface);\n" -"\n" +"You can use L to monitor disk usage of your guests over time. " +"The link below contains a guide." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:170 -msgid "" -"This is the same as C but it allows you to specify the " -"QEMU interface emulation to use at run time." +#. type: textblock +#: ../examples/guestfs-recipes.pod:335 +msgid "http://virt-tools.org/learning/advanced-virt-df/" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:182 -msgid "guestfs_aug_clear" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:337 +msgid "Reading the Windows Event Log from Windows Vista (or later)" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:184 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:339 msgid "" -" int guestfs_aug_clear (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" -"\n" +"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-actions.pod:187 ../fish/guestfish-actions.pod:142 +#. type: textblock +#: ../examples/guestfs-recipes.pod:343 msgid "" -"Set the value associated with C to C. This is the same as the " -"L C command." +"https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-" +"guestfish/#content" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:192 -msgid "guestfs_aug_close" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:345 +msgid "Remove root password (Linux)" +msgstr "" + +#. type: textblock +#: ../examples/guestfs-recipes.pod:347 +msgid "" +"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-actions.pod:194 +#. type: verbatim +#: ../examples/guestfs-recipes.pod:350 #, no-wrap msgid "" -" int guestfs_aug_close (guestfs_h *g);\n" +" virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:196 -msgid "" -"Close the current Augeas handle and free up any resources used by it. After " -"calling this, you have to call C again before you can use " -"any other Augeas functions." +#. type: =head1 +#: ../examples/guestfs-recipes.pod:352 +msgid "Remove Administrator password (Windows)" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:203 -msgid "guestfs_aug_defnode" +#. type: textblock +#: ../examples/guestfs-recipes.pod:354 +msgid "" +"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: verbatim -#: ../src/guestfs-actions.pod:205 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:359 msgid "" -" struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr,\n" -"\t\tconst char *val);\n" -"\n" +"https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-" +"administrator-password-with-guestfish/" +msgstr "" + +#. type: =head1 +#: ../examples/guestfs-recipes.pod:361 +msgid "Unpack a live CD" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:210 ../fish/guestfish-actions.pod:158 +#. type: textblock +#: ../examples/guestfs-recipes.pod:363 msgid "" -"Defines a variable C whose value is the result of evaluating C." +"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-actions.pod:213 +#. type: textblock +#: ../examples/guestfs-recipes.pod:367 msgid "" -"If C evaluates to an empty nodeset, a node is created, equivalent to " -"calling C C, C. C will be the nodeset " -"containing that single node." +"https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-" +"cd/#content" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:217 ../fish/guestfish-actions.pod:165 +#. type: =head1 +#: ../examples/guestfs-recipes.pod:369 +msgid "Uploading and downloading files" +msgstr "" + +#. type: textblock +#: ../examples/guestfs-recipes.pod:371 msgid "" -"On success this returns a pair containing the number of nodes in the " -"nodeset, and a boolean flag if a node was created." +"The link below contains general tips on uploading (copying in) and " +"downloading (copying out) files from VMs." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:221 +#. type: textblock +#: ../examples/guestfs-recipes.pod:374 msgid "" -"This function returns a C, or NULL if there was " -"an error. I after use>." +"https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:225 -msgid "guestfs_aug_defvar" +#. type: =head1 +#: ../examples/guestfs-recipes.pod:376 +msgid "Use libguestfs tools on VMware ESX guests" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:227 -#, no-wrap +#. type: textblock +#: ../examples/guestfs-recipes.pod:378 msgid "" -" int guestfs_aug_defvar (guestfs_h *g,\n" -"\t\tconst char *name,\n" -"\t\tconst char *expr);\n" -"\n" +"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-actions.pod:231 ../fish/guestfish-actions.pod:173 +#. type: textblock +#: ../examples/guestfs-recipes.pod:382 msgid "" -"Defines an Augeas variable C whose value is the result of evaluating " -"C. If C is NULL, then C is undefined." +"https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-" +"guests/#content" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:235 ../fish/guestfish-actions.pod:177 +#. type: textblock +#: ../examples/guestfs-recipes.pod:386 msgid "" -"On success this returns the number of nodes in C, or C<0> if C " -"evaluates to something which is not a nodeset." +"L, L, L, L, L, L, L, L, L, L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:379 -#: ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:558 -#: ../src/guestfs-actions.pod:573 ../src/guestfs-actions.pod:589 -#: ../src/guestfs-actions.pod:1107 ../src/guestfs-actions.pod:1422 -#: ../src/guestfs-actions.pod:1604 ../src/guestfs-actions.pod:1685 -#: ../src/guestfs-actions.pod:1716 ../src/guestfs-actions.pod:1759 -#: ../src/guestfs-actions.pod:1776 ../src/guestfs-actions.pod:2001 -#: ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2231 -#: ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3708 -#: ../src/guestfs-actions.pod:4062 ../src/guestfs-actions.pod:4085 -#: ../src/guestfs-actions.pod:5184 ../src/guestfs-actions.pod:5534 -#: ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5554 -msgid "On error this function returns -1." +#. type: textblock +#: ../examples/guestfs-recipes.pod:403 +msgid "Copyright (C) 2009-2011 Red Hat Inc. L" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:240 -msgid "guestfs_aug_get" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1 +msgid "add-cdrom" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:242 +#. type: verbatim +#: ../fish/guestfish-actions.pod:3 #, no-wrap msgid "" -" char *guestfs_aug_get (guestfs_h *g,\n" -"\t\tconst char *augpath);\n" +" add-cdrom filename\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:245 ../fish/guestfish-actions.pod:184 -msgid "" -"Look up the value associated with C. If C matches exactly one " -"node, the C is returned." +#. type: textblock +#: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14 +msgid "This function adds a virtual CD-ROM disk image to the guest." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:248 ../src/guestfs-actions.pod:676 -#: ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:748 -#: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:852 -#: ../src/guestfs-actions.pod:965 ../src/guestfs-actions.pod:994 -#: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1024 -#: ../src/guestfs-actions.pod:1135 ../src/guestfs-actions.pod:1299 -#: ../src/guestfs-actions.pod:1408 ../src/guestfs-actions.pod:1553 -#: ../src/guestfs-actions.pod:1567 ../src/guestfs-actions.pod:1643 -#: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1795 -#: ../src/guestfs-actions.pod:1934 ../src/guestfs-actions.pod:2115 -#: ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:2281 -#: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2631 -#: ../src/guestfs-actions.pod:2928 ../src/guestfs-actions.pod:3069 -#: ../src/guestfs-actions.pod:3165 ../src/guestfs-actions.pod:3723 -#: ../src/guestfs-actions.pod:3899 ../src/guestfs-actions.pod:4040 -#: ../src/guestfs-actions.pod:4201 ../src/guestfs-actions.pod:4244 -#: ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:4733 -#: ../src/guestfs-actions.pod:4747 ../src/guestfs-actions.pod:4768 -#: ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:5343 -#: ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:5506 -#: ../src/guestfs-actions.pod:5736 -msgid "" -"This function returns a string, or NULL on error. I." +#. 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: =head2 -#: ../src/guestfs-actions.pod:251 -msgid "guestfs_aug_init" +#. type: textblock +#: ../fish/guestfish-actions.pod:15 +msgid "" +"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: verbatim -#: ../src/guestfs-actions.pod:253 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:22 msgid "" -" int guestfs_aug_init (guestfs_h *g,\n" -"\t\tconst char *root,\n" -"\t\tint flags);\n" -"\n" +"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: textblock -#: ../src/guestfs-actions.pod:257 ../fish/guestfish-actions.pod:191 +#. type: textblock +#: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 +#: ../fish/guestfish-actions.pod:177 msgid "" -"Create a new Augeas handle for editing configuration files. If there was " -"any previous Augeas handle associated with this guestfs session, then it is " -"closed." +"I In new code, use the L call " +"instead." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:261 -msgid "You must call this before using any other C commands." +#. type: textblock +#: ../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: textblock -#: ../src/guestfs-actions.pod:264 ../fish/guestfish-actions.pod:198 -msgid "" -"C is the filesystem root. C must not be NULL, use C instead." +#. type: =head2 +#: ../fish/guestfish-actions.pod:35 +msgid "add-domain" +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:37 +msgid "domain" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:267 ../fish/guestfish-actions.pod:201 +#. type: verbatim +#: ../fish/guestfish-actions.pod:39 +#, no-wrap msgid "" -"The flags are the same as the flags defined in Eaugeas.hE, the " -"logical I of the following integers:" +" add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:273 ../fish/guestfish-actions.pod:207 -msgid "C = 1" +#. type: textblock +#: ../fish/guestfish-actions.pod:41 +msgid "" +"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 -#: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:209 -msgid "Keep the original file with a C<.augsave> extension." +#. type: textblock +#: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64 +msgid "" +"The number of disks added is returned. This operation is atomic: if an " +"error is returned, then no disks are added." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:277 ../fish/guestfish-actions.pod:211 -msgid "C = 2" +#. type: textblock +#: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67 +msgid "" +"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: textblock -#: ../src/guestfs-actions.pod:279 ../fish/guestfish-actions.pod:213 +#. type: textblock +#: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71 msgid "" -"Save changes into a file with extension C<.augnew>, and do not overwrite " -"original. Overrides C." +"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: =item -#: ../src/guestfs-actions.pod:282 ../fish/guestfish-actions.pod:216 -msgid "C = 4" +#. type: textblock +#: ../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: textblock -#: ../src/guestfs-actions.pod:284 ../fish/guestfish-actions.pod:218 -msgid "Typecheck lenses (can be expensive)." +#. type: textblock +#: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82 +msgid "" +"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: =item -#: ../src/guestfs-actions.pod:286 ../fish/guestfish-actions.pod:220 -msgid "C = 8" +#. type: textblock +#: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89 +msgid "" +"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 -#: ../src/guestfs-actions.pod:288 ../fish/guestfish-actions.pod:222 -msgid "Do not use standard load path for modules." +#. type: textblock +#: ../fish/guestfish-actions.pod:76 +msgid "" +"The other optional parameters are passed directly through to L." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:224 -msgid "C = 16" +#. type: textblock +#: ../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 "" +"This command has one or more optional arguments. See L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:292 ../fish/guestfish-actions.pod:226 -msgid "Make save a no-op, just record what would have been changed." +#. type: =head2 +#: ../fish/guestfish-actions.pod:81 +msgid "add-drive" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:294 ../fish/guestfish-actions.pod:228 -msgid "C = 32" +#. type: verbatim +#: ../fish/guestfish-actions.pod:83 +#, no-wrap +msgid "" +" add-drive filename\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:296 -msgid "Do not load the tree in C." +#. type: textblock +#: ../fish/guestfish-actions.pod:85 +msgid "" +"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 -#: ../src/guestfs-actions.pod:300 -msgid "To close the handle, you can call C." +#. type: textblock +#: ../fish/guestfish-actions.pod:89 +msgid "" +"Automatic detection of the format opens you up to a potential security hole " +"when dealing with untrusted raw-format images. See CVE-2010-3851 and " +"RHBZ#642934. Specifying the format closes this security hole. Therefore " +"you should think about replacing calls to this function with calls to L, and specifying the format." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:302 ../fish/guestfish-actions.pod:236 -msgid "To find out more about Augeas, see L." +#. type: =head2 +#: ../fish/guestfish-actions.pod:96 +msgid "add-drive-opts" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:306 -msgid "guestfs_aug_insert" +#. type: =head2 +#: ../fish/guestfish-actions.pod:98 +msgid "add" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:308 +#. type: verbatim +#: ../fish/guestfish-actions.pod:100 #, no-wrap msgid "" -" int guestfs_aug_insert (guestfs_h *g,\n" -"\t\tconst char *augpath,\n" -"\t\tconst char *label,\n" -"\t\tint before);\n" +" add-drive-opts filename [readonly:..] [format:..] [iface:..]\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:313 ../fish/guestfish-actions.pod:242 +#. type: textblock +#: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160 msgid "" -"Create a new sibling C functions which have " +"a more complex interface." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:961 ../fish/guestfish-actions.pod:754 +#. type: textblock +#: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:757 +#: ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:980 +#: ../fish/guestfish-actions.pod:990 ../fish/guestfish-actions.pod:1057 +#: ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1259 +#: ../fish/guestfish-actions.pod:1572 ../fish/guestfish-actions.pod:1582 +#: ../fish/guestfish-actions.pod:1632 ../fish/guestfish-actions.pod:1647 +#: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1676 +#: ../fish/guestfish-actions.pod:3769 ../fish/guestfish-actions.pod:3784 +#: ../fish/guestfish-actions.pod:3860 ../fish/guestfish-actions.pod:3877 +#: ../fish/guestfish-actions.pod:3892 ../fish/guestfish-actions.pod:4573 +#: ../fish/guestfish-actions.pod:4619 ../fish/guestfish-actions.pod:4704 +#: ../fish/guestfish-actions.pod:4719 ../fish/guestfish-actions.pod:5125 +#: ../fish/guestfish-actions.pod:5137 ../fish/guestfish-actions.pod:5155 +#: ../fish/guestfish-actions.pod:5172 ../fish/guestfish-actions.pod:5182 +#: ../fish/guestfish-actions.pod:5239 ../fish/guestfish-actions.pod:5249 +#: ../fish/guestfish-actions.pod:5278 ../fish/guestfish-actions.pod:5288 +#: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1127 +#: ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1554 +#: ../src/guestfs-actions.pod:1573 ../src/guestfs-actions.pod:1676 +#: ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1941 +#: ../src/guestfs-actions.pod:2423 ../src/guestfs-actions.pod:2442 +#: ../src/guestfs-actions.pod:2507 ../src/guestfs-actions.pod:2531 +#: ../src/guestfs-actions.pod:2548 ../src/guestfs-actions.pod:2577 +#: ../src/guestfs-actions.pod:5757 ../src/guestfs-actions.pod:5783 +#: ../src/guestfs-actions.pod:5914 ../src/guestfs-actions.pod:5940 +#: ../src/guestfs-actions.pod:5964 ../src/guestfs-actions.pod:6931 +#: ../src/guestfs-actions.pod:6986 ../src/guestfs-actions.pod:7132 +#: ../src/guestfs-actions.pod:7156 ../src/guestfs-actions.pod:7821 +#: ../src/guestfs-actions.pod:7841 ../src/guestfs-actions.pod:7874 +#: ../src/guestfs-actions.pod:7893 ../src/guestfs-actions.pod:7912 +#: ../src/guestfs-actions.pod:8006 ../src/guestfs-actions.pod:8025 +#: ../src/guestfs-actions.pod:8071 ../src/guestfs-actions.pod:8090 msgid "" -"There is no comprehensive help for this command. You have to look at the " -"file C in the libguestfs source to find out what you can do." +"Because of the message protocol, there is a transfer limit of somewhere " +"between 2MB and 4MB. See L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:968 -msgid "guestfs_debug_upload" +#. type: =head2 +#: ../fish/guestfish-actions.pod:625 +msgid "checksum" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:970 +#. type: verbatim +#: ../fish/guestfish-actions.pod:627 #, no-wrap msgid "" -" int guestfs_debug_upload (guestfs_h *g,\n" -"\t\tconst char *filename,\n" -"\t\tconst char *tmpname,\n" -"\t\tint mode);\n" +" checksum csumtype path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:975 +#. type: textblock +#: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960 msgid "" -"The C command uploads a file to the libguestfs " -"appliance." +"This call computes the MD5, SHAx or CRC checksum of the file named C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:765 +#. type: textblock +#: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963 msgid "" -"There is no comprehensive help for this command. You have to look at the " -"file C in the libguestfs source to find out what it is for." +"The type of checksum to compute is given by the C parameter which " +"must have one of the following values:" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:984 -msgid "guestfs_df" +#. type: =item +#: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:986 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970 msgid "" -" char *guestfs_df (guestfs_h *g);\n" -"\n" +"Compute the cyclic redundancy check (CRC) specified by POSIX for the " +"C command." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:988 ../fish/guestfish-actions.pod:775 -msgid "This command runs the C command to report disk space used." +#. type: =item +#: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1004 -#: ../fish/guestfish-actions.pod:777 ../fish/guestfish-actions.pod:788 -msgid "" -"This command is mostly useful for interactive sessions. It is I " -"intended that you try to parse the output string. Use C from " -"programs." +#. type: textblock +#: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975 +msgid "Compute the MD5 hash (using the C program)." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:997 -msgid "guestfs_df_h" +#. type: =item +#: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:999 -#, no-wrap -msgid "" -" char *guestfs_df_h (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979 +msgid "Compute the SHA1 hash (using the C program)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1001 ../fish/guestfish-actions.pod:785 -msgid "" -"This command runs the C command to report disk space used in human-" -"readable format." +#. type: =item +#: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1011 -msgid "guestfs_dmesg" +#. type: textblock +#: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983 +msgid "Compute the SHA224 hash (using the C program)." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1013 -#, no-wrap -msgid "" -" char *guestfs_dmesg (guestfs_h *g);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1015 ../fish/guestfish-actions.pod:796 -msgid "" -"This returns the kernel messages (C output) from the guest kernel. " -"This is sometimes useful for extended debugging of problems." +#. type: textblock +#: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987 +msgid "Compute the SHA256 hash (using the C program)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1019 -msgid "" -"Another way to get the same information is to enable verbose messages with " -"C or by setting the environment variable " -"C before running the program." +#. type: =item +#: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1027 -msgid "guestfs_download" +#. type: textblock +#: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991 +msgid "Compute the SHA384 hash (using the C program)." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1029 -#, no-wrap -msgid "" -" int guestfs_download (guestfs_h *g,\n" -"\t\tconst char *remotefilename,\n" -"\t\tconst char *filename);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1033 ../src/guestfs-actions.pod:1055 -#: ../fish/guestfish-actions.pod:809 ../fish/guestfish-actions.pod:822 -msgid "" -"Download file C and save it as C on the local " -"machine." +#. type: textblock +#: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995 +msgid "Compute the SHA512 hash (using the C program)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1036 ../src/guestfs-actions.pod:5216 -#: ../fish/guestfish-actions.pod:812 ../fish/guestfish-actions.pod:4041 -msgid "C can also be a named pipe." +#. type: textblock +#: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999 +msgid "The checksum is returned as a printable string." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1038 -msgid "See also C, C." +#. type: textblock +#: ../fish/guestfish-actions.pod:670 +msgid "To get the checksum for a device, use L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1047 -msgid "guestfs_download_offset" +#. type: textblock +#: ../fish/guestfish-actions.pod:672 +msgid "To get the checksums for many files, use L." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:674 +msgid "checksum-device" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1049 +#. type: verbatim +#: ../fish/guestfish-actions.pod:676 #, no-wrap msgid "" -" int guestfs_download_offset (guestfs_h *g,\n" -"\t\tconst char *remotefilename,\n" -"\t\tconst char *filename,\n" -"\t\tint64_t offset,\n" -"\t\tint64_t size);\n" +" checksum-device csumtype device\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1058 ../fish/guestfish-actions.pod:825 +#. type: textblock +#: ../fish/guestfish-actions.pod:678 msgid "" -"C is read for C bytes starting at C (this " -"region must be within the file or device)." +"This call computes the MD5, SHAx or CRC checksum of the contents of the " +"device named C. For the types of checksums supported see the L command." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1061 -msgid "" -"Note that there is no limit on the amount of data that can be downloaded " -"with this call, unlike with C, and this call always reads the " -"full amount unless an error occurs." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1066 -msgid "See also C, C." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:1075 -msgid "guestfs_drop_caches" +#. type: =head2 +#: ../fish/guestfish-actions.pod:682 +msgid "checksums-out" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1077 +#. type: verbatim +#: ../fish/guestfish-actions.pod:684 #, no-wrap msgid "" -" int guestfs_drop_caches (guestfs_h *g,\n" -"\t\tint whattodrop);\n" +" checksums-out csumtype directory (sumsfile|-)\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1080 ../fish/guestfish-actions.pod:841 +#. type: textblock +#: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034 msgid "" -"This instructs the guest kernel to drop its page cache, and/or dentries and " -"inode caches. The parameter C tells the kernel what precisely " -"to drop, see L" -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1085 ../fish/guestfish-actions.pod:846 -msgid "Setting C to 3 should drop everything." +"This command computes the checksums of all regular files in C and " +"then emits a list of those checksums to the local output file C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1087 ../fish/guestfish-actions.pod:848 +#. type: textblock +#: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038 msgid "" -"This automatically calls L before the operation, so that the " -"maximum guest memory is freed." +"This can be used for verifying the integrity of a virtual machine. However " +"to be properly secure you should pay attention to the output of the checksum " +"command (it uses the ones from GNU coreutils). In particular when the " +"filename is not printable, coreutils uses a special backslash syntax. For " +"more information, see the GNU coreutils info file." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1092 -msgid "guestfs_du" +#. type: =head2 +#: ../fish/guestfish-actions.pod:700 +msgid "chmod" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1094 +#. type: verbatim +#: ../fish/guestfish-actions.pod:702 #, no-wrap msgid "" -" int64_t guestfs_du (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" chmod mode path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1097 ../fish/guestfish-actions.pod:855 +#. type: textblock +#: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057 msgid "" -"This command runs the C command to estimate file space usage for " -"C." +"Change the mode (permissions) of C to C. Only numeric modes are " +"supported." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:858 +#. type: textblock +#: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060 msgid "" -"C can be a file or a directory. If C is a directory then the " -"estimate includes the contents of the directory and all subdirectories " -"(recursively)." +"I: When using this command from guestfish, C by default would be " +"decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not " +"C<700>." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:862 -msgid "" -"The result is the estimated size in I (ie. units of 1024 bytes)." +#. type: textblock +#: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod:3132 +#: ../fish/guestfish-actions.pod:3271 ../fish/guestfish-actions.pod:3281 +#: ../fish/guestfish-actions.pod:3291 ../src/guestfs-actions.pod:1064 +#: ../src/guestfs-actions.pod:4739 ../src/guestfs-actions.pod:4948 +#: ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:4986 +msgid "The mode actually set is affected by the umask." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1109 -msgid "guestfs_e2fsck_f" +#. type: =head2 +#: ../fish/guestfish-actions.pod:713 +msgid "chown" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1111 +#. type: verbatim +#: ../fish/guestfish-actions.pod:715 #, no-wrap msgid "" -" int guestfs_e2fsck_f (guestfs_h *g,\n" -"\t\tconst char *device);\n" +" chown owner group path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1114 ../fish/guestfish-actions.pod:869 -msgid "" -"This runs C, ie. runs the ext2/ext3 filesystem checker " -"on C, noninteractively (C<-p>), even if the filesystem appears to be " -"clean (C<-f>)." +#. type: textblock +#: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078 +msgid "Change the file owner to C and group to C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1118 +#. type: textblock +#: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2567 +#: ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3810 msgid "" -"This command is only needed because of C (q.v.). " -"Normally you should use C." +"Only numeric uid and gid are supported. If you want to use names, you will " +"need to locate and parse the password file yourself (Augeas support makes " +"this relatively easy)." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1123 -msgid "guestfs_echo_daemon" +#. type: =head2 +#: ../fish/guestfish-actions.pod:723 +msgid "command" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1125 +#. type: verbatim +#: ../fish/guestfish-actions.pod:725 #, no-wrap msgid "" -" char *guestfs_echo_daemon (guestfs_h *g,\n" -"\t\tchar *const *words);\n" +" command 'arguments ...'\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1128 ../fish/guestfish-actions.pod:880 +#. type: textblock +#: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094 msgid "" -"This command concatenates the list of C passed with single spaces " -"between them and returns the resulting string." +"This call runs a command from the guest filesystem. The filesystem must be " +"mounted, and must contain a compatible operating system (ie. something " +"Linux, with the same or compatible processor architecture)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1131 ../fish/guestfish-actions.pod:883 -msgid "You can use this command to test the connection through to the daemon." +#. type: textblock +#: ../fish/guestfish-actions.pod:732 +msgid "" +"The single parameter is an argv-style list of arguments. The first element " +"is the name of the program to run. Subsequent elements are parameters. The " +"list must be non-empty (ie. must contain a program name). Note that the " +"command runs directly, and is I invoked via the shell (see L)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1133 -msgid "See also C." +#. type: textblock +#: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106 +msgid "The return value is anything printed to I by the command." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1138 -msgid "guestfs_egrep" +#. type: textblock +#: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109 +msgid "" +"If the command returns a non-zero exit status, then this function returns an " +"error message. The error message string is the content of I from " +"the command." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1140 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113 msgid "" -" char **guestfs_egrep (guestfs_h *g,\n" -"\t\tconst char *regex,\n" -"\t\tconst char *path);\n" -"\n" +"The C<$PATH> environment variable will contain at least C and C. If you require a program from another location, you should provide " +"the full path in the first parameter." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1144 ../fish/guestfish-actions.pod:891 +#. type: textblock +#: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118 msgid "" -"This calls the external C program and returns the matching lines." +"Shared libraries and data files required by the program must be available on " +"filesystems which are mounted in the correct places. It is the caller's " +"responsibility to ensure all filesystems that are needed are mounted at the " +"right locations." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1154 -msgid "guestfs_egrepi" +#. type: =head2 +#: ../fish/guestfish-actions.pod:760 +msgid "command-lines" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1156 +#. type: verbatim +#: ../fish/guestfish-actions.pod:762 #, no-wrap msgid "" -" char **guestfs_egrepi (guestfs_h *g,\n" -"\t\tconst char *regex,\n" -"\t\tconst char *path);\n" +" command-lines 'arguments ...'\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1160 ../fish/guestfish-actions.pod:901 +#. type: textblock +#: ../fish/guestfish-actions.pod:764 msgid "" -"This calls the external C program and returns the matching lines." +"This is the same as L, but splits the result into a list of lines." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1170 -msgid "guestfs_equal" +#. type: textblock +#: ../fish/guestfish-actions.pod:767 +msgid "See also: L" +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:772 +msgid "compress-device-out" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1172 +#. type: verbatim +#: ../fish/guestfish-actions.pod:774 #, no-wrap msgid "" -" int guestfs_equal (guestfs_h *g,\n" -"\t\tconst char *file1,\n" -"\t\tconst char *file2);\n" +" compress-device-out ctype device (zdevice|-) [level:..]\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1176 ../fish/guestfish-actions.pod:911 +#. type: textblock +#: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1168 msgid "" -"This compares the two files C and C and returns true if their " -"content is exactly equal, or false otherwise." +"This command compresses C and writes it out to the local file " +"C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1179 ../fish/guestfish-actions.pod:914 -msgid "The external L program is used for the comparison." +#. type: textblock +#: ../fish/guestfish-actions.pod:779 +msgid "" +"The C and optional C parameters have the same meaning as in L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1183 -msgid "guestfs_exists" +#. type: =head2 +#: ../fish/guestfish-actions.pod:786 +msgid "compress-out" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1185 +#. type: verbatim +#: ../fish/guestfish-actions.pod:788 #, no-wrap msgid "" -" int guestfs_exists (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" compress-out ctype file (zfile|-) [level:..]\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1188 ../fish/guestfish-actions.pod:920 +#. type: textblock +#: ../fish/guestfish-actions.pod:790 ../src/guestfs-actions.pod:1220 msgid "" -"This returns C if and only if there is a file, directory (or anything) " -"with the given C name." +"This command compresses C and writes it out to the local file C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1191 -msgid "See also C, C, C." +#. type: textblock +#: ../fish/guestfish-actions.pod:793 ../src/guestfs-actions.pod:1223 +msgid "" +"The compression program used is controlled by the C parameter. " +"Currently this includes: C, C, C, C or C. " +"Some compression types may not be supported by particular builds of " +"libguestfs, in which case you will get an error containing the substring " +"\"not supported\"." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1195 -msgid "guestfs_fallocate" +#. type: textblock +#: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1229 +msgid "" +"The optional C parameter controls compression level. The meaning and " +"default for this parameter depends on the compression program being used." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:807 +msgid "config" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1197 +#. type: verbatim +#: ../fish/guestfish-actions.pod:809 #, no-wrap msgid "" -" int guestfs_fallocate (guestfs_h *g,\n" -"\t\tconst char *path,\n" -"\t\tint len);\n" +" config qemuparam qemuvalue\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1201 ../src/guestfs-actions.pod:1224 -#: ../fish/guestfish-actions.pod:929 ../fish/guestfish-actions.pod:948 +#. type: textblock +#: ../fish/guestfish-actions.pod:811 ../src/guestfs-actions.pod:1270 msgid "" -"This command preallocates a file (containing zero bytes) named C of " -"size C bytes. If the file exists already, it is overwritten." +"This can be used to add arbitrary qemu command line parameters of the form " +"I<-param value>. Actually it's not quite arbitrary - we prevent you from " +"setting some parameters which would interfere with parameters that we use." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1205 ../fish/guestfish-actions.pod:933 -msgid "" -"Do not confuse this with the guestfish-specific C command which " -"allocates a file in the host and attaches it as a device." +#. type: textblock +#: ../fish/guestfish-actions.pod:816 ../src/guestfs-actions.pod:1275 +msgid "The first character of C string must be a C<-> (dash)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:937 -msgid "" -"This function is deprecated. In new code, use the C call " -"instead." +#. type: textblock +#: ../fish/guestfish-actions.pod:818 ../src/guestfs-actions.pod:1277 +msgid "C can be NULL." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1218 -msgid "guestfs_fallocate64" +#. type: =head2 +#: ../fish/guestfish-actions.pod:820 +msgid "copy-size" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1220 +#. type: verbatim +#: ../fish/guestfish-actions.pod:822 #, no-wrap msgid "" -" int guestfs_fallocate64 (guestfs_h *g,\n" -"\t\tconst char *path,\n" -"\t\tint64_t len);\n" +" copy-size src dest size\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1228 -msgid "" -"Note that this call allocates disk blocks for the file. To create a sparse " -"file use C instead." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1231 +#. type: textblock +#: ../fish/guestfish-actions.pod:824 ../src/guestfs-actions.pod:1291 msgid "" -"The deprecated call C does the same, but owing to an " -"oversight it only allowed 30 bit lengths to be specified, effectively " -"limiting the maximum size of files created through that call to 1GB." +"This command copies exactly C bytes from one source device or file " +"C to another destination device or file C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1236 ../fish/guestfish-actions.pod:960 +#. type: textblock +#: ../fish/guestfish-actions.pod:827 ../src/guestfs-actions.pod:1294 msgid "" -"Do not confuse this with the guestfish-specific C and C " -"commands which create a file in the host and attach it as a device." +"Note this will fail if the source is too short or if the destination is not " +"large enough." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1242 -msgid "guestfs_fgrep" +#. type: =head2 +#: ../fish/guestfish-actions.pod:830 +msgid "cp" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1244 +#. type: verbatim +#: ../fish/guestfish-actions.pod:832 #, no-wrap msgid "" -" char **guestfs_fgrep (guestfs_h *g,\n" -"\t\tconst char *pattern,\n" -"\t\tconst char *path);\n" +" cp src dest\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1248 ../fish/guestfish-actions.pod:968 +#. type: textblock +#: ../fish/guestfish-actions.pod:834 ../src/guestfs-actions.pod:1313 msgid "" -"This calls the external C program and returns the matching lines." +"This copies a file from C to C where C is either a " +"destination filename or destination directory." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1258 -msgid "guestfs_fgrepi" +#. type: =head2 +#: ../fish/guestfish-actions.pod:837 +msgid "cp-a" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1260 +#. type: verbatim +#: ../fish/guestfish-actions.pod:839 #, no-wrap msgid "" -" char **guestfs_fgrepi (guestfs_h *g,\n" -"\t\tconst char *pattern,\n" -"\t\tconst char *path);\n" +" cp-a src dest\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1264 ../fish/guestfish-actions.pod:978 +#. type: textblock +#: ../fish/guestfish-actions.pod:841 ../src/guestfs-actions.pod:1327 msgid "" -"This calls the external C program and returns the matching lines." +"This copies a file or directory from C to C recursively using the " +"C command." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1274 -msgid "guestfs_file" +#. type: =head2 +#: ../fish/guestfish-actions.pod:844 +msgid "dd" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1276 +#. type: verbatim +#: ../fish/guestfish-actions.pod:846 #, no-wrap msgid "" -" char *guestfs_file (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" dd src dest\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:988 +#. type: textblock +#: ../fish/guestfish-actions.pod:848 ../src/guestfs-actions.pod:1341 msgid "" -"This call uses the standard L command to determine the type or " -"contents of the file." +"This command copies from one source device or file C to another " +"destination device or file C. Normally you would use this to copy to " +"or from a device or partition, for example to duplicate a filesystem." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:991 +#. type: textblock +#: ../fish/guestfish-actions.pod:853 msgid "" -"This call will also transparently look inside various types of compressed " -"file." +"If the destination is a device, it must be as large or larger than the " +"source file or device, otherwise the copy will fail. This command cannot do " +"partial copies (see L)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1285 ../fish/guestfish-actions.pod:994 -msgid "" -"The exact command which runs is C. Note in particular that " -"the filename is not prepended to the output (the C<-b> option)." +#. type: =head2 +#: ../fish/guestfish-actions.pod:857 +msgid "df" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1289 +#. type: verbatim +#: ../fish/guestfish-actions.pod:859 +#, no-wrap msgid "" -"This command can also be used on C devices (and partitions, LV " -"names). You can for example use this to determine if a device contains a " -"filesystem, although it's usually better to use C." +" df\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1294 ../fish/guestfish-actions.pod:1003 +#. type: textblock +#: ../fish/guestfish-actions.pod:861 ../src/guestfs-actions.pod:1359 +msgid "This command runs the C command to report disk space used." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:874 msgid "" -"If the C does not begin with C then this command only works for " -"the content of regular files. For other file types (directory, symbolic " -"link etc) it will just return the string C etc." +"This command is mostly useful for interactive sessions. It is I " +"intended that you try to parse the output string. Use L from " +"programs." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1302 -msgid "guestfs_file_architecture" +#. type: =head2 +#: ../fish/guestfish-actions.pod:867 +msgid "df-h" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1304 +#. type: verbatim +#: ../fish/guestfish-actions.pod:869 #, no-wrap msgid "" -" char *guestfs_file_architecture (guestfs_h *g,\n" -"\t\tconst char *filename);\n" +" df-h\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1307 ../fish/guestfish-actions.pod:1012 +#. type: textblock +#: ../fish/guestfish-actions.pod:871 ../src/guestfs-actions.pod:1375 msgid "" -"This detects the architecture of the binary C, and returns it if " -"known." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1310 ../fish/guestfish-actions.pod:1015 -msgid "Currently defined architectures are:" +"This command runs the C command to report disk space used in human-" +"readable format." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:1019 -msgid "\"i386\"" +#. type: =head2 +#: ../fish/guestfish-actions.pod:878 +msgid "dmesg" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1316 ../fish/guestfish-actions.pod:1021 +#. type: verbatim +#: ../fish/guestfish-actions.pod:880 +#, no-wrap msgid "" -"This string is returned for all 32 bit i386, i486, i586, i686 binaries " -"irrespective of the precise processor requirements of the binary." +" dmesg\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:1319 ../fish/guestfish-actions.pod:1024 -msgid "\"x86_64\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:882 ../src/guestfs-actions.pod:1392 +msgid "" +"This returns the kernel messages (C output) from the guest kernel. " +"This is sometimes useful for extended debugging of problems." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1321 ../fish/guestfish-actions.pod:1026 -msgid "64 bit x86-64." +#. type: textblock +#: ../fish/guestfish-actions.pod:886 +msgid "" +"Another way to get the same information is to enable verbose messages with " +"L or by setting the environment variable C " +"before running the program." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:1323 ../fish/guestfish-actions.pod:1028 -msgid "\"sparc\"" +#. type: =head2 +#: ../fish/guestfish-actions.pod:891 +msgid "download" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:1030 -msgid "32 bit SPARC." +#. type: verbatim +#: ../fish/guestfish-actions.pod:893 +#, no-wrap +msgid "" +" download remotefilename (filename|-)\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:1327 ../fish/guestfish-actions.pod:1032 -msgid "\"sparc64\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:895 ../fish/guestfish-actions.pod:908 +#: ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1438 +msgid "" +"Download file C and save it as C on the local " +"machine." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1329 ../fish/guestfish-actions.pod:1034 -msgid "64 bit SPARC V9 and above." +#. type: textblock +#: ../fish/guestfish-actions.pod:898 ../fish/guestfish-actions.pod:4877 +#: ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:7391 +msgid "C can also be a named pipe." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:1331 ../fish/guestfish-actions.pod:1036 -msgid "\"ia64\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:900 +msgid "See also L, L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1333 ../fish/guestfish-actions.pod:1038 -msgid "Intel Itanium." +#. type: =head2 +#: ../fish/guestfish-actions.pod:904 +msgid "download-offset" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:1335 ../fish/guestfish-actions.pod:1040 -msgid "\"ppc\"" +#. type: verbatim +#: ../fish/guestfish-actions.pod:906 +#, no-wrap +msgid "" +" download-offset remotefilename (filename|-) offset size\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:1042 -msgid "32 bit Power PC." +#. type: textblock +#: ../fish/guestfish-actions.pod:911 ../src/guestfs-actions.pod:1441 +msgid "" +"C is read for C bytes starting at C (this " +"region must be within the file or device)." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:1339 ../fish/guestfish-actions.pod:1044 -msgid "\"ppc64\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:914 +msgid "" +"Note that there is no limit on the amount of data that can be downloaded " +"with this call, unlike with L, and this call always reads the full " +"amount unless an error occurs." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1341 ../fish/guestfish-actions.pod:1046 -msgid "64 bit Power PC." +#. type: textblock +#: ../fish/guestfish-actions.pod:919 +msgid "See also L, L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1345 ../fish/guestfish-actions.pod:1050 -msgid "Libguestfs may return other architecture strings in future." +#. type: =head2 +#: ../fish/guestfish-actions.pod:923 +msgid "drop-caches" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1347 ../fish/guestfish-actions.pod:1052 -msgid "The function works on at least the following types of files:" +#. type: verbatim +#: ../fish/guestfish-actions.pod:925 +#, no-wrap +msgid "" +" drop-caches whattodrop\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:1058 -msgid "many types of Un*x and Linux binary" -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1357 ../fish/guestfish-actions.pod:1062 -msgid "many types of Un*x and Linux shared library" -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1361 ../fish/guestfish-actions.pod:1066 -msgid "Windows Win32 and Win64 binaries" +#. type: textblock +#: ../fish/guestfish-actions.pod:927 ../src/guestfs-actions.pod:1466 +msgid "" +"This instructs the guest kernel to drop its page cache, and/or dentries and " +"inode caches. The parameter C tells the kernel what precisely " +"to drop, see L" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1365 ../fish/guestfish-actions.pod:1070 -msgid "Windows Win32 and Win64 DLLs" +#. type: textblock +#: ../fish/guestfish-actions.pod:932 ../src/guestfs-actions.pod:1471 +msgid "Setting C to 3 should drop everything." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1367 ../fish/guestfish-actions.pod:1072 -msgid "Win32 binaries and DLLs return C." +#. type: textblock +#: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1473 +msgid "" +"This automatically calls L before the operation, so that the " +"maximum guest memory is freed." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1369 ../fish/guestfish-actions.pod:1074 -msgid "Win64 binaries and DLLs return C." +#. type: =head2 +#: ../fish/guestfish-actions.pod:937 +msgid "du" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1373 ../fish/guestfish-actions.pod:1078 -msgid "Linux kernel modules" +#. type: verbatim +#: ../fish/guestfish-actions.pod:939 +#, no-wrap +msgid "" +" du path\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:1082 -msgid "Linux new-style initrd images" +#. type: textblock +#: ../fish/guestfish-actions.pod:941 ../src/guestfs-actions.pod:1486 +msgid "" +"This command runs the C command to estimate file space usage for " +"C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1381 ../fish/guestfish-actions.pod:1086 -msgid "some non-x86 Linux vmlinuz kernels" +#. type: textblock +#: ../fish/guestfish-actions.pod:944 ../src/guestfs-actions.pod:1489 +msgid "" +"C can be a file or a directory. If C is a directory then the " +"estimate includes the contents of the directory and all subdirectories " +"(recursively)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1385 ../fish/guestfish-actions.pod:1090 -msgid "What it can't do currently:" +#. type: textblock +#: ../fish/guestfish-actions.pod:948 ../src/guestfs-actions.pod:1493 +msgid "" +"The result is the estimated size in I (ie. units of 1024 bytes)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:1096 -msgid "static libraries (libfoo.a)" +#. type: =head2 +#: ../fish/guestfish-actions.pod:951 +msgid "e2fsck-f" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1395 ../fish/guestfish-actions.pod:1100 -msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)" +#. type: verbatim +#: ../fish/guestfish-actions.pod:953 +#, no-wrap +msgid "" +" e2fsck-f device\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1399 ../fish/guestfish-actions.pod:1104 -msgid "x86 Linux vmlinuz kernels" +#. type: textblock +#: ../fish/guestfish-actions.pod:955 ../src/guestfs-actions.pod:1511 +msgid "" +"This runs C, ie. runs the ext2/ext3 filesystem checker " +"on C, noninteractively (I<-p>), even if the filesystem appears to be " +"clean (I<-f>)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1401 ../fish/guestfish-actions.pod:1106 +#. type: textblock +#: ../fish/guestfish-actions.pod:959 msgid "" -"x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and " -"compressed code, and are horribly hard to unpack. If you want to find the " -"architecture of a kernel, use the architecture of the associated initrd or " -"kernel module(s) instead." +"This command is only needed because of L (q.v.). Normally you " +"should use L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1411 -msgid "guestfs_filesize" +#. type: =head2 +#: ../fish/guestfish-actions.pod:962 +msgid "echo-daemon" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1413 +#. type: verbatim +#: ../fish/guestfish-actions.pod:964 #, no-wrap msgid "" -" int64_t guestfs_filesize (guestfs_h *g,\n" -"\t\tconst char *file);\n" +" echo-daemon 'words ...'\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1416 ../fish/guestfish-actions.pod:1117 -msgid "This command returns the size of C in bytes." +#. type: textblock +#: ../fish/guestfish-actions.pod:966 ../src/guestfs-actions.pod:1528 +msgid "" +"This command concatenates the list of C passed with single spaces " +"between them and returns the resulting string." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1418 -msgid "" -"To get other stats about a file, use C, C, " -"C, C etc. To get the size of block " -"devices, use C." +#. type: textblock +#: ../fish/guestfish-actions.pod:969 ../src/guestfs-actions.pod:1531 +msgid "You can use this command to test the connection through to the daemon." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1424 -msgid "guestfs_fill" +#. type: textblock +#: ../fish/guestfish-actions.pod:971 +msgid "See also L." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1426 -#, no-wrap -msgid "" -" int guestfs_fill (guestfs_h *g,\n" -"\t\tint c,\n" -"\t\tint len,\n" -"\t\tconst char *path);\n" -"\n" +#. type: =head2 +#: ../fish/guestfish-actions.pod:973 +msgid "egrep" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:1127 +#. type: verbatim +#: ../fish/guestfish-actions.pod:975 +#, no-wrap 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]>." +" egrep regex path\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1435 +#. type: textblock +#: ../fish/guestfish-actions.pod:977 ../src/guestfs-actions.pod:1547 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." +"This calls the external C program and returns the matching lines." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1447 -msgid "guestfs_fill_pattern" +#. type: =head2 +#: ../fish/guestfish-actions.pod:983 +msgid "egrepi" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1449 +#. type: verbatim +#: ../fish/guestfish-actions.pod:985 #, no-wrap msgid "" -" int guestfs_fill_pattern (guestfs_h *g,\n" -"\t\tconst char *pattern,\n" -"\t\tint len,\n" -"\t\tconst char *path);\n" +" egrepi regex path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1454 +#. type: textblock +#: ../fish/guestfish-actions.pod:987 ../src/guestfs-actions.pod:1566 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." +"This calls the external C program and returns the matching lines." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1466 -msgid "guestfs_find" +#. type: =head2 +#: ../fish/guestfish-actions.pod:993 +msgid "equal" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1468 +#. type: verbatim +#: ../fish/guestfish-actions.pod:995 #, no-wrap msgid "" -" char **guestfs_find (guestfs_h *g,\n" -"\t\tconst char *directory);\n" +" equal file1 file2\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1471 ../fish/guestfish-actions.pod:1149 +#. type: textblock +#: ../fish/guestfish-actions.pod:997 ../src/guestfs-actions.pod:1585 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." +"This compares the two files C and C and returns true if their " +"content is exactly equal, or false otherwise." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1476 ../fish/guestfish-actions.pod:1154 -msgid "" -"This returns a list of strings I. Thus if the directory " -"structure was:" +#. type: textblock +#: ../fish/guestfish-actions.pod:1000 ../src/guestfs-actions.pod:1588 +msgid "The external L program is used for the comparison." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1002 +msgid "exists" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:1157 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1004 #, no-wrap msgid "" -" /tmp/a\n" -" /tmp/b\n" -" /tmp/c/d\n" +" exists path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1483 +#. type: textblock +#: ../fish/guestfish-actions.pod:1006 ../src/guestfs-actions.pod:1600 msgid "" -"then the returned list from C C would be 4 elements:" +"This returns C if and only if there is a file, directory (or anything) " +"with the given C name." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:1009 +msgid "See also L, L, L." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1486 ../fish/guestfish-actions.pod:1164 +#. type: =head2 +#: ../fish/guestfish-actions.pod:1011 +msgid "fallocate" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:1013 #, no-wrap msgid "" -" a\n" -" b\n" -" c\n" -" c/d\n" +" fallocate path len\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1491 ../fish/guestfish-actions.pod:1169 -msgid "If C is not a directory, then this command returns an error." +#. type: textblock +#: ../fish/guestfish-actions.pod:1015 ../fish/guestfish-actions.pod:1034 +#: ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1642 +msgid "" +"This command preallocates a file (containing zero bytes) named C of " +"size C bytes. If the file exists already, it is overwritten." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:1172 -msgid "The returned list is sorted." +#. type: textblock +#: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1627 +msgid "" +"Do not confuse this with the guestfish-specific C command which " +"allocates a file in the host and attaches it as a device." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1496 -msgid "See also C." +#. type: textblock +#: ../fish/guestfish-actions.pod:1023 +msgid "" +"I In new code, use the L call " +"instead." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1505 -msgid "guestfs_find0" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1030 +msgid "fallocate64" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1507 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1032 #, no-wrap msgid "" -" int guestfs_find0 (guestfs_h *g,\n" -"\t\tconst char *directory,\n" -"\t\tconst char *files);\n" +" fallocate64 path len\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1511 ../fish/guestfish-actions.pod:1183 +#. type: textblock +#: ../fish/guestfish-actions.pod:1038 msgid "" -"This command lists out all files and directories, recursively, starting at " -"C, placing the resulting list in the external file called " -"C." +"Note that this call allocates disk blocks for the file. To create a sparse " +"file use L instead." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1515 +#. type: textblock +#: ../fish/guestfish-actions.pod:1041 msgid "" -"This command works the same way as C with the following " -"exceptions:" -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1522 ../fish/guestfish-actions.pod:1194 -msgid "The resulting list is written to an external file." +"The deprecated call L does the same, but owing to an oversight " +"it only allowed 30 bit lengths to be specified, effectively limiting the " +"maximum size of files created through that call to 1GB." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:1198 +#. type: textblock +#: ../fish/guestfish-actions.pod:1046 ../src/guestfs-actions.pod:1654 msgid "" -"Items (filenames) in the result are separated by C<\\0> characters. See " -"L option I<-print0>." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1203 -msgid "This command is not limited in the number of names that it can return." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1536 ../fish/guestfish-actions.pod:1208 -msgid "The result list is not sorted." +"Do not confuse this with the guestfish-specific C and C " +"commands which create a file in the host and attach it as a device." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1542 -msgid "guestfs_findfs_label" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1050 +msgid "fgrep" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1544 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1052 #, no-wrap msgid "" -" char *guestfs_findfs_label (guestfs_h *g,\n" -"\t\tconst char *label);\n" +" fgrep pattern path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1547 ../fish/guestfish-actions.pod:1218 +#. type: textblock +#: ../fish/guestfish-actions.pod:1054 ../src/guestfs-actions.pod:1669 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." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1551 -msgid "To find the label of a filesystem, use C." +"This calls the external C program and returns the matching lines." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1556 -msgid "guestfs_findfs_uuid" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1060 +msgid "fgrepi" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1558 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1062 #, no-wrap msgid "" -" char *guestfs_findfs_uuid (guestfs_h *g,\n" -"\t\tconst char *uuid);\n" +" fgrepi pattern path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1228 +#. type: textblock +#: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1688 msgid "" -"This command searches the filesystems and returns the one which has the " -"given UUID. An error is returned if no such filesystem can be found." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1565 -msgid "To find the UUID of a filesystem, use C." +"This calls the external C program and returns the matching lines." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1570 -msgid "guestfs_fsck" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1070 +msgid "file" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1572 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1072 #, no-wrap msgid "" -" int guestfs_fsck (guestfs_h *g,\n" -"\t\tconst char *fstype,\n" -"\t\tconst char *device);\n" +" file path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1576 ../fish/guestfish-actions.pod:1238 +#. type: textblock +#: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1706 msgid "" -"This runs the filesystem checker (fsck) on C which should have " -"filesystem type C." +"This call uses the standard L command to determine the type or " +"contents of the file." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1241 +#. type: textblock +#: ../fish/guestfish-actions.pod:1077 ../src/guestfs-actions.pod:1709 msgid "" -"The returned integer is the status. See L for the list of status " -"codes from C." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1588 ../fish/guestfish-actions.pod:1250 -msgid "Multiple status codes can be summed together." +"This call will also transparently look inside various types of compressed " +"file." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1592 ../fish/guestfish-actions.pod:1254 +#. type: textblock +#: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1712 msgid "" -"A non-zero return code can mean \"success\", for example if errors have been " -"corrected on the filesystem." +"The exact command which runs is C. Note in particular that " +"the filename is not prepended to the output (the I<-b> option)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1259 -msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)." +#. type: textblock +#: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1716 +msgid "" +"The output depends on the output of the underlying L command and it " +"can change in future in ways beyond our control. In other words, the output " +"is not guaranteed by the ABI." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1602 ../fish/guestfish-actions.pod:1264 +#. type: textblock +#: ../fish/guestfish-actions.pod:1088 msgid "" -"This command is entirely equivalent to running C." +"See also: L, L, L, L, L " +"(etc), L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1606 -msgid "guestfs_get_append" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1091 +msgid "file-architecture" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1608 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1093 #, no-wrap msgid "" -" const char *guestfs_get_append (guestfs_h *g);\n" +" file-architecture filename\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1610 ../fish/guestfish-actions.pod:1270 +#. type: textblock +#: ../fish/guestfish-actions.pod:1095 ../src/guestfs-actions.pod:1734 msgid "" -"Return the additional kernel options which are added to the guest kernel " -"command line." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1273 -msgid "If C then no options are added." +"This detects the architecture of the binary C, and returns it if " +"known." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1615 -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." +#. type: textblock +#: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1737 +msgid "Currently defined architectures are:" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1619 -msgid "guestfs_get_autosync" +#. type: =item +#: ../fish/guestfish-actions.pod:1102 ../src/guestfs-actions.pod:1741 +msgid "\"i386\"" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1621 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1104 ../src/guestfs-actions.pod:1743 msgid "" -" int guestfs_get_autosync (guestfs_h *g);\n" -"\n" +"This string is returned for all 32 bit i386, i486, i586, i686 binaries " +"irrespective of the precise processor requirements of the binary." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1279 -msgid "Get the autosync flag." +#. type: =item +#: ../fish/guestfish-actions.pod:1107 ../src/guestfs-actions.pod:1746 +msgid "\"x86_64\"" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1627 -msgid "guestfs_get_direct" +#. type: textblock +#: ../fish/guestfish-actions.pod:1109 ../src/guestfs-actions.pod:1748 +msgid "64 bit x86-64." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1629 -#, no-wrap -msgid "" -" int guestfs_get_direct (guestfs_h *g);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:1111 ../src/guestfs-actions.pod:1750 +msgid "\"sparc\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1285 -msgid "Return the direct appliance mode flag." +#. type: textblock +#: ../fish/guestfish-actions.pod:1113 ../src/guestfs-actions.pod:1752 +msgid "32 bit SPARC." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1635 -msgid "guestfs_get_e2label" +#. type: =item +#: ../fish/guestfish-actions.pod:1115 ../src/guestfs-actions.pod:1754 +msgid "\"sparc64\"" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1637 -#, no-wrap -msgid "" -" char *guestfs_get_e2label (guestfs_h *g,\n" -"\t\tconst char *device);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1117 ../src/guestfs-actions.pod:1756 +msgid "64 bit SPARC V9 and above." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1291 -msgid "" -"This returns the ext2/3/4 filesystem label of the filesystem on C." +#. type: =item +#: ../fish/guestfish-actions.pod:1119 ../src/guestfs-actions.pod:1758 +msgid "\"ia64\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1294 -msgid "" -"This function is deprecated. In new code, use the C call instead." +#. type: textblock +#: ../fish/guestfish-actions.pod:1121 ../src/guestfs-actions.pod:1760 +msgid "Intel Itanium." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1653 -msgid "guestfs_get_e2uuid" +#. type: =item +#: ../fish/guestfish-actions.pod:1123 ../src/guestfs-actions.pod:1762 +msgid "\"ppc\"" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1655 -#, no-wrap -msgid "" -" char *guestfs_get_e2uuid (guestfs_h *g,\n" -"\t\tconst char *device);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1125 ../src/guestfs-actions.pod:1764 +msgid "32 bit Power PC." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1305 -msgid "" -"This returns the ext2/3/4 filesystem UUID of the filesystem on C." +#. type: =item +#: ../fish/guestfish-actions.pod:1127 ../src/guestfs-actions.pod:1766 +msgid "\"ppc64\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1664 ../fish/guestfish-actions.pod:1308 -msgid "" -"This function is deprecated. In new code, use the C call instead." +#. type: textblock +#: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1768 +msgid "64 bit Power PC." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1671 -msgid "guestfs_get_memsize" +#. type: textblock +#: ../fish/guestfish-actions.pod:1133 ../src/guestfs-actions.pod:1772 +msgid "Libguestfs may return other architecture strings in future." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1673 -#, no-wrap -msgid "" -" int guestfs_get_memsize (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1135 ../src/guestfs-actions.pod:1774 +msgid "The function works on at least the following types of files:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1675 ../fish/guestfish-actions.pod:1319 -msgid "" -"This gets the memory size in megabytes allocated to the qemu subprocess." +#. type: textblock +#: ../fish/guestfish-actions.pod:1141 ../src/guestfs-actions.pod:1780 +msgid "many types of Un*x and Linux binary" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1678 -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: textblock +#: ../fish/guestfish-actions.pod:1145 ../src/guestfs-actions.pod:1784 +msgid "many types of Un*x and Linux shared library" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1745 -#: ../src/guestfs-actions.pod:4469 ../src/guestfs-actions.pod:4561 -#: ../fish/guestfish-actions.pod:1326 ../fish/guestfish-actions.pod:1377 -#: ../fish/guestfish-actions.pod:3448 ../fish/guestfish-actions.pod:3535 -msgid "" -"For more information on the architecture of libguestfs, see L." +#. type: textblock +#: ../fish/guestfish-actions.pod:1149 ../src/guestfs-actions.pod:1788 +msgid "Windows Win32 and Win64 binaries" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1687 -msgid "guestfs_get_network" +#. type: textblock +#: ../fish/guestfish-actions.pod:1153 ../src/guestfs-actions.pod:1792 +msgid "Windows Win32 and Win64 DLLs" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1689 -#, no-wrap -msgid "" -" int guestfs_get_network (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1155 ../src/guestfs-actions.pod:1794 +msgid "Win32 binaries and DLLs return C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1691 ../fish/guestfish-actions.pod:1333 -msgid "This returns the enable network flag." +#. type: textblock +#: ../fish/guestfish-actions.pod:1157 ../src/guestfs-actions.pod:1796 +msgid "Win64 binaries and DLLs return C." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1695 -msgid "guestfs_get_path" +#. type: textblock +#: ../fish/guestfish-actions.pod:1161 ../src/guestfs-actions.pod:1800 +msgid "Linux kernel modules" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1697 -#, no-wrap -msgid "" -" const char *guestfs_get_path (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1804 +msgid "Linux new-style initrd images" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1699 ../fish/guestfish-actions.pod:1339 -msgid "Return the current search path." +#. type: textblock +#: ../fish/guestfish-actions.pod:1169 ../src/guestfs-actions.pod:1808 +msgid "some non-x86 Linux vmlinuz kernels" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1701 ../fish/guestfish-actions.pod:1341 -msgid "" -"This is always non-NULL. If it wasn't set already, then this will return " -"the default path." +#. type: textblock +#: ../fish/guestfish-actions.pod:1173 ../src/guestfs-actions.pod:1812 +msgid "What it can't do currently:" +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:1179 ../src/guestfs-actions.pod:1818 +msgid "static libraries (libfoo.a)" +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:1183 ../src/guestfs-actions.pod:1822 +msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)" +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:1187 ../src/guestfs-actions.pod:1826 +msgid "x86 Linux vmlinuz kernels" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1727 +#. type: textblock +#: ../fish/guestfish-actions.pod:1189 ../src/guestfs-actions.pod:1828 msgid "" -"This function returns a string, or NULL on error. The string is owned by " -"the guest handle and must I be freed." +"x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and " +"compressed code, and are horribly hard to unpack. If you want to find the " +"architecture of a kernel, use the architecture of the associated initrd or " +"kernel module(s) instead." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1707 -msgid "guestfs_get_pid" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1196 +msgid "filesize" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1709 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1198 #, no-wrap msgid "" -" int guestfs_get_pid (guestfs_h *g);\n" +" filesize file\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1711 ../fish/guestfish-actions.pod:1350 -msgid "" -"Return the process ID of the qemu subprocess. If there is no qemu " -"subprocess, then this will return an error." +#. type: textblock +#: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:1846 +msgid "This command returns the size of C in bytes." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1714 ../fish/guestfish-actions.pod:1353 -msgid "This is an internal call used for debugging and testing." +#. type: textblock +#: ../fish/guestfish-actions.pod:1202 +msgid "" +"To get other stats about a file, use L, L, L, L etc. To get the size of block devices, use L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1718 -msgid "guestfs_get_qemu" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1206 +msgid "fill" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1720 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1208 #, no-wrap msgid "" -" const char *guestfs_get_qemu (guestfs_h *g);\n" +" fill c len path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1722 ../fish/guestfish-actions.pod:1359 -msgid "Return the current qemu binary." +#. type: textblock +#: ../fish/guestfish-actions.pod:1210 ../src/guestfs-actions.pod:1864 +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]>." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1361 +#. type: textblock +#: ../fish/guestfish-actions.pod:1214 msgid "" -"This is always non-NULL. If it wasn't set already, then this will return " -"the default qemu binary name." +"To fill a file with zero bytes (sparsely), it is much more efficient to use " +"L. To create a file with a pattern of repeating bytes use " +"L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1730 -msgid "guestfs_get_recovery_proc" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1219 +msgid "fill-pattern" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1732 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1221 #, no-wrap msgid "" -" int guestfs_get_recovery_proc (guestfs_h *g);\n" +" fill-pattern pattern len path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1368 -msgid "Return the recovery process enabled flag." +#. type: textblock +#: ../fish/guestfish-actions.pod:1223 +msgid "" +"This function is like L 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." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1738 -msgid "guestfs_get_selinux" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1228 +msgid "find" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1740 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1230 #, no-wrap msgid "" -" int guestfs_get_selinux (guestfs_h *g);\n" +" find directory\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1742 +#. type: textblock +#: ../fish/guestfish-actions.pod:1232 ../src/guestfs-actions.pod:1910 msgid "" -"This returns the current setting of the selinux flag which is passed to the " -"appliance at boot time. See C." +"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." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1750 -msgid "guestfs_get_state" +#. type: textblock +#: ../fish/guestfish-actions.pod:1237 ../src/guestfs-actions.pod:1915 +msgid "" +"This returns a list of strings I. Thus if the directory " +"structure was:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1752 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1240 ../src/guestfs-actions.pod:1918 #, no-wrap msgid "" -" int guestfs_get_state (guestfs_h *g);\n" +" /tmp/a\n" +" /tmp/b\n" +" /tmp/c/d\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1754 ../fish/guestfish-actions.pod:1384 -msgid "" -"This returns the current state as an opaque integer. This is only useful " -"for printing debug and internal error messages." +#. type: textblock +#: ../fish/guestfish-actions.pod:1244 +msgid "then the returned list from L C would be 4 elements:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1757 ../src/guestfs-actions.pod:2378 -#: ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:2450 -#: ../src/guestfs-actions.pod:2471 ../fish/guestfish-actions.pod:1387 -#: ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:1899 -#: ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:1953 -msgid "For more information on states, see L." +#. type: verbatim +#: ../fish/guestfish-actions.pod:1247 ../src/guestfs-actions.pod:1925 +#, no-wrap +msgid "" +" a\n" +" b\n" +" c\n" +" c/d\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1761 -msgid "guestfs_get_trace" +#. type: textblock +#: ../fish/guestfish-actions.pod:1252 ../src/guestfs-actions.pod:1930 +msgid "If C is not a directory, then this command returns an error." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1763 -#, no-wrap -msgid "" -" int guestfs_get_trace (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1255 ../src/guestfs-actions.pod:1933 +msgid "The returned list is sorted." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1765 ../fish/guestfish-actions.pod:1393 -msgid "Return the command trace flag." +#. type: textblock +#: ../fish/guestfish-actions.pod:1257 +msgid "See also L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1769 -msgid "guestfs_get_umask" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1262 +msgid "find0" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1771 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1264 #, no-wrap msgid "" -" int guestfs_get_umask (guestfs_h *g);\n" +" find0 directory (files|-)\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1773 +#. type: textblock +#: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1953 msgid "" -"Return the current umask. By default the umask is C<022> unless it has been " -"set by calling C." +"This command lists out all files and directories, recursively, starting at " +"C, placing the resulting list in the external file called " +"C." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1778 -msgid "guestfs_get_verbose" +#. type: textblock +#: ../fish/guestfish-actions.pod:1270 +msgid "" +"This command works the same way as L with the following exceptions:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1780 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1277 ../src/guestfs-actions.pod:1964 +msgid "The resulting list is written to an external file." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:1281 ../src/guestfs-actions.pod:1968 msgid "" -" int guestfs_get_verbose (guestfs_h *g);\n" -"\n" +"Items (filenames) in the result are separated by C<\\0> characters. See " +"L option I<-print0>." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1406 -msgid "This returns the verbose messages flag." +#. type: textblock +#: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1973 +msgid "This command is not limited in the number of names that it can return." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1786 -msgid "guestfs_getcon" +#. type: textblock +#: ../fish/guestfish-actions.pod:1291 ../src/guestfs-actions.pod:1978 +msgid "The result list is not sorted." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1297 +msgid "findfs-label" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1788 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1299 #, no-wrap msgid "" -" char *guestfs_getcon (guestfs_h *g);\n" +" findfs-label label\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1790 ../fish/guestfish-actions.pod:1412 -msgid "This gets the SELinux security context of the daemon." +#. type: textblock +#: ../fish/guestfish-actions.pod:1301 ../src/guestfs-actions.pod:1992 +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." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1792 -msgid "" -"See the documentation about SELINUX in L, and C" +#. type: textblock +#: ../fish/guestfish-actions.pod:1305 +msgid "To find the label of a filesystem, use L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1798 -msgid "guestfs_getxattrs" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1307 +msgid "findfs-uuid" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1800 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1309 #, no-wrap msgid "" -" struct guestfs_xattr_list *guestfs_getxattrs (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" findfs-uuid uuid\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1421 -msgid "" -"This call lists the extended attributes of the file or directory C." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1806 ../fish/guestfish-actions.pod:1424 +#. type: textblock +#: ../fish/guestfish-actions.pod:1311 ../src/guestfs-actions.pod:2009 msgid "" -"At the system call level, this is a combination of the L and " -"L calls." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1809 -msgid "See also: C, L." +"This command searches the filesystems and returns the one which has the " +"given UUID. An error is returned if no such filesystem can be found." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1811 ../src/guestfs-actions.pod:2545 -#: ../src/guestfs-actions.pod:3100 -msgid "" -"This function returns a C (see Eguestfs-" -"structs.hE), or NULL if there was an error. I after use>." +#. type: textblock +#: ../fish/guestfish-actions.pod:1315 +msgid "To find the UUID of a filesystem, use L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1816 -msgid "guestfs_glob_expand" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1317 +msgid "fsck" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1818 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1319 #, no-wrap msgid "" -" char **guestfs_glob_expand (guestfs_h *g,\n" -"\t\tconst char *pattern);\n" +" fsck fstype device\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1821 ../fish/guestfish-actions.pod:1433 +#. type: textblock +#: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:2027 msgid "" -"This command searches for all the pathnames matching C according to " -"the wildcard expansion rules used by the shell." +"This runs the filesystem checker (fsck) on C which should have " +"filesystem type C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1825 ../fish/guestfish-actions.pod:1437 +#. type: textblock +#: ../fish/guestfish-actions.pod:1324 ../src/guestfs-actions.pod:2030 msgid "" -"If no paths match, then this returns an empty list (note: not an error)." +"The returned integer is the status. See L for the list of status " +"codes from C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1828 ../fish/guestfish-actions.pod:1440 -msgid "" -"It is just a wrapper around the C L function with flags C. See that manual page for more details." +#. type: textblock +#: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:2039 +msgid "Multiple status codes can be summed together." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1836 -msgid "guestfs_grep" +#. type: textblock +#: ../fish/guestfish-actions.pod:1337 ../src/guestfs-actions.pod:2043 +msgid "" +"A non-zero return code can mean \"success\", for example if errors have been " +"corrected on the filesystem." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1838 -#, no-wrap -msgid "" -" char **guestfs_grep (guestfs_h *g,\n" -"\t\tconst char *regex,\n" -"\t\tconst char *path);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1342 ../src/guestfs-actions.pod:2048 +msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:1448 -msgid "This calls the external C program and returns the matching lines." +#. type: textblock +#: ../fish/guestfish-actions.pod:1347 ../src/guestfs-actions.pod:2053 +msgid "" +"This command is entirely equivalent to running C." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1852 -msgid "guestfs_grepi" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1349 +msgid "get-append" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1854 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1351 #, no-wrap msgid "" -" char **guestfs_grepi (guestfs_h *g,\n" -"\t\tconst char *regex,\n" -"\t\tconst char *path);\n" +" get-append\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1858 ../fish/guestfish-actions.pod:1458 +#. type: textblock +#: ../fish/guestfish-actions.pod:1353 ../src/guestfs-actions.pod:2064 msgid "" -"This calls the external C program and returns the matching lines." +"Return the additional kernel options which are added to the guest kernel " +"command line." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1868 -msgid "guestfs_grub_install" +#. type: textblock +#: ../fish/guestfish-actions.pod:1356 ../src/guestfs-actions.pod:2067 +msgid "If C then no options are added." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1358 +msgid "get-attach-method" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1870 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1360 #, no-wrap msgid "" -" int guestfs_grub_install (guestfs_h *g,\n" -"\t\tconst char *root,\n" -"\t\tconst char *device);\n" +" get-attach-method\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1874 ../fish/guestfish-actions.pod:1468 -msgid "" -"This command installs GRUB (the Grand Unified Bootloader) on C, with " -"the root directory being C." +#. type: textblock +#: ../fish/guestfish-actions.pod:1362 +msgid "Return the current attach method. See L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1877 ../fish/guestfish-actions.pod:1471 -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:1364 +msgid "get-autosync" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1884 ../fish/guestfish-actions.pod:1478 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1366 #, no-wrap msgid "" -" (hd0) /dev/vda\n" +" get-autosync\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1886 ../fish/guestfish-actions.pod:1480 -msgid "replacing C with the name of the installation device." +#. type: textblock +#: ../fish/guestfish-actions.pod:1368 ../src/guestfs-actions.pod:2092 +msgid "Get the autosync flag." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1890 -msgid "guestfs_head" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1370 +msgid "get-direct" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1892 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1372 #, no-wrap msgid "" -" char **guestfs_head (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" get-direct\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1895 ../fish/guestfish-actions.pod:1486 -msgid "" -"This command returns up to the first 10 lines of a file as a list of strings." +#. type: textblock +#: ../fish/guestfish-actions.pod:1374 ../src/guestfs-actions.pod:2103 +msgid "Return the direct appliance mode flag." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1905 -msgid "guestfs_head_n" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1376 +msgid "get-e2label" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1907 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1378 #, no-wrap msgid "" -" char **guestfs_head_n (guestfs_h *g,\n" -"\t\tint nrlines,\n" -"\t\tconst char *path);\n" +" get-e2label device\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1911 ../fish/guestfish-actions.pod:1496 +#. type: textblock +#: ../fish/guestfish-actions.pod:1380 ../src/guestfs-actions.pod:2122 msgid "" -"If the parameter C is a positive number, this returns the first " -"C lines of the file C." +"This returns the ext2/3/4 filesystem label of the filesystem on C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1499 +#. type: textblock +#: ../fish/guestfish-actions.pod:1383 msgid "" -"If the parameter C is a negative number, this returns lines from " -"the file C, excluding the last C lines." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:5017 -#: ../fish/guestfish-actions.pod:1502 ../fish/guestfish-actions.pod:3881 -msgid "If the parameter C is zero, this returns an empty list." +"I In new code, use the L call " +"instead." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1926 -msgid "guestfs_hexdump" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1390 +msgid "get-e2uuid" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1928 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1392 #, no-wrap msgid "" -" char *guestfs_hexdump (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" get-e2uuid device\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1931 ../fish/guestfish-actions.pod:1511 +#. type: textblock +#: ../fish/guestfish-actions.pod:1394 ../src/guestfs-actions.pod:2143 msgid "" -"This runs C on the given C. The result is the human-" -"readable, canonical hex dump of the file." +"This returns the ext2/3/4 filesystem UUID of the filesystem on C." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1940 -msgid "guestfs_initrd_cat" +#. type: textblock +#: ../fish/guestfish-actions.pod:1397 +msgid "" +"I In new code, use the L call " +"instead." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1404 +msgid "get-memsize" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1942 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1406 #, no-wrap msgid "" -" char *guestfs_initrd_cat (guestfs_h *g,\n" -"\t\tconst char *initrdpath,\n" -"\t\tconst char *filename,\n" -"\t\tsize_t *size_r);\n" +" get-memsize\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1947 ../fish/guestfish-actions.pod:1521 +#. type: textblock +#: ../fish/guestfish-actions.pod:1408 ../src/guestfs-actions.pod:2156 msgid "" -"This command unpacks the file C from the initrd file called " -"C. The filename must be given I the initial C " -"character." +"This gets the memory size in megabytes allocated to the qemu subprocess." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1525 +#. type: textblock +#: ../fish/guestfish-actions.pod:1411 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:" +"If L was not called on this handle, and if " +"C was not set, then this returns the compiled-in default " +"value for memsize." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1955 ../fish/guestfish-actions.pod:1529 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1415 ../fish/guestfish-actions.pod:1472 +#: ../fish/guestfish-actions.pod:4225 ../fish/guestfish-actions.pod:4327 +#: ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:2255 +#: ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6562 msgid "" -" initrd-cat /boot/initrd-.img init\n" -"\n" +"For more information on the architecture of libguestfs, see L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1957 -msgid "See also C." +#. type: =head2 +#: ../fish/guestfish-actions.pod:1418 +msgid "get-network" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1959 ../src/guestfs-actions.pod:3929 -#: ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:4104 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1420 +#, 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." +" get-network\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1966 -msgid "guestfs_initrd_list" +#. type: textblock +#: ../fish/guestfish-actions.pod:1422 ../src/guestfs-actions.pod:2175 +msgid "This returns the enable network flag." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1424 +msgid "get-path" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1968 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1426 #, no-wrap msgid "" -" char **guestfs_initrd_list (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" get-path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1971 ../fish/guestfish-actions.pod:1540 -msgid "This command lists out files contained in an initrd." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1973 ../fish/guestfish-actions.pod:1542 -msgid "" -"The files are listed without any initial C character. The files are " -"listed in the order they appear (not necessarily alphabetical). Directory " -"names are listed as separate items." +#. type: textblock +#: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2186 +msgid "Return the current search path." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1977 ../fish/guestfish-actions.pod:1546 +#. type: textblock +#: ../fish/guestfish-actions.pod:1430 ../src/guestfs-actions.pod:2188 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)." +"This is always non-NULL. If it wasn't set already, then this will return " +"the default path." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:1985 -msgid "guestfs_inotify_add_watch" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1433 +msgid "get-pgroup" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:1987 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1435 #, no-wrap msgid "" -" int64_t guestfs_inotify_add_watch (guestfs_h *g,\n" -"\t\tconst char *path,\n" -"\t\tint mask);\n" +" get-pgroup\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1991 ../fish/guestfish-actions.pod:1554 -msgid "Watch C for the events listed in C." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:1993 ../fish/guestfish-actions.pod:1556 -msgid "" -"Note that if C is a directory then events within that directory are " -"watched, but this does I happen recursively (in subdirectories)." +#. type: textblock +#: ../fish/guestfish-actions.pod:1437 ../src/guestfs-actions.pod:2201 +msgid "This returns the process group flag." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:1997 ../fish/guestfish-actions.pod:1560 -msgid "" -"Note for non-C or non-Linux callers: the inotify events are defined by the " -"Linux kernel ABI and are listed in C." +#. type: =head2 +#: ../fish/guestfish-actions.pod:1439 +msgid "get-pid" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2003 -msgid "guestfs_inotify_close" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1441 +msgid "pid" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2005 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1443 #, no-wrap msgid "" -" int guestfs_inotify_close (guestfs_h *g);\n" +" get-pid\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2007 ../fish/guestfish-actions.pod:1568 +#. type: textblock +#: ../fish/guestfish-actions.pod:1445 ../src/guestfs-actions.pod:2212 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." +"Return the process ID of the qemu subprocess. If there is no qemu " +"subprocess, then this will return an error." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2013 -msgid "guestfs_inotify_files" +#. type: textblock +#: ../fish/guestfish-actions.pod:1448 ../src/guestfs-actions.pod:2215 +msgid "This is an internal call used for debugging and testing." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2015 -#, no-wrap -msgid "" -" char **guestfs_inotify_files (guestfs_h *g);\n" -"\n" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1450 +msgid "get-qemu" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2017 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1452 +#, no-wrap 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." +" get-qemu\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2025 -msgid "guestfs_inotify_init" +#. type: textblock +#: ../fish/guestfish-actions.pod:1454 ../src/guestfs-actions.pod:2226 +msgid "Return the current qemu binary." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2027 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1456 ../src/guestfs-actions.pod:2228 msgid "" -" int guestfs_inotify_init (guestfs_h *g,\n" -"\t\tint maxevents);\n" -"\n" +"This is always non-NULL. If it wasn't set already, then this will return " +"the default qemu binary name." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2030 ../fish/guestfish-actions.pod:1584 -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." +#. type: =head2 +#: ../fish/guestfish-actions.pod:1459 +msgid "get-recovery-proc" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2034 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1461 +#, no-wrap 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)." +" get-recovery-proc\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2044 -msgid "" -"Before any events are generated, you have to add some watches to the " -"internal watch list. See: C, " -"C and C." +#. type: textblock +#: ../fish/guestfish-actions.pod:1463 ../src/guestfs-actions.pod:2241 +msgid "Return the recovery process enabled flag." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2050 -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." +#. type: =head2 +#: ../fish/guestfish-actions.pod:1465 +msgid "get-selinux" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2057 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1467 +#, no-wrap msgid "" -"The handle should be closed after use by calling C. " -"This also removes any watches automatically." +" get-selinux\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2061 ../fish/guestfish-actions.pod:1615 +#. type: textblock +#: ../fish/guestfish-actions.pod:1469 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." +"This returns the current setting of the selinux flag which is passed to the " +"appliance at boot time. See L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2068 -msgid "guestfs_inotify_read" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1475 +msgid "get-smp" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2070 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1477 #, no-wrap msgid "" -" struct guestfs_inotify_event_list *guestfs_inotify_read (guestfs_h *g);\n" +" get-smp\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2072 ../fish/guestfish-actions.pod:1624 -msgid "" -"Return the complete queue of events that have happened since the previous " -"read call." +#. type: textblock +#: ../fish/guestfish-actions.pod:1479 ../src/guestfs-actions.pod:2267 +msgid "This returns the number of virtual CPUs assigned to the appliance." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2075 ../fish/guestfish-actions.pod:1627 -msgid "If no events have happened, this returns an empty list." +#. type: =head2 +#: ../fish/guestfish-actions.pod:1481 +msgid "get-state" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2077 ../fish/guestfish-actions.pod:1629 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1483 +#, no-wrap 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." +" get-state\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2083 +#. type: textblock +#: ../fish/guestfish-actions.pod:1485 ../src/guestfs-actions.pod:2278 msgid "" -"This function returns a C (see " -"Eguestfs-structs.hE), or NULL if there was an error. I after use>." +"This returns the current state as an opaque integer. This is only useful " +"for printing debug and internal error messages." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2088 -msgid "guestfs_inotify_rm_watch" +#. type: textblock +#: ../fish/guestfish-actions.pod:1488 ../fish/guestfish-actions.pod:2434 +#: ../fish/guestfish-actions.pod:2452 ../fish/guestfish-actions.pod:2490 +#: ../fish/guestfish-actions.pod:2506 ../src/guestfs-actions.pod:2281 +#: ../src/guestfs-actions.pod:3587 ../src/guestfs-actions.pod:3616 +#: ../src/guestfs-actions.pod:3677 ../src/guestfs-actions.pod:3704 +msgid "For more information on states, see L." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1490 +msgid "get-trace" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2090 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1492 #, no-wrap msgid "" -" int guestfs_inotify_rm_watch (guestfs_h *g,\n" -"\t\tint wd);\n" +" get-trace\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2093 -msgid "" -"Remove a previously defined inotify watch. See C." +#. type: textblock +#: ../fish/guestfish-actions.pod:1494 ../src/guestfs-actions.pod:2292 +msgid "Return the command trace flag." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2098 -msgid "guestfs_inspect_get_arch" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1496 +msgid "get-umask" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2100 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1498 #, no-wrap msgid "" -" char *guestfs_inspect_get_arch (guestfs_h *g,\n" -"\t\tconst char *root);\n" +" get-umask\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:2123 -#: ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:2196 -#: ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2238 -#: ../src/guestfs-actions.pod:2268 ../src/guestfs-actions.pod:2289 +#. type: textblock +#: ../fish/guestfish-actions.pod:1500 msgid "" -"This function should only be called with a root device string as returned by " -"C." +"Return the current umask. By default the umask is C<022> unless it has been " +"set by calling L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2106 -msgid "" -"This returns the architecture of the inspected operating system. The " -"possible return values are listed under C." +#. type: =head2 +#: ../fish/guestfish-actions.pod:1503 +msgid "get-verbose" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1653 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1505 +#, no-wrap msgid "" -"If the architecture could not be determined, then the string C is " -"returned." +" get-verbose\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2113 ../src/guestfs-actions.pod:2163 -#: ../src/guestfs-actions.pod:2211 ../src/guestfs-actions.pod:2279 -#: ../src/guestfs-actions.pod:2314 ../src/guestfs-actions.pod:2351 -#: ../fish/guestfish-actions.pod:1656 ../fish/guestfish-actions.pod:1702 -#: ../fish/guestfish-actions.pod:1741 ../fish/guestfish-actions.pod:1796 -#: ../fish/guestfish-actions.pod:1827 ../fish/guestfish-actions.pod:1861 -msgid "Please read L for more details." +#. type: textblock +#: ../fish/guestfish-actions.pod:1507 ../src/guestfs-actions.pod:2315 +msgid "This returns the verbose messages flag." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2118 -msgid "guestfs_inspect_get_distro" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1509 +msgid "getcon" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2120 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1511 #, no-wrap msgid "" -" char *guestfs_inspect_get_distro (guestfs_h *g,\n" -"\t\tconst char *root);\n" +" getcon\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2126 ../fish/guestfish-actions.pod:1665 -msgid "" -"This returns the distro (distribution) of the inspected operating system." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:2129 ../fish/guestfish-actions.pod:1668 -msgid "Currently defined distros are:" -msgstr "" - -# type: =item -#: ../src/guestfs-actions.pod:2133 ../fish/guestfish-actions.pod:1672 -msgid "\"debian\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2326 +msgid "This gets the SELinux security context of the daemon." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2135 ../fish/guestfish-actions.pod:1674 -msgid "Debian or a Debian-derived distro such as Ubuntu." +#. type: textblock +#: ../fish/guestfish-actions.pod:1515 +msgid "See the documentation about SELINUX in L, and L" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1676 -msgid "\"fedora\"" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1518 +msgid "getxattr" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2139 ../fish/guestfish-actions.pod:1678 -msgid "Fedora." +#. type: verbatim +#: ../fish/guestfish-actions.pod:1520 +#, no-wrap +msgid "" +" getxattr path name\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1680 -msgid "\"redhat-based\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:1522 +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 L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2143 ../fish/guestfish-actions.pod:1682 -msgid "Some Red Hat-derived distro." +#. type: textblock +#: ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:2579 +msgid "" +"Normally it is better to get all extended attributes from a file in one go " +"by calling L. However some Linux filesystem implementations are " +"buggy and do not provide a way to list out attributes. For these " +"filesystems (notably ntfs-3g) you have to know the names of the extended " +"attributes you want in advance and call this function." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:2145 ../fish/guestfish-actions.pod:1684 -msgid "\"rhel\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:2586 +#: ../src/guestfs-actions.pod:2355 ../src/guestfs-actions.pod:3837 +msgid "" +"Extended attribute values are blobs of binary data. If there is no extended " +"attribute named C, this returns an error." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1686 -msgid "Red Hat Enterprise Linux and some derivatives." +#. type: textblock +#: ../fish/guestfish-actions.pod:1536 +msgid "See also: L, L, L." msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:2301 -#: ../fish/guestfish-actions.pod:1688 ../fish/guestfish-actions.pod:1814 -msgid "\"windows\"" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1538 +msgid "getxattrs" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2151 ../fish/guestfish-actions.pod:1690 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1540 +#, no-wrap msgid "" -"Windows does not have distributions. This string is returned if the OS type " -"is Windows." +" getxattrs path\n" +"\n" msgstr "" -# type: =item -#: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2305 -#: ../fish/guestfish-actions.pod:1693 ../fish/guestfish-actions.pod:1818 -msgid "\"unknown\"" +#. type: textblock +#: ../fish/guestfish-actions.pod:1542 ../src/guestfs-actions.pod:2372 +msgid "" +"This call lists the extended attributes of the file or directory C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2156 ../fish/guestfish-actions.pod:1695 -msgid "The distro could not be determined." +#. type: textblock +#: ../fish/guestfish-actions.pod:1545 ../src/guestfs-actions.pod:2375 +msgid "" +"At the system call level, this is a combination of the L and " +"L calls." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2160 ../src/guestfs-actions.pod:2311 -#: ../fish/guestfish-actions.pod:1699 ../fish/guestfish-actions.pod:1824 -msgid "" -"Future versions of libguestfs may return other strings here. The caller " -"should be prepared to handle any string." +#. type: textblock +#: ../fish/guestfish-actions.pod:1548 +msgid "See also: L, L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2168 -msgid "guestfs_inspect_get_filesystems" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1550 +msgid "glob-expand" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2170 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1552 #, no-wrap msgid "" -" char **guestfs_inspect_get_filesystems (guestfs_h *g,\n" -"\t\tconst char *root);\n" +" glob-expand pattern\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1711 +#. type: textblock +#: ../fish/guestfish-actions.pod:1554 ../src/guestfs-actions.pod:2392 msgid "" -"This returns a list of all the filesystems that we think are associated with " -"this operating system. This includes the root filesystem, other ordinary " -"filesystems, and non-mounted devices like swap partitions." +"This command searches for all the pathnames matching C according to " +"the wildcard expansion rules used by the shell." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2181 ../fish/guestfish-actions.pod:1716 +#. type: textblock +#: ../fish/guestfish-actions.pod:1558 ../src/guestfs-actions.pod:2396 msgid "" -"In the case of a multi-boot virtual machine, it is possible for a filesystem " -"to be shared between operating systems." +"If no paths match, then this returns an empty list (note: not an error)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2184 +#. type: textblock +#: ../fish/guestfish-actions.pod:1561 ../src/guestfs-actions.pod:2399 msgid "" -"Please read L for more details. See also " -"C." +"It is just a wrapper around the C L function with flags C. See that manual page for more details." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2191 -msgid "guestfs_inspect_get_major_version" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1565 +msgid "grep" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2193 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1567 #, no-wrap msgid "" -" int guestfs_inspect_get_major_version (guestfs_h *g,\n" -"\t\tconst char *root);\n" +" grep regex path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1729 -msgid "" -"This returns the major version number of the inspected operating system." +#. type: textblock +#: ../fish/guestfish-actions.pod:1569 ../src/guestfs-actions.pod:2416 +msgid "This calls the external C program and returns the matching lines." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1575 +msgid "grepi" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1732 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1577 +#, no-wrap 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." +" grepi regex path\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2209 ../src/guestfs-actions.pod:2226 -#: ../fish/guestfish-actions.pod:1739 ../fish/guestfish-actions.pod:1753 -msgid "If the version could not be determined, then C<0> is returned." +#. type: textblock +#: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2435 +msgid "" +"This calls the external C program and returns the matching lines." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2215 -msgid "guestfs_inspect_get_minor_version" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1585 +msgid "grub-install" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2217 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1587 #, no-wrap msgid "" -" int guestfs_inspect_get_minor_version (guestfs_h *g,\n" -"\t\tconst char *root);\n" +" grub-install root device\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1750 +#. type: textblock +#: ../fish/guestfish-actions.pod:1589 ../src/guestfs-actions.pod:2454 msgid "" -"This returns the minor version number of the inspected operating system." +"This command installs GRUB 1 (the Grand Unified Bootloader) on C, " +"with the root directory being C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2228 +#. type: textblock +#: ../fish/guestfish-actions.pod:1598 ../src/guestfs-actions.pod:2463 msgid "" -"Please read L for more details. See also " -"C." +"There is currently no way in the API to install grub2, which is used by most " +"modern Linux guests. It is possible to run the grub2 command from the " +"guest, although see the caveats in L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2233 -msgid "guestfs_inspect_get_mountpoints" +#. type: textblock +#: ../fish/guestfish-actions.pod:1605 ../src/guestfs-actions.pod:2470 +msgid "" +"This uses C from the host. Unfortunately grub is not always " +"compatible with itself, so this only works in rather narrow circumstances. " +"Careful testing with each guest version is advisable." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2235 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1612 ../src/guestfs-actions.pod:2477 msgid "" -" char **guestfs_inspect_get_mountpoints (guestfs_h *g,\n" -"\t\tconst char *root);\n" -"\n" +"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:" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1765 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1619 ../src/guestfs-actions.pod:2484 +#, no-wrap 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." +" (hd0) /dev/vda\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2246 ../fish/guestfish-actions.pod:1770 -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)." +#. type: textblock +#: ../fish/guestfish-actions.pod:1621 ../src/guestfs-actions.pod:2486 +msgid "replacing C with the name of the installation device." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2251 ../fish/guestfish-actions.pod:1775 -msgid "" -"Non-mounted devices such as swap devices are I returned in this list." +#. type: =head2 +#: ../fish/guestfish-actions.pod:1625 +msgid "head" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2254 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1627 +#, no-wrap msgid "" -"Please read L for more details. See also " -"C." +" head path\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2597 -#: ../src/guestfs-actions.pod:3551 ../src/guestfs-actions.pod:5134 +#. type: textblock +#: ../fish/guestfish-actions.pod:1629 ../src/guestfs-actions.pod:2500 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." +"This command returns up to the first 10 lines of a file as a list of strings." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2263 -msgid "guestfs_inspect_get_product_name" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1635 +msgid "head-n" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2265 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1637 #, no-wrap msgid "" -" char *guestfs_inspect_get_product_name (guestfs_h *g,\n" -"\t\tconst char *root);\n" +" head-n nrlines path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2271 ../fish/guestfish-actions.pod:1788 +#. type: textblock +#: ../fish/guestfish-actions.pod:1639 ../src/guestfs-actions.pod:2519 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." +"If the parameter C is a positive number, this returns the first " +"C lines of the file C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2276 ../fish/guestfish-actions.pod:1793 +#. type: textblock +#: ../fish/guestfish-actions.pod:1642 ../src/guestfs-actions.pod:2522 msgid "" -"If the product name could not be determined, then the string C is " -"returned." +"If the parameter C is a negative number, this returns lines from " +"the file C, excluding the last C lines." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2284 -msgid "guestfs_inspect_get_type" +#. type: textblock +#: ../fish/guestfish-actions.pod:1645 ../fish/guestfish-actions.pod:4717 +#: ../src/guestfs-actions.pod:2525 ../src/guestfs-actions.pod:7150 +msgid "If the parameter C is zero, this returns an empty list." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1650 +msgid "hexdump" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2286 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1652 #, no-wrap msgid "" -" char *guestfs_inspect_get_type (guestfs_h *g,\n" -"\t\tconst char *root);\n" +" hexdump path\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1805 +#. type: textblock +#: ../fish/guestfish-actions.pod:1654 ../src/guestfs-actions.pod:2542 msgid "" -"This returns the type of the inspected operating system. Currently defined " -"types are:" -msgstr "" - -# type: =item -#: ../src/guestfs-actions.pod:2297 ../fish/guestfish-actions.pod:1810 -msgid "\"linux\"" +"This runs C on the given C. The result is the human-" +"readable, canonical hex dump of the file." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2299 ../fish/guestfish-actions.pod:1812 -msgid "Any Linux-based operating system." +#. type: =head2 +#: ../fish/guestfish-actions.pod:1660 +msgid "initrd-cat" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2303 ../fish/guestfish-actions.pod:1816 -msgid "Any Microsoft Windows operating system." +#. type: verbatim +#: ../fish/guestfish-actions.pod:1662 +#, no-wrap +msgid "" +" initrd-cat initrdpath filename\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2307 ../fish/guestfish-actions.pod:1820 -msgid "The operating system type could not be determined." +#. type: textblock +#: ../fish/guestfish-actions.pod:1664 ../src/guestfs-actions.pod:2561 +msgid "" +"This command unpacks the file C from the initrd file called " +"C. The filename must be given I the initial C " +"character." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2319 -msgid "guestfs_inspect_os" +#. type: textblock +#: ../fish/guestfish-actions.pod:1668 ../src/guestfs-actions.pod:2565 +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:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2321 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1672 ../src/guestfs-actions.pod:2569 #, no-wrap msgid "" -" char **guestfs_inspect_os (guestfs_h *g);\n" +" initrd-cat /boot/initrd-.img init\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2323 ../fish/guestfish-actions.pod:1833 -msgid "" -"This function uses other libguestfs functions and certain heuristics to " -"inspect the disk(s) (usually disks belonging to a virtual machine), looking " -"for operating systems." +#. type: textblock +#: ../fish/guestfish-actions.pod:1674 +msgid "See also L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2327 ../fish/guestfish-actions.pod:1837 -msgid "The list returned is empty if no operating systems were found." +#. type: =head2 +#: ../fish/guestfish-actions.pod:1679 +msgid "initrd-list" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2329 ../fish/guestfish-actions.pod:1839 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1681 +#, no-wrap msgid "" -"If one operating system was found, then this returns a list with a single " -"element, which is the name of the root filesystem of this operating system. " -"It is also possible for this function to return a list containing more than " -"one element, indicating a dual-boot or multi-boot virtual machine, with each " -"element being the root filesystem of one of the operating systems." +" initrd-list path\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2336 -msgid "" -"You can pass the root string(s) returned to other C " -"functions in order to query further information about each operating system, " -"such as the name and version." +#. type: textblock +#: ../fish/guestfish-actions.pod:1683 ../src/guestfs-actions.pod:2588 +msgid "This command lists out files contained in an initrd." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2341 +#. type: textblock +#: ../fish/guestfish-actions.pod:1685 ../src/guestfs-actions.pod:2590 msgid "" -"This function uses other libguestfs features such as C and " -"C 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." +"The files are listed without any initial C character. The files are " +"listed in the order they appear (not necessarily alphabetical). Directory " +"names are listed as separate items." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1857 +#. type: textblock +#: ../fish/guestfish-actions.pod:1689 ../src/guestfs-actions.pod:2594 msgid "" -"This function cannot decrypt encrypted disks. The caller must do that first " -"(supplying the necessary keys) if the disk is encrypted." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:2353 ../src/guestfs-actions.pod:2558 -#: ../src/guestfs-actions.pod:2614 -msgid "See also C." +"Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as " +"initrd. We I support the newer initramfs format (compressed cpio " +"files)." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2359 -msgid "guestfs_is_blockdev" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1693 +msgid "inotify-add-watch" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2361 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1695 #, no-wrap msgid "" -" int guestfs_is_blockdev (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" inotify-add-watch path mask\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1869 +#. type: textblock +#: ../fish/guestfish-actions.pod:1697 ../src/guestfs-actions.pod:2611 +msgid "Watch C for the events listed in C." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:1699 ../src/guestfs-actions.pod:2613 msgid "" -"This returns C if and only if there is a block device with the given " -"C name." +"Note that if C is a directory then events within that directory are " +"watched, but this does I happen recursively (in subdirectories)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2367 ../src/guestfs-actions.pod:2390 -#: ../src/guestfs-actions.pod:2414 ../src/guestfs-actions.pod:2426 -#: ../src/guestfs-actions.pod:2439 ../src/guestfs-actions.pod:2483 -#: ../src/guestfs-actions.pod:2495 -msgid "See also C." +#. type: textblock +#: ../fish/guestfish-actions.pod:1703 ../src/guestfs-actions.pod:2617 +msgid "" +"Note for non-C or non-Linux callers: the inotify events are defined by the " +"Linux kernel ABI and are listed in C." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2371 -msgid "guestfs_is_busy" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1707 +msgid "inotify-close" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2373 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1709 #, no-wrap msgid "" -" int guestfs_is_busy (guestfs_h *g);\n" +" inotify-close\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2375 ../fish/guestfish-actions.pod:1878 +#. type: textblock +#: ../fish/guestfish-actions.pod:1711 ../src/guestfs-actions.pod:2630 msgid "" -"This returns true iff this handle is busy processing a command (in the " -"C state)." +"This closes the inotify handle which was previously opened by inotify_init. " +"It removes all watches, throws away any pending events, and deallocates all " +"resources." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2382 -msgid "guestfs_is_chardev" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1715 +msgid "inotify-files" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2384 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1717 #, no-wrap msgid "" -" int guestfs_is_chardev (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" inotify-files\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2387 ../fish/guestfish-actions.pod:1887 +#. type: textblock +#: ../fish/guestfish-actions.pod:1719 msgid "" -"This returns C if and only if there is a character device with the " -"given C name." +"This function is a helpful wrapper around L which just " +"returns a list of pathnames of objects that were touched. The returned " +"pathnames are sorted and deduplicated." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2394 -msgid "guestfs_is_config" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1723 +msgid "inotify-init" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2396 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1725 #, no-wrap msgid "" -" int guestfs_is_config (guestfs_h *g);\n" +" inotify-init maxevents\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2398 ../fish/guestfish-actions.pod:1896 +#. type: textblock +#: ../fish/guestfish-actions.pod:1727 ../src/guestfs-actions.pod:2659 msgid "" -"This returns true iff this handle is being configured (in the C " -"state)." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:2405 -msgid "guestfs_is_dir" +"This command creates a new inotify handle. The inotify subsystem can be " +"used to notify events which happen to objects in the guest filesystem." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2407 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1731 msgid "" -" int guestfs_is_dir (guestfs_h *g,\n" -"\t\tconst char *path);\n" -"\n" +"C is the maximum number of events which will be queued up between " +"calls to L or L. 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 L)." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2410 ../fish/guestfish-actions.pod:1905 +#. type: textblock +#: ../fish/guestfish-actions.pod:1741 msgid "" -"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." +"Before any events are generated, you have to add some watches to the " +"internal watch list. See: L, L and " +"L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2418 -msgid "guestfs_is_fifo" +#. type: textblock +#: ../fish/guestfish-actions.pod:1747 +msgid "" +"Queued up events should be read periodically by calling L (or " +"L which is just a helpful wrapper around L). " +"If you don't read the events out often enough then you risk the internal " +"queue overflowing." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2420 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1754 msgid "" -" int guestfs_is_fifo (guestfs_h *g,\n" -"\t\tconst char *path);\n" -"\n" +"The handle should be closed after use by calling L. This " +"also removes any watches automatically." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2423 ../fish/guestfish-actions.pod:1915 +#. type: textblock +#: ../fish/guestfish-actions.pod:1758 ../src/guestfs-actions.pod:2690 msgid "" -"This returns C if and only if there is a FIFO (named pipe) with the " -"given C name." +"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." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2430 -msgid "guestfs_is_file" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1763 +msgid "inotify-read" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2432 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1765 #, no-wrap msgid "" -" int guestfs_is_file (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" inotify-read\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2435 ../fish/guestfish-actions.pod:1924 +#. type: textblock +#: ../fish/guestfish-actions.pod:1767 ../src/guestfs-actions.pod:2704 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 -#: ../src/guestfs-actions.pod:2443 -msgid "guestfs_is_launching" +"Return the complete queue of events that have happened since the previous " +"read call." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2445 -#, no-wrap -msgid "" -" int guestfs_is_launching (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2707 +msgid "If no events have happened, this returns an empty list." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2447 ../fish/guestfish-actions.pod:1934 +#. type: textblock +#: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2709 msgid "" -"This returns true iff this handle is launching the subprocess (in the " -"C state)." +"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." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2454 -msgid "guestfs_is_lv" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1778 +msgid "inotify-rm-watch" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2456 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1780 #, no-wrap msgid "" -" int guestfs_is_lv (guestfs_h *g,\n" -"\t\tconst char *device);\n" +" inotify-rm-watch wd\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2459 ../fish/guestfish-actions.pod:1943 -msgid "" -"This command tests whether C is a logical volume, and returns true " -"iff this is the case." +#. type: textblock +#: ../fish/guestfish-actions.pod:1782 +msgid "Remove a previously defined inotify watch. See L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2464 -msgid "guestfs_is_ready" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1785 +msgid "inspect-get-arch" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2466 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1787 #, no-wrap msgid "" -" int guestfs_is_ready (guestfs_h *g);\n" +" inspect-get-arch root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2468 ../fish/guestfish-actions.pod:1950 +#. type: textblock +#: ../fish/guestfish-actions.pod:1789 msgid "" -"This returns true iff this handle is ready to accept commands (in the " -"C state)." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:2475 -msgid "guestfs_is_socket" +"This returns the architecture of the inspected operating system. The " +"possible return values are listed under L." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2477 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1793 ../src/guestfs-actions.pod:2744 msgid "" -" int guestfs_is_socket (guestfs_h *g,\n" -"\t\tconst char *path);\n" -"\n" +"If the architecture could not be determined, then the string C is " +"returned." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2480 ../fish/guestfish-actions.pod:1959 -msgid "" -"This returns C if and only if there is a Unix domain socket with the " -"given C name." +#. type: textblock +#: ../fish/guestfish-actions.pod:1796 ../fish/guestfish-actions.pod:1883 +#: ../fish/guestfish-actions.pod:1962 ../fish/guestfish-actions.pod:1974 +#: ../fish/guestfish-actions.pod:2058 ../fish/guestfish-actions.pod:2119 +#: ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2154 +#: ../fish/guestfish-actions.pod:2194 ../fish/guestfish-actions.pod:2226 +#: ../fish/guestfish-actions.pod:2239 ../fish/guestfish-actions.pod:2252 +#: ../fish/guestfish-actions.pod:2262 ../fish/guestfish-actions.pod:2272 +#: ../fish/guestfish-actions.pod:2284 ../fish/guestfish-actions.pod:2380 +#: ../fish/guestfish-actions.pod:2414 ../src/guestfs-actions.pod:2747 +#: ../src/guestfs-actions.pod:2841 ../src/guestfs-actions.pod:2945 +#: ../src/guestfs-actions.pod:2964 ../src/guestfs-actions.pod:3095 +#: ../src/guestfs-actions.pod:3178 ../src/guestfs-actions.pod:3206 +#: ../src/guestfs-actions.pod:3227 ../src/guestfs-actions.pod:3280 +#: ../src/guestfs-actions.pod:3320 ../src/guestfs-actions.pod:3340 +#: ../src/guestfs-actions.pod:3360 ../src/guestfs-actions.pod:3377 +#: ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3411 +#: ../src/guestfs-actions.pod:3513 ../src/guestfs-actions.pod:3554 +msgid "Please read L for more details." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2487 -msgid "guestfs_is_symlink" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1798 +msgid "inspect-get-distro" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2489 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1800 #, no-wrap msgid "" -" int guestfs_is_symlink (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" inspect-get-distro root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1968 +#. type: textblock +#: ../fish/guestfish-actions.pod:1802 ../src/guestfs-actions.pod:2760 msgid "" -"This returns C if and only if there is a symbolic link with the given " -"C name." +"This returns the distro (distribution) of the inspected operating system." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2499 -msgid "guestfs_kill_subprocess" +#. type: textblock +#: ../fish/guestfish-actions.pod:1805 ../src/guestfs-actions.pod:2763 +msgid "Currently defined distros are:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2501 -#, no-wrap -msgid "" -" int guestfs_kill_subprocess (guestfs_h *g);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:1809 ../src/guestfs-actions.pod:2767 +msgid "\"archlinux\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2503 ../fish/guestfish-actions.pod:1977 -msgid "This kills the qemu subprocess. You should never need to call this." +#. type: textblock +#: ../fish/guestfish-actions.pod:1811 ../src/guestfs-actions.pod:2769 +msgid "Arch Linux." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2507 -msgid "guestfs_launch" +#. type: =item +#: ../fish/guestfish-actions.pod:1813 ../src/guestfs-actions.pod:2771 +msgid "\"centos\"" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2509 -#, no-wrap -msgid "" -" int guestfs_launch (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1815 ../src/guestfs-actions.pod:2773 +msgid "CentOS." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2511 ../fish/guestfish-actions.pod:1985 -msgid "" -"Internally libguestfs is implemented by running a virtual machine using " -"L." +#. type: =item +#: ../fish/guestfish-actions.pod:1817 ../src/guestfs-actions.pod:2775 +msgid "\"debian\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1988 -msgid "" -"You should call this after configuring the handle (eg. adding drives) but " -"before performing any actions." +#. type: textblock +#: ../fish/guestfish-actions.pod:1819 ../src/guestfs-actions.pod:2777 +msgid "Debian." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2519 -msgid "guestfs_lchown" +#. type: =item +#: ../fish/guestfish-actions.pod:1821 ../src/guestfs-actions.pod:2779 +msgid "\"fedora\"" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2521 -#, no-wrap -msgid "" -" int guestfs_lchown (guestfs_h *g,\n" -"\t\tint owner,\n" -"\t\tint group,\n" -"\t\tconst char *path);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1823 ../src/guestfs-actions.pod:2781 +msgid "Fedora." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2526 -msgid "" -"Change the file owner to C and group to C. This is like " -"C but if C is a symlink then the link itself is " -"changed, not the target." +#. type: =item +#: ../fish/guestfish-actions.pod:1825 ../src/guestfs-actions.pod:2783 +msgid "\"gentoo\"" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2536 -msgid "guestfs_lgetxattrs" +#. type: textblock +#: ../fish/guestfish-actions.pod:1827 ../src/guestfs-actions.pod:2785 +msgid "Gentoo." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2538 -#, no-wrap -msgid "" -" struct guestfs_xattr_list *guestfs_lgetxattrs (guestfs_h *g,\n" -"\t\tconst char *path);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:1829 ../src/guestfs-actions.pod:2787 +msgid "\"linuxmint\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2541 -msgid "" -"This is the same as C, but if C is a symbolic link, " -"then it returns the extended attributes of the link itself." +#. type: textblock +#: ../fish/guestfish-actions.pod:1831 ../src/guestfs-actions.pod:2789 +msgid "Linux Mint." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2550 -msgid "guestfs_list_devices" +#. type: =item +#: ../fish/guestfish-actions.pod:1833 ../src/guestfs-actions.pod:2791 +msgid "\"mandriva\"" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2552 -#, no-wrap -msgid "" -" char **guestfs_list_devices (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1835 ../src/guestfs-actions.pod:2793 +msgid "Mandriva." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:2015 -msgid "List all the block devices." +#. type: =item +#: ../fish/guestfish-actions.pod:1837 ../src/guestfs-actions.pod:2795 +msgid "\"meego\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:2017 -msgid "The full block device names are returned, eg. C." +#. type: textblock +#: ../fish/guestfish-actions.pod:1839 ../src/guestfs-actions.pod:2797 +msgid "MeeGo." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2564 -msgid "guestfs_list_filesystems" +#. type: =item +#: ../fish/guestfish-actions.pod:1841 ../src/guestfs-actions.pod:2799 +msgid "\"pardus\"" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2566 -#, no-wrap -msgid "" -" char **guestfs_list_filesystems (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1843 ../src/guestfs-actions.pod:2801 +msgid "Pardus." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:2025 -msgid "" -"This inspection command looks for filesystems on partitions, block devices " -"and logical volumes, returning a list of devices containing filesystems and " -"their type." +#. type: =item +#: ../fish/guestfish-actions.pod:1845 ../src/guestfs-actions.pod:2803 +msgid "\"redhat-based\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:2029 -msgid "" -"The return value is a hash, where the keys are the devices containing " -"filesystems, and the values are the filesystem types. For example:" +#. type: textblock +#: ../fish/guestfish-actions.pod:1847 ../src/guestfs-actions.pod:2805 +msgid "Some Red Hat-derived distro." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:2033 -#, 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" +#. type: =item +#: ../fish/guestfish-actions.pod:1849 ../src/guestfs-actions.pod:2807 +msgid "\"rhel\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2581 ../fish/guestfish-actions.pod:2038 -msgid "" -"The value can have the special value \"unknown\", meaning the content of the " -"device is undetermined or empty. \"swap\" means a Linux swap partition." +#. type: textblock +#: ../fish/guestfish-actions.pod:1851 ../src/guestfs-actions.pod:2809 +msgid "Red Hat Enterprise Linux." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2585 -msgid "" -"This command runs other libguestfs commands, which might include " -"C and C, and therefore you should use this " -"soon after launch and only when nothing is mounted." +#. type: =item +#: ../fish/guestfish-actions.pod:1853 ../src/guestfs-actions.pod:2811 +msgid "\"scientificlinux\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2589 -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 C to look for OSes)." +#. type: textblock +#: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2813 +msgid "Scientific Linux." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2603 -msgid "guestfs_list_partitions" +#. type: =item +#: ../fish/guestfish-actions.pod:1857 ../src/guestfs-actions.pod:2815 +msgid "\"slackware\"" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2605 -#, no-wrap -msgid "" -" char **guestfs_list_partitions (guestfs_h *g);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:1859 ../src/guestfs-actions.pod:2817 +msgid "Slackware." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:2058 -msgid "List all the partitions detected on all block devices." +#. type: =item +#: ../fish/guestfish-actions.pod:1861 ../src/guestfs-actions.pod:2819 +msgid "\"ttylinux\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:2060 -msgid "The full partition device names are returned, eg. C" +#. type: textblock +#: ../fish/guestfish-actions.pod:1863 ../src/guestfs-actions.pod:2821 +msgid "ttylinux." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2611 -msgid "" -"This does not return logical volumes. For that you will need to call " -"C." +#. type: =item +#: ../fish/guestfish-actions.pod:1865 ../src/guestfs-actions.pod:2823 +msgid "\"ubuntu\"" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2620 -msgid "guestfs_ll" +#. type: textblock +#: ../fish/guestfish-actions.pod:1867 ../src/guestfs-actions.pod:2825 +msgid "Ubuntu." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2622 -#, no-wrap -msgid "" -" char *guestfs_ll (guestfs_h *g,\n" -"\t\tconst char *directory);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:1869 ../fish/guestfish-actions.pod:1953 +#: ../fish/guestfish-actions.pod:2217 ../src/guestfs-actions.pod:2827 +#: ../src/guestfs-actions.pod:2936 ../src/guestfs-actions.pod:3311 +msgid "\"unknown\"" +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:1871 ../src/guestfs-actions.pod:2829 +msgid "The distro could not be determined." +msgstr "" + +#. type: =item +#: ../fish/guestfish-actions.pod:1873 ../fish/guestfish-actions.pod:2209 +#: ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:3303 +msgid "\"windows\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2625 ../fish/guestfish-actions.pod:2071 +#. type: textblock +#: ../fish/guestfish-actions.pod:1875 ../src/guestfs-actions.pod:2833 msgid "" -"List the files in C (relative to the root directory, there is no " -"cwd) in the format of 'ls -la'." +"Windows does not have distributions. This string is returned if the OS type " +"is Windows." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2628 ../fish/guestfish-actions.pod:2074 +#. type: textblock +#: ../fish/guestfish-actions.pod:1880 ../fish/guestfish-actions.pod:1959 +#: ../fish/guestfish-actions.pod:2223 ../src/guestfs-actions.pod:2838 +#: ../src/guestfs-actions.pod:2942 ../src/guestfs-actions.pod:3317 msgid "" -"This command is mostly useful for interactive sessions. It is I " -"intended that you try to parse the output string." +"Future versions of libguestfs may return other strings here. The caller " +"should be prepared to handle any string." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2634 -msgid "guestfs_ln" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1885 +msgid "inspect-get-drive-mappings" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2636 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1887 #, no-wrap msgid "" -" int guestfs_ln (guestfs_h *g,\n" -"\t\tconst char *target,\n" -"\t\tconst char *linkname);\n" +" inspect-get-drive-mappings root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2640 ../fish/guestfish-actions.pod:2081 -msgid "This command creates a hard link using the C command." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:2644 -msgid "guestfs_ln_f" +#. type: textblock +#: ../fish/guestfish-actions.pod:1889 ../src/guestfs-actions.pod:2854 +msgid "" +"This call is useful for Windows which uses a primitive system of assigning " +"drive letters (like \"C:\") to partitions. This inspection API examines the " +"Windows Registry to find out how disks/partitions are mapped to drive " +"letters, and returns a hash table as in the example below:" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2646 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1895 ../src/guestfs-actions.pod:2860 #, no-wrap msgid "" -" int guestfs_ln_f (guestfs_h *g,\n" -"\t\tconst char *target,\n" -"\t\tconst char *linkname);\n" +" C => /dev/vda2\n" +" E => /dev/vdb1\n" +" F => /dev/vdc1\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:2087 +#. type: textblock +#: ../fish/guestfish-actions.pod:1899 ../src/guestfs-actions.pod:2864 msgid "" -"This command creates a hard link using the C command. The C<-f> " -"option removes the link (C) if it exists already." +"Note that keys are drive letters. For Windows, the key is case insensitive " +"and just contains the drive letter, without the customary colon separator " +"character." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2655 -msgid "guestfs_ln_s" +#. type: textblock +#: ../fish/guestfish-actions.pod:1903 ../src/guestfs-actions.pod:2868 +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." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2657 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1908 ../src/guestfs-actions.pod:2873 msgid "" -" int guestfs_ln_s (guestfs_h *g,\n" -"\t\tconst char *target,\n" -"\t\tconst char *linkname);\n" -"\n" +"For Windows guests, currently only hard drive mappings are returned. " +"Removable disks (eg. DVD-ROMs) are ignored." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2661 ../fish/guestfish-actions.pod:2094 -msgid "This command creates a symbolic link using the C command." +#. type: textblock +#: ../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: =head2 -#: ../src/guestfs-actions.pod:2665 -msgid "guestfs_ln_sf" +#. type: textblock +#: ../fish/guestfish-actions.pod:1914 +msgid "" +"Please read L for more details. See also L, L." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1918 +msgid "inspect-get-filesystems" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2667 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1920 #, no-wrap msgid "" -" int guestfs_ln_sf (guestfs_h *g,\n" -"\t\tconst char *target,\n" -"\t\tconst char *linkname);\n" +" inspect-get-filesystems root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2671 ../fish/guestfish-actions.pod:2100 +#. type: textblock +#: ../fish/guestfish-actions.pod:1922 ../src/guestfs-actions.pod:2897 msgid "" -"This command creates a symbolic link using the C command, The C<-f> " -"option removes the link (C) if it exists already." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:2676 -msgid "guestfs_lremovexattr" +"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: verbatim -#: ../src/guestfs-actions.pod:2678 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:1927 ../src/guestfs-actions.pod:2902 msgid "" -" int guestfs_lremovexattr (guestfs_h *g,\n" -"\t\tconst char *xattr,\n" -"\t\tconst char *path);\n" -"\n" +"In the case of a multi-boot virtual machine, it is possible for a filesystem " +"to be shared between operating systems." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2682 +#. type: textblock +#: ../fish/guestfish-actions.pod:1930 msgid "" -"This is the same as C, but if C is a symbolic " -"link, then it removes an extended attribute of the link itself." +"Please read L for more details. See also L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2688 -msgid "guestfs_ls" +#. type: =head2 +#: ../fish/guestfish-actions.pod:1933 +msgid "inspect-get-format" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2690 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1935 #, no-wrap msgid "" -" char **guestfs_ls (guestfs_h *g,\n" -"\t\tconst char *directory);\n" +" inspect-get-format root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2693 ../fish/guestfish-actions.pod:2115 +#. type: textblock +#: ../fish/guestfish-actions.pod:1937 ../src/guestfs-actions.pod:2920 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." +"This returns the format of the inspected operating system. You can use it " +"to detect install images, live CDs and similar." +msgstr "" + +#. type: textblock +#: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:2923 +msgid "Currently defined formats are:" +msgstr "" + +#. type: =item +#: ../fish/guestfish-actions.pod:1944 ../src/guestfs-actions.pod:2927 +msgid "\"installed\"" +msgstr "" + +#. type: textblock +#: ../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 -#: ../src/guestfs-actions.pod:2697 +#. type: textblock +#: ../fish/guestfish-actions.pod:1950 ../src/guestfs-actions.pod:2933 msgid "" -"This command is mostly useful for interactive sessions. Programs should " -"probably use C instead." +"The disk image being inspected is not an installed operating system, but a " +"I install disk, live CD, or similar." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2704 -msgid "guestfs_lsetxattr" +#. type: textblock +#: ../fish/guestfish-actions.pod:1955 ../src/guestfs-actions.pod:2938 +msgid "The format of this disk image is not known." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:1964 +msgid "inspect-get-hostname" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2706 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1966 #, no-wrap msgid "" -" int guestfs_lsetxattr (guestfs_h *g,\n" -"\t\tconst char *xattr,\n" -"\t\tconst char *val,\n" -"\t\tint vallen,\n" -"\t\tconst char *path);\n" +" inspect-get-hostname root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2712 +#. type: textblock +#: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2958 msgid "" -"This is the same as C, but if C is a symbolic link, " -"then it sets an extended attribute of the link itself." +"This function returns the hostname of the operating system as found by " +"inspection of the guest's configuration files." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2718 -msgid "guestfs_lstat" +#. type: textblock +#: ../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 +#: ../fish/guestfish-actions.pod:1976 +msgid "inspect-get-icon" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2720 +#. type: verbatim +#: ../fish/guestfish-actions.pod:1978 #, no-wrap msgid "" -" struct guestfs_stat *guestfs_lstat (guestfs_h *g,\n" -"\t\tconst char *path);\n" +" inspect-get-icon root [favicon:..] [highquality:..]\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2723 ../src/guestfs-actions.pod:4799 -#: ../fish/guestfish-actions.pod:2134 ../fish/guestfish-actions.pod:3716 -msgid "Returns file information for the given C." +#. type: textblock +#: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:2987 +msgid "" +"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 -#: ../src/guestfs-actions.pod:2725 +#. type: textblock +#: ../fish/guestfish-actions.pod:1984 ../src/guestfs-actions.pod:2991 msgid "" -"This is the same as C except that if C is a symbolic " -"link, then the link is stat-ed, not the file it refers to." +"If it was not possible to get an icon this function returns a zero-length " +"(non-NULL) buffer. I." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:2140 -msgid "This is the same as the C system call." +#. type: textblock +#: ../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: textblock -#: ../src/guestfs-actions.pod:2731 ../src/guestfs-actions.pod:4803 +#. type: textblock +#: ../fish/guestfish-actions.pod:1993 ../src/guestfs-actions.pod:3000 msgid "" -"This function returns a C, or NULL if there was an " -"error. I after use>." +"If finding the favicon fails, then we look in other places in the guest for " +"a suitable icon." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2735 -msgid "guestfs_lstatlist" +#. type: textblock +#: ../fish/guestfish-actions.pod:1996 ../src/guestfs-actions.pod:3003 +msgid "" +"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: verbatim -#: ../src/guestfs-actions.pod:2737 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2007 ../src/guestfs-actions.pod:3014 msgid "" -" struct guestfs_stat_list *guestfs_lstatlist (guestfs_h *g,\n" -"\t\tconst char *path,\n" -"\t\tchar *const *names);\n" -"\n" +"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 -#: ../src/guestfs-actions.pod:2741 +#. type: textblock +#: ../fish/guestfish-actions.pod:2013 ../src/guestfs-actions.pod:3020 msgid "" -"This call allows you to perform the C operation on multiple " -"files, where all files are in the directory C. C is the list " -"of files from this directory." +"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: textblock -#: ../src/guestfs-actions.pod:2745 ../fish/guestfish-actions.pod:2150 +#. type: textblock +#: ../fish/guestfish-actions.pod:2021 ../src/guestfs-actions.pod:3028 msgid "" -"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>." +"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: textblock -#: ../src/guestfs-actions.pod:2750 +#. type: textblock +#: ../fish/guestfish-actions.pod:2028 ../src/guestfs-actions.pod:3035 msgid "" -"This call is intended for programs that want to efficiently list a directory " -"contents without making many round-trips. See also C " -"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." +"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 -#: ../src/guestfs-actions.pod:2758 +#. type: textblock +#: ../fish/guestfish-actions.pod:2035 ../src/guestfs-actions.pod:3042 msgid "" -"This function returns a C (see Eguestfs-" -"structs.hE), or NULL if there was an error. I after use>." +"Operating system icons are usually trademarks. Seek legal advice before " +"using trademarks in applications." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2763 -msgid "guestfs_luks_add_key" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2042 +msgid "inspect-get-major-version" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2765 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2044 #, no-wrap msgid "" -" int guestfs_luks_add_key (guestfs_h *g,\n" -"\t\tconst char *device,\n" -"\t\tconst char *key,\n" -"\t\tconst char *newkey,\n" -"\t\tint keyslot);\n" +" inspect-get-major-version root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:2167 +#. type: textblock +#: ../fish/guestfish-actions.pod:2046 ../src/guestfs-actions.pod:3083 msgid "" -"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." +"This returns the major version number of the inspected operating system." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2776 +#. type: textblock +#: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3086 msgid "" -"Note that if C already contains a key, then this command will " -"fail. You have to use C first to remove that key." +"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 -#: ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2816 -#: ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:2853 -#: ../src/guestfs-actions.pod:2882 ../src/guestfs-actions.pod:2898 -msgid "" -"This function takes a key or passphrase parameter which could contain " -"sensitive material. Read the section L for more " -"information." +#. type: textblock +#: ../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: =head2 -#: ../src/guestfs-actions.pod:2786 -msgid "guestfs_luks_close" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2060 +msgid "inspect-get-minor-version" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2788 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2062 #, no-wrap msgid "" -" int guestfs_luks_close (guestfs_h *g,\n" -"\t\tconst char *device);\n" +" inspect-get-minor-version root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2791 +#. type: textblock +#: ../fish/guestfish-actions.pod:2064 ../src/guestfs-actions.pod:3107 msgid "" -"This closes a LUKS device that was created earlier by C " -"or C. The C parameter must be the name of the " -"LUKS mapping device (ie. C) and I the name of the " -"underlying block device." +"This returns the minor version number of the inspected operating system." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2799 -msgid "guestfs_luks_format" +#. type: textblock +#: ../fish/guestfish-actions.pod:2069 +msgid "" +"Please read L for more details. See also L." +msgstr "" + +#. type: =head2 +#: ../fish/guestfish-actions.pod:2072 +msgid "inspect-get-mountpoints" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2801 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2074 #, no-wrap msgid "" -" int guestfs_luks_format (guestfs_h *g,\n" -"\t\tconst char *device,\n" -"\t\tconst char *key,\n" -"\t\tint keyslot);\n" +" inspect-get-mountpoints root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:2193 +#. type: textblock +#: ../fish/guestfish-actions.pod:2076 ../src/guestfs-actions.pod:3125 msgid "" -"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)." +"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 -#: ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:2833 -#: ../src/guestfs-actions.pod:2952 ../src/guestfs-actions.pod:3679 -#: ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:4661 -#: ../src/guestfs-actions.pod:4681 ../src/guestfs-actions.pod:4704 -#: ../src/guestfs-actions.pod:5669 ../fish/guestfish-actions.pod:2201 -#: ../fish/guestfish-actions.pod:2214 ../fish/guestfish-actions.pod:2298 -#: ../fish/guestfish-actions.pod:2828 ../fish/guestfish-actions.pod:3335 -#: ../fish/guestfish-actions.pod:3615 ../fish/guestfish-actions.pod:3631 -#: ../fish/guestfish-actions.pod:3646 ../fish/guestfish-actions.pod:4361 +#. type: textblock +#: ../fish/guestfish-actions.pod:2085 ../src/guestfs-actions.pod:3134 msgid "" -"B." +"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: =head2 -#: ../src/guestfs-actions.pod:2820 -msgid "guestfs_luks_format_cipher" +#. type: textblock +#: ../fish/guestfish-actions.pod:2090 ../src/guestfs-actions.pod:3139 +msgid "" +"Non-mounted devices such as swap devices are I returned in this list." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2822 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2093 msgid "" -" int guestfs_luks_format_cipher (guestfs_h *g,\n" -"\t\tconst char *device,\n" -"\t\tconst char *key,\n" -"\t\tint keyslot,\n" -"\t\tconst char *cipher);\n" -"\n" +"For operating systems like Windows which still use drive letters, this call " +"will only return an entry for the first drive \"mounted on\" C. For " +"information about the mapping of drive letters to partitions, see L." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2828 +#. type: textblock +#: ../fish/guestfish-actions.pod:2099 msgid "" -"This command is the same as C but it also allows you to " -"set the C used." +"Please read L for more details. See also L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2840 -msgid "guestfs_luks_kill_slot" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2102 +msgid "inspect-get-package-format" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2842 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2104 #, no-wrap msgid "" -" int guestfs_luks_kill_slot (guestfs_h *g,\n" -"\t\tconst char *device,\n" -"\t\tconst char *key,\n" -"\t\tint keyslot);\n" +" inspect-get-package-format root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:2221 +#. type: textblock +#: ../fish/guestfish-actions.pod:2106 msgid "" -"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:2857 -msgid "guestfs_luks_open" +"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: verbatim -#: ../src/guestfs-actions.pod:2859 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2112 ../src/guestfs-actions.pod:3171 msgid "" -" int guestfs_luks_open (guestfs_h *g,\n" -"\t\tconst char *device,\n" -"\t\tconst char *key,\n" -"\t\tconst char *mapname);\n" -"\n" +"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 -#: ../src/guestfs-actions.pod:2864 ../fish/guestfish-actions.pod:2232 +#. type: textblock +#: ../fish/guestfish-actions.pod:2116 ../src/guestfs-actions.pod:3175 msgid "" -"This command opens a block device which has been encrypted according to the " -"Linux Unified Key Setup (LUKS) standard." +"Possible strings include: C, C, C, C, C. " +"Future versions of libguestfs may return other strings." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2867 ../fish/guestfish-actions.pod:2235 -msgid "C is the encrypted block device or partition." +#. type: =head2 +#: ../fish/guestfish-actions.pod:2121 +msgid "inspect-get-package-management" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2869 ../fish/guestfish-actions.pod:2237 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2123 +#, no-wrap msgid "" -"The caller must supply one of the keys associated with the LUKS block " -"device, in the C parameter." +" inspect-get-package-management root\n" +"\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:2240 +#. type: textblock +#: ../fish/guestfish-actions.pod:2125 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." +"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 -#: ../src/guestfs-actions.pod:2876 +#. type: textblock +#: ../fish/guestfish-actions.pod:2131 ../src/guestfs-actions.pod:3197 msgid "" -"If this block device contains LVM volume groups, then calling " -"C followed by C will make them " -"visible." +"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: =head2 -#: ../src/guestfs-actions.pod:2886 -msgid "guestfs_luks_open_ro" +#. 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 +#: ../fish/guestfish-actions.pod:2142 +msgid "inspect-get-product-name" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2888 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2144 #, no-wrap msgid "" -" int guestfs_luks_open_ro (guestfs_h *g,\n" -"\t\tconst char *device,\n" -"\t\tconst char *key,\n" -"\t\tconst char *mapname);\n" +" inspect-get-product-name root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2893 +#. type: textblock +#: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3219 msgid "" -"This is the same as C except that a read-only mapping is " -"created." +"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: =head2 -#: ../src/guestfs-actions.pod:2902 -msgid "guestfs_lvcreate" +#. type: textblock +#: ../fish/guestfish-actions.pod:2151 ../src/guestfs-actions.pod:3224 +msgid "" +"If the product name could not be determined, then the string C is " +"returned." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2904 -#, no-wrap -msgid "" -" int guestfs_lvcreate (guestfs_h *g,\n" -"\t\tconst char *logvol,\n" -"\t\tconst char *volgroup,\n" -"\t\tint mbytes);\n" -"\n" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2156 +msgid "inspect-get-product-variant" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2265 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2158 +#, no-wrap msgid "" -"This creates an LVM logical volume called C on the volume group " -"C, with C megabytes." +" inspect-get-product-variant root\n" +"\n" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2914 -msgid "guestfs_lvm_canonical_lv_name" +#. type: textblock +#: ../fish/guestfish-actions.pod:2160 ../src/guestfs-actions.pod:3240 +msgid "This returns the product variant of the inspected operating system." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2916 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2163 ../src/guestfs-actions.pod:3243 msgid "" -" char *guestfs_lvm_canonical_lv_name (guestfs_h *g,\n" -"\t\tconst char *lvname);\n" -"\n" +"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 -#: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2272 +#. type: textblock +#: ../fish/guestfish-actions.pod:2172 ../src/guestfs-actions.pod:3252 msgid "" -"This converts alternative naming schemes for LVs that you might find to the " -"canonical name. For example, C is converted to C." +"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 -#: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2276 +#. type: textblock +#: ../fish/guestfish-actions.pod:2176 ../src/guestfs-actions.pod:3256 msgid "" -"This command returns an error if the C parameter does not refer to a " -"logical volume." +"If the product variant could not be determined, then the string C " +"is returned." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2926 -msgid "See also C." +#. type: textblock +#: ../fish/guestfish-actions.pod:2179 +msgid "" +"Please read L for more details. See also L, L." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2931 -msgid "guestfs_lvm_clear_filter" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2183 +msgid "inspect-get-roots" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2933 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2185 #, no-wrap msgid "" -" int guestfs_lvm_clear_filter (guestfs_h *g);\n" +" inspect-get-roots\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2935 +#. type: textblock +#: ../fish/guestfish-actions.pod:2187 msgid "" -"This undoes the effect of C. LVM will be able to " -"see every block device." +"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 -#: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2974 -#: ../fish/guestfish-actions.pod:2288 ../fish/guestfish-actions.pod:2319 +#. type: textblock +#: ../fish/guestfish-actions.pod:2191 msgid "" -"This command also clears the LVM cache and performs a volume group scan." +"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:2943 -msgid "guestfs_lvm_remove_all" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2196 +msgid "inspect-get-type" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2945 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2198 #, no-wrap msgid "" -" int guestfs_lvm_remove_all (guestfs_h *g);\n" +" inspect-get-type root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2947 ../fish/guestfish-actions.pod:2295 +#. type: textblock +#: ../fish/guestfish-actions.pod:2200 ../src/guestfs-actions.pod:3294 msgid "" -"This command removes all LVM logical volumes, volume groups and physical " -"volumes." +"This returns the type of the inspected operating system. Currently defined " +"types are:" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2955 -msgid "guestfs_lvm_set_filter" +#. type: =item +#: ../fish/guestfish-actions.pod:2205 ../src/guestfs-actions.pod:3299 +msgid "\"linux\"" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2957 -#, no-wrap -msgid "" -" int guestfs_lvm_set_filter (guestfs_h *g,\n" -"\t\tchar *const *devices);\n" -"\n" +#. type: textblock +#: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3301 +msgid "Any Linux-based operating system." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2960 ../fish/guestfish-actions.pod:2305 -msgid "" -"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." +#. type: textblock +#: ../fish/guestfish-actions.pod:2211 ../src/guestfs-actions.pod:3305 +msgid "Any Microsoft Windows operating system." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2964 ../fish/guestfish-actions.pod:2309 -msgid "" -"Where disk image(s) contain duplicate PVs or VGs, this command is useful to " -"get LVM to ignore the duplicates, otherwise LVM can get confused. Note also " -"there are two types of duplication possible: either cloned PVs/VGs which " -"have identical UUIDs; or VGs that are not cloned but just happen to have the " -"same name. In normal operation you cannot create this situation, but you " -"can do it outside LVM, eg. by cloning disk images or by bit twiddling " -"inside the LVM metadata." +#. type: =item +#: ../fish/guestfish-actions.pod:2213 ../src/guestfs-actions.pod:3307 +msgid "\"freebsd\"" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2322 -msgid "You can filter whole block devices or individual partitions." +#. type: textblock +#: ../fish/guestfish-actions.pod:2215 ../src/guestfs-actions.pod:3309 +msgid "FreeBSD." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2324 -msgid "" -"You cannot use this if any VG is currently in use (eg. contains a mounted " -"filesystem), even if you are not filtering out that VG." +#. type: textblock +#: ../fish/guestfish-actions.pod:2219 ../src/guestfs-actions.pod:3313 +msgid "The operating system type could not be determined." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:2985 -msgid "guestfs_lvremove" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2228 +msgid "inspect-get-windows-current-control-set" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:2987 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2230 #, no-wrap msgid "" -" int guestfs_lvremove (guestfs_h *g,\n" -"\t\tconst char *device);\n" +" inspect-get-windows-current-control-set root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2990 ../fish/guestfish-actions.pod:2332 +#. type: textblock +#: ../fish/guestfish-actions.pod:2232 ../src/guestfs-actions.pod:3333 msgid "" -"Remove an LVM logical volume C, where C is the path to the " -"LV, such as C." +"This returns the Windows CurrentControlSet of the inspected guest. The " +"CurrentControlSet is a registry key name such as C." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2335 +#. type: textblock +#: ../fish/guestfish-actions.pod:2235 ../src/guestfs-actions.pod:3336 msgid "" -"You can also remove all LVs in a volume group by specifying the VG name, C." +"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 -#: ../src/guestfs-actions.pod:2998 -msgid "guestfs_lvrename" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2241 +msgid "inspect-get-windows-systemroot" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3000 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2243 #, no-wrap msgid "" -" int guestfs_lvrename (guestfs_h *g,\n" -"\t\tconst char *logvol,\n" -"\t\tconst char *newlogvol);\n" +" inspect-get-windows-systemroot root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3004 ../fish/guestfish-actions.pod:2342 -msgid "Rename a logical volume C with the new name C." +#. type: textblock +#: ../fish/guestfish-actions.pod:2245 ../src/guestfs-actions.pod:3353 +msgid "" +"This returns the Windows systemroot of the inspected guest. The systemroot " +"is a directory path such as C." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:3008 -msgid "guestfs_lvresize" +#. type: textblock +#: ../fish/guestfish-actions.pod:2248 ../src/guestfs-actions.pod:3356 +msgid "" +"This call assumes that the guest is Windows and that the systemroot could be " +"determined by inspection. If this is not the case then an error is returned." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3010 +#. type: =head2 +#: ../fish/guestfish-actions.pod:2254 +msgid "inspect-is-live" +msgstr "" + +#. type: verbatim +#: ../fish/guestfish-actions.pod:2256 #, no-wrap msgid "" -" int guestfs_lvresize (guestfs_h *g,\n" -"\t\tconst char *device,\n" -"\t\tint mbytes);\n" +" inspect-is-live root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3014 ../fish/guestfish-actions.pod:2348 +#. type: textblock +#: ../fish/guestfish-actions.pod:2258 msgid "" -"This resizes (expands or shrinks) an existing LVM logical volume to " -"C. When reducing, data in the reduced part is lost." +"If L returns C (this is an install disk), " +"then this returns true if a live image was detected on the disk." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:3020 -msgid "guestfs_lvresize_free" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2264 +msgid "inspect-is-multipart" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3022 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2266 #, no-wrap msgid "" -" int guestfs_lvresize_free (guestfs_h *g,\n" -"\t\tconst char *lv,\n" -"\t\tint percent);\n" +" inspect-is-multipart root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3026 ../fish/guestfish-actions.pod:2356 +#. type: textblock +#: ../fish/guestfish-actions.pod:2268 msgid "" -"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." +"If L returns C (this is an install disk), " +"then this returns true if the disk is part of a set." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:3034 -msgid "guestfs_lvs" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2274 +msgid "inspect-is-netinst" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3036 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2276 #, no-wrap msgid "" -" char **guestfs_lvs (guestfs_h *g);\n" +" inspect-is-netinst root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3038 ../fish/guestfish-actions.pod:2366 -msgid "" -"List all the logical volumes detected. This is the equivalent of the L command." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:3041 ../fish/guestfish-actions.pod:2369 +#. type: textblock +#: ../fish/guestfish-actions.pod:2278 msgid "" -"This returns a list of the logical volume device names (eg. C)." -msgstr "" - -# type: textblock -#: ../src/guestfs-actions.pod:3044 -msgid "See also C, C." +"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 -#: ../src/guestfs-actions.pod:3050 -msgid "guestfs_lvs_full" +#. type: =head2 +#: ../fish/guestfish-actions.pod:2286 +msgid "inspect-list-applications" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3052 +#. type: verbatim +#: ../fish/guestfish-actions.pod:2288 #, no-wrap msgid "" -" struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *g);\n" +" inspect-list-applications root\n" "\n" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3054 ../fish/guestfish-actions.pod:2378 -msgid "" -"List all the logical volumes detected. This is the equivalent of the L command. The \"full\" version includes all fields." +#. type: textblock +#: ../fish/guestfish-actions.pod:2290 ../src/guestfs-actions.pod:3423 +msgid "Return the list of applications installed in the operating system." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3057 +#. type: textblock +#: ../fish/guestfish-actions.pod:2292 msgid "" -"This function returns a C (see Eguestfs-" -"structs.hE), or NULL if there was an error. I after use>." -msgstr "" - -# type: =head2 -#: ../src/guestfs-actions.pod:3062 -msgid "guestfs_lvuuid" +"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: verbatim -#: ../src/guestfs-actions.pod:3064 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2302 ../src/guestfs-actions.pod:3435 msgid "" -" char *guestfs_lvuuid (guestfs_h *g,\n" -"\t\tconst char *device);\n" -"\n" +"This returns an empty list if the inspection code was not able to determine " +"the list of applications." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3067 ../fish/guestfish-actions.pod:2385 -msgid "This command returns the UUID of the LVM LV C." +#. type: textblock +#: ../fish/guestfish-actions.pod:2305 ../src/guestfs-actions.pod:3438 +msgid "The application structure contains the following fields:" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:3072 -msgid "guestfs_lxattrlist" +#. type: =item +#: ../fish/guestfish-actions.pod:2309 ../src/guestfs-actions.pod:3442 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3074 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2311 ../src/guestfs-actions.pod:3444 msgid "" -" struct guestfs_xattr_list *guestfs_lxattrlist (guestfs_h *g,\n" -"\t\tconst char *path,\n" -"\t\tchar *const *names);\n" -"\n" +"The name of the application. For Red Hat-derived and Debian-derived Linux " +"guests, this is the package name." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:2391 -msgid "" -"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." +#. type: =item +#: ../fish/guestfish-actions.pod:2314 ../src/guestfs-actions.pod:3447 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3082 ../fish/guestfish-actions.pod:2395 +#. type: textblock +#: ../fish/guestfish-actions.pod:2316 ../src/guestfs-actions.pod:3449 msgid "" -"On return you get a flat list of xattr structs which must be interpreted " -"sequentially. The first xattr struct always has a zero-length C. " -"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." +"The display name of the application, sometimes localized to the install " +"language of the guest operating system." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3092 +#. type: textblock +#: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3452 msgid "" -"This call is intended for programs that want to efficiently list a directory " -"contents without making many round-trips. See also C 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." +"If unavailable this is returned as an empty string C<\"\">. Callers needing " +"to display something can use C instead." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:3105 -msgid "guestfs_mkdir" +#. type: =item +#: ../fish/guestfish-actions.pod:2322 ../src/guestfs-actions.pod:3455 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3107 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2324 ../src/guestfs-actions.pod:3457 msgid "" -" int guestfs_mkdir (guestfs_h *g,\n" -"\t\tconst char *path);\n" -"\n" +"For package managers which use epochs, this contains the epoch of the " +"package (an integer). If unavailable, this is returned as C<0>." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3110 ../fish/guestfish-actions.pod:2417 -msgid "Create a directory named C." +#. type: =item +#: ../fish/guestfish-actions.pod:2327 ../src/guestfs-actions.pod:3460 +msgid "C" msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:3114 -msgid "guestfs_mkdir_mode" +#. type: textblock +#: ../fish/guestfish-actions.pod:2329 ../src/guestfs-actions.pod:3462 +msgid "" +"The version string of the application or package. If unavailable this is " +"returned as an empty string C<\"\">." msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3116 -#, no-wrap -msgid "" -" int guestfs_mkdir_mode (guestfs_h *g,\n" -"\t\tconst char *path,\n" -"\t\tint mode);\n" -"\n" +#. type: =item +#: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3465 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3120 ../fish/guestfish-actions.pod:2423 +#. type: textblock +#: ../fish/guestfish-actions.pod:2334 ../src/guestfs-actions.pod:3467 msgid "" -"This command creates a directory, setting the initial permissions of the " -"directory to C." +"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: =item +#: ../fish/guestfish-actions.pod:2338 ../src/guestfs-actions.pod:3471 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3123 ../fish/guestfish-actions.pod:2426 +#. type: textblock +#: ../fish/guestfish-actions.pod:2340 ../src/guestfs-actions.pod:3473 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." +"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 -#: ../src/guestfs-actions.pod:3127 -msgid "See also C, C" +#. type: textblock +#: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3478 +msgid "If unavailable this is returned as an empty string C<\"\">." msgstr "" -# type: =head2 -#: ../src/guestfs-actions.pod:3131 -msgid "guestfs_mkdir_p" +#. type: =item +#: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3480 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3133 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3482 msgid "" -" int guestfs_mkdir_p (guestfs_h *g,\n" -"\t\tconst char *path);\n" -"\n" +"The install path translated into a libguestfs path. If unavailable this is " +"returned as an empty string C<\"\">." +msgstr "" + +#. type: =item +#: ../fish/guestfish-actions.pod:2352 ../src/guestfs-actions.pod:3485 +msgid "C" msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2436 +#. type: textblock +#: ../fish/guestfish-actions.pod:2354 ../src/guestfs-actions.pod:3487 msgid "" -"Create a directory named C, creating any parent directories as " -"necessary. This is like the C shell command." +"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 -#: ../src/guestfs-actions.pod:3141 -msgid "guestfs_mkdtemp" +#. type: =item +#: ../fish/guestfish-actions.pod:2358 ../src/guestfs-actions.pod:3491 +msgid "C" msgstr "" -# type: verbatim -#: ../src/guestfs-actions.pod:3143 -#, no-wrap +#. type: textblock +#: ../fish/guestfish-actions.pod:2360 ../src/guestfs-actions.pod:3493 msgid "" -" char *guestfs_mkdtemp (guestfs_h *g,\n" -"\t\tconst char *template);\n" -"\n" +"The URL (eg. upstream URL) of the application. If unavailable this is " +"returned as an empty string C<\"\">." msgstr "" -# type: textblock -#: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2443 -msgid "" -"This command creates a temporary directory. The C