1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: libguestfs 1.8.12\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-08-17 13:54+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
26 #: ../src/guestfs.pod:5
27 msgid "guestfs - Library for accessing and modifying virtual machine images"
31 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
36 #: ../src/guestfs.pod:9
39 " #include <guestfs.h>\n"
44 #: ../src/guestfs.pod:11
47 " guestfs_h *g = guestfs_create ();\n"
48 " guestfs_add_drive (g, \"guest.img\");\n"
49 " guestfs_launch (g);\n"
50 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
51 " guestfs_touch (g, \"/hello\");\n"
52 " guestfs_umount (g, \"/\");\n"
53 " guestfs_close (g);\n"
58 #: ../src/guestfs.pod:19
61 " cc prog.c -o prog -lguestfs\n"
63 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
68 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
73 #: ../src/guestfs.pod:25
75 "Libguestfs is a library for accessing and modifying guest disk images. "
76 "Amongst the things this is good for: making batch configuration changes to "
77 "guests, getting disk used/free statistics (see also: virt-df), migrating "
78 "between virtualization systems (see also: virt-p2v), performing partial "
79 "backups, performing partial guest clones, cloning guests and changing "
80 "registry/UUID/hostname info, and much else besides."
84 #: ../src/guestfs.pod:33
86 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
87 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
88 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
93 #: ../src/guestfs.pod:38
95 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
96 "what filesystem is in each LV, etc.). It can also run commands in the "
97 "context of the guest. Also you can access filesystems over FUSE."
101 #: ../src/guestfs.pod:43
103 "Libguestfs is a library that can be linked with C and C++ management "
104 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
105 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
110 #: ../src/guestfs.pod:48
112 "You don't need to be root to use libguestfs, although obviously you do need "
113 "enough permissions to access the disk images."
117 #: ../src/guestfs.pod:51
119 "Libguestfs is a large API because it can do many things. For a gentle "
120 "introduction, please read the L</API OVERVIEW> section next."
124 #: ../src/guestfs.pod:54
126 "There are also some example programs in the L<guestfs-examples(3)> manual "
131 #: ../src/guestfs.pod:57
136 #: ../src/guestfs.pod:59
138 "This section provides a gentler overview of the libguestfs API. We also try "
139 "to group API calls together, where that may not be obvious from reading "
140 "about the individual calls in the main section of this manual."
144 #: ../src/guestfs.pod:64
149 #: ../src/guestfs.pod:66
151 "Before you can use libguestfs calls, you have to create a handle. Then you "
152 "must add at least one disk image to the handle, followed by launching the "
153 "handle, then performing whatever operations you want, and finally closing "
154 "the handle. By convention we use the single letter C<g> for the name of the "
155 "handle variable, although of course you can use any name you want."
159 #: ../src/guestfs.pod:73
160 msgid "The general structure of all libguestfs-using programs looks like this:"
164 #: ../src/guestfs.pod:76
167 " guestfs_h *g = guestfs_create ();\n"
172 #: ../src/guestfs.pod:78
175 " /* Call guestfs_add_drive additional times if there are\n"
176 " * multiple disk images.\n"
178 " guestfs_add_drive (g, \"guest.img\");\n"
183 #: ../src/guestfs.pod:83
186 " /* Most manipulation calls won't work until you've launched\n"
187 " * the handle 'g'. You have to do this _after_ adding drives\n"
188 " * and _before_ other commands.\n"
190 " guestfs_launch (g);\n"
195 #: ../src/guestfs.pod:89
198 " /* Now you can examine what partitions, LVs etc are available.\n"
200 " char **partitions = guestfs_list_partitions (g);\n"
201 " char **logvols = guestfs_lvs (g);\n"
206 #: ../src/guestfs.pod:94
209 " /* To access a filesystem in the image, you must mount it.\n"
211 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
216 #: ../src/guestfs.pod:98
219 " /* Now you can perform filesystem actions on the guest\n"
222 " guestfs_touch (g, \"/hello\");\n"
227 #: ../src/guestfs.pod:103
230 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
231 " * it is done automatically when you close the handle. See\n"
232 " * discussion of autosync in this page.\n"
234 " guestfs_sync (g);\n"
239 #: ../src/guestfs.pod:109
242 " /* Close the handle 'g'. */\n"
243 " guestfs_close (g);\n"
248 #: ../src/guestfs.pod:112
250 "The code above doesn't include any error checking. In real code you should "
251 "check return values carefully for errors. In general all functions that "
252 "return integers return C<-1> on error, and all functions that return "
253 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
254 "how to handle errors, and consult the documentation for each function call "
255 "below to see precisely how they return error indications. See "
256 "L<guestfs-examples(3)> for fully worked examples."
260 #: ../src/guestfs.pod:121
265 #: ../src/guestfs.pod:123
267 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
268 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
269 "actual block device, or simply an empty file of zeroes that you have created "
270 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
275 #: ../src/guestfs.pod:129
277 "The call you should use in modern code for adding drives is "
278 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
279 "specifying that the format is raw, do:"
283 #: ../src/guestfs.pod:133
286 " guestfs_add_drive_opts (g, filename,\n"
287 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
293 #: ../src/guestfs.pod:137
294 msgid "You can add a disk read-only using:"
298 #: ../src/guestfs.pod:139
301 " guestfs_add_drive_opts (g, filename,\n"
302 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
303 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
309 #: ../src/guestfs.pod:144
311 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
312 "libguestfs won't modify the file."
316 #: ../src/guestfs.pod:147
318 "Be extremely cautious if the disk image is in use, eg. if it is being used "
319 "by a virtual machine. Adding it read-write will almost certainly cause disk "
320 "corruption, but adding it read-only is safe."
324 #: ../src/guestfs.pod:151
326 "You must add at least one disk image, and you may add multiple disk images. "
327 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
328 "first one you added), C</dev/sdb> (for the second one you added), etc."
332 #: ../src/guestfs.pod:156
334 "Once L</guestfs_launch> has been called you cannot add any more images. You "
335 "can call L</guestfs_list_devices> to get a list of the device names, in the "
336 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
340 #: ../src/guestfs.pod:161
345 #: ../src/guestfs.pod:163
347 "Before you can read or write files, create directories and so on in a disk "
348 "image that contains filesystems, you have to mount those filesystems using "
349 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
350 "a disk image contains (for example) one partition with a filesystem on that "
351 "partition, then you can mount it directly:"
355 #: ../src/guestfs.pod:170
358 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
363 #: ../src/guestfs.pod:172
365 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
366 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
367 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
368 "that these are libguestfs virtual devices, and are nothing to do with host "
373 #: ../src/guestfs.pod:178
375 "If you are given a disk image and you don't know what it contains then you "
376 "have to find out. Libguestfs can do that too: use "
377 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
378 "and LVs, and either try mounting each to see what is mountable, or else "
379 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
380 "filesystems, use L</guestfs_list_filesystems>."
384 #: ../src/guestfs.pod:186
386 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
387 "L</INSPECTION> below). But you might find it easier to look at higher level "
388 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
392 #: ../src/guestfs.pod:191
394 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
395 "several other variations of the C<guestfs_mount_*> call."
399 #: ../src/guestfs.pod:194
400 msgid "FILESYSTEM ACCESS AND MODIFICATION"
404 #: ../src/guestfs.pod:196
406 "The majority of the libguestfs API consists of fairly low-level calls for "
407 "accessing and modifying the files, directories, symlinks etc on mounted "
408 "filesystems. There are over a hundred such calls which you can find listed "
409 "in detail below in this man page, and we don't even pretend to cover them "
410 "all in this overview."
414 #: ../src/guestfs.pod:202
416 "Specify filenames as full paths, starting with C<\"/\"> and including the "
421 #: ../src/guestfs.pod:205
423 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
424 "the file called C<\"etc/passwd\"> then you could do:"
428 #: ../src/guestfs.pod:208
431 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
436 #: ../src/guestfs.pod:210
438 "This would return C<data> as a newly allocated buffer containing the full "
439 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
440 "or C<NULL> if there was an error."
444 #: ../src/guestfs.pod:214
446 "As another example, to create a top-level directory on that filesystem "
447 "called C<\"var\"> you would do:"
451 #: ../src/guestfs.pod:217
454 " guestfs_mkdir (g, \"/var\");\n"
459 #: ../src/guestfs.pod:219
460 msgid "To create a symlink you could do:"
464 #: ../src/guestfs.pod:221
467 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
468 " \"/etc/rc3.d/S30portmap\");\n"
473 #: ../src/guestfs.pod:224
475 "Libguestfs will reject attempts to use relative paths and there is no "
476 "concept of a current working directory."
480 #: ../src/guestfs.pod:227
482 "Libguestfs can return errors in many situations: for example if the "
483 "filesystem isn't writable, or if a file or directory that you requested "
484 "doesn't exist. If you are using the C API (documented here) you have to "
485 "check for those error conditions after each call. (Other language bindings "
486 "turn these errors into exceptions)."
490 #: ../src/guestfs.pod:233
492 "File writes are affected by the per-handle umask, set by calling "
493 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
497 #: ../src/guestfs.pod:236
502 #: ../src/guestfs.pod:238
504 "Libguestfs contains API calls to read, create and modify partition tables on "
509 #: ../src/guestfs.pod:241
511 "In the common case where you want to create a single partition covering the "
512 "whole disk, you should use the L</guestfs_part_disk> call:"
516 #: ../src/guestfs.pod:245
519 " const char *parttype = \"mbr\";\n"
520 " if (disk_is_larger_than_2TB)\n"
521 " parttype = \"gpt\";\n"
522 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
527 #: ../src/guestfs.pod:250
529 "Obviously this effectively wipes anything that was on that disk image "
534 #: ../src/guestfs.pod:253
539 #: ../src/guestfs.pod:255
541 "Libguestfs provides access to a large part of the LVM2 API, such as "
542 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
543 "unless you familiarize yourself with the concepts of physical volumes, "
544 "volume groups and logical volumes."
548 #: ../src/guestfs.pod:260
550 "This author strongly recommends reading the LVM HOWTO, online at "
551 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
555 #: ../src/guestfs.pod:263
560 #: ../src/guestfs.pod:265
562 "Use L</guestfs_cat> to download small, text only files. This call is "
563 "limited to files which are less than 2 MB and which cannot contain any ASCII "
564 "NUL (C<\\0>) characters. However the API is very simple to use."
568 #: ../src/guestfs.pod:269
570 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
571 "bit data, since it returns a (pointer, size) pair. However it is still "
572 "limited to \"small\" files, less than 2 MB."
576 #: ../src/guestfs.pod:273
578 "L</guestfs_download> can be used to download any file, with no limits on "
579 "content or size (even files larger than 4 GB)."
583 #: ../src/guestfs.pod:276
584 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
588 #: ../src/guestfs.pod:279
593 #: ../src/guestfs.pod:281
595 "It's often the case that you want to write a file or files to the disk "
600 #: ../src/guestfs.pod:284
602 "To write a small file with fixed content, use L</guestfs_write>. To create "
603 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
604 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
605 "variety of other functions for creating test files, for example "
606 "L</guestfs_fill> and L</guestfs_fill_pattern>."
610 #: ../src/guestfs.pod:290
612 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
613 "file content or size (even files larger than 4 GB)."
617 #: ../src/guestfs.pod:293
618 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
622 #: ../src/guestfs.pod:295
624 "However the fastest way to upload I<large numbers of arbitrary files> is to "
625 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
626 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
627 "the drive in a predictable way (eg. adding it last after all other drives) "
628 "then you can get the device name from L</guestfs_list_devices> and mount it "
629 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
630 "sometimes non-portable between kernel versions, and they don't support "
631 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
632 "using a label or UUID, use an ISO image instead."
636 #: ../src/guestfs.pod:306
641 #: ../src/guestfs.pod:308
643 "There are various different commands for copying between files and devices "
644 "and in and out of the guest filesystem. These are summarised in the table "
649 #: ../src/guestfs.pod:314
650 msgid "B<file> to B<file>"
654 #: ../src/guestfs.pod:316
656 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
657 "directories recursively."
661 #: ../src/guestfs.pod:319
662 msgid "B<file or device> to B<file or device>"
666 #: ../src/guestfs.pod:321
668 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
669 "devices in the guest."
673 #: ../src/guestfs.pod:324
674 msgid "Example: duplicate the contents of an LV:"
678 #: ../src/guestfs.pod:326
681 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
686 #: ../src/guestfs.pod:328
688 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
689 "(C</dev/VG/Original>). To copy less than the whole source device, use "
690 "L</guestfs_copy_size>."
694 #: ../src/guestfs.pod:332
695 msgid "B<file on the host> to B<file or device>"
699 #: ../src/guestfs.pod:334
700 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
704 #: ../src/guestfs.pod:336
705 msgid "B<file or device> to B<file on the host>"
709 #: ../src/guestfs.pod:338
710 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
714 #: ../src/guestfs.pod:342
715 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
719 #: ../src/guestfs.pod:344
721 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
722 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
723 "appears you can only upload and download to files. However many Un*x-like "
724 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
725 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
726 "stderr, and arbitrary file descriptor N."
730 #: ../src/guestfs.pod:352
731 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
735 #: ../src/guestfs.pod:355
738 " guestfs_download (g, filename, \"/dev/stdout\");\n"
743 #: ../src/guestfs.pod:357
744 msgid "and you can write tar output to a pipe C<fd> by doing:"
748 #: ../src/guestfs.pod:359
752 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
753 " guestfs_tar_out (g, \"/\", devfd);\n"
758 #: ../src/guestfs.pod:363
759 msgid "LISTING FILES"
763 #: ../src/guestfs.pod:365
765 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
766 "L<guestfish(1)>-equivalent command C<ll>)."
770 #: ../src/guestfs.pod:368
772 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
773 "programs, as a flat list of strings."
777 #: ../src/guestfs.pod:371
779 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
780 "directory, plus additional information about each one. It is more "
781 "equivalent to using the L<readdir(3)> call on a local filesystem."
785 #: ../src/guestfs.pod:375
787 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
792 #: ../src/guestfs.pod:378
793 msgid "RUNNING COMMANDS"
797 #: ../src/guestfs.pod:380
799 "Although libguestfs is primarily an API for manipulating files inside guest "
800 "images, we also provide some limited facilities for running commands inside "
805 #: ../src/guestfs.pod:384
806 msgid "There are many limitations to this:"
810 #: ../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:1011 ../src/guestfs.pod:1015 ../src/guestfs.pod:1019 ../src/guestfs.pod:1024 ../src/guestfs.pod:1032 ../src/guestfs.pod:1051 ../src/guestfs.pod:1059 ../src/guestfs.pod:1081 ../src/guestfs.pod:1085 ../src/guestfs.pod:1089 ../src/guestfs.pod:1093 ../src/guestfs.pod:1097 ../src/guestfs.pod:1101 ../src/guestfs.pod:1583 ../src/guestfs.pod:1588 ../src/guestfs.pod:1592 ../src/guestfs.pod:1702 ../src/guestfs.pod:1707 ../src/guestfs.pod:1711 ../src/guestfs.pod:2064 ../src/guestfs.pod:2070 ../src/guestfs.pod:2075 ../src/guestfs.pod:2081 ../src/guestfs.pod:2540 ../src/guestfs.pod:2544 ../src/guestfs.pod:2548 ../src/guestfs.pod:2552 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:574 ../src/guestfs-actions.pod:582 ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:378 ../fish/guestfish-actions.pod:386 ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 ../tools/virt-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
815 #: ../src/guestfs.pod:390
817 "The kernel version that the command runs under will be different from what "
822 #: ../src/guestfs.pod:395
824 "If the command needs to communicate with daemons, then most likely they "
829 #: ../src/guestfs.pod:400
830 msgid "The command will be running in limited memory."
834 #: ../src/guestfs.pod:404
836 "The network may not be available unless you enable it (see "
837 "L</guestfs_set_network>)."
841 #: ../src/guestfs.pod:409
842 msgid "Only supports Linux guests (not Windows, BSD, etc)."
846 #: ../src/guestfs.pod:413
847 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
851 #: ../src/guestfs.pod:418
853 "For SELinux guests, you may need to enable SELinux and load policy first. "
854 "See L</SELINUX> in this manpage."
858 #: ../src/guestfs.pod:423
860 "I<Security:> It is not safe to run commands from untrusted, possibly "
861 "malicious guests. These commands may attempt to exploit your program by "
862 "sending unexpected output. They could also try to exploit the Linux kernel "
863 "or qemu provided by the libguestfs appliance. They could use the network "
864 "provided by the libguestfs appliance to bypass ordinary network partitions "
865 "and firewalls. They could use the elevated privileges or different SELinux "
866 "context of your program to their advantage."
870 #: ../src/guestfs.pod:432
872 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
873 "(a script which runs when the guest next boots normally), and to have this "
874 "script run the commands you want in the normal context of the running guest, "
875 "network security and so on. For information about other security issues, "
880 #: ../src/guestfs.pod:440
882 "The two main API calls to run commands are L</guestfs_command> and "
883 "L</guestfs_sh> (there are also variations)."
887 #: ../src/guestfs.pod:443
889 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
890 "shell globs, redirections, etc will work."
894 #: ../src/guestfs.pod:446
895 msgid "CONFIGURATION FILES"
899 #: ../src/guestfs.pod:448
901 "To read and write configuration files in Linux guest filesystems, we "
902 "strongly recommend using Augeas. For example, Augeas understands how to "
903 "read and write, say, a Linux shadow password file or X.org configuration "
904 "file, and so avoids you having to write that code."
908 #: ../src/guestfs.pod:453
910 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
911 "document Augeas itself here because there is excellent documentation on the "
912 "L<http://augeas.net/> website."
916 #: ../src/guestfs.pod:457
918 "If you don't want to use Augeas (you fool!) then try calling "
919 "L</guestfs_read_lines> to get the file as a list of lines which you can "
924 #: ../src/guestfs.pod:461
929 #: ../src/guestfs.pod:463
931 "We support SELinux guests. To ensure that labeling happens correctly in "
932 "SELinux guests, you need to enable SELinux and load the guest's policy:"
936 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1204 ../src/guestfs.pod:1335 ../src/guestfs.pod:2109
941 #: ../src/guestfs.pod:471
942 msgid "Before launching, do:"
946 #: ../src/guestfs.pod:473
949 " guestfs_set_selinux (g, 1);\n"
954 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1208 ../src/guestfs.pod:1339 ../src/guestfs.pod:2134
959 #: ../src/guestfs.pod:477
961 "After mounting the guest's filesystem(s), load the policy. This is best "
962 "done by running the L<load_policy(8)> command in the guest itself:"
966 #: ../src/guestfs.pod:481
969 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
974 #: ../src/guestfs.pod:483
976 "(Older versions of C<load_policy> require you to specify the name of the "
981 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1345
986 #: ../src/guestfs.pod:488
988 "Optionally, set the security context for the API. The correct security "
989 "context to use can only be known by inspecting the guest. As an example:"
993 #: ../src/guestfs.pod:492
996 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1001 #: ../src/guestfs.pod:496
1002 msgid "This will work for running commands and editing existing files."
1006 #: ../src/guestfs.pod:498
1008 "When new files are created, you may need to label them explicitly, for "
1009 "example by running the external command C<restorecon pathname>."
1013 #: ../src/guestfs.pod:502
1018 #: ../src/guestfs.pod:504
1020 "Certain calls are affected by the current file mode creation mask (the "
1021 "\"umask\"). In particular ones which create files or directories, such as "
1022 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1023 "either the default mode that the file is created with or modifies the mode "
1028 #: ../src/guestfs.pod:510
1030 "The default umask is C<022>, so files are created with modes such as C<0644> "
1031 "and directories with C<0755>."
1035 #: ../src/guestfs.pod:513
1037 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1038 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
1039 "L</guestfs_chmod> after creating each file or directory."
1043 #: ../src/guestfs.pod:517
1044 msgid "For more information about umask, see L<umask(2)>."
1048 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:720
1049 msgid "ENCRYPTED DISKS"
1053 #: ../src/guestfs.pod:521
1055 "Libguestfs allows you to access Linux guests which have been encrypted using "
1056 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1057 "standard. This includes nearly all whole disk encryption systems used by "
1058 "modern Linux guests."
1062 #: ../src/guestfs.pod:527
1064 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1065 "returns the string C<crypto_LUKS>)."
1069 #: ../src/guestfs.pod:530
1071 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1072 "will require the passphrase!"
1076 #: ../src/guestfs.pod:533
1078 "Opening a LUKS device creates a new device mapper device called "
1079 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1080 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1081 "decrypted from and encrypted to the underlying block device respectively."
1085 #: ../src/guestfs.pod:539
1087 "LVM volume groups on the device can be made visible by calling "
1088 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1089 "volume(s) can now be mounted in the usual way."
1093 #: ../src/guestfs.pod:543
1095 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1096 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1097 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1098 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1099 "underlying encrypted block device)."
1103 #: ../src/guestfs.pod:550
1108 #: ../src/guestfs.pod:552
1110 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1111 "contains operating systems. (These APIs used to be in a separate Perl-only "
1112 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1113 "frequently used part of this library has been rewritten in C and moved into "
1118 #: ../src/guestfs.pod:558
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:561
1127 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1128 "and certain heuristics, and returns a list of operating systems that were "
1129 "found. An empty list means none were found. A single element is the root "
1130 "filesystem of the operating system. For dual- or multi-boot guests, "
1131 "multiple roots can be returned, each one corresponding to a separate "
1132 "operating system. (Multi-boot virtual machines are extremely rare in the "
1133 "world of virtualization, but since this scenario can happen, we have built "
1134 "libguestfs to deal with it.)"
1138 #: ../src/guestfs.pod:570
1140 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1141 "to get additional details about that operating system. For example, call "
1142 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1143 "Windows and Linux-based operating systems respectively."
1147 #: ../src/guestfs.pod:576
1149 "Un*x-like and Linux-based operating systems usually consist of several "
1150 "filesystems which are mounted at boot time (for example, a separate boot "
1151 "partition mounted on C</boot>). The inspection rules are able to detect how "
1152 "filesystems correspond to mount points. Call "
1153 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1154 "hash table like this example:"
1158 #: ../src/guestfs.pod:583
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:587
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:590
1177 "Be careful to mount filesystems in the right order (eg. C</> before "
1178 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1183 #: ../src/guestfs.pod:594
1185 "Inspection currently only works for some common operating systems. "
1186 "Contributors are welcome to send patches for other operating systems that we "
1187 "currently cannot detect."
1191 #: ../src/guestfs.pod:598
1193 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1194 "for more details. The L</guestfs_inspect_os> function just ignores any "
1195 "encrypted devices."
1199 #: ../src/guestfs.pod:602
1201 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1202 "inspection and caches the results in the guest handle. Subsequent calls to "
1203 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1204 "re-read the disks. If you change the content of the guest disks, you can "
1205 "redo inspection by calling L</guestfs_inspect_os> again. "
1206 "(L</guestfs_inspect_list_applications> works a little differently from the "
1207 "other calls and does read the disks. See documentation for that function "
1212 #: ../src/guestfs.pod:611
1213 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1217 #: ../src/guestfs.pod:613
1219 "Libguestfs can mount NTFS partitions. It does this using the "
1220 "L<http://www.ntfs-3g.org/> driver."
1224 #: ../src/guestfs.pod:616
1225 msgid "DRIVE LETTERS AND PATHS"
1229 #: ../src/guestfs.pod:618
1231 "DOS and Windows still use drive letters, and the filesystems are always "
1232 "treated as case insensitive by Windows itself, and therefore you might find "
1233 "a Windows configuration file referring to a path like "
1234 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1235 "that directory might be referred to as C</WINDOWS/System32>."
1239 #: ../src/guestfs.pod:624
1241 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1242 "libguestfs to read the appropriate Windows Registry and configuration files, "
1243 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1244 "L<virt-inspector(1)>)."
1248 #: ../src/guestfs.pod:629
1250 "Replacing backslash characters with forward slash characters is also outside "
1251 "the scope of libguestfs, but something that you can easily do."
1255 #: ../src/guestfs.pod:632
1257 "Where we can help is in resolving the case insensitivity of paths. For "
1258 "this, call L</guestfs_case_sensitive_path>."
1262 #: ../src/guestfs.pod:635
1263 msgid "ACCESSING THE WINDOWS REGISTRY"
1267 #: ../src/guestfs.pod:637
1269 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1270 "files, through the library C<hivex> which is part of the libguestfs project "
1271 "although ships as a separate tarball. You have to locate and download the "
1272 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1273 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1274 "L<virt-win-reg(1)> for more help on this issue."
1278 #: ../src/guestfs.pod:645
1279 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1283 #: ../src/guestfs.pod:647
1285 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1286 "provide something which looks like a Linux symlink. The way it tries to do "
1287 "the rewriting is described here:"
1291 #: ../src/guestfs.pod:651
1292 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1296 #: ../src/guestfs.pod:653
1298 "The essential problem is that ntfs-3g simply does not have enough "
1299 "information to do a correct job. NTFS links can contain drive letters and "
1300 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1301 "It is almost certainly the case that libguestfs callers should ignore what "
1302 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1306 #: ../src/guestfs.pod:660
1308 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1309 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1310 "attribute, and read the raw reparse data from that (you can find the format "
1311 "documented in various places around the web)."
1315 #: ../src/guestfs.pod:665
1316 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1320 #: ../src/guestfs.pod:667
1322 "There are other useful extended attributes that can be read from ntfs-3g "
1323 "filesystems (using L</guestfs_getxattr>). See:"
1327 #: ../src/guestfs.pod:670
1328 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1332 #: ../src/guestfs.pod:672
1333 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1337 #: ../src/guestfs.pod:674
1339 "Although we don't want to discourage you from using the C API, we will "
1340 "mention here that the same API is also available in other languages."
1344 #: ../src/guestfs.pod:677
1346 "The API is broadly identical in all supported languages. This means that "
1347 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1348 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1349 "OCaml. In other words, a straightforward, predictable isomorphism between "
1354 #: ../src/guestfs.pod:683
1356 "Error messages are automatically transformed into exceptions if the language "
1361 #: ../src/guestfs.pod:686
1363 "We don't try to \"object orientify\" parts of the API in OO languages, "
1364 "although contributors are welcome to write higher level APIs above what we "
1365 "provide in their favourite languages if they wish."
1369 #: ../src/guestfs.pod:692
1374 #: ../src/guestfs.pod:694
1376 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1377 "identical to the C API. C++ classes and exceptions are not used."
1381 #: ../src/guestfs.pod:698
1386 #: ../src/guestfs.pod:700
1388 "The C# bindings are highly experimental. Please read the warnings at the "
1389 "top of C<csharp/Libguestfs.cs>."
1393 #: ../src/guestfs.pod:703
1398 #: ../src/guestfs.pod:705
1400 "This is the only language binding that is working but incomplete. Only "
1401 "calls which return simple integers have been bound in Haskell, and we are "
1402 "looking for help to complete this binding."
1406 #: ../src/guestfs.pod:709
1411 #: ../src/guestfs.pod:711
1413 "Full documentation is contained in the Javadoc which is distributed with "
1418 #: ../src/guestfs.pod:714
1423 #: ../src/guestfs.pod:716
1424 msgid "See L<guestfs-ocaml(3)>."
1428 #: ../src/guestfs.pod:718
1433 #: ../src/guestfs.pod:720
1434 msgid "See L<Sys::Guestfs(3)>."
1438 #: ../src/guestfs.pod:722
1443 #: ../src/guestfs.pod:724
1445 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1446 "the php-libguestfs package for your distribution."
1450 #: ../src/guestfs.pod:727
1451 msgid "The PHP binding only works correctly on 64 bit machines."
1455 #: ../src/guestfs.pod:729
1460 #: ../src/guestfs.pod:731
1461 msgid "See L<guestfs-python(3)>."
1465 #: ../src/guestfs.pod:733
1470 #: ../src/guestfs.pod:735
1471 msgid "See L<guestfs-ruby(3)>."
1475 #: ../src/guestfs.pod:737
1476 msgid "B<shell scripts>"
1480 #: ../src/guestfs.pod:739
1481 msgid "See L<guestfish(1)>."
1485 #: ../src/guestfs.pod:743
1486 msgid "LIBGUESTFS GOTCHAS"
1490 #: ../src/guestfs.pod:745
1492 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1493 "system [...] that works in the way it is documented but is counterintuitive "
1494 "and almost invites mistakes.\""
1498 #: ../src/guestfs.pod:749
1500 "Since we developed libguestfs and the associated tools, there are several "
1501 "things we would have designed differently, but are now stuck with for "
1502 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1503 "release, you can expect these to change. Beware of them."
1507 #: ../src/guestfs.pod:757
1508 msgid "Autosync / forgetting to sync."
1512 #: ../src/guestfs.pod:759
1514 "When modifying a filesystem from C or another language, you B<must> unmount "
1515 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1516 "libguestfs handle. You can also call:"
1520 #: ../src/guestfs.pod:763
1523 " guestfs_set_autosync (g, 1);\n"
1528 #: ../src/guestfs.pod:765
1530 "to have the unmount/sync done automatically for you when the handle 'g' is "
1531 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1536 #: ../src/guestfs.pod:769
1538 "If you forget to do this, then it is entirely possible that your changes "
1539 "won't be written out, or will be partially written, or (very rarely) that "
1540 "you'll get disk corruption."
1544 #: ../src/guestfs.pod:773
1546 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1547 "guestfish scripts that forget to sync will work just fine, which can make "
1548 "this very puzzling if you are trying to debug a problem."
1552 #: ../src/guestfs.pod:777
1554 "Update: Autosync is enabled by default for all API users starting from "
1555 "libguestfs 1.5.24."
1559 #: ../src/guestfs.pod:780
1560 msgid "Mount option C<-o sync> should not be the default."
1564 #: ../src/guestfs.pod:782
1566 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1567 "However C<-o sync> does not add any reliability benefit, but does have a "
1568 "very large performance impact."
1572 #: ../src/guestfs.pod:786
1574 "The work around is to use L</guestfs_mount_options> and set the mount "
1575 "options that you actually want to use."
1579 #: ../src/guestfs.pod:789
1580 msgid "Read-only should be the default."
1584 #: ../src/guestfs.pod:791
1586 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1587 "specify I<--rw> if you want to make changes to the image."
1591 #: ../src/guestfs.pod:794
1592 msgid "This would reduce the potential to corrupt live VM images."
1596 #: ../src/guestfs.pod:796
1598 "Note that many filesystems change the disk when you just mount and unmount, "
1599 "even if you didn't perform any writes. You need to use "
1600 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1604 #: ../src/guestfs.pod:800
1605 msgid "guestfish command line is hard to use."
1609 #: ../src/guestfs.pod:802
1611 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1612 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1613 "exist, so it fails. In earlier versions of guestfish the error message was "
1614 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1615 "we should have used C<guestfish -c command> to run commands."
1619 #: ../src/guestfs.pod:809
1620 msgid "guestfish megabyte modifiers don't work right on all commands"
1624 #: ../src/guestfs.pod:811
1626 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1627 "other modifiers). What guestfish actually does is to multiply the number "
1628 "part by the modifier part and pass the result to the C API. However this "
1629 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1630 "expecting some other unit (eg. megabytes)."
1634 #: ../src/guestfs.pod:818
1635 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1639 #: ../src/guestfs.pod:820
1642 " lvcreate LV VG 100M\n"
1647 #: ../src/guestfs.pod:822
1649 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1650 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1651 "megabytes * megabytes) logical volume. The error message you get from this "
1652 "is also a little obscure."
1656 #: ../src/guestfs.pod:827
1658 "This could be fixed in the generator by specially marking parameters and "
1659 "return values which take bytes or other units."
1663 #: ../src/guestfs.pod:830
1664 msgid "Ambiguity between devices and paths"
1668 #: ../src/guestfs.pod:832
1670 "There is a subtle ambiguity in the API between a device name "
1671 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1672 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1676 #: ../src/guestfs.pod:837
1678 "In the current API we usually resolve this ambiguity by having two separate "
1679 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1680 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1681 "detecting if the path supplied begins with C</dev/>."
1685 #: ../src/guestfs.pod:843
1687 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1688 "make paths/devices into structured names. One way to do this would be to "
1689 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1690 "aspect of grub. Another way would be to use a structured type, equivalent "
1691 "to this OCaml type:"
1695 #: ../src/guestfs.pod:849
1698 " type path = Path of string | Device of int | Partition of int * int\n"
1703 #: ../src/guestfs.pod:851
1704 msgid "which would allow you to pass arguments like:"
1708 #: ../src/guestfs.pod:853
1711 " Path \"/foo/bar\"\n"
1712 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1713 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1714 " Path \"/dev/sdb2\" (* not a device *)\n"
1719 #: ../src/guestfs.pod:858
1721 "As you can see there are still problems to resolve even with this "
1722 "representation. Also consider how it might work in guestfish."
1726 #: ../src/guestfs.pod:863
1727 msgid "PROTOCOL LIMITS"
1731 #: ../src/guestfs.pod:865
1733 "Internally libguestfs uses a message-based protocol to pass API calls and "
1734 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1735 "plenty more detail about this). The maximum message size used by the "
1736 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1737 "aware of this limit. The API calls which may be affected are individually "
1738 "documented, with a link back to this section of the documentation."
1742 #: ../src/guestfs.pod:873
1744 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1745 "a simple string. Because this string is at some point internally encoded as "
1746 "a message, the maximum size that it can return is slightly under 4 MB. If "
1747 "the requested file is larger than this then you will get an error."
1751 #: ../src/guestfs.pod:879
1753 "In order to transfer large files into and out of the guest filesystem, you "
1754 "need to use particular calls that support this. The sections L</UPLOADING> "
1755 "and L</DOWNLOADING> document how to do this."
1759 #: ../src/guestfs.pod:883
1761 "You might also consider mounting the disk image using our FUSE filesystem "
1762 "support (L<guestmount(1)>)."
1766 #: ../src/guestfs.pod:886
1767 msgid "KEYS AND PASSPHRASES"
1771 #: ../src/guestfs.pod:888
1773 "Certain libguestfs calls take a parameter that contains sensitive key "
1774 "material, passed in as a C string."
1778 #: ../src/guestfs.pod:891
1780 "In the future we would hope to change the libguestfs implementation so that "
1781 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1782 "swap. However this is I<not> done at the moment, because of the complexity "
1783 "of such an implementation."
1787 #: ../src/guestfs.pod:896
1789 "Therefore you should be aware that any key parameter you pass to libguestfs "
1790 "might end up being written out to the swap partition. If this is a concern, "
1791 "scrub the swap partition or don't use libguestfs on encrypted devices."
1795 #: ../src/guestfs.pod:901
1796 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1800 #: ../src/guestfs.pod:903
1802 "All high-level libguestfs actions are synchronous. If you want to use "
1803 "libguestfs asynchronously then you must create a thread."
1807 #: ../src/guestfs.pod:906
1809 "Only use the handle from a single thread. Either use the handle exclusively "
1810 "from one thread, or provide your own mutex so that two threads cannot issue "
1811 "calls on the same handle at the same time."
1815 #: ../src/guestfs.pod:910
1817 "See the graphical program guestfs-browser for one possible architecture for "
1818 "multithreaded programs using libvirt and libguestfs."
1822 #: ../src/guestfs.pod:913
1827 #: ../src/guestfs.pod:915
1829 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1834 #: ../src/guestfs.pod:918
1836 "By default it looks for these in the directory C<$libdir/guestfs> "
1837 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1841 #: ../src/guestfs.pod:921
1843 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1844 "to change the directories that libguestfs will search in. The value is a "
1845 "colon-separated list of paths. The current directory is I<not> searched "
1846 "unless the path contains an empty element or C<.>. For example "
1847 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1848 "then C</usr/lib/guestfs>."
1852 #: ../src/guestfs.pod:928
1853 msgid "QEMU WRAPPERS"
1857 #: ../src/guestfs.pod:930
1859 "If you want to compile your own qemu, run qemu from a non-standard location, "
1860 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1865 #: ../src/guestfs.pod:934
1867 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1868 "last command in the shell script (so that qemu replaces the shell and "
1869 "becomes the direct child of the libguestfs-using program). If you don't do "
1870 "this, then the qemu process won't be cleaned up correctly."
1874 #: ../src/guestfs.pod:939
1876 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1881 #: ../src/guestfs.pod:942
1885 " qemudir=/home/rjones/d/qemu\n"
1886 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1892 #: ../src/guestfs.pod:946
1894 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1895 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1900 #: ../src/guestfs.pod:950
1903 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1908 #: ../src/guestfs.pod:952
1910 "Note that libguestfs also calls qemu with the -help and -version options in "
1911 "order to determine features."
1915 #: ../src/guestfs.pod:955
1916 msgid "ABI GUARANTEE"
1920 #: ../src/guestfs.pod:957
1922 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1923 "actions as outlined in this section. Although we will deprecate some "
1924 "actions, for example if they get replaced by newer calls, we will keep the "
1925 "old actions forever. This allows you the developer to program in confidence "
1926 "against the libguestfs API."
1930 #: ../src/guestfs.pod:963
1931 msgid "BLOCK DEVICE NAMING"
1935 #: ../src/guestfs.pod:965
1937 "In the kernel there is now quite a profusion of schemata for naming block "
1938 "devices (in this context, by I<block device> I mean a physical or virtual "
1939 "hard drive). The original Linux IDE driver used names starting with "
1940 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1941 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1942 "replacement for the old IDE driver (particularly for SATA devices) those "
1943 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1944 "machines with paravirtualized drivers. This has created several different "
1945 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1950 #: ../src/guestfs.pod:977
1952 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1953 "Linux kernel to access block devices. We can run a variety of appliances "
1954 "based on a variety of Linux kernels."
1958 #: ../src/guestfs.pod:981
1960 "This causes a problem for libguestfs because many API calls use device or "
1961 "partition names. Working scripts and the recipe (example) scripts that we "
1962 "make available over the internet could fail if the naming scheme changes."
1966 #: ../src/guestfs.pod:986
1968 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1969 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1970 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1971 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1975 #: ../src/guestfs.pod:992
1977 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1978 "L</guestfs_list_partitions> and similar calls return the true names of the "
1979 "devices and partitions as known to the appliance."
1983 #: ../src/guestfs.pod:997
1984 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1988 #: ../src/guestfs.pod:999
1990 "Usually this translation is transparent. However in some (very rare) cases "
1991 "you may need to know the exact algorithm. Such cases include where you use "
1992 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
1993 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
1998 #: ../src/guestfs.pod:1005
2000 "The algorithm is applied only to I<parameters> which are known to be either "
2001 "device or partition names. Return values from functions such as "
2002 "L</guestfs_list_devices> are never changed."
2006 #: ../src/guestfs.pod:1013
2007 msgid "Is the string a parameter which is a device or partition name?"
2011 #: ../src/guestfs.pod:1017
2012 msgid "Does the string begin with C</dev/sd>?"
2016 #: ../src/guestfs.pod:1021
2018 "Does the named device exist? If so, we use that device. However if I<not> "
2019 "then we continue with this algorithm."
2023 #: ../src/guestfs.pod:1026
2024 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2028 #: ../src/guestfs.pod:1028
2029 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2033 #: ../src/guestfs.pod:1030
2034 msgid "If that named device exists, use it. If not, continue."
2038 #: ../src/guestfs.pod:1034
2039 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2043 #: ../src/guestfs.pod:1036
2044 msgid "If that named device exists, use it. If not, return an error."
2048 #: ../src/guestfs.pod:1040
2049 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2053 #: ../src/guestfs.pod:1042
2055 "Although the standard naming scheme and automatic translation is useful for "
2056 "simple programs and guestfish scripts, for larger programs it is best not to "
2057 "rely on this mechanism."
2061 #: ../src/guestfs.pod:1046
2063 "Where possible for maximum future portability programs using libguestfs "
2064 "should use these future-proof techniques:"
2068 #: ../src/guestfs.pod:1053
2070 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2071 "device names, and then use those names directly."
2075 #: ../src/guestfs.pod:1056
2076 msgid "Since those device names exist by definition, they will never be translated."
2080 #: ../src/guestfs.pod:1061
2082 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2083 "filesystem labels."
2087 #: ../src/guestfs.pod:1066
2092 #: ../src/guestfs.pod:1068
2094 "This section discusses security implications of using libguestfs, "
2095 "particularly with untrusted or malicious guests or disk images."
2099 #: ../src/guestfs.pod:1071
2100 msgid "GENERAL SECURITY CONSIDERATIONS"
2104 #: ../src/guestfs.pod:1073
2106 "Be careful with any files or data that you download from a guest (by "
2107 "\"download\" we mean not just the L</guestfs_download> command but any "
2108 "command that reads files, filenames, directories or anything else from a "
2109 "disk image). An attacker could manipulate the data to fool your program "
2110 "into doing the wrong thing. Consider cases such as:"
2114 #: ../src/guestfs.pod:1083
2115 msgid "the data (file etc) not being present"
2119 #: ../src/guestfs.pod:1087
2120 msgid "being present but empty"
2124 #: ../src/guestfs.pod:1091
2125 msgid "being much larger than normal"
2129 #: ../src/guestfs.pod:1095
2130 msgid "containing arbitrary 8 bit data"
2134 #: ../src/guestfs.pod:1099
2135 msgid "being in an unexpected character encoding"
2139 #: ../src/guestfs.pod:1103
2140 msgid "containing homoglyphs."
2144 #: ../src/guestfs.pod:1107
2145 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2149 #: ../src/guestfs.pod:1109
2151 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2152 "(VFS) module can sometimes be escalated into exploits by deliberately "
2153 "creating a malicious, malformed filesystem. These exploits are very severe "
2154 "for two reasons. Firstly there are very many filesystem drivers in the "
2155 "kernel, and many of them are infrequently used and not much developer "
2156 "attention has been paid to the code. Linux userspace helps potential "
2157 "crackers by detecting the filesystem type and automatically choosing the "
2158 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2159 "the administrator. Secondly, a kernel-level exploit is like a local root "
2160 "exploit (worse in some ways), giving immediate and total access to the "
2161 "system right down to the hardware level."
2165 #: ../src/guestfs.pod:1122
2167 "That explains why you should never mount a filesystem from an untrusted "
2168 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2169 "inside a qemu virtual machine, usually running as a non-root user. The "
2170 "attacker would need to write a filesystem which first exploited the kernel, "
2171 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2172 "the libguestfs protocol, and finally to be as serious as the host kernel "
2173 "exploit it would need to escalate its privileges to root. This multi-step "
2174 "escalation, performed by a static piece of data, is thought to be extremely "
2175 "hard to do, although we never say 'never' about security issues."
2179 #: ../src/guestfs.pod:1133
2181 "In any case callers can reduce the attack surface by forcing the filesystem "
2182 "type when mounting (use L</guestfs_mount_vfs>)."
2186 #: ../src/guestfs.pod:1136
2187 msgid "PROTOCOL SECURITY"
2191 #: ../src/guestfs.pod:1138
2193 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2194 "defined upper message size. However a program that uses libguestfs must "
2195 "also take care - for example you can write a program that downloads a binary "
2196 "from a disk image and executes it locally, and no amount of protocol "
2197 "security will save you from the consequences."
2201 #: ../src/guestfs.pod:1144
2202 msgid "INSPECTION SECURITY"
2206 #: ../src/guestfs.pod:1146
2208 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2209 "directly from the guest, and these could contain any 8 bit data. Callers "
2210 "should be careful to escape these before printing them to a structured file "
2211 "(for example, use HTML escaping if creating a web page)."
2215 #: ../src/guestfs.pod:1152
2217 "Guest configuration may be altered in unusual ways by the administrator of "
2218 "the virtual machine, and may not reflect reality (particularly for untrusted "
2219 "or actively malicious guests). For example we parse the hostname from "
2220 "configuration files like C</etc/sysconfig/network> that we find in the "
2221 "guest, but the guest administrator can easily manipulate these files to "
2222 "provide the wrong hostname."
2226 #: ../src/guestfs.pod:1160
2228 "The inspection API parses guest configuration using two external libraries: "
2229 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2230 "designed to be robust in the face of malicious data, although denial of "
2231 "service attacks are still possible, for example with oversized configuration "
2236 #: ../src/guestfs.pod:1166
2237 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2241 #: ../src/guestfs.pod:1168
2243 "Be very cautious about running commands from the guest. By running a "
2244 "command in the guest, you are giving CPU time to a binary that you do not "
2245 "control, under the same user account as the library, albeit wrapped in qemu "
2246 "virtualization. More information and alternatives can be found in the "
2247 "section L</RUNNING COMMANDS>."
2251 #: ../src/guestfs.pod:1174
2252 msgid "CVE-2010-3851"
2256 #: ../src/guestfs.pod:1176
2257 msgid "https://bugzilla.redhat.com/642934"
2261 #: ../src/guestfs.pod:1178
2263 "This security bug concerns the automatic disk format detection that qemu "
2264 "does on disk images."
2268 #: ../src/guestfs.pod:1181
2270 "A raw disk image is just the raw bytes, there is no header. Other disk "
2271 "images like qcow2 contain a special header. Qemu deals with this by looking "
2272 "for one of the known headers, and if none is found then assuming the disk "
2273 "image must be raw."
2277 #: ../src/guestfs.pod:1186
2279 "This allows a guest which has been given a raw disk image to write some "
2280 "other header. At next boot (or when the disk image is accessed by "
2281 "libguestfs) qemu would do autodetection and think the disk image format was, "
2282 "say, qcow2 based on the header written by the guest."
2286 #: ../src/guestfs.pod:1191
2288 "This in itself would not be a problem, but qcow2 offers many features, one "
2289 "of which is to allow a disk image to refer to another image (called the "
2290 "\"backing disk\"). It does this by placing the path to the backing disk "
2291 "into the qcow2 header. This path is not validated and could point to any "
2292 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2293 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2294 "control of the attacker."
2298 #: ../src/guestfs.pod:1199
2299 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2303 #: ../src/guestfs.pod:1206
2304 msgid "You have enabled the network or have opened the disk in write mode."
2308 #: ../src/guestfs.pod:1210
2310 "You are also running untrusted code from the guest (see L</RUNNING "
2315 #: ../src/guestfs.pod:1215
2317 "The way to avoid this is to specify the expected disk format when adding "
2318 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2319 "should always do this if the disk is raw format, and it's a good idea for "
2324 #: ../src/guestfs.pod:1220
2326 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2327 "format is fetched from libvirt and passed through."
2331 #: ../src/guestfs.pod:1223
2333 "For libguestfs tools, use the I<--format> command line parameter as "
2338 #: ../src/guestfs.pod:1226
2339 msgid "CONNECTION MANAGEMENT"
2343 #: ../src/guestfs.pod:1228
2348 #: ../src/guestfs.pod:1230
2350 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2351 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2352 "handle and release all resources used."
2356 #: ../src/guestfs.pod:1234
2358 "For information on using multiple handles and threads, see the section "
2359 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2363 #: ../src/guestfs.pod:1237
2364 msgid "guestfs_create"
2368 #: ../src/guestfs.pod:1239
2371 " guestfs_h *guestfs_create (void);\n"
2376 #: ../src/guestfs.pod:1241
2377 msgid "Create a connection handle."
2381 #: ../src/guestfs.pod:1243
2383 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2384 "on the handle at least once."
2388 #: ../src/guestfs.pod:1246
2390 "This function returns a non-NULL pointer to a handle on success or NULL on "
2395 #: ../src/guestfs.pod:1249
2396 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2400 #: ../src/guestfs.pod:1251
2402 "You may also want to configure error handling for the handle. See L</ERROR "
2403 "HANDLING> section below."
2407 #: ../src/guestfs.pod:1254
2408 msgid "guestfs_close"
2412 #: ../src/guestfs.pod:1256
2415 " void guestfs_close (guestfs_h *g);\n"
2420 #: ../src/guestfs.pod:1258
2421 msgid "This closes the connection handle and frees up all resources used."
2425 #: ../src/guestfs.pod:1260
2426 msgid "ERROR HANDLING"
2430 #: ../src/guestfs.pod:1262
2432 "API functions can return errors. For example, almost all functions that "
2433 "return C<int> will return C<-1> to indicate an error."
2437 #: ../src/guestfs.pod:1265
2439 "Additional information is available for errors: an error message string and "
2440 "optionally an error number (errno) if the thing that failed was a system "
2445 #: ../src/guestfs.pod:1269
2447 "You can get at the additional information about the last error on the handle "
2448 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2449 "up an error handler with L</guestfs_set_error_handler>."
2453 #: ../src/guestfs.pod:1274
2455 "When the handle is created, a default error handler is installed which "
2456 "prints the error message string to C<stderr>. For small short-running "
2457 "command line programs it is sufficient to do:"
2461 #: ../src/guestfs.pod:1278
2464 " if (guestfs_launch (g) == -1)\n"
2465 " exit (EXIT_FAILURE);\n"
2470 #: ../src/guestfs.pod:1281
2472 "since the default error handler will ensure that an error message has been "
2473 "printed to C<stderr> before the program exits."
2477 #: ../src/guestfs.pod:1284
2479 "For other programs the caller will almost certainly want to install an "
2480 "alternate error handler or do error handling in-line like this:"
2484 #: ../src/guestfs.pod:1287
2487 " g = guestfs_create ();\n"
2492 #: ../src/guestfs.pod:1289
2495 " /* This disables the default behaviour of printing errors\n"
2497 " guestfs_set_error_handler (g, NULL, NULL);\n"
2502 #: ../src/guestfs.pod:1293
2505 " if (guestfs_launch (g) == -1) {\n"
2506 " /* Examine the error message and print it etc. */\n"
2507 " char *msg = guestfs_last_error (g);\n"
2508 " int errnum = guestfs_last_errno (g);\n"
2509 " fprintf (stderr, \"%s\\n\", msg);\n"
2516 #: ../src/guestfs.pod:1301
2518 "Out of memory errors are handled differently. The default action is to call "
2519 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2520 "L</guestfs_set_out_of_memory_handler>."
2524 #: ../src/guestfs.pod:1305
2526 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2527 "because there is no handle if this happens there is no way to get additional "
2528 "error information. However L</guestfs_create> is supposed to be a "
2529 "lightweight operation which can only fail because of insufficient memory (it "
2530 "returns NULL in this case)."
2534 #: ../src/guestfs.pod:1311
2535 msgid "guestfs_last_error"
2539 #: ../src/guestfs.pod:1313
2542 " const char *guestfs_last_error (guestfs_h *g);\n"
2547 #: ../src/guestfs.pod:1315
2549 "This returns the last error message that happened on C<g>. If there has not "
2550 "been an error since the handle was created, then this returns C<NULL>."
2554 #: ../src/guestfs.pod:1319
2556 "The lifetime of the returned string is until the next error occurs, or "
2557 "L</guestfs_close> is called."
2561 #: ../src/guestfs.pod:1322
2562 msgid "guestfs_last_errno"
2566 #: ../src/guestfs.pod:1324
2569 " int guestfs_last_errno (guestfs_h *g);\n"
2574 #: ../src/guestfs.pod:1326
2575 msgid "This returns the last error number (errno) that happened on C<g>."
2579 #: ../src/guestfs.pod:1328
2580 msgid "If successful, an errno integer not equal to zero is returned."
2584 #: ../src/guestfs.pod:1330
2585 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2589 #: ../src/guestfs.pod:1337
2590 msgid "There has not been any error on the handle."
2594 #: ../src/guestfs.pod:1341
2596 "There has been an error but the errno was meaningless. This corresponds to "
2597 "the case where the error did not come from a failed system call, but for "
2598 "some other reason."
2602 #: ../src/guestfs.pod:1347
2604 "There was an error from a failed system call, but for some reason the errno "
2605 "was not captured and returned. This usually indicates a bug in libguestfs."
2609 #: ../src/guestfs.pod:1353
2611 "Libguestfs tries to convert the errno from inside the applicance into a "
2612 "corresponding errno for the caller (not entirely trivial: the appliance "
2613 "might be running a completely different operating system from the library "
2614 "and error numbers are not standardized across Un*xen). If this could not be "
2615 "done, then the error is translated to C<EINVAL>. In practice this should "
2616 "only happen in very rare circumstances."
2620 #: ../src/guestfs.pod:1361
2621 msgid "guestfs_set_error_handler"
2625 #: ../src/guestfs.pod:1363
2628 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2630 " const char *msg);\n"
2631 " void guestfs_set_error_handler (guestfs_h *g,\n"
2632 " guestfs_error_handler_cb cb,\n"
2638 #: ../src/guestfs.pod:1370
2640 "The callback C<cb> will be called if there is an error. The parameters "
2641 "passed to the callback are an opaque data pointer and the error message "
2646 #: ../src/guestfs.pod:1374
2648 "C<errno> is not passed to the callback. To get that the callback must call "
2649 "L</guestfs_last_errno>."
2653 #: ../src/guestfs.pod:1377
2655 "Note that the message string C<msg> is freed as soon as the callback "
2656 "function returns, so if you want to stash it somewhere you must make your "
2661 #: ../src/guestfs.pod:1381
2662 msgid "The default handler prints messages on C<stderr>."
2666 #: ../src/guestfs.pod:1383
2667 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2671 #: ../src/guestfs.pod:1385
2672 msgid "guestfs_get_error_handler"
2676 #: ../src/guestfs.pod:1387
2679 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2680 " void **opaque_rtn);\n"
2685 #: ../src/guestfs.pod:1390
2686 msgid "Returns the current error handler callback."
2690 #: ../src/guestfs.pod:1392
2691 msgid "guestfs_set_out_of_memory_handler"
2695 #: ../src/guestfs.pod:1394
2698 " typedef void (*guestfs_abort_cb) (void);\n"
2699 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2700 " guestfs_abort_cb);\n"
2705 #: ../src/guestfs.pod:1398
2707 "The callback C<cb> will be called if there is an out of memory situation. "
2708 "I<Note this callback must not return>."
2712 #: ../src/guestfs.pod:1401
2713 msgid "The default is to call L<abort(3)>."
2717 #: ../src/guestfs.pod:1403
2718 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2722 #: ../src/guestfs.pod:1406
2723 msgid "guestfs_get_out_of_memory_handler"
2727 #: ../src/guestfs.pod:1408
2730 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2735 #: ../src/guestfs.pod:1410
2736 msgid "This returns the current out of memory handler."
2740 #: ../src/guestfs.pod:1412
2745 #: ../src/guestfs.pod:1414 ../fish/guestfish.pod:969
2750 #: ../src/guestfs.pod:1416
2755 #: ../src/guestfs.pod:1418
2760 #: ../src/guestfs.pod:1420
2761 msgid "AVAILABILITY"
2765 #: ../src/guestfs.pod:1422
2766 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2770 #: ../src/guestfs.pod:1424
2772 "Using L</guestfs_available> you can test availability of the following "
2773 "groups of functions. This test queries the appliance to see if the "
2774 "appliance you are currently using supports the functionality."
2778 #: ../src/guestfs.pod:1429
2779 msgid "@AVAILABILITY@"
2783 #: ../src/guestfs.pod:1431
2784 msgid "GUESTFISH supported COMMAND"
2788 #: ../src/guestfs.pod:1433
2790 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2791 "prints out the available groups and whether they are supported by this build "
2792 "of libguestfs. Note however that you have to do C<run> first."
2796 #: ../src/guestfs.pod:1438
2797 msgid "SINGLE CALLS AT COMPILE TIME"
2801 #: ../src/guestfs.pod:1440
2803 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2804 "function, such as:"
2808 #: ../src/guestfs.pod:1443
2811 " #define LIBGUESTFS_HAVE_DD 1\n"
2816 #: ../src/guestfs.pod:1445
2817 msgid "if L</guestfs_dd> is available."
2821 #: ../src/guestfs.pod:1447
2823 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2824 "function is available at compile time, we recommended using build tools such "
2825 "as autoconf or cmake. For example in autotools you could use:"
2829 #: ../src/guestfs.pod:1452
2832 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2833 " AC_CHECK_FUNCS([guestfs_dd])\n"
2838 #: ../src/guestfs.pod:1455
2840 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2845 #: ../src/guestfs.pod:1458
2846 msgid "SINGLE CALLS AT RUN TIME"
2850 #: ../src/guestfs.pod:1460
2852 "Testing at compile time doesn't guarantee that a function really exists in "
2853 "the library. The reason is that you might be dynamically linked against a "
2854 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2855 "This situation unfortunately results in a segmentation fault, which is a "
2856 "shortcoming of the C dynamic linking system itself."
2860 #: ../src/guestfs.pod:1467
2862 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2863 "in this example program (note that you still need the compile time check as "
2868 #: ../src/guestfs.pod:1471
2871 " #include <stdio.h>\n"
2872 " #include <stdlib.h>\n"
2873 " #include <unistd.h>\n"
2874 " #include <dlfcn.h>\n"
2875 " #include <guestfs.h>\n"
2880 #: ../src/guestfs.pod:1477
2885 " #ifdef LIBGUESTFS_HAVE_DD\n"
2887 " int has_function;\n"
2892 #: ../src/guestfs.pod:1483
2895 " /* Test if the function guestfs_dd is really available. */\n"
2896 " dl = dlopen (NULL, RTLD_LAZY);\n"
2898 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2899 " exit (EXIT_FAILURE);\n"
2901 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2907 #: ../src/guestfs.pod:1492
2910 " if (!has_function)\n"
2911 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2913 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2914 " /* Now it's safe to call\n"
2915 " guestfs_dd (g, \"foo\", \"bar\");\n"
2919 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2926 #: ../src/guestfs.pod:1505
2928 "You may think the above is an awful lot of hassle, and it is. There are "
2929 "other ways outside of the C linking system to ensure that this kind of "
2930 "incompatibility never arises, such as using package versioning:"
2934 #: ../src/guestfs.pod:1510
2937 " Requires: libguestfs >= 1.0.80\n"
2942 #: ../src/guestfs.pod:1512
2943 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2947 #: ../src/guestfs.pod:1514
2949 "A recent feature of the API is the introduction of calls which take optional "
2950 "arguments. In C these are declared 3 ways. The main way is as a call which "
2951 "takes variable arguments (ie. C<...>), as in this example:"
2955 #: ../src/guestfs.pod:1519
2958 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2963 #: ../src/guestfs.pod:1521
2965 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2966 "call with no optional arguments specified:"
2970 #: ../src/guestfs.pod:1524
2973 " guestfs_add_drive_opts (g, filename, -1);\n"
2978 #: ../src/guestfs.pod:1526
2979 msgid "With a single optional argument:"
2983 #: ../src/guestfs.pod:1528
2986 " guestfs_add_drive_opts (g, filename,\n"
2987 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2993 #: ../src/guestfs.pod:1532
2998 #: ../src/guestfs.pod:1534
3001 " guestfs_add_drive_opts (g, filename,\n"
3002 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3003 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3009 #: ../src/guestfs.pod:1539
3011 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3016 #: ../src/guestfs.pod:1542
3017 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3021 #: ../src/guestfs.pod:1544
3023 "The second variant has the same name with the suffix C<_va>, which works the "
3024 "same way but takes a C<va_list>. See the C manual for details. For the "
3025 "example function, this is declared:"
3029 #: ../src/guestfs.pod:1548
3032 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3038 #: ../src/guestfs.pod:1551
3039 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3043 #: ../src/guestfs.pod:1553
3045 "The third variant is useful where you need to construct these calls. You "
3046 "pass in a structure where you fill in the optional fields. The structure "
3047 "has a bitmask as the first element which you must set to indicate which "
3048 "fields you have filled in. For our example function the structure and call "
3053 #: ../src/guestfs.pod:1559
3056 " struct guestfs_add_drive_opts_argv {\n"
3057 " uint64_t bitmask;\n"
3059 " const char *format;\n"
3062 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3063 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3068 #: ../src/guestfs.pod:1568
3069 msgid "You could call it like this:"
3073 #: ../src/guestfs.pod:1570
3076 " struct guestfs_add_drive_opts_argv optargs = {\n"
3077 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3078 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3080 " .format = \"qcow2\"\n"
3086 #: ../src/guestfs.pod:1577
3089 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3094 #: ../src/guestfs.pod:1579 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255 ../tools/virt-win-reg.pl:532
3099 #: ../src/guestfs.pod:1585
3100 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3104 #: ../src/guestfs.pod:1590
3105 msgid "You do not need to fill in all fields of the structure."
3109 #: ../src/guestfs.pod:1594
3111 "There must be a one-to-one correspondence between fields of the structure "
3112 "that are filled in, and bits set in the bitmask."
3116 #: ../src/guestfs.pod:1599
3117 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3121 #: ../src/guestfs.pod:1601
3123 "In other languages, optional arguments are expressed in the way that is "
3124 "natural for that language. We refer you to the language-specific "
3125 "documentation for more details on that."
3129 #: ../src/guestfs.pod:1605
3130 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3134 #: ../src/guestfs.pod:1607
3135 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3139 #: ../src/guestfs.pod:1609
3141 "The child process generates events in some situations. Current events "
3142 "include: receiving a log message, the child process exits."
3146 #: ../src/guestfs.pod:1612
3148 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3153 #: ../src/guestfs.pod:1615
3155 "Only I<one callback of each type> can be registered for each handle. "
3156 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3157 "that type. Cancel all callbacks of this type by calling this function with "
3158 "C<cb> set to C<NULL>."
3162 #: ../src/guestfs.pod:1620
3163 msgid "guestfs_set_log_message_callback"
3167 #: ../src/guestfs.pod:1622
3170 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3171 " char *buf, int len);\n"
3172 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3173 " guestfs_log_message_cb cb,\n"
3179 #: ../src/guestfs.pod:1628
3181 "The callback function C<cb> will be called whenever qemu or the guest writes "
3182 "anything to the console."
3186 #: ../src/guestfs.pod:1631
3187 msgid "Use this function to capture kernel messages and similar."
3191 #: ../src/guestfs.pod:1633
3193 "Normally there is no log message handler, and log messages are just "
3198 #: ../src/guestfs.pod:1636
3199 msgid "guestfs_set_subprocess_quit_callback"
3203 #: ../src/guestfs.pod:1638
3206 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3207 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3208 " guestfs_subprocess_quit_cb cb,\n"
3214 #: ../src/guestfs.pod:1643
3216 "The callback function C<cb> will be called when the child process quits, "
3217 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3218 "corresponds to a transition from any state to the CONFIG state)."
3222 #: ../src/guestfs.pod:1648
3223 msgid "guestfs_set_launch_done_callback"
3227 #: ../src/guestfs.pod:1650
3230 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3231 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3232 " guestfs_launch_done_cb cb,\n"
3238 #: ../src/guestfs.pod:1655
3240 "The callback function C<cb> will be called when the child process becomes "
3241 "ready first time after it has been launched. (This corresponds to a "
3242 "transition from LAUNCHING to the READY state)."
3246 #: ../src/guestfs.pod:1659
3247 msgid "guestfs_set_close_callback"
3251 #: ../src/guestfs.pod:1661
3254 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3255 " void guestfs_set_close_callback (guestfs_h *g,\n"
3256 " guestfs_close_cb cb,\n"
3262 #: ../src/guestfs.pod:1666
3264 "The callback function C<cb> will be called while the handle is being closed "
3265 "(synchronously from L</guestfs_close>)."
3269 #: ../src/guestfs.pod:1669
3271 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3272 "handles that are open when the program exits. This means that this callback "
3273 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3274 "problems in higher-level languages (eg. if your HLL interpreter has already "
3275 "been cleaned up by the time this is called, and if your callback then jumps "
3276 "into some HLL function)."
3280 #: ../src/guestfs.pod:1677
3281 msgid "guestfs_set_progress_callback"
3285 #: ../src/guestfs.pod:1679
3288 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3289 " int proc_nr, int serial,\n"
3290 " uint64_t position, uint64_t total);\n"
3291 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3292 " guestfs_progress_cb cb,\n"
3298 #: ../src/guestfs.pod:1686
3300 "Some long-running operations can generate progress messages. If this "
3301 "callback is registered, then it will be called each time a progress message "
3302 "is generated (usually two seconds after the operation started, and three "
3303 "times per second thereafter until it completes, although the frequency may "
3304 "change in future versions)."
3308 #: ../src/guestfs.pod:1692
3310 "The callback receives two numbers: C<position> and C<total>. The units of "
3311 "C<total> are not defined, although for some operations C<total> may relate "
3312 "in some way to the amount of data to be transferred (eg. in bytes or "
3313 "megabytes), and C<position> may be the portion which has been transferred."
3317 #: ../src/guestfs.pod:1698
3318 msgid "The only defined and stable parts of the API are:"
3322 #: ../src/guestfs.pod:1704
3324 "The callback can display to the user some type of progress bar or indicator "
3325 "which shows the ratio of C<position>:C<total>."
3329 #: ../src/guestfs.pod:1709
3330 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3334 #: ../src/guestfs.pod:1713
3336 "If any progress notification is sent during a call, then a final progress "
3337 "notification is always sent when C<position> = C<total> (I<unless> the call "
3338 "fails with an error)."
3342 #: ../src/guestfs.pod:1717
3344 "This is to simplify caller code, so callers can easily set the progress "
3345 "indicator to \"100%\" at the end of the operation, without requiring special "
3346 "code to detect this case."
3350 #: ../src/guestfs.pod:1723
3352 "The callback also receives the procedure number and serial number of the "
3353 "call. These are only useful for debugging protocol issues, and the callback "
3354 "can normally ignore them. The callback may want to print these numbers in "
3355 "error messages or debugging messages."
3359 #: ../src/guestfs.pod:1728
3360 msgid "PRIVATE DATA AREA"
3364 #: ../src/guestfs.pod:1730
3366 "You can attach named pieces of private data to the libguestfs handle, and "
3367 "fetch them by name for the lifetime of the handle. This is called the "
3368 "private data area and is only available from the C API."
3372 #: ../src/guestfs.pod:1734
3373 msgid "To attach a named piece of data, use the following call:"
3377 #: ../src/guestfs.pod:1736
3380 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3385 #: ../src/guestfs.pod:1738
3387 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3388 "pointer (which can be C<NULL>). Any previous item with the same name is "
3393 #: ../src/guestfs.pod:1742
3395 "You can use any C<key> you want, but names beginning with an underscore "
3396 "character are reserved for internal libguestfs purposes (for implementing "
3397 "language bindings). It is recommended to prefix the name with some unique "
3398 "string to avoid collisions with other users."
3402 #: ../src/guestfs.pod:1747
3403 msgid "To retrieve the pointer, use:"
3407 #: ../src/guestfs.pod:1749
3410 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3415 #: ../src/guestfs.pod:1751
3417 "This function returns C<NULL> if either no data is found associated with "
3418 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3423 #: ../src/guestfs.pod:1755
3425 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3426 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3427 "all. In particular, libguestfs does I<not> try to free the data when the "
3428 "handle is closed. If the data must be freed, then the caller must either "
3429 "free it before calling L</guestfs_close> or must set up a close callback to "
3430 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3431 "can be registered for a handle)."
3435 #: ../src/guestfs.pod:1763
3437 "The private data area is implemented using a hash table, and should be "
3438 "reasonably efficient for moderate numbers of keys."
3442 #: ../src/guestfs.pod:1766 ../src/guestfs.pod:1771
3447 #: ../src/guestfs.pod:1768
3449 "<!-- old anchor for the next section --> <a "
3450 "name=\"state_machine_and_low_level_event_api\"/>"
3454 #: ../src/guestfs.pod:1773
3455 msgid "ARCHITECTURE"
3459 #: ../src/guestfs.pod:1775
3461 "Internally, libguestfs is implemented by running an appliance (a special "
3462 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3463 "process of the main program."
3467 #: ../src/guestfs.pod:1779
3470 " ___________________\n"
3472 " | main program |\n"
3474 " | | child process / appliance\n"
3475 " | | __________________________\n"
3477 " +-------------------+ RPC | +-----------------+ |\n"
3478 " | libguestfs <--------------------> guestfsd | |\n"
3479 " | | | +-----------------+ |\n"
3480 " \\___________________/ | | Linux kernel | |\n"
3481 " | +--^--------------+ |\n"
3482 " \\_________|________________/\n"
3488 " \\______________/\n"
3493 #: ../src/guestfs.pod:1799
3495 "The library, linked to the main program, creates the child process and hence "
3496 "the appliance in the L</guestfs_launch> function."
3500 #: ../src/guestfs.pod:1802
3502 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3503 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3504 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3505 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3506 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3507 "attached to the qemu process which translates device access by the "
3508 "appliance's Linux kernel into accesses to the image."
3512 #: ../src/guestfs.pod:1811
3514 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3515 "Although the disk image you are attached to might also be used by some "
3516 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3517 "care if both libguestfs's qemu process and your virtual machine are trying "
3518 "to update the disk image at the same time, since these usually results in "
3519 "massive disk corruption)."
3523 #: ../src/guestfs.pod:1818
3524 msgid "STATE MACHINE"
3528 #: ../src/guestfs.pod:1820
3529 msgid "libguestfs uses a state machine to model the child process:"
3533 #: ../src/guestfs.pod:1822
3545 " / | \\ \\ guestfs_launch\n"
3546 " / | _\\__V______\n"
3548 " / | | LAUNCHING |\n"
3549 " / | \\___________/\n"
3551 " / | guestfs_launch\n"
3553 " ______ / __|____V\n"
3554 " / \\ ------> / \\\n"
3555 " | BUSY | | READY |\n"
3556 " \\______/ <------ \\________/\n"
3561 #: ../src/guestfs.pod:1844
3563 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3564 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3565 "(3) alternating between READY and BUSY as commands are issued to, and "
3566 "carried out by, the child process."
3570 #: ../src/guestfs.pod:1849
3572 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3573 "asynchronously at any time (eg. due to some internal error), and that causes "
3574 "the state to transition back to CONFIG."
3578 #: ../src/guestfs.pod:1853
3580 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3581 "issued when in the CONFIG state."
3585 #: ../src/guestfs.pod:1856
3587 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3588 "L</guestfs_launch> blocks until the child process is READY to accept "
3589 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3590 "moves the state from CONFIG to LAUNCHING while it is running."
3594 #: ../src/guestfs.pod:1862
3596 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3597 "state. These API calls block waiting for the command to be carried out "
3598 "(ie. the state to transition to BUSY and then back to READY). There are no "
3599 "non-blocking versions, and no way to issue more than one command per handle "
3604 #: ../src/guestfs.pod:1868
3606 "Finally, the child process sends asynchronous messages back to the main "
3607 "program, such as kernel log messages. You can register a callback to "
3608 "receive these messages."
3612 #: ../src/guestfs.pod:1872
3617 #: ../src/guestfs.pod:1874
3618 msgid "COMMUNICATION PROTOCOL"
3622 #: ../src/guestfs.pod:1876
3624 "Don't rely on using this protocol directly. This section documents how it "
3625 "currently works, but it may change at any time."
3629 #: ../src/guestfs.pod:1879
3631 "The protocol used to talk between the library and the daemon running inside "
3632 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3633 "1014, RFC 1832, RFC 4506)."
3637 #: ../src/guestfs.pod:1883
3639 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3640 "this file is automatically generated)."
3644 #: ../src/guestfs.pod:1886
3646 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3647 "and C<FileOut> parameters, which are handled with very simple request/reply "
3648 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3649 "parameters, which use the same request and reply messages, but they may also "
3650 "be followed by files sent using a chunked encoding."
3654 #: ../src/guestfs.pod:1893
3655 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3659 #: ../src/guestfs.pod:1895
3660 msgid "For ordinary functions, the request message is:"
3664 #: ../src/guestfs.pod:1897
3667 " total length (header + arguments,\n"
3668 " but not including the length word itself)\n"
3669 " struct guestfs_message_header (encoded as XDR)\n"
3670 " struct guestfs_<foo>_args (encoded as XDR)\n"
3675 #: ../src/guestfs.pod:1902
3677 "The total length field allows the daemon to allocate a fixed size buffer "
3678 "into which it slurps the rest of the message. As a result, the total length "
3679 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3680 "effective size of any request is limited to somewhere under this size."
3684 #: ../src/guestfs.pod:1908
3686 "Note also that many functions don't take any arguments, in which case the "
3687 "C<guestfs_I<foo>_args> is completely omitted."
3691 #: ../src/guestfs.pod:1911
3693 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3694 "receiver knows what type of args structure to expect, or none at all."
3698 #: ../src/guestfs.pod:1915
3700 "For functions that take optional arguments, the optional arguments are "
3701 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3702 "arguments. A bitmask in the header indicates which optional arguments are "
3703 "meaningful. The bitmask is also checked to see if it contains bits set "
3704 "which the daemon does not know about (eg. if more optional arguments were "
3705 "added in a later version of the library), and this causes the call to be "
3710 #: ../src/guestfs.pod:1923
3711 msgid "The reply message for ordinary functions is:"
3715 #: ../src/guestfs.pod:1925
3718 " total length (header + ret,\n"
3719 " but not including the length word itself)\n"
3720 " struct guestfs_message_header (encoded as XDR)\n"
3721 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3726 #: ../src/guestfs.pod:1930
3728 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3729 "functions that return no formal return values."
3733 #: ../src/guestfs.pod:1933
3734 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3738 #: ../src/guestfs.pod:1936
3740 "In the case of an error, a flag is set in the header, and the reply message "
3741 "is slightly changed:"
3745 #: ../src/guestfs.pod:1939
3748 " total length (header + error,\n"
3749 " but not including the length word itself)\n"
3750 " struct guestfs_message_header (encoded as XDR)\n"
3751 " struct guestfs_message_error (encoded as XDR)\n"
3756 #: ../src/guestfs.pod:1944
3758 "The C<guestfs_message_error> structure contains the error message as a "
3763 #: ../src/guestfs.pod:1947
3764 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3768 #: ../src/guestfs.pod:1949
3770 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3771 "The normal request message is sent (see above). However this is followed by "
3772 "a sequence of file chunks."
3776 #: ../src/guestfs.pod:1953
3779 " total length (header + arguments,\n"
3780 " but not including the length word itself,\n"
3781 " and not including the chunks)\n"
3782 " struct guestfs_message_header (encoded as XDR)\n"
3783 " struct guestfs_<foo>_args (encoded as XDR)\n"
3784 " sequence of chunks for FileIn param #0\n"
3785 " sequence of chunks for FileIn param #1 etc.\n"
3790 #: ../src/guestfs.pod:1961
3791 msgid "The \"sequence of chunks\" is:"
3795 #: ../src/guestfs.pod:1963
3798 " length of chunk (not including length word itself)\n"
3799 " struct guestfs_chunk (encoded as XDR)\n"
3800 " length of chunk\n"
3801 " struct guestfs_chunk (encoded as XDR)\n"
3803 " length of chunk\n"
3804 " struct guestfs_chunk (with data.data_len == 0)\n"
3809 #: ../src/guestfs.pod:1971
3811 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3812 "is set in the final chunk to indicate either successful completion or early "
3817 #: ../src/guestfs.pod:1975
3819 "At time of writing there are no functions that have more than one FileIn "
3820 "parameter. However this is (theoretically) supported, by sending the "
3821 "sequence of chunks for each FileIn parameter one after another (from left to "
3826 #: ../src/guestfs.pod:1980
3828 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3829 "transfer. The library does this by sending a chunk with a special flag set "
3830 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3831 "RPC, does I<not> send any reply, and goes back to reading the next request."
3835 #: ../src/guestfs.pod:1986
3837 "The daemon may also cancel. It does this by writing a special word "
3838 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3839 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3840 "cancel chunk). The special word is chosen so that even if cancellation "
3841 "happens right at the end of the transfer (after the library has finished "
3842 "writing and has started listening for the reply), the \"spurious\" cancel "
3843 "flag will not be confused with the reply message."
3847 #: ../src/guestfs.pod:1995
3849 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3850 "limit), and also files where the size is not known in advance (eg. from "
3851 "pipes or sockets). However the chunks are rather small "
3852 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3853 "to keep much in memory."
3857 #: ../src/guestfs.pod:2001
3858 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3862 #: ../src/guestfs.pod:2003
3864 "The protocol for FileOut parameters is exactly the same as for FileIn "
3865 "parameters, but with the roles of daemon and library reversed."
3869 #: ../src/guestfs.pod:2006
3872 " total length (header + ret,\n"
3873 " but not including the length word itself,\n"
3874 " and not including the chunks)\n"
3875 " struct guestfs_message_header (encoded as XDR)\n"
3876 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3877 " sequence of chunks for FileOut param #0\n"
3878 " sequence of chunks for FileOut param #1 etc.\n"
3883 #: ../src/guestfs.pod:2014
3884 msgid "INITIAL MESSAGE"
3888 #: ../src/guestfs.pod:2016
3890 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3891 "which indicates that the guest and daemon is alive. This is what "
3892 "L</guestfs_launch> waits for."
3896 #: ../src/guestfs.pod:2020
3897 msgid "PROGRESS NOTIFICATION MESSAGES"
3901 #: ../src/guestfs.pod:2022
3903 "The daemon may send progress notification messages at any time. These are "
3904 "distinguished by the normal length word being replaced by "
3905 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3909 #: ../src/guestfs.pod:2026
3911 "The library turns them into progress callbacks (see "
3912 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3913 "discards them if not."
3917 #: ../src/guestfs.pod:2030
3919 "The daemon self-limits the frequency of progress messages it sends (see "
3920 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3925 #: ../src/guestfs.pod:2034
3926 msgid "LIBGUESTFS VERSION NUMBERS"
3930 #: ../src/guestfs.pod:2036
3932 "Since April 2010, libguestfs has started to make separate development and "
3933 "stable releases, along with corresponding branches in our git repository. "
3934 "These separate releases can be identified by version number:"
3938 #: ../src/guestfs.pod:2041
3941 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3942 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3948 " | `-------- sub-version\n"
3950 " `------ always '1' because we don't change the ABI\n"
3955 #: ../src/guestfs.pod:2052
3956 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3960 #: ../src/guestfs.pod:2054
3962 "As time passes we cherry pick fixes from the development branch and backport "
3963 "those into the stable branch, the effect being that the stable branch should "
3964 "get more stable and less buggy over time. So the stable releases are ideal "
3965 "for people who don't need new features but would just like the software to "
3970 #: ../src/guestfs.pod:2060
3971 msgid "Our criteria for backporting changes are:"
3975 #: ../src/guestfs.pod:2066
3977 "Documentation changes which don't affect any code are backported unless the "
3978 "documentation refers to a future feature which is not in stable."
3982 #: ../src/guestfs.pod:2072
3984 "Bug fixes which are not controversial, fix obvious problems, and have been "
3985 "well tested are backported."
3989 #: ../src/guestfs.pod:2077
3991 "Simple rearrangements of code which shouldn't affect how it works get "
3992 "backported. This is so that the code in the two branches doesn't get too "
3993 "far out of step, allowing us to backport future fixes more easily."
3997 #: ../src/guestfs.pod:2083
3999 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4000 "exceptional case: the new feature is required in order to implement an "
4001 "important bug fix."
4005 #: ../src/guestfs.pod:2089
4007 "A new stable branch starts when we think the new features in development are "
4008 "substantial and compelling enough over the current stable branch to warrant "
4009 "it. When that happens we create new stable and development versions 1.N.0 "
4010 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4011 "stable at this point, but by backporting fixes from development, that branch "
4012 "will stabilize over time."
4016 #: ../src/guestfs.pod:2097
4017 msgid "EXTENDING LIBGUESTFS"
4021 #: ../src/guestfs.pod:2099
4022 msgid "ADDING A NEW API ACTION"
4026 #: ../src/guestfs.pod:2101
4028 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4029 "documentation) are generated, and this makes it easy to extend the "
4034 #: ../src/guestfs.pod:2105
4035 msgid "To add a new API action there are two changes:"
4039 #: ../src/guestfs.pod:2111
4041 "You need to add a description of the call (name, parameters, return type, "
4042 "tests, documentation) to C<generator/generator_actions.ml>."
4046 #: ../src/guestfs.pod:2114
4048 "There are two sorts of API action, depending on whether the call goes "
4049 "through to the daemon in the appliance, or is serviced entirely by the "
4050 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4051 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4052 "an example of the latter, since a trace flag is maintained in the handle and "
4053 "all tracing is done on the library side."
4057 #: ../src/guestfs.pod:2122
4059 "Most new actions are of the first type, and get added to the "
4060 "C<daemon_functions> list. Each function has a unique procedure number used "
4061 "in the RPC protocol which is assigned to that action when we publish "
4062 "libguestfs and cannot be reused. Take the latest procedure number and "
4067 #: ../src/guestfs.pod:2128
4069 "For library-only actions of the second type, add to the "
4070 "C<non_daemon_functions> list. Since these functions are serviced by the "
4071 "library and do not travel over the RPC mechanism to the daemon, these "
4072 "functions do not need a procedure number, and so the procedure number is set "
4077 #: ../src/guestfs.pod:2136
4078 msgid "Implement the action (in C):"
4082 #: ../src/guestfs.pod:2138
4084 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4085 "C<daemon/> directory."
4089 #: ../src/guestfs.pod:2141
4091 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4092 "(note: double underscore) in the C<src/> directory."
4096 #: ../src/guestfs.pod:2144
4097 msgid "In either case, use another function as an example of what to do."
4101 #: ../src/guestfs.pod:2148
4102 msgid "After making these changes, use C<make> to compile."
4106 #: ../src/guestfs.pod:2150
4108 "Note that you don't need to implement the RPC, language bindings, manual "
4109 "pages or anything else. It's all automatically generated from the OCaml "
4114 #: ../src/guestfs.pod:2154
4115 msgid "ADDING TESTS FOR AN API ACTION"
4119 #: ../src/guestfs.pod:2156
4121 "You can supply zero or as many tests as you want per API call. The tests "
4122 "can either be added as part of the API description "
4123 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4124 "drop a script into C<regressions/>. Note that adding a script to "
4125 "C<regressions/> is slower, so if possible use the first method."
4129 #: ../src/guestfs.pod:2162
4131 "The following describes the test environment used when you add an API test "
4132 "in C<generator_actions.ml>."
4136 #: ../src/guestfs.pod:2165
4137 msgid "The test environment has 4 block devices:"
4141 #: ../src/guestfs.pod:2169
4142 msgid "C</dev/sda> 500MB"
4146 #: ../src/guestfs.pod:2171
4147 msgid "General block device for testing."
4151 #: ../src/guestfs.pod:2173
4152 msgid "C</dev/sdb> 50MB"
4156 #: ../src/guestfs.pod:2175
4158 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4163 #: ../src/guestfs.pod:2178
4164 msgid "C</dev/sdc> 10MB"
4168 #: ../src/guestfs.pod:2180
4169 msgid "Used in a few tests where two block devices are needed."
4173 #: ../src/guestfs.pod:2182
4178 #: ../src/guestfs.pod:2184
4179 msgid "ISO with fixed content (see C<images/test.iso>)."
4183 #: ../src/guestfs.pod:2188
4185 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4186 "appliance and block devices are reused between tests. So don't try testing "
4187 "L</guestfs_kill_subprocess> :-x"
4191 #: ../src/guestfs.pod:2192
4193 "Each test starts with an initial scenario, selected using one of the "
4194 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4195 "initialize the disks mentioned above in a particular way as documented in "
4196 "C<generator_types.ml>. You should not assume anything about the previous "
4197 "contents of other disks that are not initialized."
4201 #: ../src/guestfs.pod:2198
4203 "You can add a prerequisite clause to any individual test. This is a "
4204 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4205 "if testing a command which might not work on all variations of libguestfs "
4206 "builds. A test that has prerequisite of C<Always> means to run "
4211 #: ../src/guestfs.pod:2204
4213 "In addition, packagers can skip individual tests by setting environment "
4214 "variables before running C<make check>."
4218 #: ../src/guestfs.pod:2207
4221 " SKIP_TEST_<CMD>_<NUM>=1\n"
4226 #: ../src/guestfs.pod:2209
4227 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4231 #: ../src/guestfs.pod:2211
4236 #: ../src/guestfs.pod:2213
4239 " SKIP_TEST_<CMD>=1\n"
4244 #: ../src/guestfs.pod:2215
4245 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4249 #: ../src/guestfs.pod:2217
4250 msgid "Packagers can run only certain tests by setting for example:"
4254 #: ../src/guestfs.pod:2219
4257 " TEST_ONLY=\"vfs_type zerofree\"\n"
4262 #: ../src/guestfs.pod:2221
4264 "See C<capitests/tests.c> for more details of how these environment variables "
4269 #: ../src/guestfs.pod:2224
4270 msgid "DEBUGGING NEW API ACTIONS"
4274 #: ../src/guestfs.pod:2226
4275 msgid "Test new actions work before submitting them."
4279 #: ../src/guestfs.pod:2228
4280 msgid "You can use guestfish to try out new commands."
4284 #: ../src/guestfs.pod:2230
4286 "Debugging the daemon is a problem because it runs inside a minimal "
4287 "environment. However you can fprintf messages in the daemon to stderr, and "
4288 "they will show up if you use C<guestfish -v>."
4292 #: ../src/guestfs.pod:2234
4293 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4297 #: ../src/guestfs.pod:2236
4299 "Our C source code generally adheres to some basic code-formatting "
4300 "conventions. The existing code base is not totally consistent on this "
4301 "front, but we do prefer that contributed code be formatted similarly. In "
4302 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4303 "indentation level, and other than that, follow the K&R style."
4307 #: ../src/guestfs.pod:2242
4309 "If you use Emacs, add the following to one of one of your start-up files "
4310 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4314 #: ../src/guestfs.pod:2245
4317 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4318 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4319 " (add-hook 'find-file-hook\n"
4320 " '(lambda () (if (and buffer-file-name\n"
4321 " (string-match \"/libguestfs\\\\>\"\n"
4322 " (buffer-file-name))\n"
4323 " (not (string-equal mode-name \"Change Log\"))\n"
4324 " (not (string-equal mode-name \"Makefile\")))\n"
4325 " (setq indent-tabs-mode nil))))\n"
4330 #: ../src/guestfs.pod:2255
4333 " ;;; When editing C sources in libguestfs, use this style.\n"
4334 " (defun libguestfs-c-mode ()\n"
4335 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4337 " (c-set-style \"K&R\")\n"
4338 " (setq c-indent-level 2)\n"
4339 " (setq c-basic-offset 2))\n"
4340 " (add-hook 'c-mode-hook\n"
4341 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4342 " (buffer-file-name))\n"
4343 " (libguestfs-c-mode))))\n"
4348 #: ../src/guestfs.pod:2267
4349 msgid "Enable warnings when compiling (and fix any problems this finds):"
4353 #: ../src/guestfs.pod:2270
4356 " ./configure --enable-gcc-warnings\n"
4361 #: ../src/guestfs.pod:2272
4362 msgid "Useful targets are:"
4366 #: ../src/guestfs.pod:2274
4369 " make syntax-check # checks the syntax of the C code\n"
4370 " make check # runs the test suite\n"
4375 #: ../src/guestfs.pod:2277
4376 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4380 #: ../src/guestfs.pod:2279
4382 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4383 "which are used to do shell quoting."
4387 #: ../src/guestfs.pod:2284
4392 #: ../src/guestfs.pod:2286
4394 "Simple shell quoted string. Any spaces or other shell characters are "
4399 #: ../src/guestfs.pod:2289
4404 #: ../src/guestfs.pod:2291
4406 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4411 #: ../src/guestfs.pod:2296 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4412 msgid "For example:"
4416 #: ../src/guestfs.pod:2298
4419 " asprintf (&cmd, \"cat %R\", path);\n"
4424 #: ../src/guestfs.pod:2300
4425 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4429 #: ../src/guestfs.pod:2302
4431 "I<Note:> Do I<not> use these when you are passing parameters to the "
4432 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4433 "because they are not passed via the shell (instead, straight to exec). You "
4434 "probably want to use the C<sysroot_path()> function however."
4438 #: ../src/guestfs.pod:2308
4439 msgid "SUBMITTING YOUR NEW API ACTIONS"
4443 #: ../src/guestfs.pod:2310
4445 "Submit patches to the mailing list: "
4446 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
4447 "L<rjones@redhat.com>."
4451 #: ../src/guestfs.pod:2314
4452 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
4456 #: ../src/guestfs.pod:2316
4457 msgid "We support i18n (gettext anyhow) in the library."
4461 #: ../src/guestfs.pod:2318
4463 "However many messages come from the daemon, and we don't translate those at "
4464 "the moment. One reason is that the appliance generally has all locale files "
4465 "removed from it, because they take up a lot of space. So we'd have to readd "
4466 "some of those, as well as copying our PO files into the appliance."
4470 #: ../src/guestfs.pod:2324
4472 "Debugging messages are never translated, since they are intended for the "
4477 #: ../src/guestfs.pod:2327
4478 msgid "SOURCE CODE SUBDIRECTORIES"
4482 #: ../src/guestfs.pod:2331
4483 msgid "C<appliance>"
4487 #: ../src/guestfs.pod:2333
4488 msgid "The libguestfs appliance, build scripts and so on."
4492 #: ../src/guestfs.pod:2335
4493 msgid "C<capitests>"
4497 #: ../src/guestfs.pod:2337
4498 msgid "Automated tests of the C API."
4502 #: ../src/guestfs.pod:2339
4507 #: ../src/guestfs.pod:2341
4509 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
4514 #: ../src/guestfs.pod:2344
4519 #: ../src/guestfs.pod:2346
4521 "Safety and liveness tests of components that libguestfs depends upon (not of "
4522 "libguestfs itself). Mainly this is for qemu and the kernel."
4526 #: ../src/guestfs.pod:2349
4531 #: ../src/guestfs.pod:2351
4532 msgid "Outside contributions, experimental parts."
4536 #: ../src/guestfs.pod:2353
4541 #: ../src/guestfs.pod:2355
4543 "The daemon that runs inside the libguestfs appliance and carries out "
4548 #: ../src/guestfs.pod:2358
4553 #: ../src/guestfs.pod:2360
4554 msgid "L<virt-df(1)> command and documentation."
4558 #: ../src/guestfs.pod:2362
4563 #: ../src/guestfs.pod:2364
4564 msgid "C API example code."
4568 #: ../src/guestfs.pod:2366
4573 #: ../src/guestfs.pod:2368
4574 msgid "L<guestfish(1)>, the command-line shell."
4578 #: ../src/guestfs.pod:2370
4583 #: ../src/guestfs.pod:2372
4584 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
4588 #: ../src/guestfs.pod:2374
4589 msgid "C<generator>"
4593 #: ../src/guestfs.pod:2376
4595 "The crucially important generator, used to automatically generate large "
4596 "amounts of boilerplate C code for things like RPC and bindings."
4600 #: ../src/guestfs.pod:2379
4605 #: ../src/guestfs.pod:2381
4606 msgid "Files used by the test suite."
4610 #: ../src/guestfs.pod:2383
4611 msgid "Some \"phony\" guest images which we test against."
4615 #: ../src/guestfs.pod:2385
4616 msgid "C<inspector>"
4620 #: ../src/guestfs.pod:2387
4621 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
4625 #: ../src/guestfs.pod:2389
4630 #: ../src/guestfs.pod:2391
4631 msgid "M4 macros used by autoconf."
4635 #: ../src/guestfs.pod:2393
4640 #: ../src/guestfs.pod:2395
4641 msgid "Translations of simple gettext strings."
4645 #: ../src/guestfs.pod:2397
4650 #: ../src/guestfs.pod:2399
4652 "The build infrastructure and PO files for translations of manpages and POD "
4653 "files. Eventually this will be combined with the C<po> directory, but that "
4654 "is rather complicated."
4658 #: ../src/guestfs.pod:2403
4659 msgid "C<regressions>"
4663 #: ../src/guestfs.pod:2405
4664 msgid "Regression tests."
4668 #: ../src/guestfs.pod:2407
4673 #: ../src/guestfs.pod:2409
4674 msgid "L<virt-rescue(1)> command and documentation."
4678 #: ../src/guestfs.pod:2411
4683 #: ../src/guestfs.pod:2413
4684 msgid "Source code to the C library."
4688 #: ../src/guestfs.pod:2415
4693 #: ../src/guestfs.pod:2417
4694 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
4698 #: ../src/guestfs.pod:2419
4699 msgid "C<test-tool>"
4703 #: ../src/guestfs.pod:2421
4705 "Test tool for end users to test if their qemu/kernel combination will work "
4710 #: ../src/guestfs.pod:2424
4715 #: ../src/guestfs.pod:2426
4720 #: ../src/guestfs.pod:2428
4725 #: ../src/guestfs.pod:2430
4730 #: ../src/guestfs.pod:2432
4735 #: ../src/guestfs.pod:2434
4740 #: ../src/guestfs.pod:2436
4745 #: ../src/guestfs.pod:2438
4750 #: ../src/guestfs.pod:2440
4751 msgid "Language bindings."
4755 #: ../src/guestfs.pod:2444 ../fish/guestfish.pod:976 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:375
4756 msgid "ENVIRONMENT VARIABLES"
4760 #: ../src/guestfs.pod:2448 ../fish/guestfish.pod:1002
4761 msgid "LIBGUESTFS_APPEND"
4765 #: ../src/guestfs.pod:2450 ../fish/guestfish.pod:1004
4766 msgid "Pass additional options to the guest kernel."
4770 #: ../src/guestfs.pod:2452 ../fish/guestfish.pod:1006
4771 msgid "LIBGUESTFS_DEBUG"
4775 #: ../src/guestfs.pod:2454
4777 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
4778 "effect as calling C<guestfs_set_verbose (g, 1)>."
4782 #: ../src/guestfs.pod:2457 ../fish/guestfish.pod:1011
4783 msgid "LIBGUESTFS_MEMSIZE"
4787 #: ../src/guestfs.pod:2459 ../fish/guestfish.pod:1013
4788 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
4792 #: ../src/guestfs.pod:2462 ../fish/guestfish.pod:1016
4795 " LIBGUESTFS_MEMSIZE=700\n"
4800 #: ../src/guestfs.pod:2464 ../fish/guestfish.pod:1018
4801 msgid "LIBGUESTFS_PATH"
4805 #: ../src/guestfs.pod:2466
4807 "Set the path that libguestfs uses to search for a supermin appliance. See "
4808 "the discussion of paths in section L</PATH> above."
4812 #: ../src/guestfs.pod:2469 ../fish/guestfish.pod:1023
4813 msgid "LIBGUESTFS_QEMU"
4817 #: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1025
4819 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4820 "which was found at compile time by the configure script is used."
4824 #: ../src/guestfs.pod:2475
4825 msgid "See also L</QEMU WRAPPERS> above."
4829 #: ../src/guestfs.pod:2477 ../fish/guestfish.pod:1029
4830 msgid "LIBGUESTFS_TRACE"
4834 #: ../src/guestfs.pod:2479
4836 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4837 "effect as calling C<guestfs_set_trace (g, 1)>."
4841 #: ../src/guestfs.pod:2482 ../fish/guestfish.pod:1038
4846 #: ../src/guestfs.pod:2484 ../fish/guestfish.pod:1040
4847 msgid "Location of temporary directory, defaults to C</tmp>."
4851 #: ../src/guestfs.pod:2486 ../fish/guestfish.pod:1042
4853 "If libguestfs was compiled to use the supermin appliance then the real "
4854 "appliance is cached in this directory, shared between all handles belonging "
4855 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4856 "use in case C</tmp> is not large enough."
4860 #: ../src/guestfs.pod:2494 ../fish/guestfish.pod:1100 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:395 ../tools/virt-win-reg.pl:572 ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
4865 #: ../src/guestfs.pod:2496
4867 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4868 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4869 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
4870 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4871 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4872 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4873 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4877 #: ../src/guestfs.pod:2519
4879 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4880 "L<lvm(8)>, L<disktype(1)>."
4884 #: ../src/guestfs.pod:2526 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:553
4889 #: ../src/guestfs.pod:2528
4890 msgid "To get a list of bugs against libguestfs use this link:"
4894 #: ../src/guestfs.pod:2530
4895 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4899 #: ../src/guestfs.pod:2532
4900 msgid "To report a new bug against libguestfs use this link:"
4904 #: ../src/guestfs.pod:2534
4905 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4909 #: ../src/guestfs.pod:2536
4910 msgid "When reporting a bug, please check:"
4914 #: ../src/guestfs.pod:2542
4915 msgid "That the bug hasn't been reported already."
4919 #: ../src/guestfs.pod:2546
4920 msgid "That you are testing a recent version."
4924 #: ../src/guestfs.pod:2550
4925 msgid "Describe the bug accurately, and give a way to reproduce it."
4929 #: ../src/guestfs.pod:2554
4931 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4936 #: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1119 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4941 #: ../src/guestfs.pod:2561 ../fish/guestfish.pod:1121 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4942 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4946 #: ../src/guestfs.pod:2563 ../fish/guestfish.pod:1123 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:411 ../tools/virt-win-reg.pl:602 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
4951 #: ../src/guestfs.pod:2565 ../fish/guestfish.pod:1125 ../fuse/guestmount.pod:250
4952 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4956 #: ../src/guestfs.pod:2568
4958 "This library is free software; you can redistribute it and/or modify it "
4959 "under the terms of the GNU Lesser General Public License as published by the "
4960 "Free Software Foundation; either version 2 of the License, or (at your "
4961 "option) any later version."
4965 #: ../src/guestfs.pod:2573
4967 "This library is distributed in the hope that it will be useful, but WITHOUT "
4968 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4969 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4974 #: ../src/guestfs.pod:2578
4976 "You should have received a copy of the GNU Lesser General Public License "
4977 "along with this library; if not, write to the Free Software Foundation, "
4978 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4982 #: ../src/guestfs-actions.pod:1
4983 msgid "guestfs_add_cdrom"
4987 #: ../src/guestfs-actions.pod:3
4991 " guestfs_add_cdrom (guestfs_h *g,\n"
4992 " const char *filename);\n"
4997 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4998 msgid "This function adds a virtual CD-ROM disk image to the guest."
5002 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5003 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5007 #: ../src/guestfs-actions.pod:17
5009 "This call checks for the existence of C<filename>. This stops you from "
5010 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5011 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5016 #: ../src/guestfs-actions.pod:24
5018 "If you just want to add an ISO file (often you use this as an efficient way "
5019 "to transfer large files into the guest), then you should probably use "
5020 "C<guestfs_add_drive_ro> instead."
5024 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:413 ../src/guestfs-actions.pod:433 ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:492 ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:538 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:638 ../src/guestfs-actions.pod:652 ../src/guestfs-actions.pod:667 ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:784 ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:812 ../src/guestfs-actions.pod:973 ../src/guestfs-actions.pod:993 ../src/guestfs-actions.pod:1011 ../src/guestfs-actions.pod:1095 ../src/guestfs-actions.pod:1113 ../src/guestfs-actions.pod:1132 ../src/guestfs-actions.pod:1146 ../src/guestfs-actions.pod:1166 ../src/guestfs-actions.pod:1236 ../src/guestfs-actions.pod:1267 ../src/guestfs-actions.pod:1292 ../src/guestfs-actions.pod:1329 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1469 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2245 ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:3228 ../src/guestfs-actions.pod:3243 ../src/guestfs-actions.pod:3263 ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:3459 ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3602 ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3665 ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:3716 ../src/guestfs-actions.pod:3735 ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:3782 ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3834 ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3972 ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4005 ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:4108 ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4153 ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4188 ../src/guestfs-actions.pod:4234 ../src/guestfs-actions.pod:4307 ../src/guestfs-actions.pod:4338 ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4388 ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:4433 ../src/guestfs-actions.pod:4448 ../src/guestfs-actions.pod:4483 ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4532 ../src/guestfs-actions.pod:4549 ../src/guestfs-actions.pod:4598 ../src/guestfs-actions.pod:4644 ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4686 ../src/guestfs-actions.pod:4703 ../src/guestfs-actions.pod:4721 ../src/guestfs-actions.pod:4855 ../src/guestfs-actions.pod:4912 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5050 ../src/guestfs-actions.pod:5067 ../src/guestfs-actions.pod:5080 ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5416 ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5442 ../src/guestfs-actions.pod:5454 ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5505 ../src/guestfs-actions.pod:5524 ../src/guestfs-actions.pod:5543 ../src/guestfs-actions.pod:5561 ../src/guestfs-actions.pod:5584 ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5621 ../src/guestfs-actions.pod:5642 ../src/guestfs-actions.pod:5661 ../src/guestfs-actions.pod:5678 ../src/guestfs-actions.pod:5706 ../src/guestfs-actions.pod:5730 ../src/guestfs-actions.pod:5749 ../src/guestfs-actions.pod:5773 ../src/guestfs-actions.pod:5788 ../src/guestfs-actions.pod:5803 ../src/guestfs-actions.pod:5822 ../src/guestfs-actions.pod:5859 ../src/guestfs-actions.pod:5882 ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:6016 ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6149 ../src/guestfs-actions.pod:6162 ../src/guestfs-actions.pod:6175 ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6210 ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6251 ../src/guestfs-actions.pod:6310 ../src/guestfs-actions.pod:6327 ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6359 ../src/guestfs-actions.pod:6376 ../src/guestfs-actions.pod:6389 ../src/guestfs-actions.pod:6409 ../src/guestfs-actions.pod:6445 ../src/guestfs-actions.pod:6459 ../src/guestfs-actions.pod:6500 ../src/guestfs-actions.pod:6513 ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6565 ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6720 ../src/guestfs-actions.pod:6738 ../src/guestfs-actions.pod:6752 ../src/guestfs-actions.pod:6807 ../src/guestfs-actions.pod:6820 ../src/guestfs-actions.pod:6865 ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6952 ../src/guestfs-actions.pod:6978 ../src/guestfs-actions.pod:7044 ../src/guestfs-actions.pod:7063 ../src/guestfs-actions.pod:7092
5025 msgid "This function returns 0 on success or -1 on error."
5029 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261
5031 "This function is deprecated. In new code, use the "
5032 "L</guestfs_add_drive_opts> call instead."
5036 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1440 ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:4193 ../src/guestfs-actions.pod:6986 ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168 ../fish/guestfish-actions.pod:954 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:2822 ../fish/guestfish-actions.pod:4635 ../fish/guestfish-actions.pod:4732
5038 "Deprecated functions will not be removed from the API, but the fact that "
5039 "they are deprecated indicates that there are problems with correct use of "
5044 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1097 ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:3230 ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:4485 ../src/guestfs-actions.pod:5563 ../src/guestfs-actions.pod:5680 ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6900
5045 msgid "(Added in 0.3)"
5049 #: ../src/guestfs-actions.pod:41
5050 msgid "guestfs_add_domain"
5054 #: ../src/guestfs-actions.pod:43
5058 " guestfs_add_domain (guestfs_h *g,\n"
5059 " const char *dom,\n"
5065 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137 ../src/guestfs-actions.pod:4207
5067 "You may supply a list of optional arguments to this call. Use zero or more "
5068 "of the following pairs of parameters, and terminate the list with C<-1> on "
5069 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5073 #: ../src/guestfs-actions.pod:53
5076 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5077 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5078 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5083 #: ../src/guestfs-actions.pod:57
5085 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5086 "It works by connecting to libvirt, requesting the domain and domain XML from "
5087 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5092 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5094 "The number of disks added is returned. This operation is atomic: if an "
5095 "error is returned, then no disks are added."
5099 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5101 "This function does some minimal checks to make sure the libvirt domain is "
5102 "not running (unless C<readonly> is true). In a future version we will try "
5103 "to acquire the libvirt lock on each disk."
5107 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5109 "Disks must be accessible locally. This often means that adding disks from a "
5110 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5111 "unless those disks are accessible via the same device path locally too."
5115 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5117 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5118 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5119 "default libvirt URI (or one set through an environment variable, see the "
5120 "libvirt documentation for full details)."
5124 #: ../src/guestfs-actions.pod:80
5126 "The other optional parameters are passed directly through to "
5127 "C<guestfs_add_drive_opts>."
5131 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:506 ../src/guestfs-actions.pod:684 ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:733 ../src/guestfs-actions.pod:752 ../src/guestfs-actions.pod:1312 ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4758 ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5190 ../src/guestfs-actions.pod:6486 ../src/guestfs-actions.pod:6911 ../src/guestfs-actions.pod:6924 ../src/guestfs-actions.pod:6937
5132 msgid "On error this function returns -1."
5136 #: ../src/guestfs-actions.pod:85
5137 msgid "(Added in 1.7.4)"
5141 #: ../src/guestfs-actions.pod:87
5142 msgid "guestfs_add_domain_va"
5146 #: ../src/guestfs-actions.pod:89
5150 " guestfs_add_domain_va (guestfs_h *g,\n"
5151 " const char *dom,\n"
5157 #: ../src/guestfs-actions.pod:94
5158 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5162 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:4248 ../src/guestfs-actions.pod:4260
5163 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5167 #: ../src/guestfs-actions.pod:98
5168 msgid "guestfs_add_domain_argv"
5172 #: ../src/guestfs-actions.pod:100
5176 " guestfs_add_domain_argv (guestfs_h *g,\n"
5177 " const char *dom,\n"
5178 " const struct guestfs_add_domain_argv *optargs);\n"
5183 #: ../src/guestfs-actions.pod:105
5184 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5188 #: ../src/guestfs-actions.pod:109
5189 msgid "guestfs_add_drive"
5193 #: ../src/guestfs-actions.pod:111
5197 " guestfs_add_drive (guestfs_h *g,\n"
5198 " const char *filename);\n"
5203 #: ../src/guestfs-actions.pod:115
5205 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5206 "optional parameters, so the disk is added writable, with the format being "
5207 "detected automatically."
5211 #: ../src/guestfs-actions.pod:119
5213 "Automatic detection of the format opens you up to a potential security hole "
5214 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5215 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5216 "you should think about replacing calls to this function with calls to "
5217 "C<guestfs_add_drive_opts>, and specifying the format."
5221 #: ../src/guestfs-actions.pod:130
5222 msgid "guestfs_add_drive_opts"
5226 #: ../src/guestfs-actions.pod:132
5230 " guestfs_add_drive_opts (guestfs_h *g,\n"
5231 " const char *filename,\n"
5237 #: ../src/guestfs-actions.pod:142
5240 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5241 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5242 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5247 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
5249 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5250 "The first time you call this function, the disk appears as C</dev/sda>, the "
5251 "second time as C</dev/sdb>, and so on."
5255 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
5257 "You don't necessarily need to be root when using libguestfs. However you "
5258 "obviously do need sufficient permissions to access the filename for whatever "
5259 "operations you want to perform (ie. read access if you just want to read the "
5260 "image or write access if you want to modify the image)."
5264 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
5265 msgid "This call checks that C<filename> exists."
5269 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4217 ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2833
5270 msgid "The optional arguments are:"
5274 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
5279 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
5281 "If true then the image is treated as read-only. Writes are still allowed, "
5282 "but they are stored in a temporary snapshot overlay which is discarded at "
5283 "the end. The disk that you add is not modified."
5287 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
5292 #: ../src/guestfs-actions.pod:171
5294 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5295 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5296 "Possible formats include C<raw> and C<qcow2>."
5300 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
5302 "Automatic detection of the format opens you up to a potential security hole "
5303 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5304 "RHBZ#642934. Specifying the format closes this security hole."
5308 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
5313 #: ../src/guestfs-actions.pod:182
5315 "This rarely-used option lets you emulate the behaviour of the deprecated "
5316 "C<guestfs_add_drive_with_if> call (q.v.)"
5320 #: ../src/guestfs-actions.pod:189
5321 msgid "(Added in 1.5.23)"
5325 #: ../src/guestfs-actions.pod:191
5326 msgid "guestfs_add_drive_opts_va"
5330 #: ../src/guestfs-actions.pod:193
5334 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5335 " const char *filename,\n"
5341 #: ../src/guestfs-actions.pod:198
5342 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5346 #: ../src/guestfs-actions.pod:202
5347 msgid "guestfs_add_drive_opts_argv"
5351 #: ../src/guestfs-actions.pod:204
5355 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5356 " const char *filename,\n"
5357 " const struct guestfs_add_drive_opts_argv "
5363 #: ../src/guestfs-actions.pod:209
5364 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5368 #: ../src/guestfs-actions.pod:213
5369 msgid "guestfs_add_drive_ro"
5373 #: ../src/guestfs-actions.pod:215
5377 " guestfs_add_drive_ro (guestfs_h *g,\n"
5378 " const char *filename);\n"
5383 #: ../src/guestfs-actions.pod:219
5385 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5386 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5387 "disk is added read-only, with the format being detected automatically."
5391 #: ../src/guestfs-actions.pod:226
5392 msgid "(Added in 1.0.38)"
5396 #: ../src/guestfs-actions.pod:228
5397 msgid "guestfs_add_drive_ro_with_if"
5401 #: ../src/guestfs-actions.pod:230
5405 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
5406 " const char *filename,\n"
5407 " const char *iface);\n"
5412 #: ../src/guestfs-actions.pod:235
5414 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
5415 "QEMU interface emulation to use at run time."
5419 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2335
5420 msgid "(Added in 1.0.84)"
5424 #: ../src/guestfs-actions.pod:249
5425 msgid "guestfs_add_drive_with_if"
5429 #: ../src/guestfs-actions.pod:251
5433 " guestfs_add_drive_with_if (guestfs_h *g,\n"
5434 " const char *filename,\n"
5435 " const char *iface);\n"
5440 #: ../src/guestfs-actions.pod:256
5442 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
5443 "QEMU interface emulation to use at run time."
5447 #: ../src/guestfs-actions.pod:270
5448 msgid "guestfs_aug_clear"
5452 #: ../src/guestfs-actions.pod:272
5456 " guestfs_aug_clear (guestfs_h *g,\n"
5457 " const char *augpath);\n"
5462 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
5464 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5465 "L<augtool(1)> C<clear> command."
5469 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2085
5470 msgid "(Added in 1.3.4)"
5474 #: ../src/guestfs-actions.pod:283
5475 msgid "guestfs_aug_close"
5479 #: ../src/guestfs-actions.pod:285
5483 " guestfs_aug_close (guestfs_h *g);\n"
5488 #: ../src/guestfs-actions.pod:288
5490 "Close the current Augeas handle and free up any resources used by it. After "
5491 "calling this, you have to call C<guestfs_aug_init> again before you can use "
5492 "any other Augeas functions."
5496 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:415 ../src/guestfs-actions.pod:435 ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:480 ../src/guestfs-actions.pod:494 ../src/guestfs-actions.pod:508 ../src/guestfs-actions.pod:522 ../src/guestfs-actions.pod:540 ../src/guestfs-actions.pod:5241
5497 msgid "(Added in 0.7)"
5501 #: ../src/guestfs-actions.pod:297
5502 msgid "guestfs_aug_defnode"
5506 #: ../src/guestfs-actions.pod:299
5509 " struct guestfs_int_bool *\n"
5510 " guestfs_aug_defnode (guestfs_h *g,\n"
5511 " const char *name,\n"
5512 " const char *expr,\n"
5513 " const char *val);\n"
5518 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
5519 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5523 #: ../src/guestfs-actions.pod:308
5525 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5526 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
5527 "containing that single node."
5531 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
5533 "On success this returns a pair containing the number of nodes in the "
5534 "nodeset, and a boolean flag if a node was created."
5538 #: ../src/guestfs-actions.pod:316
5540 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
5541 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
5545 #: ../src/guestfs-actions.pod:322
5546 msgid "guestfs_aug_defvar"
5550 #: ../src/guestfs-actions.pod:324
5554 " guestfs_aug_defvar (guestfs_h *g,\n"
5555 " const char *name,\n"
5556 " const char *expr);\n"
5561 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
5563 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5564 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5568 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
5570 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5571 "evaluates to something which is not a nodeset."
5575 #: ../src/guestfs-actions.pod:340
5576 msgid "guestfs_aug_get"
5580 #: ../src/guestfs-actions.pod:342
5584 " guestfs_aug_get (guestfs_h *g,\n"
5585 " const char *augpath);\n"
5590 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
5592 "Look up the value associated with C<path>. If C<path> matches exactly one "
5593 "node, the C<value> is returned."
5597 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:872 ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1051 ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:1217 ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938 ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2300 ../src/guestfs-actions.pod:2507 ../src/guestfs-actions.pod:2588 ../src/guestfs-actions.pod:2636 ../src/guestfs-actions.pod:2750 ../src/guestfs-actions.pod:2781 ../src/guestfs-actions.pod:2805 ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2890 ../src/guestfs-actions.pod:3404 ../src/guestfs-actions.pod:3754 ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4776 ../src/guestfs-actions.pod:4969 ../src/guestfs-actions.pod:5139 ../src/guestfs-actions.pod:5317 ../src/guestfs-actions.pod:5366 ../src/guestfs-actions.pod:5929 ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5962 ../src/guestfs-actions.pod:5986 ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6697 ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:7149
5599 "This function returns a string, or NULL on error. I<The caller must free "
5600 "the returned string after use>."
5604 #: ../src/guestfs-actions.pod:354
5605 msgid "guestfs_aug_init"
5609 #: ../src/guestfs-actions.pod:356
5613 " guestfs_aug_init (guestfs_h *g,\n"
5614 " const char *root,\n"
5620 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
5622 "Create a new Augeas handle for editing configuration files. If there was "
5623 "any previous Augeas handle associated with this guestfs session, then it is "
5628 #: ../src/guestfs-actions.pod:365
5629 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5633 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
5634 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5638 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
5640 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5641 "logical I<or> of the following integers:"
5645 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
5646 msgid "C<AUG_SAVE_BACKUP> = 1"
5650 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
5651 msgid "Keep the original file with a C<.augsave> extension."
5655 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
5656 msgid "C<AUG_SAVE_NEWFILE> = 2"
5660 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
5662 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5663 "original. Overrides C<AUG_SAVE_BACKUP>."
5667 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
5668 msgid "C<AUG_TYPE_CHECK> = 4"
5672 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
5673 msgid "Typecheck lenses."
5677 #: ../src/guestfs-actions.pod:390
5679 "This option is only useful when debugging Augeas lenses. Use of this option "
5680 "may require additional memory for the libguestfs appliance. You may need to "
5681 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
5682 "C<guestfs_set_memsize>."
5686 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:259
5687 msgid "C<AUG_NO_STDINC> = 8"
5691 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:261
5692 msgid "Do not use standard load path for modules."
5696 #: ../src/guestfs-actions.pod:399 ../fish/guestfish-actions.pod:263
5697 msgid "C<AUG_SAVE_NOOP> = 16"
5701 #: ../src/guestfs-actions.pod:401 ../fish/guestfish-actions.pod:265
5702 msgid "Make save a no-op, just record what would have been changed."
5706 #: ../src/guestfs-actions.pod:403 ../fish/guestfish-actions.pod:267
5707 msgid "C<AUG_NO_LOAD> = 32"
5711 #: ../src/guestfs-actions.pod:405
5712 msgid "Do not load the tree in C<guestfs_aug_init>."
5716 #: ../src/guestfs-actions.pod:409
5717 msgid "To close the handle, you can call C<guestfs_aug_close>."
5721 #: ../src/guestfs-actions.pod:411 ../fish/guestfish-actions.pod:275
5722 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5726 #: ../src/guestfs-actions.pod:417
5727 msgid "guestfs_aug_insert"
5731 #: ../src/guestfs-actions.pod:419
5735 " guestfs_aug_insert (guestfs_h *g,\n"
5736 " const char *augpath,\n"
5737 " const char *label,\n"
5743 #: ../src/guestfs-actions.pod:425 ../fish/guestfish-actions.pod:281
5745 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5746 "or after C<path> (depending on the boolean flag C<before>)."
5750 #: ../src/guestfs-actions.pod:429 ../fish/guestfish-actions.pod:285
5752 "C<path> must match exactly one existing node in the tree, and C<label> must "
5753 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5757 #: ../src/guestfs-actions.pod:437
5758 msgid "guestfs_aug_load"
5762 #: ../src/guestfs-actions.pod:439
5766 " guestfs_aug_load (guestfs_h *g);\n"
5771 #: ../src/guestfs-actions.pod:442 ../fish/guestfish-actions.pod:293
5772 msgid "Load files into the tree."
5776 #: ../src/guestfs-actions.pod:444 ../fish/guestfish-actions.pod:295
5777 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5781 #: ../src/guestfs-actions.pod:451
5782 msgid "guestfs_aug_ls"
5786 #: ../src/guestfs-actions.pod:453
5790 " guestfs_aug_ls (guestfs_h *g,\n"
5791 " const char *augpath);\n"
5796 #: ../src/guestfs-actions.pod:457
5798 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5799 "sorting the resulting nodes into alphabetical order."
5803 #: ../src/guestfs-actions.pod:460 ../src/guestfs-actions.pod:476 ../src/guestfs-actions.pod:622 ../src/guestfs-actions.pod:1070 ../src/guestfs-actions.pod:1361 ../src/guestfs-actions.pod:1380 ../src/guestfs-actions.pod:1483 ../src/guestfs-actions.pod:1502 ../src/guestfs-actions.pod:1748 ../src/guestfs-actions.pod:2180 ../src/guestfs-actions.pod:2196 ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:2282 ../src/guestfs-actions.pod:2353 ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2824 ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3324 ../src/guestfs-actions.pod:3386 ../src/guestfs-actions.pod:3491 ../src/guestfs-actions.pod:3896 ../src/guestfs-actions.pod:4582 ../src/guestfs-actions.pod:5111 ../src/guestfs-actions.pod:5237 ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:6002 ../src/guestfs-actions.pod:6063 ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6264 ../src/guestfs-actions.pod:6288 ../src/guestfs-actions.pod:6770 ../src/guestfs-actions.pod:6790 ../src/guestfs-actions.pod:6837 ../src/guestfs-actions.pod:7002 ../src/guestfs-actions.pod:7021 ../src/guestfs-actions.pod:7106 ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7171 ../src/guestfs-actions.pod:7190
5805 "This function returns a NULL-terminated array of strings (like "
5806 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
5807 "strings and the array after use>."
5811 #: ../src/guestfs-actions.pod:464 ../src/guestfs-actions.pod:995 ../src/guestfs-actions.pod:1013 ../src/guestfs-actions.pod:1418 ../src/guestfs-actions.pod:3117 ../src/guestfs-actions.pod:3148 ../src/guestfs-actions.pod:3737 ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:3974 ../src/guestfs-actions.pod:4007 ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:5430 ../src/guestfs-actions.pod:5444 ../src/guestfs-actions.pod:5456 ../src/guestfs-actions.pod:5864 ../src/guestfs-actions.pod:6502 ../src/guestfs-actions.pod:6515 ../src/guestfs-actions.pod:6754 ../src/guestfs-actions.pod:6990
5812 msgid "(Added in 0.8)"
5816 #: ../src/guestfs-actions.pod:466
5817 msgid "guestfs_aug_match"
5821 #: ../src/guestfs-actions.pod:468
5825 " guestfs_aug_match (guestfs_h *g,\n"
5826 " const char *augpath);\n"
5831 #: ../src/guestfs-actions.pod:472 ../fish/guestfish-actions.pod:309
5833 "Returns a list of paths which match the path expression C<path>. The "
5834 "returned paths are sufficiently qualified so that they match exactly one "
5835 "node in the current tree."
5839 #: ../src/guestfs-actions.pod:482
5840 msgid "guestfs_aug_mv"
5844 #: ../src/guestfs-actions.pod:484
5848 " guestfs_aug_mv (guestfs_h *g,\n"
5849 " const char *src,\n"
5850 " const char *dest);\n"
5855 #: ../src/guestfs-actions.pod:489 ../fish/guestfish-actions.pod:317
5857 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5858 "C<dest> is overwritten if it exists."
5862 #: ../src/guestfs-actions.pod:496
5863 msgid "guestfs_aug_rm"
5867 #: ../src/guestfs-actions.pod:498
5871 " guestfs_aug_rm (guestfs_h *g,\n"
5872 " const char *augpath);\n"
5877 #: ../src/guestfs-actions.pod:502 ../fish/guestfish-actions.pod:324
5878 msgid "Remove C<path> and all of its children."
5882 #: ../src/guestfs-actions.pod:504 ../fish/guestfish-actions.pod:326
5883 msgid "On success this returns the number of entries which were removed."
5887 #: ../src/guestfs-actions.pod:510
5888 msgid "guestfs_aug_save"
5892 #: ../src/guestfs-actions.pod:512
5896 " guestfs_aug_save (guestfs_h *g);\n"
5901 #: ../src/guestfs-actions.pod:515 ../fish/guestfish-actions.pod:332
5902 msgid "This writes all pending changes to disk."
5906 #: ../src/guestfs-actions.pod:517
5908 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5913 #: ../src/guestfs-actions.pod:524
5914 msgid "guestfs_aug_set"
5918 #: ../src/guestfs-actions.pod:526
5922 " guestfs_aug_set (guestfs_h *g,\n"
5923 " const char *augpath,\n"
5924 " const char *val);\n"
5929 #: ../src/guestfs-actions.pod:531 ../fish/guestfish-actions.pod:341
5930 msgid "Set the value associated with C<path> to C<val>."
5934 #: ../src/guestfs-actions.pod:533
5936 "In the Augeas API, it is possible to clear a node by setting the value to "
5937 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5938 "this call. Instead you must use the C<guestfs_aug_clear> call."
5942 #: ../src/guestfs-actions.pod:542
5943 msgid "guestfs_available"
5947 #: ../src/guestfs-actions.pod:544
5951 " guestfs_available (guestfs_h *g,\n"
5952 " char *const *groups);\n"
5957 #: ../src/guestfs-actions.pod:548 ../fish/guestfish-actions.pod:352
5959 "This command is used to check the availability of some groups of "
5960 "functionality in the appliance, which not all builds of the libguestfs "
5961 "appliance will be able to provide."
5965 #: ../src/guestfs-actions.pod:552
5967 "The libguestfs groups, and the functions that those groups correspond to, "
5968 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5969 "runtime by calling C<guestfs_available_all_groups>."
5973 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
5975 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5976 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5977 "and Augeas (configuration file editing) functions."
5981 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
5982 msgid "The command returns no error if I<all> requested groups are available."
5986 #: ../src/guestfs-actions.pod:564 ../fish/guestfish-actions.pod:368
5988 "It fails with an error if one or more of the requested groups is unavailable "
5993 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:371
5995 "If an unknown group name is included in the list of groups then an error is "
6000 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:374
6005 #: ../src/guestfs-actions.pod:576
6006 msgid "You must call C<guestfs_launch> before calling this function."
6010 #: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:382
6012 "The reason is because we don't know what groups are supported by the "
6013 "appliance/daemon until it is running and can be queried."
6017 #: ../src/guestfs-actions.pod:584 ../fish/guestfish-actions.pod:388
6019 "If a group of functions is available, this does not necessarily mean that "
6020 "they will work. You still have to check for errors when calling individual "
6021 "API functions even if they are available."
6025 #: ../src/guestfs-actions.pod:591 ../fish/guestfish-actions.pod:395
6027 "It is usually the job of distro packagers to build complete functionality "
6028 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6029 "with all requirements satisfied, will support everything."
6033 #: ../src/guestfs-actions.pod:598
6035 "This call was added in version C<1.0.80>. In previous versions of "
6036 "libguestfs all you could do would be to speculatively execute a command to "
6037 "find out if the daemon implemented it. See also C<guestfs_version>."
6041 #: ../src/guestfs-actions.pod:607 ../src/guestfs-actions.pod:1168
6042 msgid "(Added in 1.0.80)"
6046 #: ../src/guestfs-actions.pod:609
6047 msgid "guestfs_available_all_groups"
6051 #: ../src/guestfs-actions.pod:611
6055 " guestfs_available_all_groups (guestfs_h *g);\n"
6060 #: ../src/guestfs-actions.pod:614
6062 "This command returns a list of all optional groups that this daemon knows "
6063 "about. Note this returns both supported and unsupported groups. To find "
6064 "out which ones the daemon can actually support you have to call "
6065 "C<guestfs_available> on each member of the returned list."
6069 #: ../src/guestfs-actions.pod:620
6070 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6074 #: ../src/guestfs-actions.pod:626
6075 msgid "(Added in 1.3.15)"
6079 #: ../src/guestfs-actions.pod:628
6080 msgid "guestfs_base64_in"
6084 #: ../src/guestfs-actions.pod:630
6088 " guestfs_base64_in (guestfs_h *g,\n"
6089 " const char *base64file,\n"
6090 " const char *filename);\n"
6095 #: ../src/guestfs-actions.pod:635 ../fish/guestfish-actions.pod:425
6096 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6100 #: ../src/guestfs-actions.pod:640 ../src/guestfs-actions.pod:654
6101 msgid "(Added in 1.3.5)"
6105 #: ../src/guestfs-actions.pod:642
6106 msgid "guestfs_base64_out"
6110 #: ../src/guestfs-actions.pod:644
6114 " guestfs_base64_out (guestfs_h *g,\n"
6115 " const char *filename,\n"
6116 " const char *base64file);\n"
6121 #: ../src/guestfs-actions.pod:649 ../fish/guestfish-actions.pod:434
6123 "This command downloads the contents of C<filename>, writing it out to local "
6124 "file C<base64file> encoded as base64."
6128 #: ../src/guestfs-actions.pod:656
6129 msgid "guestfs_blockdev_flushbufs"
6133 #: ../src/guestfs-actions.pod:658
6137 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6138 " const char *device);\n"
6143 #: ../src/guestfs-actions.pod:662 ../fish/guestfish-actions.pod:443
6144 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6148 #: ../src/guestfs-actions.pod:665 ../src/guestfs-actions.pod:682 ../src/guestfs-actions.pod:697 ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:731 ../src/guestfs-actions.pod:750 ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:796 ../src/guestfs-actions.pod:810 ../fish/guestfish-actions.pod:446 ../fish/guestfish-actions.pod:457 ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:476 ../fish/guestfish-actions.pod:488 ../fish/guestfish-actions.pod:501 ../fish/guestfish-actions.pod:509 ../fish/guestfish-actions.pod:520 ../fish/guestfish-actions.pod:528 ../fish/guestfish-actions.pod:536
6149 msgid "This uses the L<blockdev(8)> command."
6153 #: ../src/guestfs-actions.pod:669 ../src/guestfs-actions.pod:686 ../src/guestfs-actions.pod:701 ../src/guestfs-actions.pod:717 ../src/guestfs-actions.pod:735 ../src/guestfs-actions.pod:754 ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:786 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:814
6154 msgid "(Added in 0.9.3)"
6158 #: ../src/guestfs-actions.pod:671
6159 msgid "guestfs_blockdev_getbsz"
6163 #: ../src/guestfs-actions.pod:673
6167 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6168 " const char *device);\n"
6173 #: ../src/guestfs-actions.pod:677 ../fish/guestfish-actions.pod:452
6174 msgid "This returns the block size of a device."
6178 #: ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:779 ../fish/guestfish-actions.pod:454 ../fish/guestfish-actions.pod:517
6180 "(Note this is different from both I<size in blocks> and I<filesystem block "
6185 #: ../src/guestfs-actions.pod:688
6186 msgid "guestfs_blockdev_getro"
6190 #: ../src/guestfs-actions.pod:690
6194 " guestfs_blockdev_getro (guestfs_h *g,\n"
6195 " const char *device);\n"
6200 #: ../src/guestfs-actions.pod:694 ../fish/guestfish-actions.pod:463
6202 "Returns a boolean indicating if the block device is read-only (true if "
6203 "read-only, false if not)."
6207 #: ../src/guestfs-actions.pod:699 ../src/guestfs-actions.pod:1401 ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3070 ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3099 ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3130 ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3160 ../src/guestfs-actions.pod:3173 ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:3202 ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:4740
6208 msgid "This function returns a C truth value on success or -1 on error."
6212 #: ../src/guestfs-actions.pod:703
6213 msgid "guestfs_blockdev_getsize64"
6217 #: ../src/guestfs-actions.pod:705
6221 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6222 " const char *device);\n"
6227 #: ../src/guestfs-actions.pod:709 ../fish/guestfish-actions.pod:472
6228 msgid "This returns the size of the device in bytes."
6232 #: ../src/guestfs-actions.pod:711
6233 msgid "See also C<guestfs_blockdev_getsz>."
6237 #: ../src/guestfs-actions.pod:719
6238 msgid "guestfs_blockdev_getss"
6242 #: ../src/guestfs-actions.pod:721
6246 " guestfs_blockdev_getss (guestfs_h *g,\n"
6247 " const char *device);\n"
6252 #: ../src/guestfs-actions.pod:725 ../fish/guestfish-actions.pod:482
6254 "This returns the size of sectors on a block device. Usually 512, but can be "
6255 "larger for modern devices."
6259 #: ../src/guestfs-actions.pod:728
6261 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6266 #: ../src/guestfs-actions.pod:737
6267 msgid "guestfs_blockdev_getsz"
6271 #: ../src/guestfs-actions.pod:739
6275 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6276 " const char *device);\n"
6281 #: ../src/guestfs-actions.pod:743 ../fish/guestfish-actions.pod:494
6283 "This returns the size of the device in units of 512-byte sectors (even if "
6284 "the sectorsize isn't 512 bytes ... weird)."
6288 #: ../src/guestfs-actions.pod:746
6290 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6291 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6295 #: ../src/guestfs-actions.pod:756
6296 msgid "guestfs_blockdev_rereadpt"
6300 #: ../src/guestfs-actions.pod:758
6304 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6305 " const char *device);\n"
6310 #: ../src/guestfs-actions.pod:762 ../fish/guestfish-actions.pod:507
6311 msgid "Reread the partition table on C<device>."
6315 #: ../src/guestfs-actions.pod:770
6316 msgid "guestfs_blockdev_setbsz"
6320 #: ../src/guestfs-actions.pod:772
6324 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6325 " const char *device,\n"
6326 " int blocksize);\n"
6331 #: ../src/guestfs-actions.pod:777 ../fish/guestfish-actions.pod:515
6332 msgid "This sets the block size of a device."
6336 #: ../src/guestfs-actions.pod:788
6337 msgid "guestfs_blockdev_setro"
6341 #: ../src/guestfs-actions.pod:790
6345 " guestfs_blockdev_setro (guestfs_h *g,\n"
6346 " const char *device);\n"
6351 #: ../src/guestfs-actions.pod:794 ../fish/guestfish-actions.pod:526
6352 msgid "Sets the block device named C<device> to read-only."
6356 #: ../src/guestfs-actions.pod:802
6357 msgid "guestfs_blockdev_setrw"
6361 #: ../src/guestfs-actions.pod:804
6365 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6366 " const char *device);\n"
6371 #: ../src/guestfs-actions.pod:808 ../fish/guestfish-actions.pod:534
6372 msgid "Sets the block device named C<device> to read-write."
6376 #: ../src/guestfs-actions.pod:816
6377 msgid "guestfs_case_sensitive_path"
6381 #: ../src/guestfs-actions.pod:818
6385 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6386 " const char *path);\n"
6391 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
6393 "This can be used to resolve case insensitive paths on a filesystem which is "
6394 "case sensitive. The use case is to resolve paths which you have read from "
6395 "Windows configuration files or the Windows Registry, to the true path."
6399 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
6401 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6402 "(and probably others), which is that although the underlying filesystem is "
6403 "case-insensitive, the driver exports the filesystem to Linux as "
6408 #: ../src/guestfs-actions.pod:832 ../fish/guestfish-actions.pod:552
6410 "One consequence of this is that special directories such as C<c:\\windows> "
6411 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6412 "precise details of how they were created. In Windows itself this would not "
6417 #: ../src/guestfs-actions.pod:838 ../fish/guestfish-actions.pod:558
6419 "Bug or feature? You decide: "
6420 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6424 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:561
6426 "This function resolves the true case of each element in the path and returns "
6427 "the case-sensitive path."
6431 #: ../src/guestfs-actions.pod:844
6433 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
6434 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6435 "how the directories were originally created under Windows)."
6439 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:569
6440 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6444 #: ../src/guestfs-actions.pod:852
6445 msgid "See also C<guestfs_realpath>."
6449 #: ../src/guestfs-actions.pod:857 ../src/guestfs-actions.pod:6682
6450 msgid "(Added in 1.0.75)"
6454 #: ../src/guestfs-actions.pod:859
6459 #: ../src/guestfs-actions.pod:861
6463 " guestfs_cat (guestfs_h *g,\n"
6464 " const char *path);\n"
6469 #: ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:578 ../fish/guestfish-actions.pod:3479
6470 msgid "Return the contents of the file named C<path>."
6474 #: ../src/guestfs-actions.pod:867
6476 "Note that this function cannot correctly handle binary files (specifically, "
6477 "files containing C<\\0> character which is treated as end of string). For "
6478 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
6479 "functions which have a more complex interface."
6483 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1384 ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1506 ../src/guestfs-actions.pod:1752 ../src/guestfs-actions.pod:2200 ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:2262 ../src/guestfs-actions.pod:2286 ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:2332 ../src/guestfs-actions.pod:5009 ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:5166 ../src/guestfs-actions.pod:5192 ../src/guestfs-actions.pod:5216 ../src/guestfs-actions.pod:6067 ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6268 ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6954 ../src/guestfs-actions.pod:6980 ../src/guestfs-actions.pod:7006 ../src/guestfs-actions.pod:7025 ../src/guestfs-actions.pod:7110 ../src/guestfs-actions.pod:7129 ../src/guestfs-actions.pod:7175 ../src/guestfs-actions.pod:7194 ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:720 ../fish/guestfish-actions.pod:732 ../fish/guestfish-actions.pod:908 ../fish/guestfish-actions.pod:918 ../fish/guestfish-actions.pod:985 ../fish/guestfish-actions.pod:995 ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1482 ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:1520 ../fish/guestfish-actions.pod:1535 ../fish/guestfish-actions.pod:1545 ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:3349 ../fish/guestfish-actions.pod:3364 ../fish/guestfish-actions.pod:3440 ../fish/guestfish-actions.pod:3457 ../fish/guestfish-actions.pod:3472 ../fish/guestfish-actions.pod:4055 ../fish/guestfish-actions.pod:4101 ../fish/guestfish-actions.pod:4186 ../fish/guestfish-actions.pod:4201 ../fish/guestfish-actions.pod:4611 ../fish/guestfish-actions.pod:4629 ../fish/guestfish-actions.pod:4646 ../fish/guestfish-actions.pod:4656 ../fish/guestfish-actions.pod:4704 ../fish/guestfish-actions.pod:4714 ../fish/guestfish-actions.pod:4743 ../fish/guestfish-actions.pod:4753
6485 "Because of the message protocol, there is a transfer limit of somewhere "
6486 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6490 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3390 ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3495 ../src/guestfs-actions.pod:3900 ../src/guestfs-actions.pod:3914 ../src/guestfs-actions.pod:5115 ../src/guestfs-actions.pod:5129 ../src/guestfs-actions.pod:6841 ../src/guestfs-actions.pod:6855
6491 msgid "(Added in 0.4)"
6495 #: ../src/guestfs-actions.pod:880
6496 msgid "guestfs_checksum"
6500 #: ../src/guestfs-actions.pod:882
6504 " guestfs_checksum (guestfs_h *g,\n"
6505 " const char *csumtype,\n"
6506 " const char *path);\n"
6511 #: ../src/guestfs-actions.pod:887 ../fish/guestfish-actions.pod:592
6512 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6516 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
6518 "The type of checksum to compute is given by the C<csumtype> parameter which "
6519 "must have one of the following values:"
6523 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
6528 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
6530 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6535 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:605
6540 #: ../src/guestfs-actions.pod:902 ../fish/guestfish-actions.pod:607
6541 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6545 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:609
6550 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:611
6551 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6555 #: ../src/guestfs-actions.pod:908 ../fish/guestfish-actions.pod:613
6560 #: ../src/guestfs-actions.pod:910 ../fish/guestfish-actions.pod:615
6561 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6565 #: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:617
6570 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:619
6571 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6575 #: ../src/guestfs-actions.pod:916 ../fish/guestfish-actions.pod:621
6580 #: ../src/guestfs-actions.pod:918 ../fish/guestfish-actions.pod:623
6581 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6585 #: ../src/guestfs-actions.pod:920 ../fish/guestfish-actions.pod:625
6590 #: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:627
6591 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6595 #: ../src/guestfs-actions.pod:926 ../fish/guestfish-actions.pod:631
6596 msgid "The checksum is returned as a printable string."
6600 #: ../src/guestfs-actions.pod:928
6601 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6605 #: ../src/guestfs-actions.pod:930
6606 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6610 #: ../src/guestfs-actions.pod:935 ../src/guestfs-actions.pod:1243 ../src/guestfs-actions.pod:2062 ../src/guestfs-actions.pod:3072 ../src/guestfs-actions.pod:3101 ../src/guestfs-actions.pod:3162 ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:6538
6611 msgid "(Added in 1.0.2)"
6615 #: ../src/guestfs-actions.pod:937
6616 msgid "guestfs_checksum_device"
6620 #: ../src/guestfs-actions.pod:939
6624 " guestfs_checksum_device (guestfs_h *g,\n"
6625 " const char *csumtype,\n"
6626 " const char *device);\n"
6631 #: ../src/guestfs-actions.pod:944
6633 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6634 "device named C<device>. For the types of checksums supported see the "
6635 "C<guestfs_checksum> command."
6639 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:4646 ../src/guestfs-actions.pod:4705 ../src/guestfs-actions.pod:4742 ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4936 ../src/guestfs-actions.pod:6447 ../src/guestfs-actions.pod:6461 ../src/guestfs-actions.pod:6867
6640 msgid "(Added in 1.3.2)"
6644 #: ../src/guestfs-actions.pod:953
6645 msgid "guestfs_checksums_out"
6649 #: ../src/guestfs-actions.pod:955
6653 " guestfs_checksums_out (guestfs_h *g,\n"
6654 " const char *csumtype,\n"
6655 " const char *directory,\n"
6656 " const char *sumsfile);\n"
6661 #: ../src/guestfs-actions.pod:961 ../fish/guestfish-actions.pod:649
6663 "This command computes the checksums of all regular files in C<directory> and "
6664 "then emits a list of those checksums to the local output file C<sumsfile>."
6668 #: ../src/guestfs-actions.pod:965 ../fish/guestfish-actions.pod:653
6670 "This can be used for verifying the integrity of a virtual machine. However "
6671 "to be properly secure you should pay attention to the output of the checksum "
6672 "command (it uses the ones from GNU coreutils). In particular when the "
6673 "filename is not printable, coreutils uses a special backslash syntax. For "
6674 "more information, see the GNU coreutils info file."
6678 #: ../src/guestfs-actions.pod:975
6679 msgid "(Added in 1.3.7)"
6683 #: ../src/guestfs-actions.pod:977
6684 msgid "guestfs_chmod"
6688 #: ../src/guestfs-actions.pod:979
6692 " guestfs_chmod (guestfs_h *g,\n"
6694 " const char *path);\n"
6699 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:667
6701 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6706 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:670
6708 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6709 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6714 #: ../src/guestfs-actions.pod:991 ../src/guestfs-actions.pod:4151 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4374 ../fish/guestfish-actions.pod:674 ../fish/guestfish-actions.pod:2797 ../fish/guestfish-actions.pod:2915 ../fish/guestfish-actions.pod:2925 ../fish/guestfish-actions.pod:2935
6715 msgid "The mode actually set is affected by the umask."
6719 #: ../src/guestfs-actions.pod:997
6720 msgid "guestfs_chown"
6724 #: ../src/guestfs-actions.pod:999
6728 " guestfs_chown (guestfs_h *g,\n"
6731 " const char *path);\n"
6736 #: ../src/guestfs-actions.pod:1005 ../fish/guestfish-actions.pod:680
6737 msgid "Change the file owner to C<owner> and group to C<group>."
6741 #: ../src/guestfs-actions.pod:1007 ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:682 ../fish/guestfish-actions.pod:2255
6743 "Only numeric uid and gid are supported. If you want to use names, you will "
6744 "need to locate and parse the password file yourself (Augeas support makes "
6745 "this relatively easy)."
6749 #: ../src/guestfs-actions.pod:1015
6750 msgid "guestfs_command"
6754 #: ../src/guestfs-actions.pod:1017
6758 " guestfs_command (guestfs_h *g,\n"
6759 " char *const *arguments);\n"
6764 #: ../src/guestfs-actions.pod:1021 ../fish/guestfish-actions.pod:690
6766 "This call runs a command from the guest filesystem. The filesystem must be "
6767 "mounted, and must contain a compatible operating system (ie. something "
6768 "Linux, with the same or compatible processor architecture)."
6772 #: ../src/guestfs-actions.pod:1026
6774 "The single parameter is an argv-style list of arguments. The first element "
6775 "is the name of the program to run. Subsequent elements are parameters. The "
6776 "list must be non-empty (ie. must contain a program name). Note that the "
6777 "command runs directly, and is I<not> invoked via the shell (see "
6782 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:702
6783 msgid "The return value is anything printed to I<stdout> by the command."
6787 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:705
6789 "If the command returns a non-zero exit status, then this function returns an "
6790 "error message. The error message string is the content of I<stderr> from "
6795 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
6797 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6798 "C</bin>. If you require a program from another location, you should provide "
6799 "the full path in the first parameter."
6803 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:714
6805 "Shared libraries and data files required by the program must be available on "
6806 "filesystems which are mounted in the correct places. It is the caller's "
6807 "responsibility to ensure all filesystems that are needed are mounted at the "
6812 #: ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:1077 ../src/guestfs-actions.pod:1537
6813 msgid "(Added in 0.9.1)"
6817 #: ../src/guestfs-actions.pod:1059
6818 msgid "guestfs_command_lines"
6822 #: ../src/guestfs-actions.pod:1061
6826 " guestfs_command_lines (guestfs_h *g,\n"
6827 " char *const *arguments);\n"
6832 #: ../src/guestfs-actions.pod:1065
6834 "This is the same as C<guestfs_command>, but splits the result into a list of "
6839 #: ../src/guestfs-actions.pod:1068
6840 msgid "See also: C<guestfs_sh_lines>"
6844 #: ../src/guestfs-actions.pod:1079
6845 msgid "guestfs_config"
6849 #: ../src/guestfs-actions.pod:1081
6853 " guestfs_config (guestfs_h *g,\n"
6854 " const char *qemuparam,\n"
6855 " const char *qemuvalue);\n"
6860 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
6862 "This can be used to add arbitrary qemu command line parameters of the form "
6863 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6864 "setting some parameters which would interfere with parameters that we use."
6868 #: ../src/guestfs-actions.pod:1091 ../fish/guestfish-actions.pod:744
6869 msgid "The first character of C<param> string must be a C<-> (dash)."
6873 #: ../src/guestfs-actions.pod:1093 ../fish/guestfish-actions.pod:746
6874 msgid "C<value> can be NULL."
6878 #: ../src/guestfs-actions.pod:1099
6879 msgid "guestfs_copy_size"
6883 #: ../src/guestfs-actions.pod:1101
6887 " guestfs_copy_size (guestfs_h *g,\n"
6888 " const char *src,\n"
6889 " const char *dest,\n"
6895 #: ../src/guestfs-actions.pod:1107 ../fish/guestfish-actions.pod:752
6897 "This command copies exactly C<size> bytes from one source device or file "
6898 "C<src> to another destination device or file C<dest>."
6902 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:755
6904 "Note this will fail if the source is too short or if the destination is not "
6909 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:6533 ../src/guestfs-actions.pod:6567 ../src/guestfs-actions.pod:7046 ../src/guestfs-actions.pod:7065
6911 "This long-running command can generate progress notification messages so "
6912 "that the caller can display a progress bar or indicator. To receive these "
6913 "messages, the caller must register a progress callback. See "
6914 "L<guestfs(3)/guestfs_set_progress_callback>."
6918 #: ../src/guestfs-actions.pod:1120 ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:5142 ../src/guestfs-actions.pod:6774 ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6880
6919 msgid "(Added in 1.0.87)"
6923 #: ../src/guestfs-actions.pod:1122
6928 #: ../src/guestfs-actions.pod:1124
6932 " guestfs_cp (guestfs_h *g,\n"
6933 " const char *src,\n"
6934 " const char *dest);\n"
6939 #: ../src/guestfs-actions.pod:1129 ../fish/guestfish-actions.pod:762
6941 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6942 "destination filename or destination directory."
6946 #: ../src/guestfs-actions.pod:1134 ../src/guestfs-actions.pod:1148 ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1294 ../src/guestfs-actions.pod:1403 ../src/guestfs-actions.pod:4600 ../src/guestfs-actions.pod:4986
6947 msgid "(Added in 1.0.18)"
6951 #: ../src/guestfs-actions.pod:1136
6952 msgid "guestfs_cp_a"
6956 #: ../src/guestfs-actions.pod:1138
6960 " guestfs_cp_a (guestfs_h *g,\n"
6961 " const char *src,\n"
6962 " const char *dest);\n"
6967 #: ../src/guestfs-actions.pod:1143 ../fish/guestfish-actions.pod:769
6969 "This copies a file or directory from C<src> to C<dest> recursively using the "
6974 #: ../src/guestfs-actions.pod:1150
6979 #: ../src/guestfs-actions.pod:1152
6983 " guestfs_dd (guestfs_h *g,\n"
6984 " const char *src,\n"
6985 " const char *dest);\n"
6990 #: ../src/guestfs-actions.pod:1157 ../fish/guestfish-actions.pod:776
6992 "This command copies from one source device or file C<src> to another "
6993 "destination device or file C<dest>. Normally you would use this to copy to "
6994 "or from a device or partition, for example to duplicate a filesystem."
6998 #: ../src/guestfs-actions.pod:1162
7000 "If the destination is a device, it must be as large or larger than the "
7001 "source file or device, otherwise the copy will fail. This command cannot do "
7002 "partial copies (see C<guestfs_copy_size>)."
7006 #: ../src/guestfs-actions.pod:1170
7011 #: ../src/guestfs-actions.pod:1172
7015 " guestfs_df (guestfs_h *g);\n"
7020 #: ../src/guestfs-actions.pod:1175 ../fish/guestfish-actions.pod:789
7021 msgid "This command runs the C<df> command to report disk space used."
7025 #: ../src/guestfs-actions.pod:1177 ../src/guestfs-actions.pod:1194
7027 "This command is mostly useful for interactive sessions. It is I<not> "
7028 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7033 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201 ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:2265 ../src/guestfs-actions.pod:2289 ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:4037 ../src/guestfs-actions.pod:4500 ../src/guestfs-actions.pod:6271 ../src/guestfs-actions.pod:6295 ../src/guestfs-actions.pod:6913 ../src/guestfs-actions.pod:6926 ../src/guestfs-actions.pod:6939
7034 msgid "(Added in 1.0.54)"
7038 #: ../src/guestfs-actions.pod:1186
7039 msgid "guestfs_df_h"
7043 #: ../src/guestfs-actions.pod:1188
7047 " guestfs_df_h (guestfs_h *g);\n"
7052 #: ../src/guestfs-actions.pod:1191 ../fish/guestfish-actions.pod:799
7054 "This command runs the C<df -h> command to report disk space used in "
7055 "human-readable format."
7059 #: ../src/guestfs-actions.pod:1203
7060 msgid "guestfs_dmesg"
7064 #: ../src/guestfs-actions.pod:1205
7068 " guestfs_dmesg (guestfs_h *g);\n"
7073 #: ../src/guestfs-actions.pod:1208 ../fish/guestfish-actions.pod:810
7075 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7076 "This is sometimes useful for extended debugging of problems."
7080 #: ../src/guestfs-actions.pod:1212
7082 "Another way to get the same information is to enable verbose messages with "
7083 "C<guestfs_set_verbose> or by setting the environment variable "
7084 "C<LIBGUESTFS_DEBUG=1> before running the program."
7088 #: ../src/guestfs-actions.pod:1222
7089 msgid "guestfs_download"
7093 #: ../src/guestfs-actions.pod:1224
7097 " guestfs_download (guestfs_h *g,\n"
7098 " const char *remotefilename,\n"
7099 " const char *filename);\n"
7104 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1254 ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:836
7106 "Download file C<remotefilename> and save it as C<filename> on the local "
7111 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:6527 ../fish/guestfish-actions.pod:826 ../fish/guestfish-actions.pod:4359
7112 msgid "C<filename> can also be a named pipe."
7116 #: ../src/guestfs-actions.pod:1234
7117 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7121 #: ../src/guestfs-actions.pod:1245
7122 msgid "guestfs_download_offset"
7126 #: ../src/guestfs-actions.pod:1247
7130 " guestfs_download_offset (guestfs_h *g,\n"
7131 " const char *remotefilename,\n"
7132 " const char *filename,\n"
7133 " int64_t offset,\n"
7139 #: ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:839
7141 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7142 "region must be within the file or device)."
7146 #: ../src/guestfs-actions.pod:1260
7148 "Note that there is no limit on the amount of data that can be downloaded "
7149 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7150 "full amount unless an error occurs."
7154 #: ../src/guestfs-actions.pod:1265
7155 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7159 #: ../src/guestfs-actions.pod:1274 ../src/guestfs-actions.pod:6572
7160 msgid "(Added in 1.5.17)"
7164 #: ../src/guestfs-actions.pod:1276
7165 msgid "guestfs_drop_caches"
7169 #: ../src/guestfs-actions.pod:1278
7173 " guestfs_drop_caches (guestfs_h *g,\n"
7174 " int whattodrop);\n"
7179 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
7181 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7182 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7183 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7187 #: ../src/guestfs-actions.pod:1287 ../fish/guestfish-actions.pod:860
7188 msgid "Setting C<whattodrop> to 3 should drop everything."
7192 #: ../src/guestfs-actions.pod:1289 ../fish/guestfish-actions.pod:862
7194 "This automatically calls L<sync(2)> before the operation, so that the "
7195 "maximum guest memory is freed."
7199 #: ../src/guestfs-actions.pod:1296
7204 #: ../src/guestfs-actions.pod:1298
7208 " guestfs_du (guestfs_h *g,\n"
7209 " const char *path);\n"
7214 #: ../src/guestfs-actions.pod:1302 ../fish/guestfish-actions.pod:869
7216 "This command runs the C<du -s> command to estimate file space usage for "
7221 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:872
7223 "C<path> can be a file or a directory. If C<path> is a directory then the "
7224 "estimate includes the contents of the directory and all subdirectories "
7229 #: ../src/guestfs-actions.pod:1309 ../fish/guestfish-actions.pod:876
7230 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7234 #: ../src/guestfs-actions.pod:1316
7235 msgid "guestfs_e2fsck_f"
7239 #: ../src/guestfs-actions.pod:1318
7243 " guestfs_e2fsck_f (guestfs_h *g,\n"
7244 " const char *device);\n"
7249 #: ../src/guestfs-actions.pod:1322 ../fish/guestfish-actions.pod:883
7251 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7252 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7257 #: ../src/guestfs-actions.pod:1326
7259 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7260 "Normally you should use C<guestfs_fsck>."
7264 #: ../src/guestfs-actions.pod:1331
7265 msgid "(Added in 1.0.29)"
7269 #: ../src/guestfs-actions.pod:1333
7270 msgid "guestfs_echo_daemon"
7274 #: ../src/guestfs-actions.pod:1335
7278 " guestfs_echo_daemon (guestfs_h *g,\n"
7279 " char *const *words);\n"
7284 #: ../src/guestfs-actions.pod:1339 ../fish/guestfish-actions.pod:894
7286 "This command concatenates the list of C<words> passed with single spaces "
7287 "between them and returns the resulting string."
7291 #: ../src/guestfs-actions.pod:1342 ../fish/guestfish-actions.pod:897
7292 msgid "You can use this command to test the connection through to the daemon."
7296 #: ../src/guestfs-actions.pod:1344
7297 msgid "See also C<guestfs_ping_daemon>."
7301 #: ../src/guestfs-actions.pod:1349 ../src/guestfs-actions.pod:2073 ../src/guestfs-actions.pod:5775
7302 msgid "(Added in 1.0.69)"
7306 #: ../src/guestfs-actions.pod:1351
7307 msgid "guestfs_egrep"
7311 #: ../src/guestfs-actions.pod:1353
7315 " guestfs_egrep (guestfs_h *g,\n"
7316 " const char *regex,\n"
7317 " const char *path);\n"
7322 #: ../src/guestfs-actions.pod:1358 ../fish/guestfish-actions.pod:905
7323 msgid "This calls the external C<egrep> program and returns the matching lines."
7327 #: ../src/guestfs-actions.pod:1368 ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:1444 ../src/guestfs-actions.pod:1490 ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:2203 ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2378 ../src/guestfs-actions.pod:2391 ../src/guestfs-actions.pod:2406 ../src/guestfs-actions.pod:2452 ../src/guestfs-actions.pod:2474 ../src/guestfs-actions.pod:2487 ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3447 ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:4435 ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:5369 ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6151 ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6177 ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:6212 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6238 ../src/guestfs-actions.pod:7009 ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7113 ../src/guestfs-actions.pod:7132 ../src/guestfs-actions.pod:7178 ../src/guestfs-actions.pod:7197
7328 msgid "(Added in 1.0.66)"
7332 #: ../src/guestfs-actions.pod:1370
7333 msgid "guestfs_egrepi"
7337 #: ../src/guestfs-actions.pod:1372
7341 " guestfs_egrepi (guestfs_h *g,\n"
7342 " const char *regex,\n"
7343 " const char *path);\n"
7348 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:915
7349 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7353 #: ../src/guestfs-actions.pod:1389
7354 msgid "guestfs_equal"
7358 #: ../src/guestfs-actions.pod:1391
7362 " guestfs_equal (guestfs_h *g,\n"
7363 " const char *file1,\n"
7364 " const char *file2);\n"
7369 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:925
7371 "This compares the two files C<file1> and C<file2> and returns true if their "
7372 "content is exactly equal, or false otherwise."
7376 #: ../src/guestfs-actions.pod:1399 ../fish/guestfish-actions.pod:928
7377 msgid "The external L<cmp(1)> program is used for the comparison."
7381 #: ../src/guestfs-actions.pod:1405
7382 msgid "guestfs_exists"
7386 #: ../src/guestfs-actions.pod:1407
7390 " guestfs_exists (guestfs_h *g,\n"
7391 " const char *path);\n"
7396 #: ../src/guestfs-actions.pod:1411 ../fish/guestfish-actions.pod:934
7398 "This returns C<true> if and only if there is a file, directory (or anything) "
7399 "with the given C<path> name."
7403 #: ../src/guestfs-actions.pod:1414
7404 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7408 #: ../src/guestfs-actions.pod:1420
7409 msgid "guestfs_fallocate"
7413 #: ../src/guestfs-actions.pod:1422
7417 " guestfs_fallocate (guestfs_h *g,\n"
7418 " const char *path,\n"
7424 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:1453 ../fish/guestfish-actions.pod:943 ../fish/guestfish-actions.pod:962
7426 "This command preallocates a file (containing zero bytes) named C<path> of "
7427 "size C<len> bytes. If the file exists already, it is overwritten."
7431 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:947
7433 "Do not confuse this with the guestfish-specific C<alloc> command which "
7434 "allocates a file in the host and attaches it as a device."
7438 #: ../src/guestfs-actions.pod:1437
7440 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
7445 #: ../src/guestfs-actions.pod:1446
7446 msgid "guestfs_fallocate64"
7450 #: ../src/guestfs-actions.pod:1448
7454 " guestfs_fallocate64 (guestfs_h *g,\n"
7455 " const char *path,\n"
7461 #: ../src/guestfs-actions.pod:1457
7463 "Note that this call allocates disk blocks for the file. To create a sparse "
7464 "file use C<guestfs_truncate_size> instead."
7468 #: ../src/guestfs-actions.pod:1460
7470 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
7471 "oversight it only allowed 30 bit lengths to be specified, effectively "
7472 "limiting the maximum size of files created through that call to 1GB."
7476 #: ../src/guestfs-actions.pod:1465 ../fish/guestfish-actions.pod:974
7478 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7479 "commands which create a file in the host and attach it as a device."
7483 #: ../src/guestfs-actions.pod:1471
7484 msgid "(Added in 1.3.17)"
7488 #: ../src/guestfs-actions.pod:1473
7489 msgid "guestfs_fgrep"
7493 #: ../src/guestfs-actions.pod:1475
7497 " guestfs_fgrep (guestfs_h *g,\n"
7498 " const char *pattern,\n"
7499 " const char *path);\n"
7504 #: ../src/guestfs-actions.pod:1480 ../fish/guestfish-actions.pod:982
7505 msgid "This calls the external C<fgrep> program and returns the matching lines."
7509 #: ../src/guestfs-actions.pod:1492
7510 msgid "guestfs_fgrepi"
7514 #: ../src/guestfs-actions.pod:1494
7518 " guestfs_fgrepi (guestfs_h *g,\n"
7519 " const char *pattern,\n"
7520 " const char *path);\n"
7525 #: ../src/guestfs-actions.pod:1499 ../fish/guestfish-actions.pod:992
7526 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7530 #: ../src/guestfs-actions.pod:1511
7531 msgid "guestfs_file"
7535 #: ../src/guestfs-actions.pod:1513
7539 " guestfs_file (guestfs_h *g,\n"
7540 " const char *path);\n"
7545 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1002
7547 "This call uses the standard L<file(1)> command to determine the type or "
7548 "contents of the file."
7552 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1005
7554 "This call will also transparently look inside various types of compressed "
7559 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1008
7561 "The exact command which runs is C<file -zb path>. Note in particular that "
7562 "the filename is not prepended to the output (the C<-b> option)."
7566 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1012
7568 "The output depends on the output of the underlying L<file(1)> command and it "
7569 "can change in future in ways beyond our control. In other words, the output "
7570 "is not guaranteed by the ABI."
7574 #: ../src/guestfs-actions.pod:1531
7576 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
7577 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
7581 #: ../src/guestfs-actions.pod:1539
7582 msgid "guestfs_file_architecture"
7586 #: ../src/guestfs-actions.pod:1541
7590 " guestfs_file_architecture (guestfs_h *g,\n"
7591 " const char *filename);\n"
7596 #: ../src/guestfs-actions.pod:1545 ../fish/guestfish-actions.pod:1023
7598 "This detects the architecture of the binary C<filename>, and returns it if "
7603 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1026
7604 msgid "Currently defined architectures are:"
7608 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7613 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
7615 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7616 "irrespective of the precise processor requirements of the binary."
7620 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
7625 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
7626 msgid "64 bit x86-64."
7630 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
7635 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
7636 msgid "32 bit SPARC."
7640 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
7645 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
7646 msgid "64 bit SPARC V9 and above."
7650 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
7655 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
7656 msgid "Intel Itanium."
7660 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
7665 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
7666 msgid "32 bit Power PC."
7670 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
7675 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1057
7676 msgid "64 bit Power PC."
7680 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
7681 msgid "Libguestfs may return other architecture strings in future."
7685 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1063
7686 msgid "The function works on at least the following types of files:"
7690 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1069
7691 msgid "many types of Un*x and Linux binary"
7695 #: ../src/guestfs-actions.pod:1595 ../fish/guestfish-actions.pod:1073
7696 msgid "many types of Un*x and Linux shared library"
7700 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1077
7701 msgid "Windows Win32 and Win64 binaries"
7705 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
7706 msgid "Windows Win32 and Win64 DLLs"
7710 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
7711 msgid "Win32 binaries and DLLs return C<i386>."
7715 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1085
7716 msgid "Win64 binaries and DLLs return C<x86_64>."
7720 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1089
7721 msgid "Linux kernel modules"
7725 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1093
7726 msgid "Linux new-style initrd images"
7730 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1097
7731 msgid "some non-x86 Linux vmlinuz kernels"
7735 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1101
7736 msgid "What it can't do currently:"
7740 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1107
7741 msgid "static libraries (libfoo.a)"
7745 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1111
7746 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7750 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
7751 msgid "x86 Linux vmlinuz kernels"
7755 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1117
7757 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7758 "compressed code, and are horribly hard to unpack. If you want to find the "
7759 "architecture of a kernel, use the architecture of the associated initrd or "
7760 "kernel module(s) instead."
7764 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1812 ../src/guestfs-actions.pod:1829 ../src/guestfs-actions.pod:2510 ../src/guestfs-actions.pod:2591 ../src/guestfs-actions.pod:2617 ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2687 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2808 ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:3043 ../src/guestfs-actions.pod:3175
7765 msgid "(Added in 1.5.3)"
7769 #: ../src/guestfs-actions.pod:1651
7770 msgid "guestfs_filesize"
7774 #: ../src/guestfs-actions.pod:1653
7778 " guestfs_filesize (guestfs_h *g,\n"
7779 " const char *file);\n"
7784 #: ../src/guestfs-actions.pod:1657 ../fish/guestfish-actions.pod:1128
7785 msgid "This command returns the size of C<file> in bytes."
7789 #: ../src/guestfs-actions.pod:1659
7791 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7792 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7793 "devices, use C<guestfs_blockdev_getsize64>."
7797 #: ../src/guestfs-actions.pod:1665
7798 msgid "(Added in 1.0.82)"
7802 #: ../src/guestfs-actions.pod:1667
7803 msgid "guestfs_fill"
7807 #: ../src/guestfs-actions.pod:1669
7811 " guestfs_fill (guestfs_h *g,\n"
7814 " const char *path);\n"
7819 #: ../src/guestfs-actions.pod:1675 ../fish/guestfish-actions.pod:1138
7821 "This command creates a new file called C<path>. The initial content of the "
7822 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7827 #: ../src/guestfs-actions.pod:1679
7829 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7830 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7831 "bytes use C<guestfs_fill_pattern>."
7835 #: ../src/guestfs-actions.pod:1691
7836 msgid "(Added in 1.0.79)"
7840 #: ../src/guestfs-actions.pod:1693
7841 msgid "guestfs_fill_pattern"
7845 #: ../src/guestfs-actions.pod:1695
7849 " guestfs_fill_pattern (guestfs_h *g,\n"
7850 " const char *pattern,\n"
7852 " const char *path);\n"
7857 #: ../src/guestfs-actions.pod:1701
7859 "This function is like C<guestfs_fill> except that it creates a new file of "
7860 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7861 "pattern is truncated if necessary to ensure the length of the file is "
7862 "exactly C<len> bytes."
7866 #: ../src/guestfs-actions.pod:1713
7867 msgid "(Added in 1.3.12)"
7871 #: ../src/guestfs-actions.pod:1715
7872 msgid "guestfs_find"
7876 #: ../src/guestfs-actions.pod:1717
7880 " guestfs_find (guestfs_h *g,\n"
7881 " const char *directory);\n"
7886 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
7888 "This command lists out all files and directories, recursively, starting at "
7889 "C<directory>. It is essentially equivalent to running the shell command "
7890 "C<find directory -print> but some post-processing happens on the output, "
7895 #: ../src/guestfs-actions.pod:1726 ../fish/guestfish-actions.pod:1165
7897 "This returns a list of strings I<without any prefix>. Thus if the directory "
7902 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1168
7912 #: ../src/guestfs-actions.pod:1733
7913 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7917 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
7928 #: ../src/guestfs-actions.pod:1741 ../fish/guestfish-actions.pod:1180
7929 msgid "If C<directory> is not a directory, then this command returns an error."
7933 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1183
7934 msgid "The returned list is sorted."
7938 #: ../src/guestfs-actions.pod:1746
7939 msgid "See also C<guestfs_find0>."
7943 #: ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:5404
7944 msgid "(Added in 1.0.27)"
7948 #: ../src/guestfs-actions.pod:1757
7949 msgid "guestfs_find0"
7953 #: ../src/guestfs-actions.pod:1759
7957 " guestfs_find0 (guestfs_h *g,\n"
7958 " const char *directory,\n"
7959 " const char *files);\n"
7964 #: ../src/guestfs-actions.pod:1764 ../fish/guestfish-actions.pod:1194
7966 "This command lists out all files and directories, recursively, starting at "
7967 "C<directory>, placing the resulting list in the external file called "
7972 #: ../src/guestfs-actions.pod:1768
7974 "This command works the same way as C<guestfs_find> with the following "
7979 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1205
7980 msgid "The resulting list is written to an external file."
7984 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
7986 "Items (filenames) in the result are separated by C<\\0> characters. See "
7987 "L<find(1)> option I<-print0>."
7991 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
7992 msgid "This command is not limited in the number of names that it can return."
7996 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1219
7997 msgid "The result list is not sorted."
8001 #: ../src/guestfs-actions.pod:1795
8002 msgid "(Added in 1.0.74)"
8006 #: ../src/guestfs-actions.pod:1797
8007 msgid "guestfs_findfs_label"
8011 #: ../src/guestfs-actions.pod:1799
8015 " guestfs_findfs_label (guestfs_h *g,\n"
8016 " const char *label);\n"
8021 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1229
8023 "This command searches the filesystems and returns the one which has the "
8024 "given label. An error is returned if no such filesystem can be found."
8028 #: ../src/guestfs-actions.pod:1807
8029 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8033 #: ../src/guestfs-actions.pod:1814
8034 msgid "guestfs_findfs_uuid"
8038 #: ../src/guestfs-actions.pod:1816
8042 " guestfs_findfs_uuid (guestfs_h *g,\n"
8043 " const char *uuid);\n"
8048 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
8050 "This command searches the filesystems and returns the one which has the "
8051 "given UUID. An error is returned if no such filesystem can be found."
8055 #: ../src/guestfs-actions.pod:1824
8056 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8060 #: ../src/guestfs-actions.pod:1831
8061 msgid "guestfs_fsck"
8065 #: ../src/guestfs-actions.pod:1833
8069 " guestfs_fsck (guestfs_h *g,\n"
8070 " const char *fstype,\n"
8071 " const char *device);\n"
8076 #: ../src/guestfs-actions.pod:1838 ../fish/guestfish-actions.pod:1249
8078 "This runs the filesystem checker (fsck) on C<device> which should have "
8079 "filesystem type C<fstype>."
8083 #: ../src/guestfs-actions.pod:1841 ../fish/guestfish-actions.pod:1252
8085 "The returned integer is the status. See L<fsck(8)> for the list of status "
8086 "codes from C<fsck>."
8090 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1261
8091 msgid "Multiple status codes can be summed together."
8095 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
8097 "A non-zero return code can mean \"success\", for example if errors have been "
8098 "corrected on the filesystem."
8102 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
8103 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8107 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1275
8108 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8112 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:7051
8113 msgid "(Added in 1.0.16)"
8117 #: ../src/guestfs-actions.pod:1870
8118 msgid "guestfs_get_append"
8122 #: ../src/guestfs-actions.pod:1872
8126 " guestfs_get_append (guestfs_h *g);\n"
8131 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1281
8133 "Return the additional kernel options which are added to the guest kernel "
8138 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1284
8139 msgid "If C<NULL> then no options are added."
8143 #: ../src/guestfs-actions.pod:1880
8145 "This function returns a string which may be NULL. There is no way to return "
8146 "an error from this function. The string is owned by the guest handle and "
8147 "must I<not> be freed."
8151 #: ../src/guestfs-actions.pod:1884 ../src/guestfs-actions.pod:5082 ../src/guestfs-actions.pod:5545 ../src/guestfs-actions.pod:5913 ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6722 ../src/guestfs-actions.pod:6740 ../src/guestfs-actions.pod:7094
8152 msgid "(Added in 1.0.26)"
8156 #: ../src/guestfs-actions.pod:1886
8157 msgid "guestfs_get_autosync"
8161 #: ../src/guestfs-actions.pod:1888
8165 " guestfs_get_autosync (guestfs_h *g);\n"
8170 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1290
8171 msgid "Get the autosync flag."
8175 #: ../src/guestfs-actions.pod:1897
8176 msgid "guestfs_get_direct"
8180 #: ../src/guestfs-actions.pod:1899
8184 " guestfs_get_direct (guestfs_h *g);\n"
8189 #: ../src/guestfs-actions.pod:1902 ../fish/guestfish-actions.pod:1296
8190 msgid "Return the direct appliance mode flag."
8194 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:5586
8195 msgid "(Added in 1.0.72)"
8199 #: ../src/guestfs-actions.pod:1908
8200 msgid "guestfs_get_e2label"
8204 #: ../src/guestfs-actions.pod:1910
8208 " guestfs_get_e2label (guestfs_h *g,\n"
8209 " const char *device);\n"
8214 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1302
8215 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8219 #: ../src/guestfs-actions.pod:1920
8221 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
8226 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:5604 ../src/guestfs-actions.pod:5623
8227 msgid "(Added in 1.0.15)"
8231 #: ../src/guestfs-actions.pod:1929
8232 msgid "guestfs_get_e2uuid"
8236 #: ../src/guestfs-actions.pod:1931
8240 " guestfs_get_e2uuid (guestfs_h *g,\n"
8241 " const char *device);\n"
8246 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1316
8247 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8251 #: ../src/guestfs-actions.pod:1941
8253 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
8258 #: ../src/guestfs-actions.pod:1950
8259 msgid "guestfs_get_memsize"
8263 #: ../src/guestfs-actions.pod:1952
8267 " guestfs_get_memsize (guestfs_h *g);\n"
8272 #: ../src/guestfs-actions.pod:1955 ../fish/guestfish-actions.pod:1330
8273 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8277 #: ../src/guestfs-actions.pod:1958
8279 "If C<guestfs_set_memsize> was not called on this handle, and if "
8280 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8281 "value for memsize."
8285 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5639 ../src/guestfs-actions.pod:5746 ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388 ../fish/guestfish-actions.pod:3766 ../fish/guestfish-actions.pod:3853
8286 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8290 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:4155 ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:4359 ../src/guestfs-actions.pod:4378 ../src/guestfs-actions.pod:4390 ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4420 ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5644 ../src/guestfs-actions.pod:5887 ../src/guestfs-actions.pod:6488
8291 msgid "(Added in 1.0.55)"
8295 #: ../src/guestfs-actions.pod:1969
8296 msgid "guestfs_get_network"
8300 #: ../src/guestfs-actions.pod:1971
8304 " guestfs_get_network (guestfs_h *g);\n"
8309 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1344
8310 msgid "This returns the enable network flag."
8314 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:5663
8315 msgid "(Added in 1.5.4)"
8319 #: ../src/guestfs-actions.pod:1980
8320 msgid "guestfs_get_path"
8324 #: ../src/guestfs-actions.pod:1982
8328 " guestfs_get_path (guestfs_h *g);\n"
8333 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
8334 msgid "Return the current search path."
8338 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1352
8340 "This is always non-NULL. If it wasn't set already, then this will return "
8345 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:2019
8347 "This function returns a string, or NULL on error. The string is owned by "
8348 "the guest handle and must I<not> be freed."
8352 #: ../src/guestfs-actions.pod:1995
8353 msgid "guestfs_get_pid"
8357 #: ../src/guestfs-actions.pod:1997
8361 " guestfs_get_pid (guestfs_h *g);\n"
8366 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1361
8368 "Return the process ID of the qemu subprocess. If there is no qemu "
8369 "subprocess, then this will return an error."
8373 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1364
8374 msgid "This is an internal call used for debugging and testing."
8378 #: ../src/guestfs-actions.pod:2007
8379 msgid "(Added in 1.0.56)"
8383 #: ../src/guestfs-actions.pod:2009
8384 msgid "guestfs_get_qemu"
8388 #: ../src/guestfs-actions.pod:2011
8392 " guestfs_get_qemu (guestfs_h *g);\n"
8397 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
8398 msgid "Return the current qemu binary."
8402 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
8404 "This is always non-NULL. If it wasn't set already, then this will return "
8405 "the default qemu binary name."
8409 #: ../src/guestfs-actions.pod:2022 ../src/guestfs-actions.pod:5708
8410 msgid "(Added in 1.0.6)"
8414 #: ../src/guestfs-actions.pod:2024
8415 msgid "guestfs_get_recovery_proc"
8419 #: ../src/guestfs-actions.pod:2026
8423 " guestfs_get_recovery_proc (guestfs_h *g);\n"
8428 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1379
8429 msgid "Return the recovery process enabled flag."
8433 #: ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3562 ../src/guestfs-actions.pod:3962 ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:6391 ../src/guestfs-actions.pod:6411 ../src/guestfs-actions.pod:6603
8434 msgid "(Added in 1.0.77)"
8438 #: ../src/guestfs-actions.pod:2035
8439 msgid "guestfs_get_selinux"
8443 #: ../src/guestfs-actions.pod:2037
8447 " guestfs_get_selinux (guestfs_h *g);\n"
8452 #: ../src/guestfs-actions.pod:2040
8454 "This returns the current setting of the selinux flag which is passed to the "
8455 "appliance at boot time. See C<guestfs_set_selinux>."
8459 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2111 ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5805
8460 msgid "(Added in 1.0.67)"
8464 #: ../src/guestfs-actions.pod:2050
8465 msgid "guestfs_get_state"
8469 #: ../src/guestfs-actions.pod:2052
8473 " guestfs_get_state (guestfs_h *g);\n"
8478 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1395
8480 "This returns the current state as an opaque integer. This is only useful "
8481 "for printing debug and internal error messages."
8485 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:3068 ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3158 ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:2137 ../fish/guestfish-actions.pod:2155 ../fish/guestfish-actions.pod:2193 ../fish/guestfish-actions.pod:2209
8486 msgid "For more information on states, see L<guestfs(3)>."
8490 #: ../src/guestfs-actions.pod:2064
8491 msgid "guestfs_get_trace"
8495 #: ../src/guestfs-actions.pod:2066
8499 " guestfs_get_trace (guestfs_h *g);\n"
8504 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1404
8505 msgid "Return the command trace flag."
8509 #: ../src/guestfs-actions.pod:2075
8510 msgid "guestfs_get_umask"
8514 #: ../src/guestfs-actions.pod:2077
8518 " guestfs_get_umask (guestfs_h *g);\n"
8523 #: ../src/guestfs-actions.pod:2080
8525 "Return the current umask. By default the umask is C<022> unless it has been "
8526 "set by calling C<guestfs_umask>."
8530 #: ../src/guestfs-actions.pod:2087
8531 msgid "guestfs_get_verbose"
8535 #: ../src/guestfs-actions.pod:2089
8539 " guestfs_get_verbose (guestfs_h *g);\n"
8544 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
8545 msgid "This returns the verbose messages flag."
8549 #: ../src/guestfs-actions.pod:2098
8550 msgid "guestfs_getcon"
8554 #: ../src/guestfs-actions.pod:2100
8558 " guestfs_getcon (guestfs_h *g);\n"
8563 #: ../src/guestfs-actions.pod:2103 ../fish/guestfish-actions.pod:1423
8564 msgid "This gets the SELinux security context of the daemon."
8568 #: ../src/guestfs-actions.pod:2105
8569 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8573 #: ../src/guestfs-actions.pod:2113
8574 msgid "guestfs_getxattr"
8578 #: ../src/guestfs-actions.pod:2115
8582 " guestfs_getxattr (guestfs_h *g,\n"
8583 " const char *path,\n"
8584 " const char *name,\n"
8585 " size_t *size_r);\n"
8590 #: ../src/guestfs-actions.pod:2121
8592 "Get a single extended attribute from file C<path> named C<name>. This call "
8593 "follows symlinks. If you want to lookup an extended attribute for the "
8594 "symlink itself, use C<guestfs_lgetxattr>."
8598 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3279
8600 "Normally it is better to get all extended attributes from a file in one go "
8601 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
8602 "implementations are buggy and do not provide a way to list out attributes. "
8603 "For these filesystems (notably ntfs-3g) you have to know the names of the "
8604 "extended attributes you want in advance and call this function."
8608 #: ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:3286 ../fish/guestfish-actions.pod:1443 ../fish/guestfish-actions.pod:2274
8610 "Extended attribute values are blobs of binary data. If there is no extended "
8611 "attribute named C<name>, this returns an error."
8615 #: ../src/guestfs-actions.pod:2135
8616 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
8620 #: ../src/guestfs-actions.pod:2137 ../src/guestfs-actions.pod:2328 ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5212
8622 "This function returns a buffer, or NULL on error. The size of the returned "
8623 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8628 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3295
8629 msgid "(Added in 1.7.24)"
8633 #: ../src/guestfs-actions.pod:2143
8634 msgid "guestfs_getxattrs"
8638 #: ../src/guestfs-actions.pod:2145
8641 " struct guestfs_xattr_list *\n"
8642 " guestfs_getxattrs (guestfs_h *g,\n"
8643 " const char *path);\n"
8648 #: ../src/guestfs-actions.pod:2149 ../fish/guestfish-actions.pod:1452
8649 msgid "This call lists the extended attributes of the file or directory C<path>."
8653 #: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1455
8655 "At the system call level, this is a combination of the L<listxattr(2)> and "
8656 "L<getxattr(2)> calls."
8660 #: ../src/guestfs-actions.pod:2155
8661 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8665 #: ../src/guestfs-actions.pod:2157 ../src/guestfs-actions.pod:3307 ../src/guestfs-actions.pod:3958
8667 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8668 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8672 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:3311 ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:5385 ../src/guestfs-actions.pod:5824 ../src/guestfs-actions.pod:7159
8673 msgid "(Added in 1.0.59)"
8677 #: ../src/guestfs-actions.pod:2163
8678 msgid "guestfs_glob_expand"
8682 #: ../src/guestfs-actions.pod:2165
8686 " guestfs_glob_expand (guestfs_h *g,\n"
8687 " const char *pattern);\n"
8692 #: ../src/guestfs-actions.pod:2169 ../fish/guestfish-actions.pod:1464
8694 "This command searches for all the pathnames matching C<pattern> according to "
8695 "the wildcard expansion rules used by the shell."
8699 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1468
8700 msgid "If no paths match, then this returns an empty list (note: not an error)."
8704 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1471
8706 "It is just a wrapper around the C L<glob(3)> function with flags "
8707 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8711 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:5989 ../src/guestfs-actions.pod:6006
8712 msgid "(Added in 1.0.50)"
8716 #: ../src/guestfs-actions.pod:2186
8717 msgid "guestfs_grep"
8721 #: ../src/guestfs-actions.pod:2188
8725 " guestfs_grep (guestfs_h *g,\n"
8726 " const char *regex,\n"
8727 " const char *path);\n"
8732 #: ../src/guestfs-actions.pod:2193 ../fish/guestfish-actions.pod:1479
8733 msgid "This calls the external C<grep> program and returns the matching lines."
8737 #: ../src/guestfs-actions.pod:2205
8738 msgid "guestfs_grepi"
8742 #: ../src/guestfs-actions.pod:2207
8746 " guestfs_grepi (guestfs_h *g,\n"
8747 " const char *regex,\n"
8748 " const char *path);\n"
8753 #: ../src/guestfs-actions.pod:2212 ../fish/guestfish-actions.pod:1489
8754 msgid "This calls the external C<grep -i> program and returns the matching lines."
8758 #: ../src/guestfs-actions.pod:2224
8759 msgid "guestfs_grub_install"
8763 #: ../src/guestfs-actions.pod:2226
8767 " guestfs_grub_install (guestfs_h *g,\n"
8768 " const char *root,\n"
8769 " const char *device);\n"
8774 #: ../src/guestfs-actions.pod:2231 ../fish/guestfish-actions.pod:1499
8776 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8777 "the root directory being C<root>."
8781 #: ../src/guestfs-actions.pod:2234 ../fish/guestfish-actions.pod:1502
8783 "Note: If grub-install reports the error \"No suitable drive was found in the "
8784 "generated device map.\" it may be that you need to create a "
8785 "C</boot/grub/device.map> file first that contains the mapping between grub "
8786 "device names and Linux device names. It is usually sufficient to create a "
8791 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1509
8799 #: ../src/guestfs-actions.pod:2243 ../fish/guestfish-actions.pod:1511
8800 msgid "replacing C</dev/vda> with the name of the installation device."
8804 #: ../src/guestfs-actions.pod:2247
8805 msgid "(Added in 1.0.17)"
8809 #: ../src/guestfs-actions.pod:2249
8810 msgid "guestfs_head"
8814 #: ../src/guestfs-actions.pod:2251
8818 " guestfs_head (guestfs_h *g,\n"
8819 " const char *path);\n"
8824 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1517
8826 "This command returns up to the first 10 lines of a file as a list of "
8831 #: ../src/guestfs-actions.pod:2267
8832 msgid "guestfs_head_n"
8836 #: ../src/guestfs-actions.pod:2269
8840 " guestfs_head_n (guestfs_h *g,\n"
8842 " const char *path);\n"
8847 #: ../src/guestfs-actions.pod:2274 ../fish/guestfish-actions.pod:1527
8849 "If the parameter C<nrlines> is a positive number, this returns the first "
8850 "C<nrlines> lines of the file C<path>."
8854 #: ../src/guestfs-actions.pod:2277 ../fish/guestfish-actions.pod:1530
8856 "If the parameter C<nrlines> is a negative number, this returns lines from "
8857 "the file C<path>, excluding the last C<nrlines> lines."
8861 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:6286 ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:4199
8862 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8866 #: ../src/guestfs-actions.pod:2291
8867 msgid "guestfs_hexdump"
8871 #: ../src/guestfs-actions.pod:2293
8875 " guestfs_hexdump (guestfs_h *g,\n"
8876 " const char *path);\n"
8881 #: ../src/guestfs-actions.pod:2297 ../fish/guestfish-actions.pod:1542
8883 "This runs C<hexdump -C> on the given C<path>. The result is the "
8884 "human-readable, canonical hex dump of the file."
8888 #: ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6125
8889 msgid "(Added in 1.0.22)"
8893 #: ../src/guestfs-actions.pod:2308
8894 msgid "guestfs_initrd_cat"
8898 #: ../src/guestfs-actions.pod:2310
8902 " guestfs_initrd_cat (guestfs_h *g,\n"
8903 " const char *initrdpath,\n"
8904 " const char *filename,\n"
8905 " size_t *size_r);\n"
8910 #: ../src/guestfs-actions.pod:2316 ../fish/guestfish-actions.pod:1552
8912 "This command unpacks the file C<filename> from the initrd file called "
8913 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8918 #: ../src/guestfs-actions.pod:2320 ../fish/guestfish-actions.pod:1556
8920 "For example, in guestfish you could use the following command to examine the "
8921 "boot script (usually called C</init>) contained in a Linux initrd or "
8926 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1560
8929 " initrd-cat /boot/initrd-<version>.img init\n"
8934 #: ../src/guestfs-actions.pod:2326
8935 msgid "See also C<guestfs_initrd_list>."
8939 #: ../src/guestfs-actions.pod:2337
8940 msgid "guestfs_initrd_list"
8944 #: ../src/guestfs-actions.pod:2339
8948 " guestfs_initrd_list (guestfs_h *g,\n"
8949 " const char *path);\n"
8954 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1571
8955 msgid "This command lists out files contained in an initrd."
8959 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1573
8961 "The files are listed without any initial C</> character. The files are "
8962 "listed in the order they appear (not necessarily alphabetical). Directory "
8963 "names are listed as separate items."
8967 #: ../src/guestfs-actions.pod:2349 ../fish/guestfish-actions.pod:1577
8969 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8970 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8975 #: ../src/guestfs-actions.pod:2359
8976 msgid "guestfs_inotify_add_watch"
8980 #: ../src/guestfs-actions.pod:2361
8984 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8985 " const char *path,\n"
8991 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1585
8992 msgid "Watch C<path> for the events listed in C<mask>."
8996 #: ../src/guestfs-actions.pod:2368 ../fish/guestfish-actions.pod:1587
8998 "Note that if C<path> is a directory then events within that directory are "
8999 "watched, but this does I<not> happen recursively (in subdirectories)."
9003 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1591
9005 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9006 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9010 #: ../src/guestfs-actions.pod:2380
9011 msgid "guestfs_inotify_close"
9015 #: ../src/guestfs-actions.pod:2382
9019 " guestfs_inotify_close (guestfs_h *g);\n"
9024 #: ../src/guestfs-actions.pod:2385 ../fish/guestfish-actions.pod:1599
9026 "This closes the inotify handle which was previously opened by inotify_init. "
9027 "It removes all watches, throws away any pending events, and deallocates all "
9032 #: ../src/guestfs-actions.pod:2393
9033 msgid "guestfs_inotify_files"
9037 #: ../src/guestfs-actions.pod:2395
9041 " guestfs_inotify_files (guestfs_h *g);\n"
9046 #: ../src/guestfs-actions.pod:2398
9048 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9049 "returns a list of pathnames of objects that were touched. The returned "
9050 "pathnames are sorted and deduplicated."
9054 #: ../src/guestfs-actions.pod:2408
9055 msgid "guestfs_inotify_init"
9059 #: ../src/guestfs-actions.pod:2410
9063 " guestfs_inotify_init (guestfs_h *g,\n"
9064 " int maxevents);\n"
9069 #: ../src/guestfs-actions.pod:2414 ../fish/guestfish-actions.pod:1615
9071 "This command creates a new inotify handle. The inotify subsystem can be "
9072 "used to notify events which happen to objects in the guest filesystem."
9076 #: ../src/guestfs-actions.pod:2418
9078 "C<maxevents> is the maximum number of events which will be queued up between "
9079 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9080 "passed as C<0>, then the kernel (or previously set) default is used. For "
9081 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9082 "throws away events, but records the fact that it threw them away by setting "
9083 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9084 "C<guestfs_inotify_read>)."
9088 #: ../src/guestfs-actions.pod:2428
9090 "Before any events are generated, you have to add some watches to the "
9091 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9092 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9096 #: ../src/guestfs-actions.pod:2434
9098 "Queued up events should be read periodically by calling "
9099 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9100 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9101 "often enough then you risk the internal queue overflowing."
9105 #: ../src/guestfs-actions.pod:2441
9107 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9108 "This also removes any watches automatically."
9112 #: ../src/guestfs-actions.pod:2445 ../fish/guestfish-actions.pod:1646
9114 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9115 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9116 "that there is one global inotify handle per libguestfs instance."
9120 #: ../src/guestfs-actions.pod:2454
9121 msgid "guestfs_inotify_read"
9125 #: ../src/guestfs-actions.pod:2456
9128 " struct guestfs_inotify_event_list *\n"
9129 " guestfs_inotify_read (guestfs_h *g);\n"
9134 #: ../src/guestfs-actions.pod:2459 ../fish/guestfish-actions.pod:1655
9136 "Return the complete queue of events that have happened since the previous "
9141 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1658
9142 msgid "If no events have happened, this returns an empty list."
9146 #: ../src/guestfs-actions.pod:2464 ../fish/guestfish-actions.pod:1660
9148 "I<Note>: In order to make sure that all events have been read, you must call "
9149 "this function repeatedly until it returns an empty list. The reason is that "
9150 "the call will read events up to the maximum appliance-to-host message size "
9151 "and leave remaining events in the queue."
9155 #: ../src/guestfs-actions.pod:2470
9157 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9158 "there was an error. I<The caller must call "
9159 "C<guestfs_free_inotify_event_list> after use>."
9163 #: ../src/guestfs-actions.pod:2476
9164 msgid "guestfs_inotify_rm_watch"
9168 #: ../src/guestfs-actions.pod:2478
9172 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9178 #: ../src/guestfs-actions.pod:2482
9180 "Remove a previously defined inotify watch. See "
9181 "C<guestfs_inotify_add_watch>."
9185 #: ../src/guestfs-actions.pod:2489
9186 msgid "guestfs_inspect_get_arch"
9190 #: ../src/guestfs-actions.pod:2491
9194 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9195 " const char *root);\n"
9200 #: ../src/guestfs-actions.pod:2495 ../src/guestfs-actions.pod:2518 ../src/guestfs-actions.pod:2599 ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:2647 ../src/guestfs-actions.pod:2674 ../src/guestfs-actions.pod:2695 ../src/guestfs-actions.pod:2732 ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:2901
9202 "This function should only be called with a root device string as returned by "
9203 "C<guestfs_inspect_os>."
9207 #: ../src/guestfs-actions.pod:2498
9209 "This returns the architecture of the inspected operating system. The "
9210 "possible return values are listed under C<guestfs_file_architecture>."
9214 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1684
9216 "If the architecture could not be determined, then the string C<unknown> is "
9221 #: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2662 ../src/guestfs-actions.pod:2748 ../src/guestfs-actions.pod:2779 ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2822 ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2888 ../src/guestfs-actions.pod:2994 ../src/guestfs-actions.pod:3035 ../fish/guestfish-actions.pod:1687 ../fish/guestfish-actions.pod:1761 ../fish/guestfish-actions.pod:1794 ../fish/guestfish-actions.pod:1815 ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1903 ../fish/guestfish-actions.pod:1920 ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1968 ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:2083 ../fish/guestfish-actions.pod:2117
9222 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9226 #: ../src/guestfs-actions.pod:2512
9227 msgid "guestfs_inspect_get_distro"
9231 #: ../src/guestfs-actions.pod:2514
9235 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9236 " const char *root);\n"
9241 #: ../src/guestfs-actions.pod:2521 ../fish/guestfish-actions.pod:1696
9242 msgid "This returns the distro (distribution) of the inspected operating system."
9246 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1699
9247 msgid "Currently defined distros are:"
9251 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1703
9252 msgid "\"archlinux\""
9256 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1705
9261 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1707
9266 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1709
9271 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1711
9276 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1713
9281 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1715
9286 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1717
9291 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1719
9292 msgid "\"linuxmint\""
9296 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1721
9301 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1723
9302 msgid "\"mandriva\""
9306 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1725
9311 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1727
9316 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1729
9321 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1731
9326 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1733
9331 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1735
9332 msgid "\"redhat-based\""
9336 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1737
9337 msgid "Some Red Hat-derived distro."
9341 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1739
9346 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1741
9347 msgid "Red Hat Enterprise Linux and some derivatives."
9351 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1743
9356 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1745
9361 #: ../src/guestfs-actions.pod:2572 ../src/guestfs-actions.pod:2856 ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1959
9366 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1749
9367 msgid "The distro could not be determined."
9371 #: ../src/guestfs-actions.pod:2576 ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1751 ../fish/guestfish-actions.pod:1951
9376 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1753
9378 "Windows does not have distributions. This string is returned if the OS type "
9383 #: ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2862 ../fish/guestfish-actions.pod:1758 ../fish/guestfish-actions.pod:1965
9385 "Future versions of libguestfs may return other strings here. The caller "
9386 "should be prepared to handle any string."
9390 #: ../src/guestfs-actions.pod:2593
9391 msgid "guestfs_inspect_get_filesystems"
9395 #: ../src/guestfs-actions.pod:2595
9399 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9400 " const char *root);\n"
9405 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1770
9407 "This returns a list of all the filesystems that we think are associated with "
9408 "this operating system. This includes the root filesystem, other ordinary "
9409 "filesystems, and non-mounted devices like swap partitions."
9413 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1775
9415 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9416 "to be shared between operating systems."
9420 #: ../src/guestfs-actions.pod:2610
9422 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9423 "C<guestfs_inspect_get_mountpoints>."
9427 #: ../src/guestfs-actions.pod:2619
9428 msgid "guestfs_inspect_get_hostname"
9432 #: ../src/guestfs-actions.pod:2621
9436 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
9437 " const char *root);\n"
9442 #: ../src/guestfs-actions.pod:2628 ../fish/guestfish-actions.pod:1788
9444 "This function returns the hostname of the operating system as found by "
9445 "inspection of the guest's configuration files."
9449 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1791
9451 "If the hostname could not be determined, then the string C<unknown> is "
9456 #: ../src/guestfs-actions.pod:2639
9457 msgid "(Added in 1.7.9)"
9461 #: ../src/guestfs-actions.pod:2641
9462 msgid "guestfs_inspect_get_major_version"
9466 #: ../src/guestfs-actions.pod:2643
9470 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
9471 " const char *root);\n"
9476 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1803
9477 msgid "This returns the major version number of the inspected operating system."
9481 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1806
9483 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9484 "popular public names used by the operating system. Notably the operating "
9485 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9486 "1). You can find out the real versions corresponding to releases of Windows "
9487 "by consulting Wikipedia or MSDN."
9491 #: ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2680 ../fish/guestfish-actions.pod:1813 ../fish/guestfish-actions.pod:1827
9492 msgid "If the version could not be determined, then C<0> is returned."
9496 #: ../src/guestfs-actions.pod:2668
9497 msgid "guestfs_inspect_get_minor_version"
9501 #: ../src/guestfs-actions.pod:2670
9505 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9506 " const char *root);\n"
9511 #: ../src/guestfs-actions.pod:2677 ../fish/guestfish-actions.pod:1824
9512 msgid "This returns the minor version number of the inspected operating system."
9516 #: ../src/guestfs-actions.pod:2682
9518 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9519 "C<guestfs_inspect_get_major_version>."
9523 #: ../src/guestfs-actions.pod:2689
9524 msgid "guestfs_inspect_get_mountpoints"
9528 #: ../src/guestfs-actions.pod:2691
9532 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9533 " const char *root);\n"
9538 #: ../src/guestfs-actions.pod:2698 ../fish/guestfish-actions.pod:1839
9540 "This returns a hash of where we think the filesystems associated with this "
9541 "operating system should be mounted. Callers should note that this is at "
9542 "best an educated guess made by reading configuration files such as "
9543 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
9544 "are non-existent or not mountable and callers should be prepared to handle "
9545 "or ignore failures if they try to mount them."
9549 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
9551 "Each element in the returned hashtable has a key which is the path of the "
9552 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9553 "mounted there (eg. C</dev/sda1>)."
9557 #: ../src/guestfs-actions.pod:2712 ../fish/guestfish-actions.pod:1853
9558 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9562 #: ../src/guestfs-actions.pod:2715
9564 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9565 "C<guestfs_inspect_get_filesystems>."
9569 #: ../src/guestfs-actions.pod:2718 ../src/guestfs-actions.pod:3364 ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:6427
9571 "This function returns a NULL-terminated array of strings, or NULL if there "
9572 "was an error. The array of strings will always have length C<2n+1>, where "
9573 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9574 "caller must free the strings and the array after use>."
9578 #: ../src/guestfs-actions.pod:2726
9579 msgid "guestfs_inspect_get_package_format"
9583 #: ../src/guestfs-actions.pod:2728
9587 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9588 " const char *root);\n"
9593 #: ../src/guestfs-actions.pod:2735
9595 "This function and C<guestfs_inspect_get_package_management> return the "
9596 "package format and package management tool used by the inspected operating "
9597 "system. For example for Fedora these functions would return C<rpm> (package "
9598 "format) and C<yum> (package management)."
9602 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1872
9604 "This returns the string C<unknown> if we could not determine the package "
9605 "format I<or> if the operating system does not have a real packaging system "
9610 #: ../src/guestfs-actions.pod:2745 ../fish/guestfish-actions.pod:1876
9612 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9613 "Future versions of libguestfs may return other strings."
9617 #: ../src/guestfs-actions.pod:2753 ../src/guestfs-actions.pod:2784
9618 msgid "(Added in 1.7.5)"
9622 #: ../src/guestfs-actions.pod:2755
9623 msgid "guestfs_inspect_get_package_management"
9627 #: ../src/guestfs-actions.pod:2757
9631 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9632 " const char *root);\n"
9637 #: ../src/guestfs-actions.pod:2764
9639 "C<guestfs_inspect_get_package_format> and this function return the package "
9640 "format and package management tool used by the inspected operating system. "
9641 "For example for Fedora these functions would return C<rpm> (package format) "
9642 "and C<yum> (package management)."
9646 #: ../src/guestfs-actions.pod:2770 ../fish/guestfish-actions.pod:1894
9648 "This returns the string C<unknown> if we could not determine the package "
9649 "management tool I<or> if the operating system does not have a real packaging "
9650 "system (eg. Windows)."
9654 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1898
9656 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9657 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9658 "libguestfs may return other strings."
9662 #: ../src/guestfs-actions.pod:2786
9663 msgid "guestfs_inspect_get_product_name"
9667 #: ../src/guestfs-actions.pod:2788
9671 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9672 " const char *root);\n"
9677 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1912
9679 "This returns the product name of the inspected operating system. The "
9680 "product name is generally some freeform string which can be displayed to the "
9681 "user, but should not be parsed by programs."
9685 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1917
9687 "If the product name could not be determined, then the string C<unknown> is "
9692 #: ../src/guestfs-actions.pod:2810
9693 msgid "guestfs_inspect_get_roots"
9697 #: ../src/guestfs-actions.pod:2812
9701 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9706 #: ../src/guestfs-actions.pod:2815
9708 "This function is a convenient way to get the list of root devices, as "
9709 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9710 "the whole inspection process."
9714 #: ../src/guestfs-actions.pod:2819
9716 "This returns an empty list if either no root devices were found or the "
9717 "caller has not called C<guestfs_inspect_os>."
9721 #: ../src/guestfs-actions.pod:2828
9722 msgid "(Added in 1.7.3)"
9726 #: ../src/guestfs-actions.pod:2830
9727 msgid "guestfs_inspect_get_type"
9731 #: ../src/guestfs-actions.pod:2832
9735 " guestfs_inspect_get_type (guestfs_h *g,\n"
9736 " const char *root);\n"
9741 #: ../src/guestfs-actions.pod:2839 ../fish/guestfish-actions.pod:1942
9743 "This returns the type of the inspected operating system. Currently defined "
9748 #: ../src/guestfs-actions.pod:2844 ../fish/guestfish-actions.pod:1947
9753 #: ../src/guestfs-actions.pod:2846 ../fish/guestfish-actions.pod:1949
9754 msgid "Any Linux-based operating system."
9758 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1953
9759 msgid "Any Microsoft Windows operating system."
9763 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1955
9768 #: ../src/guestfs-actions.pod:2854 ../fish/guestfish-actions.pod:1957
9773 #: ../src/guestfs-actions.pod:2858 ../fish/guestfish-actions.pod:1961
9774 msgid "The operating system type could not be determined."
9778 #: ../src/guestfs-actions.pod:2872
9779 msgid "guestfs_inspect_get_windows_systemroot"
9783 #: ../src/guestfs-actions.pod:2874
9787 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9788 " const char *root);\n"
9793 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1977
9795 "This returns the Windows systemroot of the inspected guest. The systemroot "
9796 "is a directory path such as C</WINDOWS>."
9800 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1980
9802 "This call assumes that the guest is Windows and that the systemroot could be "
9803 "determined by inspection. If this is not the case then an error is "
9808 #: ../src/guestfs-actions.pod:2893
9809 msgid "(Added in 1.5.25)"
9813 #: ../src/guestfs-actions.pod:2895
9814 msgid "guestfs_inspect_list_applications"
9818 #: ../src/guestfs-actions.pod:2897
9821 " struct guestfs_application_list *\n"
9822 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9823 " const char *root);\n"
9828 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:1993
9829 msgid "Return the list of applications installed in the operating system."
9833 #: ../src/guestfs-actions.pod:2906
9835 "I<Note:> This call works differently from other parts of the inspection "
9836 "API. You have to call C<guestfs_inspect_os>, then "
9837 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9838 "this. Listing applications is a significantly more difficult operation "
9839 "which requires access to the full filesystem. Also note that unlike the "
9840 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9841 "the libguestfs handle, this call actually reads parts of the mounted "
9842 "filesystems during the call."
9846 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:2005
9848 "This returns an empty list if the inspection code was not able to determine "
9849 "the list of applications."
9853 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2008
9854 msgid "The application structure contains the following fields:"
9858 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2012
9863 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2014
9865 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9866 "guests, this is the package name."
9870 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2017
9871 msgid "C<app_display_name>"
9875 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2019
9877 "The display name of the application, sometimes localized to the install "
9878 "language of the guest operating system."
9882 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2022
9884 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9885 "to display something can use C<app_name> instead."
9889 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2025
9890 msgid "C<app_epoch>"
9894 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2027
9896 "For package managers which use epochs, this contains the epoch of the "
9897 "package (an integer). If unavailable, this is returned as C<0>."
9901 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
9902 msgid "C<app_version>"
9906 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2032
9908 "The version string of the application or package. If unavailable this is "
9909 "returned as an empty string C<\"\">."
9913 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2035
9914 msgid "C<app_release>"
9918 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2037
9920 "The release string of the application or package, for package managers that "
9921 "use this. If unavailable this is returned as an empty string C<\"\">."
9925 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2041
9926 msgid "C<app_install_path>"
9930 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2043
9932 "The installation path of the application (on operating systems such as "
9933 "Windows which use installation paths). This path is in the format used by "
9934 "the guest operating system, it is not a libguestfs path."
9938 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2048
9939 msgid "If unavailable this is returned as an empty string C<\"\">."
9943 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2050
9944 msgid "C<app_trans_path>"
9948 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2052
9950 "The install path translated into a libguestfs path. If unavailable this is "
9951 "returned as an empty string C<\"\">."
9955 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2055
9956 msgid "C<app_publisher>"
9960 #: ../src/guestfs-actions.pod:2968 ../fish/guestfish-actions.pod:2057
9962 "The name of the publisher of the application, for package managers that use "
9963 "this. If unavailable this is returned as an empty string C<\"\">."
9967 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2061
9972 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2063
9974 "The URL (eg. upstream URL) of the application. If unavailable this is "
9975 "returned as an empty string C<\"\">."
9979 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2066
9980 msgid "C<app_source_package>"
9984 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2068
9986 "For packaging systems which support this, the name of the source package. "
9987 "If unavailable this is returned as an empty string C<\"\">."
9991 #: ../src/guestfs-actions.pod:2982 ../fish/guestfish-actions.pod:2071
9992 msgid "C<app_summary>"
9996 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2073
9998 "A short (usually one line) description of the application or package. If "
9999 "unavailable this is returned as an empty string C<\"\">."
10003 #: ../src/guestfs-actions.pod:2987 ../fish/guestfish-actions.pod:2076
10004 msgid "C<app_description>"
10008 #: ../src/guestfs-actions.pod:2989 ../fish/guestfish-actions.pod:2078
10010 "A longer description of the application or package. If unavailable this is "
10011 "returned as an empty string C<\"\">."
10015 #: ../src/guestfs-actions.pod:2996
10017 "This function returns a C<struct guestfs_application_list *>, or NULL if "
10018 "there was an error. I<The caller must call C<guestfs_free_application_list> "
10023 #: ../src/guestfs-actions.pod:3000
10024 msgid "(Added in 1.7.8)"
10028 #: ../src/guestfs-actions.pod:3002
10029 msgid "guestfs_inspect_os"
10033 #: ../src/guestfs-actions.pod:3004
10037 " guestfs_inspect_os (guestfs_h *g);\n"
10042 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2089
10044 "This function uses other libguestfs functions and certain heuristics to "
10045 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10046 "for operating systems."
10050 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2093
10051 msgid "The list returned is empty if no operating systems were found."
10055 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2095
10057 "If one operating system was found, then this returns a list with a single "
10058 "element, which is the name of the root filesystem of this operating system. "
10059 "It is also possible for this function to return a list containing more than "
10060 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10061 "element being the root filesystem of one of the operating systems."
10065 #: ../src/guestfs-actions.pod:3020
10067 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10068 "functions in order to query further information about each operating system, "
10069 "such as the name and version."
10073 #: ../src/guestfs-actions.pod:3025
10075 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10076 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10077 "the contents. This should be called with no disks currently mounted. The "
10078 "function may also use Augeas, so any existing Augeas handle will be closed."
10082 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2113
10084 "This function cannot decrypt encrypted disks. The caller must do that first "
10085 "(supplying the necessary keys) if the disk is encrypted."
10089 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3384
10090 msgid "See also C<guestfs_list_filesystems>."
10094 #: ../src/guestfs-actions.pod:3045
10095 msgid "guestfs_is_blockdev"
10099 #: ../src/guestfs-actions.pod:3047
10103 " guestfs_is_blockdev (guestfs_h *g,\n"
10104 " const char *path);\n"
10109 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2125
10111 "This returns C<true> if and only if there is a block device with the given "
10116 #: ../src/guestfs-actions.pod:3054 ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3215
10117 msgid "See also C<guestfs_stat>."
10121 #: ../src/guestfs-actions.pod:3058 ../src/guestfs-actions.pod:3087 ../src/guestfs-actions.pod:3132 ../src/guestfs-actions.pod:3204 ../src/guestfs-actions.pod:3219
10122 msgid "(Added in 1.5.10)"
10126 #: ../src/guestfs-actions.pod:3060
10127 msgid "guestfs_is_busy"
10131 #: ../src/guestfs-actions.pod:3062
10135 " guestfs_is_busy (guestfs_h *g);\n"
10140 #: ../src/guestfs-actions.pod:3065 ../fish/guestfish-actions.pod:2134
10142 "This returns true iff this handle is busy processing a command (in the "
10147 #: ../src/guestfs-actions.pod:3074
10148 msgid "guestfs_is_chardev"
10152 #: ../src/guestfs-actions.pod:3076
10156 " guestfs_is_chardev (guestfs_h *g,\n"
10157 " const char *path);\n"
10162 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2143
10164 "This returns C<true> if and only if there is a character device with the "
10165 "given C<path> name."
10169 #: ../src/guestfs-actions.pod:3089
10170 msgid "guestfs_is_config"
10174 #: ../src/guestfs-actions.pod:3091
10178 " guestfs_is_config (guestfs_h *g);\n"
10183 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:2152
10185 "This returns true iff this handle is being configured (in the C<CONFIG> "
10190 #: ../src/guestfs-actions.pod:3103
10191 msgid "guestfs_is_dir"
10195 #: ../src/guestfs-actions.pod:3105
10199 " guestfs_is_dir (guestfs_h *g,\n"
10200 " const char *path);\n"
10205 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2161
10207 "This returns C<true> if and only if there is a directory with the given "
10208 "C<path> name. Note that it returns false for other objects like files."
10212 #: ../src/guestfs-actions.pod:3119
10213 msgid "guestfs_is_fifo"
10217 #: ../src/guestfs-actions.pod:3121
10221 " guestfs_is_fifo (guestfs_h *g,\n"
10222 " const char *path);\n"
10227 #: ../src/guestfs-actions.pod:3125 ../fish/guestfish-actions.pod:2171
10229 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10230 "given C<path> name."
10234 #: ../src/guestfs-actions.pod:3134
10235 msgid "guestfs_is_file"
10239 #: ../src/guestfs-actions.pod:3136
10243 " guestfs_is_file (guestfs_h *g,\n"
10244 " const char *path);\n"
10249 #: ../src/guestfs-actions.pod:3140 ../fish/guestfish-actions.pod:2180
10251 "This returns C<true> if and only if there is a regular file with the given "
10252 "C<path> name. Note that it returns false for other objects like "
10257 #: ../src/guestfs-actions.pod:3150
10258 msgid "guestfs_is_launching"
10262 #: ../src/guestfs-actions.pod:3152
10266 " guestfs_is_launching (guestfs_h *g);\n"
10271 #: ../src/guestfs-actions.pod:3155 ../fish/guestfish-actions.pod:2190
10273 "This returns true iff this handle is launching the subprocess (in the "
10274 "C<LAUNCHING> state)."
10278 #: ../src/guestfs-actions.pod:3164
10279 msgid "guestfs_is_lv"
10283 #: ../src/guestfs-actions.pod:3166
10287 " guestfs_is_lv (guestfs_h *g,\n"
10288 " const char *device);\n"
10293 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2199
10295 "This command tests whether C<device> is a logical volume, and returns true "
10296 "iff this is the case."
10300 #: ../src/guestfs-actions.pod:3177
10301 msgid "guestfs_is_ready"
10305 #: ../src/guestfs-actions.pod:3179
10309 " guestfs_is_ready (guestfs_h *g);\n"
10314 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2206
10316 "This returns true iff this handle is ready to accept commands (in the "
10321 #: ../src/guestfs-actions.pod:3191
10322 msgid "guestfs_is_socket"
10326 #: ../src/guestfs-actions.pod:3193
10330 " guestfs_is_socket (guestfs_h *g,\n"
10331 " const char *path);\n"
10336 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2215
10338 "This returns C<true> if and only if there is a Unix domain socket with the "
10339 "given C<path> name."
10343 #: ../src/guestfs-actions.pod:3206
10344 msgid "guestfs_is_symlink"
10348 #: ../src/guestfs-actions.pod:3208
10352 " guestfs_is_symlink (guestfs_h *g,\n"
10353 " const char *path);\n"
10358 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2224
10360 "This returns C<true> if and only if there is a symbolic link with the given "
10365 #: ../src/guestfs-actions.pod:3221
10366 msgid "guestfs_kill_subprocess"
10370 #: ../src/guestfs-actions.pod:3223
10374 " guestfs_kill_subprocess (guestfs_h *g);\n"
10379 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2233
10380 msgid "This kills the qemu subprocess. You should never need to call this."
10384 #: ../src/guestfs-actions.pod:3232
10385 msgid "guestfs_launch"
10389 #: ../src/guestfs-actions.pod:3234
10393 " guestfs_launch (guestfs_h *g);\n"
10398 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2241
10400 "Internally libguestfs is implemented by running a virtual machine using "
10405 #: ../src/guestfs-actions.pod:3240 ../fish/guestfish-actions.pod:2244
10407 "You should call this after configuring the handle (eg. adding drives) but "
10408 "before performing any actions."
10412 #: ../src/guestfs-actions.pod:3247
10413 msgid "guestfs_lchown"
10417 #: ../src/guestfs-actions.pod:3249
10421 " guestfs_lchown (guestfs_h *g,\n"
10424 " const char *path);\n"
10429 #: ../src/guestfs-actions.pod:3255
10431 "Change the file owner to C<owner> and group to C<group>. This is like "
10432 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
10433 "changed, not the target."
10437 #: ../src/guestfs-actions.pod:3267
10438 msgid "guestfs_lgetxattr"
10442 #: ../src/guestfs-actions.pod:3269
10446 " guestfs_lgetxattr (guestfs_h *g,\n"
10447 " const char *path,\n"
10448 " const char *name,\n"
10449 " size_t *size_r);\n"
10454 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2263
10456 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10457 "is a symlink, then this call returns an extended attribute from the symlink."
10461 #: ../src/guestfs-actions.pod:3289
10462 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
10466 #: ../src/guestfs-actions.pod:3297
10467 msgid "guestfs_lgetxattrs"
10471 #: ../src/guestfs-actions.pod:3299
10474 " struct guestfs_xattr_list *\n"
10475 " guestfs_lgetxattrs (guestfs_h *g,\n"
10476 " const char *path);\n"
10481 #: ../src/guestfs-actions.pod:3303
10483 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
10484 "then it returns the extended attributes of the link itself."
10488 #: ../src/guestfs-actions.pod:3313
10489 msgid "guestfs_list_devices"
10493 #: ../src/guestfs-actions.pod:3315
10497 " guestfs_list_devices (guestfs_h *g);\n"
10502 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2291
10503 msgid "List all the block devices."
10507 #: ../src/guestfs-actions.pod:3320 ../fish/guestfish-actions.pod:2293
10508 msgid "The full block device names are returned, eg. C</dev/sda>."
10512 #: ../src/guestfs-actions.pod:3330
10513 msgid "guestfs_list_filesystems"
10517 #: ../src/guestfs-actions.pod:3332
10521 " guestfs_list_filesystems (guestfs_h *g);\n"
10526 #: ../src/guestfs-actions.pod:3335 ../fish/guestfish-actions.pod:2301
10528 "This inspection command looks for filesystems on partitions, block devices "
10529 "and logical volumes, returning a list of devices containing filesystems and "
10534 #: ../src/guestfs-actions.pod:3339 ../fish/guestfish-actions.pod:2305
10536 "The return value is a hash, where the keys are the devices containing "
10537 "filesystems, and the values are the filesystem types. For example:"
10541 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2309
10544 " \"/dev/sda1\" => \"ntfs\"\n"
10545 " \"/dev/sda2\" => \"ext2\"\n"
10546 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10547 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10552 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2314
10554 "The value can have the special value \"unknown\", meaning the content of the "
10555 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10559 #: ../src/guestfs-actions.pod:3352
10561 "This command runs other libguestfs commands, which might include "
10562 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10563 "soon after launch and only when nothing is mounted."
10567 #: ../src/guestfs-actions.pod:3356
10569 "Not all of the filesystems returned will be mountable. In particular, swap "
10570 "partitions are returned in the list. Also this command does not check that "
10571 "each filesystem found is valid and mountable, and some filesystems might be "
10572 "mountable but require special options. Filesystems may not all belong to a "
10573 "single logical operating system (use C<guestfs_inspect_os> to look for "
10578 #: ../src/guestfs-actions.pod:3370 ../src/guestfs-actions.pod:4972
10579 msgid "(Added in 1.5.15)"
10583 #: ../src/guestfs-actions.pod:3372
10584 msgid "guestfs_list_partitions"
10588 #: ../src/guestfs-actions.pod:3374
10592 " guestfs_list_partitions (guestfs_h *g);\n"
10597 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2334
10598 msgid "List all the partitions detected on all block devices."
10602 #: ../src/guestfs-actions.pod:3379 ../fish/guestfish-actions.pod:2336
10603 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10607 #: ../src/guestfs-actions.pod:3381
10609 "This does not return logical volumes. For that you will need to call "
10614 #: ../src/guestfs-actions.pod:3392
10619 #: ../src/guestfs-actions.pod:3394
10623 " guestfs_ll (guestfs_h *g,\n"
10624 " const char *directory);\n"
10629 #: ../src/guestfs-actions.pod:3398 ../fish/guestfish-actions.pod:2347
10631 "List the files in C<directory> (relative to the root directory, there is no "
10632 "cwd) in the format of 'ls -la'."
10636 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2350
10638 "This command is mostly useful for interactive sessions. It is I<not> "
10639 "intended that you try to parse the output string."
10643 #: ../src/guestfs-actions.pod:3409
10648 #: ../src/guestfs-actions.pod:3411
10652 " guestfs_ln (guestfs_h *g,\n"
10653 " const char *target,\n"
10654 " const char *linkname);\n"
10659 #: ../src/guestfs-actions.pod:3416 ../fish/guestfish-actions.pod:2357
10660 msgid "This command creates a hard link using the C<ln> command."
10664 #: ../src/guestfs-actions.pod:3422
10665 msgid "guestfs_ln_f"
10669 #: ../src/guestfs-actions.pod:3424
10673 " guestfs_ln_f (guestfs_h *g,\n"
10674 " const char *target,\n"
10675 " const char *linkname);\n"
10680 #: ../src/guestfs-actions.pod:3429 ../fish/guestfish-actions.pod:2363
10682 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10683 "option removes the link (C<linkname>) if it exists already."
10687 #: ../src/guestfs-actions.pod:3436
10688 msgid "guestfs_ln_s"
10692 #: ../src/guestfs-actions.pod:3438
10696 " guestfs_ln_s (guestfs_h *g,\n"
10697 " const char *target,\n"
10698 " const char *linkname);\n"
10703 #: ../src/guestfs-actions.pod:3443 ../fish/guestfish-actions.pod:2370
10704 msgid "This command creates a symbolic link using the C<ln -s> command."
10708 #: ../src/guestfs-actions.pod:3449
10709 msgid "guestfs_ln_sf"
10713 #: ../src/guestfs-actions.pod:3451
10717 " guestfs_ln_sf (guestfs_h *g,\n"
10718 " const char *target,\n"
10719 " const char *linkname);\n"
10724 #: ../src/guestfs-actions.pod:3456 ../fish/guestfish-actions.pod:2376
10726 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10727 "option removes the link (C<linkname>) if it exists already."
10731 #: ../src/guestfs-actions.pod:3463
10732 msgid "guestfs_lremovexattr"
10736 #: ../src/guestfs-actions.pod:3465
10740 " guestfs_lremovexattr (guestfs_h *g,\n"
10741 " const char *xattr,\n"
10742 " const char *path);\n"
10747 #: ../src/guestfs-actions.pod:3470
10749 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10750 "link, then it removes an extended attribute of the link itself."
10754 #: ../src/guestfs-actions.pod:3478
10759 #: ../src/guestfs-actions.pod:3480
10763 " guestfs_ls (guestfs_h *g,\n"
10764 " const char *directory);\n"
10769 #: ../src/guestfs-actions.pod:3484 ../fish/guestfish-actions.pod:2391
10771 "List the files in C<directory> (relative to the root directory, there is no "
10772 "cwd). The '.' and '..' entries are not returned, but hidden files are "
10777 #: ../src/guestfs-actions.pod:3488
10779 "This command is mostly useful for interactive sessions. Programs should "
10780 "probably use C<guestfs_readdir> instead."
10784 #: ../src/guestfs-actions.pod:3497
10785 msgid "guestfs_lsetxattr"
10789 #: ../src/guestfs-actions.pod:3499
10793 " guestfs_lsetxattr (guestfs_h *g,\n"
10794 " const char *xattr,\n"
10795 " const char *val,\n"
10797 " const char *path);\n"
10802 #: ../src/guestfs-actions.pod:3506
10804 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10805 "then it sets an extended attribute of the link itself."
10809 #: ../src/guestfs-actions.pod:3514
10810 msgid "guestfs_lstat"
10814 #: ../src/guestfs-actions.pod:3516
10817 " struct guestfs_stat *\n"
10818 " guestfs_lstat (guestfs_h *g,\n"
10819 " const char *path);\n"
10824 #: ../src/guestfs-actions.pod:3520 ../src/guestfs-actions.pod:6026 ../fish/guestfish-actions.pod:2410 ../fish/guestfish-actions.pod:4034
10825 msgid "Returns file information for the given C<path>."
10829 #: ../src/guestfs-actions.pod:3522
10831 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10832 "link, then the link is stat-ed, not the file it refers to."
10836 #: ../src/guestfs-actions.pod:3526 ../fish/guestfish-actions.pod:2416
10837 msgid "This is the same as the C<lstat(2)> system call."
10841 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:6030
10843 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10844 "error. I<The caller must call C<guestfs_free_stat> after use>."
10848 #: ../src/guestfs-actions.pod:3532 ../src/guestfs-actions.pod:6034 ../src/guestfs-actions.pod:6052 ../src/guestfs-actions.pod:6433
10849 msgid "(Added in 0.9.2)"
10853 #: ../src/guestfs-actions.pod:3534
10854 msgid "guestfs_lstatlist"
10858 #: ../src/guestfs-actions.pod:3536
10861 " struct guestfs_stat_list *\n"
10862 " guestfs_lstatlist (guestfs_h *g,\n"
10863 " const char *path,\n"
10864 " char *const *names);\n"
10869 #: ../src/guestfs-actions.pod:3541
10871 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10872 "files, where all files are in the directory C<path>. C<names> is the list "
10873 "of files from this directory."
10877 #: ../src/guestfs-actions.pod:3545 ../fish/guestfish-actions.pod:2426
10879 "On return you get a list of stat structs, with a one-to-one correspondence "
10880 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10881 "then the C<ino> field of that structure is set to C<-1>."
10885 #: ../src/guestfs-actions.pod:3550
10887 "This call is intended for programs that want to efficiently list a directory "
10888 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10889 "for a similarly efficient call for getting extended attributes. Very long "
10890 "directory listings might cause the protocol message size to be exceeded, "
10891 "causing this call to fail. The caller must split up such requests into "
10892 "smaller groups of names."
10896 #: ../src/guestfs-actions.pod:3558
10898 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10899 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10903 #: ../src/guestfs-actions.pod:3564
10904 msgid "guestfs_luks_add_key"
10908 #: ../src/guestfs-actions.pod:3566
10912 " guestfs_luks_add_key (guestfs_h *g,\n"
10913 " const char *device,\n"
10914 " const char *key,\n"
10915 " const char *newkey,\n"
10921 #: ../src/guestfs-actions.pod:3573 ../fish/guestfish-actions.pod:2443
10923 "This command adds a new key on LUKS device C<device>. C<key> is any "
10924 "existing key, and is used to access the device. C<newkey> is the new key to "
10925 "add. C<keyslot> is the key slot that will be replaced."
10929 #: ../src/guestfs-actions.pod:3578
10931 "Note that if C<keyslot> already contains a key, then this command will "
10932 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10936 #: ../src/guestfs-actions.pod:3584 ../src/guestfs-actions.pod:3624 ../src/guestfs-actions.pod:3647 ../src/guestfs-actions.pod:3667 ../src/guestfs-actions.pod:3699 ../src/guestfs-actions.pod:3718
10938 "This function takes a key or passphrase parameter which could contain "
10939 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10944 #: ../src/guestfs-actions.pod:3588 ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:3671
10945 msgid "(Added in 1.5.2)"
10949 #: ../src/guestfs-actions.pod:3590
10950 msgid "guestfs_luks_close"
10954 #: ../src/guestfs-actions.pod:3592
10958 " guestfs_luks_close (guestfs_h *g,\n"
10959 " const char *device);\n"
10964 #: ../src/guestfs-actions.pod:3596
10966 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10967 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10968 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10969 "underlying block device."
10973 #: ../src/guestfs-actions.pod:3604 ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:3722 ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:3820
10974 msgid "(Added in 1.5.1)"
10978 #: ../src/guestfs-actions.pod:3606
10979 msgid "guestfs_luks_format"
10983 #: ../src/guestfs-actions.pod:3608
10987 " guestfs_luks_format (guestfs_h *g,\n"
10988 " const char *device,\n"
10989 " const char *key,\n"
10995 #: ../src/guestfs-actions.pod:3614 ../fish/guestfish-actions.pod:2469
10997 "This command erases existing data on C<device> and formats the device as a "
10998 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10999 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
11003 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3644 ../src/guestfs-actions.pod:3784 ../src/guestfs-actions.pod:4723 ../src/guestfs-actions.pod:5486 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5884 ../src/guestfs-actions.pod:5910 ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:2477 ../fish/guestfish-actions.pod:2490 ../fish/guestfish-actions.pod:2574 ../fish/guestfish-actions.pod:3146 ../fish/guestfish-actions.pod:3653 ../fish/guestfish-actions.pod:3933 ../fish/guestfish-actions.pod:3949 ../fish/guestfish-actions.pod:3964 ../fish/guestfish-actions.pod:4679
11005 "B<This command is dangerous. Without careful use you can easily destroy all "
11010 #: ../src/guestfs-actions.pod:3630
11011 msgid "guestfs_luks_format_cipher"
11015 #: ../src/guestfs-actions.pod:3632
11019 " guestfs_luks_format_cipher (guestfs_h *g,\n"
11020 " const char *device,\n"
11021 " const char *key,\n"
11023 " const char *cipher);\n"
11028 #: ../src/guestfs-actions.pod:3639
11030 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11031 "set the C<cipher> used."
11035 #: ../src/guestfs-actions.pod:3653
11036 msgid "guestfs_luks_kill_slot"
11040 #: ../src/guestfs-actions.pod:3655
11044 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11045 " const char *device,\n"
11046 " const char *key,\n"
11052 #: ../src/guestfs-actions.pod:3661 ../fish/guestfish-actions.pod:2497
11054 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11055 "device C<device>. C<key> must be one of the I<other> keys."
11059 #: ../src/guestfs-actions.pod:3673
11060 msgid "guestfs_luks_open"
11064 #: ../src/guestfs-actions.pod:3675
11068 " guestfs_luks_open (guestfs_h *g,\n"
11069 " const char *device,\n"
11070 " const char *key,\n"
11071 " const char *mapname);\n"
11076 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2508
11078 "This command opens a block device which has been encrypted according to the "
11079 "Linux Unified Key Setup (LUKS) standard."
11083 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2511
11084 msgid "C<device> is the encrypted block device or partition."
11088 #: ../src/guestfs-actions.pod:3686 ../fish/guestfish-actions.pod:2513
11090 "The caller must supply one of the keys associated with the LUKS block "
11091 "device, in the C<key> parameter."
11095 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2516
11097 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11098 "writes to this block device are decrypted from and encrypted to the "
11099 "underlying C<device> respectively."
11103 #: ../src/guestfs-actions.pod:3693
11105 "If this block device contains LVM volume groups, then calling "
11106 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11111 #: ../src/guestfs-actions.pod:3705
11112 msgid "guestfs_luks_open_ro"
11116 #: ../src/guestfs-actions.pod:3707
11120 " guestfs_luks_open_ro (guestfs_h *g,\n"
11121 " const char *device,\n"
11122 " const char *key,\n"
11123 " const char *mapname);\n"
11128 #: ../src/guestfs-actions.pod:3713
11130 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11135 #: ../src/guestfs-actions.pod:3724
11136 msgid "guestfs_lvcreate"
11140 #: ../src/guestfs-actions.pod:3726
11144 " guestfs_lvcreate (guestfs_h *g,\n"
11145 " const char *logvol,\n"
11146 " const char *volgroup,\n"
11152 #: ../src/guestfs-actions.pod:3732 ../fish/guestfish-actions.pod:2541
11154 "This creates an LVM logical volume called C<logvol> on the volume group "
11155 "C<volgroup>, with C<size> megabytes."
11159 #: ../src/guestfs-actions.pod:3739
11160 msgid "guestfs_lvm_canonical_lv_name"
11164 #: ../src/guestfs-actions.pod:3741
11168 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11169 " const char *lvname);\n"
11174 #: ../src/guestfs-actions.pod:3745 ../fish/guestfish-actions.pod:2548
11176 "This converts alternative naming schemes for LVs that you might find to the "
11177 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11182 #: ../src/guestfs-actions.pod:3749 ../fish/guestfish-actions.pod:2552
11184 "This command returns an error if the C<lvname> parameter does not refer to a "
11189 #: ../src/guestfs-actions.pod:3752
11190 msgid "See also C<guestfs_is_lv>."
11194 #: ../src/guestfs-actions.pod:3757
11195 msgid "(Added in 1.5.24)"
11199 #: ../src/guestfs-actions.pod:3759
11200 msgid "guestfs_lvm_clear_filter"
11204 #: ../src/guestfs-actions.pod:3761
11208 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11213 #: ../src/guestfs-actions.pod:3764
11215 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11216 "see every block device."
11220 #: ../src/guestfs-actions.pod:3767 ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2564 ../fish/guestfish-actions.pod:2595
11221 msgid "This command also clears the LVM cache and performs a volume group scan."
11225 #: ../src/guestfs-actions.pod:3774
11226 msgid "guestfs_lvm_remove_all"
11230 #: ../src/guestfs-actions.pod:3776
11234 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11239 #: ../src/guestfs-actions.pod:3779 ../fish/guestfish-actions.pod:2571
11241 "This command removes all LVM logical volumes, volume groups and physical "
11246 #: ../src/guestfs-actions.pod:3789
11247 msgid "guestfs_lvm_set_filter"
11251 #: ../src/guestfs-actions.pod:3791
11255 " guestfs_lvm_set_filter (guestfs_h *g,\n"
11256 " char *const *devices);\n"
11261 #: ../src/guestfs-actions.pod:3795 ../fish/guestfish-actions.pod:2581
11263 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11264 "block devices in the list C<devices>, and will ignore all other attached "
11269 #: ../src/guestfs-actions.pod:3799 ../fish/guestfish-actions.pod:2585
11271 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11272 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11273 "there are two types of duplication possible: either cloned PVs/VGs which "
11274 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11275 "same name. In normal operation you cannot create this situation, but you "
11276 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11277 "inside the LVM metadata."
11281 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
11282 msgid "You can filter whole block devices or individual partitions."
11286 #: ../src/guestfs-actions.pod:3814 ../fish/guestfish-actions.pod:2600
11288 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11289 "filesystem), even if you are not filtering out that VG."
11293 #: ../src/guestfs-actions.pod:3822
11294 msgid "guestfs_lvremove"
11298 #: ../src/guestfs-actions.pod:3824
11302 " guestfs_lvremove (guestfs_h *g,\n"
11303 " const char *device);\n"
11308 #: ../src/guestfs-actions.pod:3828 ../fish/guestfish-actions.pod:2608
11310 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11311 "LV, such as C</dev/VG/LV>."
11315 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2611
11317 "You can also remove all LVs in a volume group by specifying the VG name, "
11322 #: ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:5069 ../src/guestfs-actions.pod:6809
11323 msgid "(Added in 1.0.13)"
11327 #: ../src/guestfs-actions.pod:3838
11328 msgid "guestfs_lvrename"
11332 #: ../src/guestfs-actions.pod:3840
11336 " guestfs_lvrename (guestfs_h *g,\n"
11337 " const char *logvol,\n"
11338 " const char *newlogvol);\n"
11343 #: ../src/guestfs-actions.pod:3845 ../fish/guestfish-actions.pod:2618
11344 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11348 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:6822
11349 msgid "(Added in 1.0.83)"
11353 #: ../src/guestfs-actions.pod:3851
11354 msgid "guestfs_lvresize"
11358 #: ../src/guestfs-actions.pod:3853
11362 " guestfs_lvresize (guestfs_h *g,\n"
11363 " const char *device,\n"
11369 #: ../src/guestfs-actions.pod:3858 ../fish/guestfish-actions.pod:2624
11371 "This resizes (expands or shrinks) an existing LVM logical volume to "
11372 "C<mbytes>. When reducing, data in the reduced part is lost."
11376 #: ../src/guestfs-actions.pod:3866
11377 msgid "guestfs_lvresize_free"
11381 #: ../src/guestfs-actions.pod:3868
11385 " guestfs_lvresize_free (guestfs_h *g,\n"
11386 " const char *lv,\n"
11392 #: ../src/guestfs-actions.pod:3873 ../fish/guestfish-actions.pod:2632
11394 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11395 "remaining free space in the volume group. Commonly you would call this with "
11396 "pc = 100 which expands the logical volume as much as possible, using all "
11397 "remaining free space in the volume group."
11401 #: ../src/guestfs-actions.pod:3881
11402 msgid "(Added in 1.3.3)"
11406 #: ../src/guestfs-actions.pod:3883
11407 msgid "guestfs_lvs"
11411 #: ../src/guestfs-actions.pod:3885
11415 " guestfs_lvs (guestfs_h *g);\n"
11420 #: ../src/guestfs-actions.pod:3888 ../fish/guestfish-actions.pod:2642
11422 "List all the logical volumes detected. This is the equivalent of the "
11423 "L<lvs(8)> command."
11427 #: ../src/guestfs-actions.pod:3891 ../fish/guestfish-actions.pod:2645
11429 "This returns a list of the logical volume device names "
11430 "(eg. C</dev/VolGroup00/LogVol00>)."
11434 #: ../src/guestfs-actions.pod:3894
11435 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
11439 #: ../src/guestfs-actions.pod:3902
11440 msgid "guestfs_lvs_full"
11444 #: ../src/guestfs-actions.pod:3904
11447 " struct guestfs_lvm_lv_list *\n"
11448 " guestfs_lvs_full (guestfs_h *g);\n"
11453 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2654
11455 "List all the logical volumes detected. This is the equivalent of the "
11456 "L<lvs(8)> command. The \"full\" version includes all fields."
11460 #: ../src/guestfs-actions.pod:3910
11462 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
11463 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
11468 #: ../src/guestfs-actions.pod:3916
11469 msgid "guestfs_lvuuid"
11473 #: ../src/guestfs-actions.pod:3918
11477 " guestfs_lvuuid (guestfs_h *g,\n"
11478 " const char *device);\n"
11483 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2661
11484 msgid "This command returns the UUID of the LVM LV C<device>."
11488 #: ../src/guestfs-actions.pod:3929
11489 msgid "guestfs_lxattrlist"
11493 #: ../src/guestfs-actions.pod:3931
11496 " struct guestfs_xattr_list *\n"
11497 " guestfs_lxattrlist (guestfs_h *g,\n"
11498 " const char *path,\n"
11499 " char *const *names);\n"
11504 #: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:2667
11506 "This call allows you to get the extended attributes of multiple files, where "
11507 "all files are in the directory C<path>. C<names> is the list of files from "
11512 #: ../src/guestfs-actions.pod:3940 ../fish/guestfish-actions.pod:2671
11514 "On return you get a flat list of xattr structs which must be interpreted "
11515 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11516 "C<attrval> in this struct is zero-length to indicate there was an error "
11517 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11518 "number (the number of following attributes for this file, which could be "
11519 "C<\"0\">). Then after the first xattr struct are the zero or more "
11520 "attributes for the first named file. This repeats for the second and "
11521 "subsequent files."
11525 #: ../src/guestfs-actions.pod:3950
11527 "This call is intended for programs that want to efficiently list a directory "
11528 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11529 "a similarly efficient call for getting standard stats. Very long directory "
11530 "listings might cause the protocol message size to be exceeded, causing this "
11531 "call to fail. The caller must split up such requests into smaller groups of "
11536 #: ../src/guestfs-actions.pod:3964
11537 msgid "guestfs_mkdir"
11541 #: ../src/guestfs-actions.pod:3966
11545 " guestfs_mkdir (guestfs_h *g,\n"
11546 " const char *path);\n"
11551 #: ../src/guestfs-actions.pod:3970 ../fish/guestfish-actions.pod:2693
11552 msgid "Create a directory named C<path>."
11556 #: ../src/guestfs-actions.pod:3976
11557 msgid "guestfs_mkdir_mode"
11561 #: ../src/guestfs-actions.pod:3978
11565 " guestfs_mkdir_mode (guestfs_h *g,\n"
11566 " const char *path,\n"
11572 #: ../src/guestfs-actions.pod:3983 ../fish/guestfish-actions.pod:2699
11574 "This command creates a directory, setting the initial permissions of the "
11575 "directory to C<mode>."
11579 #: ../src/guestfs-actions.pod:3986 ../fish/guestfish-actions.pod:2702
11581 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11582 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11587 #: ../src/guestfs-actions.pod:3990
11588 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11592 #: ../src/guestfs-actions.pod:3996
11593 msgid "guestfs_mkdir_p"
11597 #: ../src/guestfs-actions.pod:3998
11601 " guestfs_mkdir_p (guestfs_h *g,\n"
11602 " const char *path);\n"
11607 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2712
11609 "Create a directory named C<path>, creating any parent directories as "
11610 "necessary. This is like the C<mkdir -p> shell command."
11614 #: ../src/guestfs-actions.pod:4009
11615 msgid "guestfs_mkdtemp"
11619 #: ../src/guestfs-actions.pod:4011
11623 " guestfs_mkdtemp (guestfs_h *g,\n"
11624 " const char *template);\n"
11629 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2719
11631 "This command creates a temporary directory. The C<template> parameter "
11632 "should be a full pathname for the temporary directory name with the final "
11633 "six characters being \"XXXXXX\"."
11637 #: ../src/guestfs-actions.pod:4020 ../fish/guestfish-actions.pod:2724
11639 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11640 "being suitable for Windows filesystems."
11644 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2727
11645 msgid "The name of the temporary directory that was created is returned."
11649 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2730
11650 msgid "The temporary directory is created with mode 0700 and is owned by root."
11654 #: ../src/guestfs-actions.pod:4029 ../fish/guestfish-actions.pod:2733
11656 "The caller is responsible for deleting the temporary directory and its "
11657 "contents after use."
11661 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2736
11662 msgid "See also: L<mkdtemp(3)>"
11666 #: ../src/guestfs-actions.pod:4039
11667 msgid "guestfs_mke2fs_J"
11671 #: ../src/guestfs-actions.pod:4041
11675 " guestfs_mke2fs_J (guestfs_h *g,\n"
11676 " const char *fstype,\n"
11677 " int blocksize,\n"
11678 " const char *device,\n"
11679 " const char *journal);\n"
11684 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2742
11686 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11687 "C<journal>. It is equivalent to the command:"
11691 #: ../src/guestfs-actions.pod:4052 ../fish/guestfish-actions.pod:2746
11694 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11699 #: ../src/guestfs-actions.pod:4054
11700 msgid "See also C<guestfs_mke2journal>."
11704 #: ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4076 ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4110 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4138 ../src/guestfs-actions.pod:4197 ../src/guestfs-actions.pod:4450
11705 msgid "(Added in 1.0.68)"
11709 #: ../src/guestfs-actions.pod:4060
11710 msgid "guestfs_mke2fs_JL"
11714 #: ../src/guestfs-actions.pod:4062
11718 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11719 " const char *fstype,\n"
11720 " int blocksize,\n"
11721 " const char *device,\n"
11722 " const char *label);\n"
11727 #: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:2754
11729 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11730 "the journal labeled C<label>."
11734 #: ../src/guestfs-actions.pod:4072
11735 msgid "See also C<guestfs_mke2journal_L>."
11739 #: ../src/guestfs-actions.pod:4078
11740 msgid "guestfs_mke2fs_JU"
11744 #: ../src/guestfs-actions.pod:4080
11748 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11749 " const char *fstype,\n"
11750 " int blocksize,\n"
11751 " const char *device,\n"
11752 " const char *uuid);\n"
11757 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2763
11759 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11760 "the journal with UUID C<uuid>."
11764 #: ../src/guestfs-actions.pod:4090
11765 msgid "See also C<guestfs_mke2journal_U>."
11769 #: ../src/guestfs-actions.pod:4096
11770 msgid "guestfs_mke2journal"
11774 #: ../src/guestfs-actions.pod:4098
11778 " guestfs_mke2journal (guestfs_h *g,\n"
11779 " int blocksize,\n"
11780 " const char *device);\n"
11785 #: ../src/guestfs-actions.pod:4103 ../fish/guestfish-actions.pod:2772
11787 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11792 #: ../src/guestfs-actions.pod:4106 ../fish/guestfish-actions.pod:2775
11795 " mke2fs -O journal_dev -b blocksize device\n"
11800 #: ../src/guestfs-actions.pod:4112
11801 msgid "guestfs_mke2journal_L"
11805 #: ../src/guestfs-actions.pod:4114
11809 " guestfs_mke2journal_L (guestfs_h *g,\n"
11810 " int blocksize,\n"
11811 " const char *label,\n"
11812 " const char *device);\n"
11817 #: ../src/guestfs-actions.pod:4120 ../fish/guestfish-actions.pod:2781
11818 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11822 #: ../src/guestfs-actions.pod:4126
11823 msgid "guestfs_mke2journal_U"
11827 #: ../src/guestfs-actions.pod:4128
11831 " guestfs_mke2journal_U (guestfs_h *g,\n"
11832 " int blocksize,\n"
11833 " const char *uuid,\n"
11834 " const char *device);\n"
11839 #: ../src/guestfs-actions.pod:4134 ../fish/guestfish-actions.pod:2787
11840 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11844 #: ../src/guestfs-actions.pod:4140
11845 msgid "guestfs_mkfifo"
11849 #: ../src/guestfs-actions.pod:4142
11853 " guestfs_mkfifo (guestfs_h *g,\n"
11855 " const char *path);\n"
11860 #: ../src/guestfs-actions.pod:4147
11862 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11863 "is just a convenient wrapper around C<guestfs_mknod>."
11867 #: ../src/guestfs-actions.pod:4157
11868 msgid "guestfs_mkfs"
11872 #: ../src/guestfs-actions.pod:4159
11876 " guestfs_mkfs (guestfs_h *g,\n"
11877 " const char *fstype,\n"
11878 " const char *device);\n"
11883 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2803
11885 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11886 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11890 #: ../src/guestfs-actions.pod:4172
11891 msgid "guestfs_mkfs_b"
11895 #: ../src/guestfs-actions.pod:4174
11899 " guestfs_mkfs_b (guestfs_h *g,\n"
11900 " const char *fstype,\n"
11901 " int blocksize,\n"
11902 " const char *device);\n"
11907 #: ../src/guestfs-actions.pod:4180
11909 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11910 "block size of the resulting filesystem. Supported block sizes depend on the "
11911 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11915 #: ../src/guestfs-actions.pod:4185 ../src/guestfs-actions.pod:4227 ../fish/guestfish-actions.pod:2816 ../fish/guestfish-actions.pod:2843
11917 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11922 #: ../src/guestfs-actions.pod:4190
11924 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
11929 #: ../src/guestfs-actions.pod:4199
11930 msgid "guestfs_mkfs_opts"
11934 #: ../src/guestfs-actions.pod:4201
11938 " guestfs_mkfs_opts (guestfs_h *g,\n"
11939 " const char *fstype,\n"
11940 " const char *device,\n"
11946 #: ../src/guestfs-actions.pod:4212
11949 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
11954 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2830
11956 "This function creates a filesystem on C<device>. The filesystem type is "
11957 "C<fstype>, for example C<ext3>."
11961 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2837
11962 msgid "C<blocksize>"
11966 #: ../src/guestfs-actions.pod:4223 ../fish/guestfish-actions.pod:2839
11968 "The filesystem block size. Supported block sizes depend on the filesystem "
11969 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11974 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2846
11975 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
11979 #: ../src/guestfs-actions.pod:4236
11980 msgid "(Added in 1.7.19)"
11984 #: ../src/guestfs-actions.pod:4238
11985 msgid "guestfs_mkfs_opts_va"
11989 #: ../src/guestfs-actions.pod:4240
11993 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
11994 " const char *fstype,\n"
11995 " const char *device,\n"
11996 " va_list args);\n"
12001 #: ../src/guestfs-actions.pod:4246
12002 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
12006 #: ../src/guestfs-actions.pod:4250
12007 msgid "guestfs_mkfs_opts_argv"
12011 #: ../src/guestfs-actions.pod:4252
12015 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
12016 " const char *fstype,\n"
12017 " const char *device,\n"
12018 " const struct guestfs_mkfs_opts_argv *optargs);\n"
12023 #: ../src/guestfs-actions.pod:4258
12024 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
12028 #: ../src/guestfs-actions.pod:4262
12029 msgid "guestfs_mkmountpoint"
12033 #: ../src/guestfs-actions.pod:4264
12037 " guestfs_mkmountpoint (guestfs_h *g,\n"
12038 " const char *exemptpath);\n"
12043 #: ../src/guestfs-actions.pod:4268
12045 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12046 "that can be used to create extra mountpoints before mounting the first "
12051 #: ../src/guestfs-actions.pod:4272 ../fish/guestfish-actions.pod:2860
12053 "These calls are I<only> necessary in some very limited circumstances, mainly "
12054 "the case where you want to mount a mix of unrelated and/or read-only "
12055 "filesystems together."
12059 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2864
12061 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12062 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12063 "inside that. You can unpack this as follows in guestfish:"
12067 #: ../src/guestfs-actions.pod:4281 ../fish/guestfish-actions.pod:2869
12070 " add-ro Fedora-11-i686-Live.iso\n"
12072 " mkmountpoint /cd\n"
12073 " mkmountpoint /sqsh\n"
12074 " mkmountpoint /ext3fs\n"
12075 " mount /dev/sda /cd\n"
12076 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12077 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12082 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2878
12083 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12087 #: ../src/guestfs-actions.pod:4292
12089 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12090 "may get unexpected errors if you try to mix these calls. It is safest to "
12091 "manually unmount filesystems and remove mountpoints after use."
12095 #: ../src/guestfs-actions.pod:4296
12097 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12098 "first, so for this to work for manual mountpoints, you must ensure that the "
12099 "innermost mountpoints have the longest pathnames, as in the example code "
12104 #: ../src/guestfs-actions.pod:4301 ../fish/guestfish-actions.pod:2889
12105 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12109 #: ../src/guestfs-actions.pod:4303
12111 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12112 "means that C<guestfs_umount_all> is called when the handle is closed which "
12113 "can also trigger these issues."
12117 #: ../src/guestfs-actions.pod:4309 ../src/guestfs-actions.pod:4568 ../src/guestfs-actions.pod:5470
12118 msgid "(Added in 1.0.62)"
12122 #: ../src/guestfs-actions.pod:4311
12123 msgid "guestfs_mknod"
12127 #: ../src/guestfs-actions.pod:4313
12131 " guestfs_mknod (guestfs_h *g,\n"
12135 " const char *path);\n"
12140 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2899
12142 "This call creates block or character special devices, or named pipes "
12147 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2902
12149 "The C<mode> parameter should be the mode, using the standard constants. "
12150 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12151 "used when creating block and character special devices."
12155 #: ../src/guestfs-actions.pod:4328
12157 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12158 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12159 "regular file). These constants are available in the standard Linux header "
12160 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12161 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12162 "the appropriate constant for you."
12166 #: ../src/guestfs-actions.pod:4342
12167 msgid "guestfs_mknod_b"
12171 #: ../src/guestfs-actions.pod:4344
12175 " guestfs_mknod_b (guestfs_h *g,\n"
12179 " const char *path);\n"
12184 #: ../src/guestfs-actions.pod:4351
12186 "This call creates a block device node called C<path> with mode C<mode> and "
12187 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12188 "wrapper around C<guestfs_mknod>."
12192 #: ../src/guestfs-actions.pod:4361
12193 msgid "guestfs_mknod_c"
12197 #: ../src/guestfs-actions.pod:4363
12201 " guestfs_mknod_c (guestfs_h *g,\n"
12205 " const char *path);\n"
12210 #: ../src/guestfs-actions.pod:4370
12212 "This call creates a char device node called C<path> with mode C<mode> and "
12213 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12214 "wrapper around C<guestfs_mknod>."
12218 #: ../src/guestfs-actions.pod:4380
12219 msgid "guestfs_mkswap"
12223 #: ../src/guestfs-actions.pod:4382
12227 " guestfs_mkswap (guestfs_h *g,\n"
12228 " const char *device);\n"
12233 #: ../src/guestfs-actions.pod:4386 ../fish/guestfish-actions.pod:2941
12234 msgid "Create a swap partition on C<device>."
12238 #: ../src/guestfs-actions.pod:4392
12239 msgid "guestfs_mkswap_L"
12243 #: ../src/guestfs-actions.pod:4394
12247 " guestfs_mkswap_L (guestfs_h *g,\n"
12248 " const char *label,\n"
12249 " const char *device);\n"
12254 #: ../src/guestfs-actions.pod:4399 ../fish/guestfish-actions.pod:2947
12255 msgid "Create a swap partition on C<device> with label C<label>."
12259 #: ../src/guestfs-actions.pod:4401 ../fish/guestfish-actions.pod:2949
12261 "Note that you cannot attach a swap label to a block device "
12262 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12263 "the kernel or swap tools."
12267 #: ../src/guestfs-actions.pod:4409
12268 msgid "guestfs_mkswap_U"
12272 #: ../src/guestfs-actions.pod:4411
12276 " guestfs_mkswap_U (guestfs_h *g,\n"
12277 " const char *uuid,\n"
12278 " const char *device);\n"
12283 #: ../src/guestfs-actions.pod:4416 ../fish/guestfish-actions.pod:2957
12284 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12288 #: ../src/guestfs-actions.pod:4422
12289 msgid "guestfs_mkswap_file"
12293 #: ../src/guestfs-actions.pod:4424
12297 " guestfs_mkswap_file (guestfs_h *g,\n"
12298 " const char *path);\n"
12303 #: ../src/guestfs-actions.pod:4428 ../fish/guestfish-actions.pod:2963
12304 msgid "Create a swap file."
12308 #: ../src/guestfs-actions.pod:4430
12310 "This command just writes a swap file signature to an existing file. To "
12311 "create the file itself, use something like C<guestfs_fallocate>."
12315 #: ../src/guestfs-actions.pod:4437
12316 msgid "guestfs_modprobe"
12320 #: ../src/guestfs-actions.pod:4439
12324 " guestfs_modprobe (guestfs_h *g,\n"
12325 " const char *modulename);\n"
12330 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:2972
12331 msgid "This loads a kernel module in the appliance."
12335 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2974
12337 "The kernel module must have been whitelisted when libguestfs was built (see "
12338 "C<appliance/kmod.whitelist.in> in the source)."
12342 #: ../src/guestfs-actions.pod:4452
12343 msgid "guestfs_mount"
12347 #: ../src/guestfs-actions.pod:4454
12351 " guestfs_mount (guestfs_h *g,\n"
12352 " const char *device,\n"
12353 " const char *mountpoint);\n"
12358 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:2981
12360 "Mount a guest disk at a position in the filesystem. Block devices are named "
12361 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12362 "those block devices contain partitions, they will have the usual names "
12363 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12367 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2987
12369 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12370 "mounted on C</> before others can be mounted. Other filesystems can only be "
12371 "mounted on directories which already exist."
12375 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:2992
12377 "The mounted filesystem is writable, if we have sufficient permissions on the "
12378 "underlying device."
12382 #: ../src/guestfs-actions.pod:4473
12384 "B<Important note:> When you use this call, the filesystem options C<sync> "
12385 "and C<noatime> are set implicitly. This was originally done because we "
12386 "thought it would improve reliability, but it turns out that I<-o sync> has a "
12387 "very large negative performance impact and negligible effect on "
12388 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
12389 "in any code that needs performance, and instead use C<guestfs_mount_options> "
12390 "(use an empty string for the first parameter if you don't want any options)."
12394 #: ../src/guestfs-actions.pod:4487
12395 msgid "guestfs_mount_loop"
12399 #: ../src/guestfs-actions.pod:4489
12403 " guestfs_mount_loop (guestfs_h *g,\n"
12404 " const char *file,\n"
12405 " const char *mountpoint);\n"
12410 #: ../src/guestfs-actions.pod:4494 ../fish/guestfish-actions.pod:3009
12412 "This command lets you mount C<file> (a filesystem image in a file) on a "
12413 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12418 #: ../src/guestfs-actions.pod:4502
12419 msgid "guestfs_mount_options"
12423 #: ../src/guestfs-actions.pod:4504
12427 " guestfs_mount_options (guestfs_h *g,\n"
12428 " const char *options,\n"
12429 " const char *device,\n"
12430 " const char *mountpoint);\n"
12435 #: ../src/guestfs-actions.pod:4510
12437 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12438 "the mount options as for the L<mount(8)> I<-o> flag."
12442 #: ../src/guestfs-actions.pod:4514 ../fish/guestfish-actions.pod:3021
12444 "If the C<options> parameter is an empty string, then no options are passed "
12445 "(all options default to whatever the filesystem uses)."
12449 #: ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4534 ../src/guestfs-actions.pod:4551
12450 msgid "(Added in 1.0.10)"
12454 #: ../src/guestfs-actions.pod:4522
12455 msgid "guestfs_mount_ro"
12459 #: ../src/guestfs-actions.pod:4524
12463 " guestfs_mount_ro (guestfs_h *g,\n"
12464 " const char *device,\n"
12465 " const char *mountpoint);\n"
12470 #: ../src/guestfs-actions.pod:4529
12472 "This is the same as the C<guestfs_mount> command, but it mounts the "
12473 "filesystem with the read-only (I<-o ro>) flag."
12477 #: ../src/guestfs-actions.pod:4536
12478 msgid "guestfs_mount_vfs"
12482 #: ../src/guestfs-actions.pod:4538
12486 " guestfs_mount_vfs (guestfs_h *g,\n"
12487 " const char *options,\n"
12488 " const char *vfstype,\n"
12489 " const char *device,\n"
12490 " const char *mountpoint);\n"
12495 #: ../src/guestfs-actions.pod:4545
12497 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12498 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
12503 #: ../src/guestfs-actions.pod:4553
12504 msgid "guestfs_mountpoints"
12508 #: ../src/guestfs-actions.pod:4555
12512 " guestfs_mountpoints (guestfs_h *g);\n"
12517 #: ../src/guestfs-actions.pod:4558
12519 "This call is similar to C<guestfs_mounts>. That call returns a list of "
12520 "devices. This one returns a hash table (map) of device name to directory "
12521 "where the device is mounted."
12525 #: ../src/guestfs-actions.pod:4570
12526 msgid "guestfs_mounts"
12530 #: ../src/guestfs-actions.pod:4572
12534 " guestfs_mounts (guestfs_h *g);\n"
12539 #: ../src/guestfs-actions.pod:4575 ../fish/guestfish-actions.pod:3052
12541 "This returns the list of currently mounted filesystems. It returns the list "
12542 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12546 #: ../src/guestfs-actions.pod:4578 ../fish/guestfish-actions.pod:3055
12547 msgid "Some internal mounts are not shown."
12551 #: ../src/guestfs-actions.pod:4580
12552 msgid "See also: C<guestfs_mountpoints>"
12556 #: ../src/guestfs-actions.pod:4588
12561 #: ../src/guestfs-actions.pod:4590
12565 " guestfs_mv (guestfs_h *g,\n"
12566 " const char *src,\n"
12567 " const char *dest);\n"
12572 #: ../src/guestfs-actions.pod:4595 ../fish/guestfish-actions.pod:3063
12574 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12575 "destination filename or destination directory."
12579 #: ../src/guestfs-actions.pod:4602
12580 msgid "guestfs_ntfs_3g_probe"
12584 #: ../src/guestfs-actions.pod:4604
12588 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12590 " const char *device);\n"
12595 #: ../src/guestfs-actions.pod:4609 ../fish/guestfish-actions.pod:3070
12597 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12598 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12599 "read-write, and some cannot be mounted at all)."
12603 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3074
12605 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12606 "can be mounted read-write. Set it to false if you want to test if the "
12607 "volume can be mounted read-only."
12611 #: ../src/guestfs-actions.pod:4617 ../fish/guestfish-actions.pod:3078
12613 "The return value is an integer which C<0> if the operation would succeed, or "
12614 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12618 #: ../src/guestfs-actions.pod:4623
12619 msgid "(Added in 1.0.43)"
12623 #: ../src/guestfs-actions.pod:4625
12624 msgid "guestfs_ntfsresize"
12628 #: ../src/guestfs-actions.pod:4627
12632 " guestfs_ntfsresize (guestfs_h *g,\n"
12633 " const char *device);\n"
12638 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3086
12640 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12641 "size of the underlying device."
12645 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3089
12647 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
12648 "consistency check (for safety). You have to boot into Windows to perform "
12649 "this check and clear this condition. Furthermore, ntfsresize refuses to "
12650 "resize filesystems which have been marked in this way. So in effect it is "
12651 "not possible to call ntfsresize multiple times on a single filesystem "
12652 "without booting into Windows between each resize."
12656 #: ../src/guestfs-actions.pod:4642 ../fish/guestfish-actions.pod:3097
12657 msgid "See also L<ntfsresize(8)>."
12661 #: ../src/guestfs-actions.pod:4648
12662 msgid "guestfs_ntfsresize_size"
12666 #: ../src/guestfs-actions.pod:4650
12670 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12671 " const char *device,\n"
12672 " int64_t size);\n"
12677 #: ../src/guestfs-actions.pod:4655
12679 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12680 "to specify the new size (in bytes) explicitly."
12684 #: ../src/guestfs-actions.pod:4660 ../src/guestfs-actions.pod:5096 ../src/guestfs-actions.pod:5169 ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:6957
12685 msgid "(Added in 1.3.14)"
12689 #: ../src/guestfs-actions.pod:4662
12690 msgid "guestfs_part_add"
12694 #: ../src/guestfs-actions.pod:4664
12698 " guestfs_part_add (guestfs_h *g,\n"
12699 " const char *device,\n"
12700 " const char *prlogex,\n"
12701 " int64_t startsect,\n"
12702 " int64_t endsect);\n"
12707 #: ../src/guestfs-actions.pod:4671
12709 "This command adds a partition to C<device>. If there is no partition table "
12710 "on the device, call C<guestfs_part_init> first."
12714 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3113
12716 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12717 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12718 "C<logical>) and C<e> (or C<extended>) partition types."
12722 #: ../src/guestfs-actions.pod:4679 ../fish/guestfish-actions.pod:3118
12724 "C<startsect> and C<endsect> are the start and end of the partition in "
12725 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12726 "from the end of the disk (C<-1> is the last sector)."
12730 #: ../src/guestfs-actions.pod:4683
12732 "Creating a partition which covers the whole disk is not so easy. Use "
12733 "C<guestfs_part_disk> to do that."
12737 #: ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4726 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4914 ../src/guestfs-actions.pod:4954
12738 msgid "(Added in 1.0.78)"
12742 #: ../src/guestfs-actions.pod:4690
12743 msgid "guestfs_part_del"
12747 #: ../src/guestfs-actions.pod:4692
12751 " guestfs_part_del (guestfs_h *g,\n"
12752 " const char *device,\n"
12758 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3129
12759 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12763 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3131
12765 "Note that in the case of MBR partitioning, deleting an extended partition "
12766 "also deletes any logical partitions it contains."
12770 #: ../src/guestfs-actions.pod:4707
12771 msgid "guestfs_part_disk"
12775 #: ../src/guestfs-actions.pod:4709
12779 " guestfs_part_disk (guestfs_h *g,\n"
12780 " const char *device,\n"
12781 " const char *parttype);\n"
12786 #: ../src/guestfs-actions.pod:4714
12788 "This command is simply a combination of C<guestfs_part_init> followed by "
12789 "C<guestfs_part_add> to create a single primary partition covering the whole "
12794 #: ../src/guestfs-actions.pod:4718
12796 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12797 "possible values are described in C<guestfs_part_init>."
12801 #: ../src/guestfs-actions.pod:4728
12802 msgid "guestfs_part_get_bootable"
12806 #: ../src/guestfs-actions.pod:4730
12810 " guestfs_part_get_bootable (guestfs_h *g,\n"
12811 " const char *device,\n"
12817 #: ../src/guestfs-actions.pod:4735 ../fish/guestfish-actions.pod:3153
12819 "This command returns true if the partition C<partnum> on C<device> has the "
12820 "bootable flag set."
12824 #: ../src/guestfs-actions.pod:4738
12825 msgid "See also C<guestfs_part_set_bootable>."
12829 #: ../src/guestfs-actions.pod:4744
12830 msgid "guestfs_part_get_mbr_id"
12834 #: ../src/guestfs-actions.pod:4746
12838 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12839 " const char *device,\n"
12845 #: ../src/guestfs-actions.pod:4751 ../fish/guestfish-actions.pod:3162
12847 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12848 "partition C<partnum>."
12852 #: ../src/guestfs-actions.pod:4754 ../src/guestfs-actions.pod:4930
12854 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12855 "undefined results for other partition table types (see "
12856 "C<guestfs_part_get_parttype>)."
12860 #: ../src/guestfs-actions.pod:4762
12861 msgid "guestfs_part_get_parttype"
12865 #: ../src/guestfs-actions.pod:4764
12869 " guestfs_part_get_parttype (guestfs_h *g,\n"
12870 " const char *device);\n"
12875 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3173
12877 "This command examines the partition table on C<device> and returns the "
12878 "partition table type (format) being used."
12882 #: ../src/guestfs-actions.pod:4771
12884 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12885 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12886 "possible, although unusual. See C<guestfs_part_init> for a full list."
12890 #: ../src/guestfs-actions.pod:4781
12891 msgid "guestfs_part_init"
12895 #: ../src/guestfs-actions.pod:4783
12899 " guestfs_part_init (guestfs_h *g,\n"
12900 " const char *device,\n"
12901 " const char *parttype);\n"
12906 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3185
12908 "This creates an empty partition table on C<device> of one of the partition "
12909 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12910 "(for large disks)."
12914 #: ../src/guestfs-actions.pod:4792
12916 "Initially there are no partitions. Following this, you should call "
12917 "C<guestfs_part_add> for each partition required."
12921 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3192
12922 msgid "Possible values for C<parttype> are:"
12926 #: ../src/guestfs-actions.pod:4799 ../fish/guestfish-actions.pod:3196
12927 msgid "B<efi> | B<gpt>"
12931 #: ../src/guestfs-actions.pod:4801 ../fish/guestfish-actions.pod:3198
12932 msgid "Intel EFI / GPT partition table."
12936 #: ../src/guestfs-actions.pod:4803 ../fish/guestfish-actions.pod:3200
12938 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12939 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12940 "the C<mbr> format."
12944 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3204
12945 msgid "B<mbr> | B<msdos>"
12949 #: ../src/guestfs-actions.pod:4809 ../fish/guestfish-actions.pod:3206
12951 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12952 "Windows. This partition type will B<only> work for device sizes up to 2 "
12953 "TB. For large disks we recommend using C<gpt>."
12957 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3213
12958 msgid "Other partition table types that may work but are not supported include:"
12962 #: ../src/guestfs-actions.pod:4821 ../fish/guestfish-actions.pod:3218
12967 #: ../src/guestfs-actions.pod:4823 ../fish/guestfish-actions.pod:3220
12968 msgid "AIX disk labels."
12972 #: ../src/guestfs-actions.pod:4825 ../fish/guestfish-actions.pod:3222
12973 msgid "B<amiga> | B<rdb>"
12977 #: ../src/guestfs-actions.pod:4827 ../fish/guestfish-actions.pod:3224
12978 msgid "Amiga \"Rigid Disk Block\" format."
12982 #: ../src/guestfs-actions.pod:4829 ../fish/guestfish-actions.pod:3226
12987 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:3228
12988 msgid "BSD disk labels."
12992 #: ../src/guestfs-actions.pod:4833 ../fish/guestfish-actions.pod:3230
12997 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3232
12998 msgid "DASD, used on IBM mainframes."
13002 #: ../src/guestfs-actions.pod:4837 ../fish/guestfish-actions.pod:3234
13007 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3236
13008 msgid "MIPS/SGI volumes."
13012 #: ../src/guestfs-actions.pod:4841 ../fish/guestfish-actions.pod:3238
13017 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3240
13018 msgid "Old Mac partition format. Modern Macs use C<gpt>."
13022 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3242
13027 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3244
13028 msgid "NEC PC-98 format, common in Japan apparently."
13032 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3246
13037 #: ../src/guestfs-actions.pod:4851 ../fish/guestfish-actions.pod:3248
13038 msgid "Sun disk labels."
13042 #: ../src/guestfs-actions.pod:4859
13043 msgid "guestfs_part_list"
13047 #: ../src/guestfs-actions.pod:4861
13050 " struct guestfs_partition_list *\n"
13051 " guestfs_part_list (guestfs_h *g,\n"
13052 " const char *device);\n"
13057 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3256
13059 "This command parses the partition table on C<device> and returns the list of "
13060 "partitions found."
13064 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3259
13065 msgid "The fields in the returned structure are:"
13069 #: ../src/guestfs-actions.pod:4872 ../fish/guestfish-actions.pod:3263
13070 msgid "B<part_num>"
13074 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3265
13075 msgid "Partition number, counting from 1."
13079 #: ../src/guestfs-actions.pod:4876 ../fish/guestfish-actions.pod:3267
13080 msgid "B<part_start>"
13084 #: ../src/guestfs-actions.pod:4878
13086 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13087 "the device's sector size, see C<guestfs_blockdev_getss>."
13091 #: ../src/guestfs-actions.pod:4881 ../fish/guestfish-actions.pod:3272
13092 msgid "B<part_end>"
13096 #: ../src/guestfs-actions.pod:4883 ../fish/guestfish-actions.pod:3274
13097 msgid "End of the partition in bytes."
13101 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3276
13102 msgid "B<part_size>"
13106 #: ../src/guestfs-actions.pod:4887 ../fish/guestfish-actions.pod:3278
13107 msgid "Size of the partition in bytes."
13111 #: ../src/guestfs-actions.pod:4891
13113 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13114 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13119 #: ../src/guestfs-actions.pod:4897
13120 msgid "guestfs_part_set_bootable"
13124 #: ../src/guestfs-actions.pod:4899
13128 " guestfs_part_set_bootable (guestfs_h *g,\n"
13129 " const char *device,\n"
13131 " int bootable);\n"
13136 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3286
13138 "This sets the bootable flag on partition numbered C<partnum> on device "
13139 "C<device>. Note that partitions are numbered from 1."
13143 #: ../src/guestfs-actions.pod:4908 ../fish/guestfish-actions.pod:3289
13145 "The bootable flag is used by some operating systems (notably Windows) to "
13146 "determine which partition to boot from. It is by no means universally "
13151 #: ../src/guestfs-actions.pod:4916
13152 msgid "guestfs_part_set_mbr_id"
13156 #: ../src/guestfs-actions.pod:4918
13160 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13161 " const char *device,\n"
13168 #: ../src/guestfs-actions.pod:4924 ../fish/guestfish-actions.pod:3297
13170 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13171 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13172 "documentation are in fact hexadecimal numbers, but usually documented "
13173 "without any leading \"0x\" which might be confusing."
13177 #: ../src/guestfs-actions.pod:4938
13178 msgid "guestfs_part_set_name"
13182 #: ../src/guestfs-actions.pod:4940
13186 " guestfs_part_set_name (guestfs_h *g,\n"
13187 " const char *device,\n"
13189 " const char *name);\n"
13194 #: ../src/guestfs-actions.pod:4946 ../fish/guestfish-actions.pod:3311
13196 "This sets the partition name on partition numbered C<partnum> on device "
13197 "C<device>. Note that partitions are numbered from 1."
13201 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3314
13203 "The partition name can only be set on certain types of partition table. "
13204 "This works on C<gpt> but not on C<mbr> partitions."
13208 #: ../src/guestfs-actions.pod:4956
13209 msgid "guestfs_part_to_dev"
13213 #: ../src/guestfs-actions.pod:4958
13217 " guestfs_part_to_dev (guestfs_h *g,\n"
13218 " const char *partition);\n"
13223 #: ../src/guestfs-actions.pod:4962 ../fish/guestfish-actions.pod:3321
13225 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13226 "partition number, returning the device name (eg. \"/dev/sdb\")."
13230 #: ../src/guestfs-actions.pod:4966
13232 "The named partition must exist, for example as a string returned from "
13233 "C<guestfs_list_partitions>."
13237 #: ../src/guestfs-actions.pod:4974
13238 msgid "guestfs_ping_daemon"
13242 #: ../src/guestfs-actions.pod:4976
13246 " guestfs_ping_daemon (guestfs_h *g);\n"
13251 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3332
13253 "This is a test probe into the guestfs daemon running inside the qemu "
13254 "subprocess. Calling this function checks that the daemon responds to the "
13255 "ping message, without affecting the daemon or attached block device(s) in "
13260 #: ../src/guestfs-actions.pod:4988
13261 msgid "guestfs_pread"
13265 #: ../src/guestfs-actions.pod:4990
13269 " guestfs_pread (guestfs_h *g,\n"
13270 " const char *path,\n"
13272 " int64_t offset,\n"
13273 " size_t *size_r);\n"
13278 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3341
13280 "This command lets you read part of a file. It reads C<count> bytes of the "
13281 "file, starting at C<offset>, from file C<path>."
13285 #: ../src/guestfs-actions.pod:5000 ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3344 ../fish/guestfish-actions.pod:3359
13287 "This may read fewer bytes than requested. For further details see the "
13288 "L<pread(2)> system call."
13292 #: ../src/guestfs-actions.pod:5003
13293 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
13297 #: ../src/guestfs-actions.pod:5014
13298 msgid "guestfs_pread_device"
13302 #: ../src/guestfs-actions.pod:5016
13306 " guestfs_pread_device (guestfs_h *g,\n"
13307 " const char *device,\n"
13309 " int64_t offset,\n"
13310 " size_t *size_r);\n"
13315 #: ../src/guestfs-actions.pod:5023 ../fish/guestfish-actions.pod:3356
13317 "This command lets you read part of a file. It reads C<count> bytes of "
13318 "C<device>, starting at C<offset>."
13322 #: ../src/guestfs-actions.pod:5029
13323 msgid "See also C<guestfs_pread>."
13327 #: ../src/guestfs-actions.pod:5038
13328 msgid "(Added in 1.5.21)"
13332 #: ../src/guestfs-actions.pod:5040
13333 msgid "guestfs_pvcreate"
13337 #: ../src/guestfs-actions.pod:5042
13341 " guestfs_pvcreate (guestfs_h *g,\n"
13342 " const char *device);\n"
13347 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3371
13349 "This creates an LVM physical volume on the named C<device>, where C<device> "
13350 "should usually be a partition name such as C</dev/sda1>."
13354 #: ../src/guestfs-actions.pod:5054
13355 msgid "guestfs_pvremove"
13359 #: ../src/guestfs-actions.pod:5056
13363 " guestfs_pvremove (guestfs_h *g,\n"
13364 " const char *device);\n"
13369 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3379
13371 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13376 #: ../src/guestfs-actions.pod:5063 ../fish/guestfish-actions.pod:3382
13378 "The implementation uses the C<pvremove> command which refuses to wipe "
13379 "physical volumes that contain any volume groups, so you have to remove those "
13384 #: ../src/guestfs-actions.pod:5071
13385 msgid "guestfs_pvresize"
13389 #: ../src/guestfs-actions.pod:5073
13393 " guestfs_pvresize (guestfs_h *g,\n"
13394 " const char *device);\n"
13399 #: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3390
13401 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13402 "the new size of the underlying device."
13406 #: ../src/guestfs-actions.pod:5084
13407 msgid "guestfs_pvresize_size"
13411 #: ../src/guestfs-actions.pod:5086
13415 " guestfs_pvresize_size (guestfs_h *g,\n"
13416 " const char *device,\n"
13417 " int64_t size);\n"
13422 #: ../src/guestfs-actions.pod:5091
13424 "This command is the same as C<guestfs_pvresize> except that it allows you to "
13425 "specify the new size (in bytes) explicitly."
13429 #: ../src/guestfs-actions.pod:5098
13430 msgid "guestfs_pvs"
13434 #: ../src/guestfs-actions.pod:5100
13438 " guestfs_pvs (guestfs_h *g);\n"
13443 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3404
13445 "List all the physical volumes detected. This is the equivalent of the "
13446 "L<pvs(8)> command."
13450 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3407
13452 "This returns a list of just the device names that contain PVs "
13453 "(eg. C</dev/sda2>)."
13457 #: ../src/guestfs-actions.pod:5109
13458 msgid "See also C<guestfs_pvs_full>."
13462 #: ../src/guestfs-actions.pod:5117
13463 msgid "guestfs_pvs_full"
13467 #: ../src/guestfs-actions.pod:5119
13470 " struct guestfs_lvm_pv_list *\n"
13471 " guestfs_pvs_full (guestfs_h *g);\n"
13476 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3416
13478 "List all the physical volumes detected. This is the equivalent of the "
13479 "L<pvs(8)> command. The \"full\" version includes all fields."
13483 #: ../src/guestfs-actions.pod:5125
13485 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
13486 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
13491 #: ../src/guestfs-actions.pod:5131
13492 msgid "guestfs_pvuuid"
13496 #: ../src/guestfs-actions.pod:5133
13500 " guestfs_pvuuid (guestfs_h *g,\n"
13501 " const char *device);\n"
13506 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3423
13507 msgid "This command returns the UUID of the LVM PV C<device>."
13511 #: ../src/guestfs-actions.pod:5144
13512 msgid "guestfs_pwrite"
13516 #: ../src/guestfs-actions.pod:5146
13520 " guestfs_pwrite (guestfs_h *g,\n"
13521 " const char *path,\n"
13522 " const char *content,\n"
13523 " size_t content_size,\n"
13524 " int64_t offset);\n"
13529 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3429
13531 "This command writes to part of a file. It writes the data buffer C<content> "
13532 "to the file C<path> starting at offset C<offset>."
13536 #: ../src/guestfs-actions.pod:5156 ../fish/guestfish-actions.pod:3432
13538 "This command implements the L<pwrite(2)> system call, and like that system "
13539 "call it may not write the full data requested. The return value is the "
13540 "number of bytes that were actually written to the file. This could even be "
13541 "0, although short writes are unlikely for regular files in ordinary "
13546 #: ../src/guestfs-actions.pod:5162
13547 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
13551 #: ../src/guestfs-actions.pod:5171
13552 msgid "guestfs_pwrite_device"
13556 #: ../src/guestfs-actions.pod:5173
13560 " guestfs_pwrite_device (guestfs_h *g,\n"
13561 " const char *device,\n"
13562 " const char *content,\n"
13563 " size_t content_size,\n"
13564 " int64_t offset);\n"
13569 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3447
13571 "This command writes to part of a device. It writes the data buffer "
13572 "C<content> to C<device> starting at offset C<offset>."
13576 #: ../src/guestfs-actions.pod:5183 ../fish/guestfish-actions.pod:3450
13578 "This command implements the L<pwrite(2)> system call, and like that system "
13579 "call it may not write the full data requested (although short writes to disk "
13580 "devices and partitions are probably impossible with standard Linux kernels)."
13584 #: ../src/guestfs-actions.pod:5188
13585 msgid "See also C<guestfs_pwrite>."
13589 #: ../src/guestfs-actions.pod:5195
13590 msgid "(Added in 1.5.20)"
13594 #: ../src/guestfs-actions.pod:5197
13595 msgid "guestfs_read_file"
13599 #: ../src/guestfs-actions.pod:5199
13603 " guestfs_read_file (guestfs_h *g,\n"
13604 " const char *path,\n"
13605 " size_t *size_r);\n"
13610 #: ../src/guestfs-actions.pod:5204 ../fish/guestfish-actions.pod:3464
13611 msgid "This calls returns the contents of the file C<path> as a buffer."
13615 #: ../src/guestfs-actions.pod:5207
13617 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13618 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13619 "function is limited in the total size of file that can be handled."
13623 #: ../src/guestfs-actions.pod:5219
13624 msgid "(Added in 1.0.63)"
13628 #: ../src/guestfs-actions.pod:5221
13629 msgid "guestfs_read_lines"
13633 #: ../src/guestfs-actions.pod:5223
13637 " guestfs_read_lines (guestfs_h *g,\n"
13638 " const char *path);\n"
13643 #: ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:3481
13645 "The file contents are returned as a list of lines. Trailing C<LF> and "
13646 "C<CRLF> character sequences are I<not> returned."
13650 #: ../src/guestfs-actions.pod:5232
13652 "Note that this function cannot correctly handle binary files (specifically, "
13653 "files containing C<\\0> character which is treated as end of line). For "
13654 "those you need to use the C<guestfs_read_file> function which has a more "
13655 "complex interface."
13659 #: ../src/guestfs-actions.pod:5243
13660 msgid "guestfs_readdir"
13664 #: ../src/guestfs-actions.pod:5245
13667 " struct guestfs_dirent_list *\n"
13668 " guestfs_readdir (guestfs_h *g,\n"
13669 " const char *dir);\n"
13674 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3493
13675 msgid "This returns the list of directory entries in directory C<dir>."
13679 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3495
13681 "All entries in the directory are returned, including C<.> and C<..>. The "
13682 "entries are I<not> sorted, but returned in the same order as the underlying "
13687 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3499
13689 "Also this call returns basic file type information about each file. The "
13690 "C<ftyp> field will contain one of the following characters:"
13694 #: ../src/guestfs-actions.pod:5260 ../fish/guestfish-actions.pod:3504
13699 #: ../src/guestfs-actions.pod:5262 ../fish/guestfish-actions.pod:3506
13700 msgid "Block special"
13704 #: ../src/guestfs-actions.pod:5264 ../fish/guestfish-actions.pod:3508
13709 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3510
13710 msgid "Char special"
13714 #: ../src/guestfs-actions.pod:5268 ../fish/guestfish-actions.pod:3512
13719 #: ../src/guestfs-actions.pod:5270 ../fish/guestfish-actions.pod:3514
13724 #: ../src/guestfs-actions.pod:5272 ../fish/guestfish-actions.pod:3516
13729 #: ../src/guestfs-actions.pod:5274 ../fish/guestfish-actions.pod:3518
13730 msgid "FIFO (named pipe)"
13734 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3520
13739 #: ../src/guestfs-actions.pod:5278 ../fish/guestfish-actions.pod:3522
13740 msgid "Symbolic link"
13744 #: ../src/guestfs-actions.pod:5280 ../fish/guestfish-actions.pod:3524
13749 #: ../src/guestfs-actions.pod:5282 ../fish/guestfish-actions.pod:3526
13750 msgid "Regular file"
13754 #: ../src/guestfs-actions.pod:5284 ../fish/guestfish-actions.pod:3528
13759 #: ../src/guestfs-actions.pod:5286 ../fish/guestfish-actions.pod:3530
13764 #: ../src/guestfs-actions.pod:5288 ../fish/guestfish-actions.pod:3532
13769 #: ../src/guestfs-actions.pod:5290 ../fish/guestfish-actions.pod:3534
13770 msgid "Unknown file type"
13774 #: ../src/guestfs-actions.pod:5292 ../fish/guestfish-actions.pod:3536
13779 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3538
13780 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13784 #: ../src/guestfs-actions.pod:5299
13786 "This function is primarily intended for use by programs. To get a simple "
13787 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13788 "consumption, use C<guestfs_ll>."
13792 #: ../src/guestfs-actions.pod:5303
13794 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13795 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
13800 #: ../src/guestfs-actions.pod:5309
13801 msgid "guestfs_readlink"
13805 #: ../src/guestfs-actions.pod:5311
13809 " guestfs_readlink (guestfs_h *g,\n"
13810 " const char *path);\n"
13815 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3551
13816 msgid "This command reads the target of a symbolic link."
13820 #: ../src/guestfs-actions.pod:5322
13821 msgid "guestfs_readlinklist"
13825 #: ../src/guestfs-actions.pod:5324
13829 " guestfs_readlinklist (guestfs_h *g,\n"
13830 " const char *path,\n"
13831 " char *const *names);\n"
13836 #: ../src/guestfs-actions.pod:5329 ../fish/guestfish-actions.pod:3557
13838 "This call allows you to do a C<readlink> operation on multiple files, where "
13839 "all files are in the directory C<path>. C<names> is the list of files from "
13844 #: ../src/guestfs-actions.pod:5333 ../fish/guestfish-actions.pod:3561
13846 "On return you get a list of strings, with a one-to-one correspondence to the "
13847 "C<names> list. Each string is the value of the symbolic link."
13851 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3565
13853 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13854 "result string is the empty string C<\"\">. However the whole operation is "
13855 "completed even if there were C<readlink(2)> errors, and so you can call this "
13856 "function with names where you don't know if they are symbolic links already "
13857 "(albeit slightly less efficient)."
13861 #: ../src/guestfs-actions.pod:5344 ../fish/guestfish-actions.pod:3572
13863 "This call is intended for programs that want to efficiently list a directory "
13864 "contents without making many round-trips. Very long directory listings "
13865 "might cause the protocol message size to be exceeded, causing this call to "
13866 "fail. The caller must split up such requests into smaller groups of names."
13870 #: ../src/guestfs-actions.pod:5357
13871 msgid "guestfs_realpath"
13875 #: ../src/guestfs-actions.pod:5359
13879 " guestfs_realpath (guestfs_h *g,\n"
13880 " const char *path);\n"
13885 #: ../src/guestfs-actions.pod:5363 ../fish/guestfish-actions.pod:3583
13887 "Return the canonicalized absolute pathname of C<path>. The returned path "
13888 "has no C<.>, C<..> or symbolic link path elements."
13892 #: ../src/guestfs-actions.pod:5371
13893 msgid "guestfs_removexattr"
13897 #: ../src/guestfs-actions.pod:5373
13901 " guestfs_removexattr (guestfs_h *g,\n"
13902 " const char *xattr,\n"
13903 " const char *path);\n"
13908 #: ../src/guestfs-actions.pod:5378 ../fish/guestfish-actions.pod:3590
13909 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
13913 #: ../src/guestfs-actions.pod:5381
13914 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13918 #: ../src/guestfs-actions.pod:5387
13919 msgid "guestfs_resize2fs"
13923 #: ../src/guestfs-actions.pod:5389
13927 " guestfs_resize2fs (guestfs_h *g,\n"
13928 " const char *device);\n"
13933 #: ../src/guestfs-actions.pod:5393 ../fish/guestfish-actions.pod:3599
13935 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13936 "underlying device."
13940 #: ../src/guestfs-actions.pod:5396
13942 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13943 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13944 "sometimes gives an error about this and sometimes not. In any case, it is "
13945 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13949 #: ../src/guestfs-actions.pod:5406
13950 msgid "guestfs_resize2fs_size"
13954 #: ../src/guestfs-actions.pod:5408
13958 " guestfs_resize2fs_size (guestfs_h *g,\n"
13959 " const char *device,\n"
13960 " int64_t size);\n"
13965 #: ../src/guestfs-actions.pod:5413
13967 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13968 "to specify the new size (in bytes) explicitly."
13972 #: ../src/guestfs-actions.pod:5420
13977 #: ../src/guestfs-actions.pod:5422
13981 " guestfs_rm (guestfs_h *g,\n"
13982 " const char *path);\n"
13987 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3619
13988 msgid "Remove the single file C<path>."
13992 #: ../src/guestfs-actions.pod:5432
13993 msgid "guestfs_rm_rf"
13997 #: ../src/guestfs-actions.pod:5434
14001 " guestfs_rm_rf (guestfs_h *g,\n"
14002 " const char *path);\n"
14007 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3625
14009 "Remove the file or directory C<path>, recursively removing the contents if "
14010 "its a directory. This is like the C<rm -rf> shell command."
14014 #: ../src/guestfs-actions.pod:5446
14015 msgid "guestfs_rmdir"
14019 #: ../src/guestfs-actions.pod:5448
14023 " guestfs_rmdir (guestfs_h *g,\n"
14024 " const char *path);\n"
14029 #: ../src/guestfs-actions.pod:5452 ../fish/guestfish-actions.pod:3633
14030 msgid "Remove the single directory C<path>."
14034 #: ../src/guestfs-actions.pod:5458
14035 msgid "guestfs_rmmountpoint"
14039 #: ../src/guestfs-actions.pod:5460
14043 " guestfs_rmmountpoint (guestfs_h *g,\n"
14044 " const char *exemptpath);\n"
14049 #: ../src/guestfs-actions.pod:5464
14051 "This calls removes a mountpoint that was previously created with "
14052 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14056 #: ../src/guestfs-actions.pod:5472
14057 msgid "guestfs_scrub_device"
14061 #: ../src/guestfs-actions.pod:5474
14065 " guestfs_scrub_device (guestfs_h *g,\n"
14066 " const char *device);\n"
14071 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3647
14073 "This command writes patterns over C<device> to make data retrieval more "
14078 #: ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5502 ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3650 ../fish/guestfish-actions.pod:3665 ../fish/guestfish-actions.pod:3678
14080 "It is an interface to the L<scrub(1)> program. See that manual page for "
14085 #: ../src/guestfs-actions.pod:5489 ../src/guestfs-actions.pod:5507 ../src/guestfs-actions.pod:5526
14086 msgid "(Added in 1.0.52)"
14090 #: ../src/guestfs-actions.pod:5491
14091 msgid "guestfs_scrub_file"
14095 #: ../src/guestfs-actions.pod:5493
14099 " guestfs_scrub_file (guestfs_h *g,\n"
14100 " const char *file);\n"
14105 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3660
14107 "This command writes patterns over a file to make data retrieval more "
14112 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3663
14113 msgid "The file is I<removed> after scrubbing."
14117 #: ../src/guestfs-actions.pod:5509
14118 msgid "guestfs_scrub_freespace"
14122 #: ../src/guestfs-actions.pod:5511
14126 " guestfs_scrub_freespace (guestfs_h *g,\n"
14127 " const char *dir);\n"
14132 #: ../src/guestfs-actions.pod:5515
14134 "This command creates the directory C<dir> and then fills it with files until "
14135 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14136 "and deletes them. The intention is to scrub any free space on the partition "
14137 "containing C<dir>."
14141 #: ../src/guestfs-actions.pod:5528
14142 msgid "guestfs_set_append"
14146 #: ../src/guestfs-actions.pod:5530
14150 " guestfs_set_append (guestfs_h *g,\n"
14151 " const char *append);\n"
14156 #: ../src/guestfs-actions.pod:5534 ../fish/guestfish-actions.pod:3687
14158 "This function is used to add additional options to the guest kernel command "
14163 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3690
14165 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14166 "environment variable."
14170 #: ../src/guestfs-actions.pod:5540 ../fish/guestfish-actions.pod:3693
14172 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14173 "(libguestfs always adds a few of its own)."
14177 #: ../src/guestfs-actions.pod:5547
14178 msgid "guestfs_set_autosync"
14182 #: ../src/guestfs-actions.pod:5549
14186 " guestfs_set_autosync (guestfs_h *g,\n"
14187 " int autosync);\n"
14192 #: ../src/guestfs-actions.pod:5553
14194 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14195 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
14196 "the handle is closed (also if the program exits without closing handles)."
14200 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3707
14202 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14203 "disabled by default)."
14207 #: ../src/guestfs-actions.pod:5565
14208 msgid "guestfs_set_direct"
14212 #: ../src/guestfs-actions.pod:5567
14216 " guestfs_set_direct (guestfs_h *g,\n"
14222 #: ../src/guestfs-actions.pod:5571 ../fish/guestfish-actions.pod:3716
14224 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14225 "passed directly through to the appliance once it is launched."
14229 #: ../src/guestfs-actions.pod:5575
14231 "One consequence of this is that log messages aren't caught by the library "
14232 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
14237 #: ../src/guestfs-actions.pod:5579 ../fish/guestfish-actions.pod:3724
14238 msgid "You probably don't want to use this unless you know what you are doing."
14242 #: ../src/guestfs-actions.pod:5582 ../fish/guestfish-actions.pod:3727
14243 msgid "The default is disabled."
14247 #: ../src/guestfs-actions.pod:5588
14248 msgid "guestfs_set_e2label"
14252 #: ../src/guestfs-actions.pod:5590
14256 " guestfs_set_e2label (guestfs_h *g,\n"
14257 " const char *device,\n"
14258 " const char *label);\n"
14263 #: ../src/guestfs-actions.pod:5595 ../fish/guestfish-actions.pod:3733
14265 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14266 "C<label>. Filesystem labels are limited to 16 characters."
14270 #: ../src/guestfs-actions.pod:5599
14272 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
14273 "the existing label on a filesystem."
14277 #: ../src/guestfs-actions.pod:5606
14278 msgid "guestfs_set_e2uuid"
14282 #: ../src/guestfs-actions.pod:5608
14286 " guestfs_set_e2uuid (guestfs_h *g,\n"
14287 " const char *device,\n"
14288 " const char *uuid);\n"
14293 #: ../src/guestfs-actions.pod:5613 ../fish/guestfish-actions.pod:3744
14295 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14296 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14297 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14301 #: ../src/guestfs-actions.pod:5618
14303 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
14304 "the existing UUID of a filesystem."
14308 #: ../src/guestfs-actions.pod:5625
14309 msgid "guestfs_set_memsize"
14313 #: ../src/guestfs-actions.pod:5627
14317 " guestfs_set_memsize (guestfs_h *g,\n"
14323 #: ../src/guestfs-actions.pod:5631
14325 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14326 "This only has any effect if called before C<guestfs_launch>."
14330 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3762
14332 "You can also change this by setting the environment variable "
14333 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14337 #: ../src/guestfs-actions.pod:5646
14338 msgid "guestfs_set_network"
14342 #: ../src/guestfs-actions.pod:5648
14346 " guestfs_set_network (guestfs_h *g,\n"
14352 #: ../src/guestfs-actions.pod:5652 ../fish/guestfish-actions.pod:3775
14354 "If C<network> is true, then the network is enabled in the libguestfs "
14355 "appliance. The default is false."
14359 #: ../src/guestfs-actions.pod:5655 ../fish/guestfish-actions.pod:3778
14361 "This affects whether commands are able to access the network (see "
14362 "L<guestfs(3)/RUNNING COMMANDS>)."
14366 #: ../src/guestfs-actions.pod:5658
14368 "You must call this before calling C<guestfs_launch>, otherwise it has no "
14373 #: ../src/guestfs-actions.pod:5665
14374 msgid "guestfs_set_path"
14378 #: ../src/guestfs-actions.pod:5667
14382 " guestfs_set_path (guestfs_h *g,\n"
14383 " const char *searchpath);\n"
14388 #: ../src/guestfs-actions.pod:5671 ../fish/guestfish-actions.pod:3790
14389 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14393 #: ../src/guestfs-actions.pod:5673 ../fish/guestfish-actions.pod:3792
14395 "The default is C<$libdir/guestfs> unless overridden by setting "
14396 "C<LIBGUESTFS_PATH> environment variable."
14400 #: ../src/guestfs-actions.pod:5676 ../fish/guestfish-actions.pod:3795
14401 msgid "Setting C<path> to C<NULL> restores the default path."
14405 #: ../src/guestfs-actions.pod:5682
14406 msgid "guestfs_set_qemu"
14410 #: ../src/guestfs-actions.pod:5684
14414 " guestfs_set_qemu (guestfs_h *g,\n"
14415 " const char *qemu);\n"
14420 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3803
14421 msgid "Set the qemu binary that we will use."
14425 #: ../src/guestfs-actions.pod:5690 ../fish/guestfish-actions.pod:3805
14426 msgid "The default is chosen when the library was compiled by the configure script."
14430 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3808
14432 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14437 #: ../src/guestfs-actions.pod:5696 ../fish/guestfish-actions.pod:3811
14438 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14442 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3813
14444 "Note that you should call this function as early as possible after creating "
14445 "the handle. This is because some pre-launch operations depend on testing "
14446 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14447 "don't retest features, and so you might see inconsistent results. Using the "
14448 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14449 "the qemu binary at the same time as the handle is created."
14453 #: ../src/guestfs-actions.pod:5710
14454 msgid "guestfs_set_recovery_proc"
14458 #: ../src/guestfs-actions.pod:5712
14462 " guestfs_set_recovery_proc (guestfs_h *g,\n"
14463 " int recoveryproc);\n"
14468 #: ../src/guestfs-actions.pod:5716
14470 "If this is called with the parameter C<false> then C<guestfs_launch> does "
14471 "not create a recovery process. The purpose of the recovery process is to "
14472 "stop runaway qemu processes in the case where the main program aborts "
14477 #: ../src/guestfs-actions.pod:5721
14479 "This only has any effect if called before C<guestfs_launch>, and the default "
14484 #: ../src/guestfs-actions.pod:5724 ../fish/guestfish-actions.pod:3835
14486 "About the only time when you would want to disable this is if the main "
14487 "process will fork itself into the background (\"daemonize\" itself). In "
14488 "this case the recovery process thinks that the main program has disappeared "
14489 "and so kills qemu, which is not very helpful."
14493 #: ../src/guestfs-actions.pod:5734
14494 msgid "guestfs_set_selinux"
14498 #: ../src/guestfs-actions.pod:5736
14502 " guestfs_set_selinux (guestfs_h *g,\n"
14508 #: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3847
14510 "This sets the selinux flag that is passed to the appliance at boot time. "
14511 "The default is C<selinux=0> (disabled)."
14515 #: ../src/guestfs-actions.pod:5743 ../fish/guestfish-actions.pod:3850
14517 "Note that if SELinux is enabled, it is always in Permissive mode "
14518 "(C<enforcing=0>)."
14522 #: ../src/guestfs-actions.pod:5753
14523 msgid "guestfs_set_trace"
14527 #: ../src/guestfs-actions.pod:5755
14531 " guestfs_set_trace (guestfs_h *g,\n"
14537 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3862
14539 "If the command trace flag is set to 1, then commands are printed on stderr "
14540 "before they are executed in a format which is very similar to the one used "
14541 "by guestfish. In other words, you can run a program with this enabled, and "
14542 "you will get out a script which you can feed to guestfish to perform the "
14543 "same set of actions."
14547 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3869
14549 "If you want to trace C API calls into libguestfs (and other libraries) then "
14550 "possibly a better way is to use the external ltrace(1) command."
14554 #: ../src/guestfs-actions.pod:5770 ../fish/guestfish-actions.pod:3873
14556 "Command traces are disabled unless the environment variable "
14557 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14561 #: ../src/guestfs-actions.pod:5777
14562 msgid "guestfs_set_verbose"
14566 #: ../src/guestfs-actions.pod:5779
14570 " guestfs_set_verbose (guestfs_h *g,\n"
14576 #: ../src/guestfs-actions.pod:5783 ../fish/guestfish-actions.pod:3882
14577 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
14581 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3884
14583 "Verbose messages are disabled unless the environment variable "
14584 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14588 #: ../src/guestfs-actions.pod:5792
14589 msgid "guestfs_setcon"
14593 #: ../src/guestfs-actions.pod:5794
14597 " guestfs_setcon (guestfs_h *g,\n"
14598 " const char *context);\n"
14603 #: ../src/guestfs-actions.pod:5798 ../fish/guestfish-actions.pod:3891
14605 "This sets the SELinux security context of the daemon to the string "
14610 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3894
14611 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14615 #: ../src/guestfs-actions.pod:5807
14616 msgid "guestfs_setxattr"
14620 #: ../src/guestfs-actions.pod:5809
14624 " guestfs_setxattr (guestfs_h *g,\n"
14625 " const char *xattr,\n"
14626 " const char *val,\n"
14628 " const char *path);\n"
14633 #: ../src/guestfs-actions.pod:5816 ../fish/guestfish-actions.pod:3900
14635 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14636 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14640 #: ../src/guestfs-actions.pod:5820
14641 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14645 #: ../src/guestfs-actions.pod:5826
14646 msgid "guestfs_sfdisk"
14650 #: ../src/guestfs-actions.pod:5828
14654 " guestfs_sfdisk (guestfs_h *g,\n"
14655 " const char *device,\n"
14659 " char *const *lines);\n"
14664 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3910
14666 "This is a direct interface to the L<sfdisk(8)> program for creating "
14667 "partitions on block devices."
14671 #: ../src/guestfs-actions.pod:5839 ../fish/guestfish-actions.pod:3913
14672 msgid "C<device> should be a block device, for example C</dev/sda>."
14676 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3915
14678 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14679 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14680 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14681 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14682 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14683 "the kernel) cannot work out the right geometry and you will need to tell it."
14687 #: ../src/guestfs-actions.pod:5849 ../fish/guestfish-actions.pod:3923
14689 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14690 "refer to the L<sfdisk(8)> manpage."
14694 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3926
14696 "To create a single partition occupying the whole disk, you would pass "
14697 "C<lines> as a single element list, when the single element being the string "
14702 #: ../src/guestfs-actions.pod:5856
14703 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14707 #: ../src/guestfs-actions.pod:5866
14708 msgid "guestfs_sfdiskM"
14712 #: ../src/guestfs-actions.pod:5868
14716 " guestfs_sfdiskM (guestfs_h *g,\n"
14717 " const char *device,\n"
14718 " char *const *lines);\n"
14723 #: ../src/guestfs-actions.pod:5873
14725 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14726 "partition sizes are specified in megabytes only (rounded to the nearest "
14727 "cylinder) and you don't need to specify the cyls, heads and sectors "
14728 "parameters which were rarely if ever used anyway."
14732 #: ../src/guestfs-actions.pod:5879
14734 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14735 "C<guestfs_part_disk>"
14739 #: ../src/guestfs-actions.pod:5889
14740 msgid "guestfs_sfdisk_N"
14744 #: ../src/guestfs-actions.pod:5891
14748 " guestfs_sfdisk_N (guestfs_h *g,\n"
14749 " const char *device,\n"
14754 " const char *line);\n"
14759 #: ../src/guestfs-actions.pod:5900 ../fish/guestfish-actions.pod:3956
14761 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14762 "(note: C<n> counts from 1)."
14766 #: ../src/guestfs-actions.pod:5903
14768 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14769 "for the cyls/heads/sectors parameters."
14773 #: ../src/guestfs-actions.pod:5906
14774 msgid "See also: C<guestfs_part_add>"
14778 #: ../src/guestfs-actions.pod:5915
14779 msgid "guestfs_sfdisk_disk_geometry"
14783 #: ../src/guestfs-actions.pod:5917
14787 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14788 " const char *device);\n"
14793 #: ../src/guestfs-actions.pod:5921
14795 "This displays the disk geometry of C<device> read from the partition table. "
14796 "Especially in the case where the underlying block device has been resized, "
14797 "this can be different from the kernel's idea of the geometry (see "
14798 "C<guestfs_sfdisk_kernel_geometry>)."
14802 #: ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5942 ../fish/guestfish-actions.pod:3976 ../fish/guestfish-actions.pod:3985
14803 msgid "The result is in human-readable format, and not designed to be parsed."
14807 #: ../src/guestfs-actions.pod:5934
14808 msgid "guestfs_sfdisk_kernel_geometry"
14812 #: ../src/guestfs-actions.pod:5936
14816 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14817 " const char *device);\n"
14822 #: ../src/guestfs-actions.pod:5940 ../fish/guestfish-actions.pod:3983
14823 msgid "This displays the kernel's idea of the geometry of C<device>."
14827 #: ../src/guestfs-actions.pod:5950
14828 msgid "guestfs_sfdisk_l"
14832 #: ../src/guestfs-actions.pod:5952
14836 " guestfs_sfdisk_l (guestfs_h *g,\n"
14837 " const char *device);\n"
14842 #: ../src/guestfs-actions.pod:5956 ../fish/guestfish-actions.pod:3992
14844 "This displays the partition table on C<device>, in the human-readable output "
14845 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14849 #: ../src/guestfs-actions.pod:5960
14850 msgid "See also: C<guestfs_part_list>"
14854 #: ../src/guestfs-actions.pod:5967
14859 #: ../src/guestfs-actions.pod:5969
14863 " guestfs_sh (guestfs_h *g,\n"
14864 " const char *command);\n"
14869 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4002
14871 "This call runs a command from the guest filesystem via the guest's "
14876 #: ../src/guestfs-actions.pod:5976
14877 msgid "This is like C<guestfs_command>, but passes the command to:"
14881 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4007
14884 " /bin/sh -c \"command\"\n"
14889 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4009
14891 "Depending on the guest's shell, this usually results in wildcards being "
14892 "expanded, shell expressions being interpolated and so on."
14896 #: ../src/guestfs-actions.pod:5984
14897 msgid "All the provisos about C<guestfs_command> apply to this call."
14901 #: ../src/guestfs-actions.pod:5991
14902 msgid "guestfs_sh_lines"
14906 #: ../src/guestfs-actions.pod:5993
14910 " guestfs_sh_lines (guestfs_h *g,\n"
14911 " const char *command);\n"
14916 #: ../src/guestfs-actions.pod:5997
14918 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14923 #: ../src/guestfs-actions.pod:6000
14924 msgid "See also: C<guestfs_command_lines>"
14928 #: ../src/guestfs-actions.pod:6008
14929 msgid "guestfs_sleep"
14933 #: ../src/guestfs-actions.pod:6010
14937 " guestfs_sleep (guestfs_h *g,\n"
14943 #: ../src/guestfs-actions.pod:6014 ../fish/guestfish-actions.pod:4028
14944 msgid "Sleep for C<secs> seconds."
14948 #: ../src/guestfs-actions.pod:6018
14949 msgid "(Added in 1.0.41)"
14953 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-structs.pod:109
14954 msgid "guestfs_stat"
14958 #: ../src/guestfs-actions.pod:6022
14961 " struct guestfs_stat *\n"
14962 " guestfs_stat (guestfs_h *g,\n"
14963 " const char *path);\n"
14968 #: ../src/guestfs-actions.pod:6028 ../fish/guestfish-actions.pod:4036
14969 msgid "This is the same as the C<stat(2)> system call."
14973 #: ../src/guestfs-actions.pod:6036 ../src/guestfs-structs.pod:135
14974 msgid "guestfs_statvfs"
14978 #: ../src/guestfs-actions.pod:6038
14981 " struct guestfs_statvfs *\n"
14982 " guestfs_statvfs (guestfs_h *g,\n"
14983 " const char *path);\n"
14988 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4042
14990 "Returns file system statistics for any mounted file system. C<path> should "
14991 "be a file or directory in the mounted file system (typically it is the mount "
14992 "point itself, but it doesn't need to be)."
14996 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4046
14997 msgid "This is the same as the C<statvfs(2)> system call."
15001 #: ../src/guestfs-actions.pod:6048
15003 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
15004 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
15008 #: ../src/guestfs-actions.pod:6054
15009 msgid "guestfs_strings"
15013 #: ../src/guestfs-actions.pod:6056
15017 " guestfs_strings (guestfs_h *g,\n"
15018 " const char *path);\n"
15023 #: ../src/guestfs-actions.pod:6060 ../fish/guestfish-actions.pod:4052
15025 "This runs the L<strings(1)> command on a file and returns the list of "
15026 "printable strings found."
15030 #: ../src/guestfs-actions.pod:6072
15031 msgid "guestfs_strings_e"
15035 #: ../src/guestfs-actions.pod:6074
15039 " guestfs_strings_e (guestfs_h *g,\n"
15040 " const char *encoding,\n"
15041 " const char *path);\n"
15046 #: ../src/guestfs-actions.pod:6079
15048 "This is like the C<guestfs_strings> command, but allows you to specify the "
15049 "encoding of strings that are looked for in the source file C<path>."
15053 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4066
15054 msgid "Allowed encodings are:"
15058 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4070
15063 #: ../src/guestfs-actions.pod:6089
15065 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15066 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15070 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4075
15075 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4077
15076 msgid "Single 8-bit-byte characters."
15080 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4079
15085 #: ../src/guestfs-actions.pod:6098 ../fish/guestfish-actions.pod:4081
15086 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15090 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4084
15091 msgid "l (lower case letter L)"
15095 #: ../src/guestfs-actions.pod:6103 ../fish/guestfish-actions.pod:4086
15097 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15098 "examining binaries in Windows guests."
15102 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4089
15107 #: ../src/guestfs-actions.pod:6108 ../fish/guestfish-actions.pod:4091
15108 msgid "32-bit big endian such as UCS-4BE."
15112 #: ../src/guestfs-actions.pod:6110 ../fish/guestfish-actions.pod:4093
15117 #: ../src/guestfs-actions.pod:6112 ../fish/guestfish-actions.pod:4095
15118 msgid "32-bit little endian such as UCS-4LE."
15122 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4099
15123 msgid "The returned strings are transcoded to UTF-8."
15127 #: ../src/guestfs-actions.pod:6127
15128 msgid "guestfs_swapoff_device"
15132 #: ../src/guestfs-actions.pod:6129
15136 " guestfs_swapoff_device (guestfs_h *g,\n"
15137 " const char *device);\n"
15142 #: ../src/guestfs-actions.pod:6133
15144 "This command disables the libguestfs appliance swap device or partition "
15145 "named C<device>. See C<guestfs_swapon_device>."
15149 #: ../src/guestfs-actions.pod:6141
15150 msgid "guestfs_swapoff_file"
15154 #: ../src/guestfs-actions.pod:6143
15158 " guestfs_swapoff_file (guestfs_h *g,\n"
15159 " const char *file);\n"
15164 #: ../src/guestfs-actions.pod:6147 ../fish/guestfish-actions.pod:4116
15165 msgid "This command disables the libguestfs appliance swap on file."
15169 #: ../src/guestfs-actions.pod:6153
15170 msgid "guestfs_swapoff_label"
15174 #: ../src/guestfs-actions.pod:6155
15178 " guestfs_swapoff_label (guestfs_h *g,\n"
15179 " const char *label);\n"
15184 #: ../src/guestfs-actions.pod:6159 ../fish/guestfish-actions.pod:4122
15186 "This command disables the libguestfs appliance swap on labeled swap "
15191 #: ../src/guestfs-actions.pod:6166
15192 msgid "guestfs_swapoff_uuid"
15196 #: ../src/guestfs-actions.pod:6168
15200 " guestfs_swapoff_uuid (guestfs_h *g,\n"
15201 " const char *uuid);\n"
15206 #: ../src/guestfs-actions.pod:6172 ../fish/guestfish-actions.pod:4129
15208 "This command disables the libguestfs appliance swap partition with the given "
15213 #: ../src/guestfs-actions.pod:6179
15214 msgid "guestfs_swapon_device"
15218 #: ../src/guestfs-actions.pod:6181
15222 " guestfs_swapon_device (guestfs_h *g,\n"
15223 " const char *device);\n"
15228 #: ../src/guestfs-actions.pod:6185
15230 "This command enables the libguestfs appliance to use the swap device or "
15231 "partition named C<device>. The increased memory is made available for all "
15232 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
15236 #: ../src/guestfs-actions.pod:6190 ../fish/guestfish-actions.pod:4141
15238 "Note that you should not swap to existing guest swap partitions unless you "
15239 "know what you are doing. They may contain hibernation information, or other "
15240 "information that the guest doesn't want you to trash. You also risk leaking "
15241 "information about the host to the guest this way. Instead, attach a new "
15242 "host device to the guest and swap on that."
15246 #: ../src/guestfs-actions.pod:6201
15247 msgid "guestfs_swapon_file"
15251 #: ../src/guestfs-actions.pod:6203
15255 " guestfs_swapon_file (guestfs_h *g,\n"
15256 " const char *file);\n"
15261 #: ../src/guestfs-actions.pod:6207
15263 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
15268 #: ../src/guestfs-actions.pod:6214
15269 msgid "guestfs_swapon_label"
15273 #: ../src/guestfs-actions.pod:6216
15277 " guestfs_swapon_label (guestfs_h *g,\n"
15278 " const char *label);\n"
15283 #: ../src/guestfs-actions.pod:6220
15285 "This command enables swap to a labeled swap partition. See "
15286 "C<guestfs_swapon_device> for other notes."
15290 #: ../src/guestfs-actions.pod:6227
15291 msgid "guestfs_swapon_uuid"
15295 #: ../src/guestfs-actions.pod:6229
15299 " guestfs_swapon_uuid (guestfs_h *g,\n"
15300 " const char *uuid);\n"
15305 #: ../src/guestfs-actions.pod:6233
15307 "This command enables swap to a swap partition with the given UUID. See "
15308 "C<guestfs_swapon_device> for other notes."
15312 #: ../src/guestfs-actions.pod:6240
15313 msgid "guestfs_sync"
15317 #: ../src/guestfs-actions.pod:6242
15321 " guestfs_sync (guestfs_h *g);\n"
15326 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4173
15328 "This syncs the disk, so that any writes are flushed through to the "
15329 "underlying disk image."
15333 #: ../src/guestfs-actions.pod:6248 ../fish/guestfish-actions.pod:4176
15335 "You should always call this if you have modified a disk image, before "
15336 "closing the handle."
15340 #: ../src/guestfs-actions.pod:6255
15341 msgid "guestfs_tail"
15345 #: ../src/guestfs-actions.pod:6257
15349 " guestfs_tail (guestfs_h *g,\n"
15350 " const char *path);\n"
15355 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4183
15356 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15360 #: ../src/guestfs-actions.pod:6273
15361 msgid "guestfs_tail_n"
15365 #: ../src/guestfs-actions.pod:6275
15369 " guestfs_tail_n (guestfs_h *g,\n"
15371 " const char *path);\n"
15376 #: ../src/guestfs-actions.pod:6280 ../fish/guestfish-actions.pod:4193
15378 "If the parameter C<nrlines> is a positive number, this returns the last "
15379 "C<nrlines> lines of the file C<path>."
15383 #: ../src/guestfs-actions.pod:6283 ../fish/guestfish-actions.pod:4196
15385 "If the parameter C<nrlines> is a negative number, this returns lines from "
15386 "the file C<path>, starting with the C<-nrlines>th line."
15390 #: ../src/guestfs-actions.pod:6297
15391 msgid "guestfs_tar_in"
15395 #: ../src/guestfs-actions.pod:6299
15399 " guestfs_tar_in (guestfs_h *g,\n"
15400 " const char *tarfile,\n"
15401 " const char *directory);\n"
15406 #: ../src/guestfs-actions.pod:6304 ../fish/guestfish-actions.pod:4208
15408 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15409 "tar file) into C<directory>."
15413 #: ../src/guestfs-actions.pod:6307
15414 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
15418 #: ../src/guestfs-actions.pod:6312 ../src/guestfs-actions.pod:6329 ../src/guestfs-actions.pod:6345 ../src/guestfs-actions.pod:6361
15419 msgid "(Added in 1.0.3)"
15423 #: ../src/guestfs-actions.pod:6314
15424 msgid "guestfs_tar_out"
15428 #: ../src/guestfs-actions.pod:6316
15432 " guestfs_tar_out (guestfs_h *g,\n"
15433 " const char *directory,\n"
15434 " const char *tarfile);\n"
15439 #: ../src/guestfs-actions.pod:6321 ../fish/guestfish-actions.pod:4220
15441 "This command packs the contents of C<directory> and downloads it to local "
15446 #: ../src/guestfs-actions.pod:6324
15448 "To download a compressed tarball, use C<guestfs_tgz_out> or "
15449 "C<guestfs_txz_out>."
15453 #: ../src/guestfs-actions.pod:6331
15454 msgid "guestfs_tgz_in"
15458 #: ../src/guestfs-actions.pod:6333
15462 " guestfs_tgz_in (guestfs_h *g,\n"
15463 " const char *tarball,\n"
15464 " const char *directory);\n"
15469 #: ../src/guestfs-actions.pod:6338 ../fish/guestfish-actions.pod:4232
15471 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15472 "tar file) into C<directory>."
15476 #: ../src/guestfs-actions.pod:6341
15477 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
15481 #: ../src/guestfs-actions.pod:6347
15482 msgid "guestfs_tgz_out"
15486 #: ../src/guestfs-actions.pod:6349
15490 " guestfs_tgz_out (guestfs_h *g,\n"
15491 " const char *directory,\n"
15492 " const char *tarball);\n"
15497 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4243
15499 "This command packs the contents of C<directory> and downloads it to local "
15504 #: ../src/guestfs-actions.pod:6357
15505 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
15509 #: ../src/guestfs-actions.pod:6363
15510 msgid "guestfs_touch"
15514 #: ../src/guestfs-actions.pod:6365
15518 " guestfs_touch (guestfs_h *g,\n"
15519 " const char *path);\n"
15524 #: ../src/guestfs-actions.pod:6369 ../fish/guestfish-actions.pod:4254
15526 "Touch acts like the L<touch(1)> command. It can be used to update the "
15527 "timestamps on a file, or, if the file does not exist, to create a new "
15528 "zero-length file."
15532 #: ../src/guestfs-actions.pod:6373 ../fish/guestfish-actions.pod:4258
15534 "This command only works on regular files, and will fail on other file types "
15535 "such as directories, symbolic links, block special etc."
15539 #: ../src/guestfs-actions.pod:6380
15540 msgid "guestfs_truncate"
15544 #: ../src/guestfs-actions.pod:6382
15548 " guestfs_truncate (guestfs_h *g,\n"
15549 " const char *path);\n"
15554 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4265
15556 "This command truncates C<path> to a zero-length file. The file must exist "
15561 #: ../src/guestfs-actions.pod:6393
15562 msgid "guestfs_truncate_size"
15566 #: ../src/guestfs-actions.pod:6395
15570 " guestfs_truncate_size (guestfs_h *g,\n"
15571 " const char *path,\n"
15572 " int64_t size);\n"
15577 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4272
15579 "This command truncates C<path> to size C<size> bytes. The file must exist "
15584 #: ../src/guestfs-actions.pod:6403
15586 "If the current file size is less than C<size> then the file is extended to "
15587 "the required size with zero bytes. This creates a sparse file (ie. disk "
15588 "blocks are not allocated for the file until you write to it). To create a "
15589 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15593 #: ../src/guestfs-actions.pod:6413
15594 msgid "guestfs_tune2fs_l"
15598 #: ../src/guestfs-actions.pod:6415
15602 " guestfs_tune2fs_l (guestfs_h *g,\n"
15603 " const char *device);\n"
15608 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4285
15610 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15615 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4288
15617 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15618 "for more details. The list of fields returned isn't clearly defined, and "
15619 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15620 "and the filesystem itself."
15624 #: ../src/guestfs-actions.pod:6435
15625 msgid "guestfs_txz_in"
15629 #: ../src/guestfs-actions.pod:6437
15633 " guestfs_txz_in (guestfs_h *g,\n"
15634 " const char *tarball,\n"
15635 " const char *directory);\n"
15640 #: ../src/guestfs-actions.pod:6442 ../fish/guestfish-actions.pod:4297
15642 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15643 "tar file) into C<directory>."
15647 #: ../src/guestfs-actions.pod:6449
15648 msgid "guestfs_txz_out"
15652 #: ../src/guestfs-actions.pod:6451
15656 " guestfs_txz_out (guestfs_h *g,\n"
15657 " const char *directory,\n"
15658 " const char *tarball);\n"
15663 #: ../src/guestfs-actions.pod:6456 ../fish/guestfish-actions.pod:4306
15665 "This command packs the contents of C<directory> and downloads it to local "
15666 "file C<tarball> (as an xz compressed tar archive)."
15670 #: ../src/guestfs-actions.pod:6463
15671 msgid "guestfs_umask"
15675 #: ../src/guestfs-actions.pod:6465
15679 " guestfs_umask (guestfs_h *g,\n"
15685 #: ../src/guestfs-actions.pod:6469 ../fish/guestfish-actions.pod:4315
15687 "This function sets the mask used for creating new files and device nodes to "
15692 #: ../src/guestfs-actions.pod:6472 ../fish/guestfish-actions.pod:4318
15694 "Typical umask values would be C<022> which creates new files with "
15695 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15696 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15700 #: ../src/guestfs-actions.pod:6477 ../fish/guestfish-actions.pod:4323
15702 "The default umask is C<022>. This is important because it means that "
15703 "directories and device nodes will be created with C<0644> or C<0755> mode "
15704 "even if you specify C<0777>."
15708 #: ../src/guestfs-actions.pod:6481
15710 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15711 "C<guestfs_mkdir>."
15715 #: ../src/guestfs-actions.pod:6484 ../fish/guestfish-actions.pod:4330
15716 msgid "This call returns the previous umask."
15720 #: ../src/guestfs-actions.pod:6490
15721 msgid "guestfs_umount"
15725 #: ../src/guestfs-actions.pod:6492
15729 " guestfs_umount (guestfs_h *g,\n"
15730 " const char *pathordevice);\n"
15735 #: ../src/guestfs-actions.pod:6496 ../fish/guestfish-actions.pod:4338
15737 "This unmounts the given filesystem. The filesystem may be specified either "
15738 "by its mountpoint (path) or the device which contains the filesystem."
15742 #: ../src/guestfs-actions.pod:6504
15743 msgid "guestfs_umount_all"
15747 #: ../src/guestfs-actions.pod:6506
15751 " guestfs_umount_all (guestfs_h *g);\n"
15756 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4348
15757 msgid "This unmounts all mounted filesystems."
15761 #: ../src/guestfs-actions.pod:6511 ../fish/guestfish-actions.pod:4350
15762 msgid "Some internal mounts are not unmounted by this call."
15766 #: ../src/guestfs-actions.pod:6517
15767 msgid "guestfs_upload"
15771 #: ../src/guestfs-actions.pod:6519
15775 " guestfs_upload (guestfs_h *g,\n"
15776 " const char *filename,\n"
15777 " const char *remotefilename);\n"
15782 #: ../src/guestfs-actions.pod:6524 ../src/guestfs-actions.pod:6548 ../fish/guestfish-actions.pod:4356 ../fish/guestfish-actions.pod:4369
15783 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15787 #: ../src/guestfs-actions.pod:6529
15788 msgid "See also C<guestfs_download>."
15792 #: ../src/guestfs-actions.pod:6540
15793 msgid "guestfs_upload_offset"
15797 #: ../src/guestfs-actions.pod:6542
15801 " guestfs_upload_offset (guestfs_h *g,\n"
15802 " const char *filename,\n"
15803 " const char *remotefilename,\n"
15804 " int64_t offset);\n"
15809 #: ../src/guestfs-actions.pod:6551 ../fish/guestfish-actions.pod:4372
15811 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15812 "The intention is to overwrite parts of existing files or devices, although "
15813 "if a non-existant file is specified then it is created with a \"hole\" "
15814 "before C<offset>. The size of the data written is implicit in the size of "
15815 "the source C<filename>."
15819 #: ../src/guestfs-actions.pod:6558
15821 "Note that there is no limit on the amount of data that can be uploaded with "
15822 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15823 "full amount unless an error occurs."
15827 #: ../src/guestfs-actions.pod:6563
15828 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15832 #: ../src/guestfs-actions.pod:6574
15833 msgid "guestfs_utimens"
15837 #: ../src/guestfs-actions.pod:6576
15841 " guestfs_utimens (guestfs_h *g,\n"
15842 " const char *path,\n"
15843 " int64_t atsecs,\n"
15844 " int64_t atnsecs,\n"
15845 " int64_t mtsecs,\n"
15846 " int64_t mtnsecs);\n"
15851 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4392
15852 msgid "This command sets the timestamps of a file with nanosecond precision."
15856 #: ../src/guestfs-actions.pod:6587 ../fish/guestfish-actions.pod:4395
15858 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15863 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4398
15865 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15866 "nanoseconds from the epoch."
15870 #: ../src/guestfs-actions.pod:6593 ../fish/guestfish-actions.pod:4401
15872 "If the C<*nsecs> field contains the special value C<-1> then the "
15873 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15874 "ignored in this case)."
15878 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4405
15880 "If the C<*nsecs> field contains the special value C<-2> then the "
15881 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15886 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-structs.pod:175
15887 msgid "guestfs_version"
15891 #: ../src/guestfs-actions.pod:6607
15894 " struct guestfs_version *\n"
15895 " guestfs_version (guestfs_h *g);\n"
15900 #: ../src/guestfs-actions.pod:6610 ../fish/guestfish-actions.pod:4413
15901 msgid "Return the libguestfs version number that the program is linked against."
15905 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
15907 "Note that because of dynamic linking this is not necessarily the version of "
15908 "libguestfs that you compiled against. You can compile the program, and then "
15909 "at runtime dynamically link against a completely different C<libguestfs.so> "
15914 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4421
15916 "This call was added in version C<1.0.58>. In previous versions of "
15917 "libguestfs there was no way to get the version number. From C code you can "
15918 "use dynamic linker functions to find out if this symbol exists (if it "
15919 "doesn't, then it's an earlier version)."
15923 #: ../src/guestfs-actions.pod:6624 ../fish/guestfish-actions.pod:4427
15925 "The call returns a structure with four elements. The first three (C<major>, "
15926 "C<minor> and C<release>) are numbers and correspond to the usual version "
15927 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15928 "but may be used for distro-specific information."
15932 #: ../src/guestfs-actions.pod:6630 ../fish/guestfish-actions.pod:4433
15933 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
15937 #: ../src/guestfs-actions.pod:6633 ../fish/guestfish-actions.pod:4436
15938 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15942 #: ../src/guestfs-actions.pod:6635
15944 "I<Note:> Don't use this call to test for availability of features. In "
15945 "enterprise distributions we backport features from later versions into "
15946 "earlier versions, making this an unreliable way to test for features. Use "
15947 "C<guestfs_available> instead."
15951 #: ../src/guestfs-actions.pod:6641
15953 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15954 "error. I<The caller must call C<guestfs_free_version> after use>."
15958 #: ../src/guestfs-actions.pod:6645
15959 msgid "(Added in 1.0.58)"
15963 #: ../src/guestfs-actions.pod:6647
15964 msgid "guestfs_vfs_label"
15968 #: ../src/guestfs-actions.pod:6649
15972 " guestfs_vfs_label (guestfs_h *g,\n"
15973 " const char *device);\n"
15978 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4448
15979 msgid "This returns the filesystem label of the filesystem on C<device>."
15983 #: ../src/guestfs-actions.pod:6656 ../fish/guestfish-actions.pod:4451
15984 msgid "If the filesystem is unlabeled, this returns the empty string."
15988 #: ../src/guestfs-actions.pod:6658
15989 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15993 #: ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:6700
15994 msgid "(Added in 1.3.18)"
15998 #: ../src/guestfs-actions.pod:6665
15999 msgid "guestfs_vfs_type"
16003 #: ../src/guestfs-actions.pod:6667
16007 " guestfs_vfs_type (guestfs_h *g,\n"
16008 " const char *device);\n"
16013 #: ../src/guestfs-actions.pod:6671 ../fish/guestfish-actions.pod:4459
16015 "This command gets the filesystem type corresponding to the filesystem on "
16020 #: ../src/guestfs-actions.pod:6674 ../fish/guestfish-actions.pod:4462
16022 "For most filesystems, the result is the name of the Linux VFS module which "
16023 "would be used to mount this filesystem if you mounted it without specifying "
16024 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
16028 #: ../src/guestfs-actions.pod:6684
16029 msgid "guestfs_vfs_uuid"
16033 #: ../src/guestfs-actions.pod:6686
16037 " guestfs_vfs_uuid (guestfs_h *g,\n"
16038 " const char *device);\n"
16043 #: ../src/guestfs-actions.pod:6690 ../fish/guestfish-actions.pod:4471
16044 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16048 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:4474
16049 msgid "If the filesystem does not have a UUID, this returns the empty string."
16053 #: ../src/guestfs-actions.pod:6695
16054 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16058 #: ../src/guestfs-actions.pod:6702
16059 msgid "guestfs_vg_activate"
16063 #: ../src/guestfs-actions.pod:6704
16067 " guestfs_vg_activate (guestfs_h *g,\n"
16069 " char *const *volgroups);\n"
16074 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4482
16076 "This command activates or (if C<activate> is false) deactivates all logical "
16077 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16078 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16079 "deactivated, then those devices disappear."
16083 #: ../src/guestfs-actions.pod:6715 ../fish/guestfish-actions.pod:4488
16084 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16088 #: ../src/guestfs-actions.pod:6717 ../fish/guestfish-actions.pod:4490
16090 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16091 "activated or deactivated."
16095 #: ../src/guestfs-actions.pod:6724
16096 msgid "guestfs_vg_activate_all"
16100 #: ../src/guestfs-actions.pod:6726
16104 " guestfs_vg_activate_all (guestfs_h *g,\n"
16105 " int activate);\n"
16110 #: ../src/guestfs-actions.pod:6730 ../fish/guestfish-actions.pod:4497
16112 "This command activates or (if C<activate> is false) deactivates all logical "
16113 "volumes in all volume groups. If activated, then they are made known to the "
16114 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16115 "those devices disappear."
16119 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4503
16120 msgid "This command is the same as running C<vgchange -a y|n>"
16124 #: ../src/guestfs-actions.pod:6742
16125 msgid "guestfs_vgcreate"
16129 #: ../src/guestfs-actions.pod:6744
16133 " guestfs_vgcreate (guestfs_h *g,\n"
16134 " const char *volgroup,\n"
16135 " char *const *physvols);\n"
16140 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4509
16142 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16143 "of physical volumes C<physvols>."
16147 #: ../src/guestfs-actions.pod:6756
16148 msgid "guestfs_vglvuuids"
16152 #: ../src/guestfs-actions.pod:6758
16156 " guestfs_vglvuuids (guestfs_h *g,\n"
16157 " const char *vgname);\n"
16162 #: ../src/guestfs-actions.pod:6762 ../fish/guestfish-actions.pod:4516
16164 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16165 "volumes created in this volume group."
16169 #: ../src/guestfs-actions.pod:6765
16171 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
16172 "associate logical volumes and volume groups."
16176 #: ../src/guestfs-actions.pod:6768
16177 msgid "See also C<guestfs_vgpvuuids>."
16181 #: ../src/guestfs-actions.pod:6776
16182 msgid "guestfs_vgpvuuids"
16186 #: ../src/guestfs-actions.pod:6778
16190 " guestfs_vgpvuuids (guestfs_h *g,\n"
16191 " const char *vgname);\n"
16196 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4528
16198 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16199 "volumes that this volume group resides on."
16203 #: ../src/guestfs-actions.pod:6785
16205 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
16206 "associate physical volumes and volume groups."
16210 #: ../src/guestfs-actions.pod:6788
16211 msgid "See also C<guestfs_vglvuuids>."
16215 #: ../src/guestfs-actions.pod:6796
16216 msgid "guestfs_vgremove"
16220 #: ../src/guestfs-actions.pod:6798
16224 " guestfs_vgremove (guestfs_h *g,\n"
16225 " const char *vgname);\n"
16230 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4540
16231 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16235 #: ../src/guestfs-actions.pod:6804 ../fish/guestfish-actions.pod:4542
16236 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16240 #: ../src/guestfs-actions.pod:6811
16241 msgid "guestfs_vgrename"
16245 #: ../src/guestfs-actions.pod:6813
16249 " guestfs_vgrename (guestfs_h *g,\n"
16250 " const char *volgroup,\n"
16251 " const char *newvolgroup);\n"
16256 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4549
16257 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16261 #: ../src/guestfs-actions.pod:6824
16262 msgid "guestfs_vgs"
16266 #: ../src/guestfs-actions.pod:6826
16270 " guestfs_vgs (guestfs_h *g);\n"
16275 #: ../src/guestfs-actions.pod:6829 ../fish/guestfish-actions.pod:4555
16277 "List all the volumes groups detected. This is the equivalent of the "
16278 "L<vgs(8)> command."
16282 #: ../src/guestfs-actions.pod:6832 ../fish/guestfish-actions.pod:4558
16284 "This returns a list of just the volume group names that were detected "
16285 "(eg. C<VolGroup00>)."
16289 #: ../src/guestfs-actions.pod:6835
16290 msgid "See also C<guestfs_vgs_full>."
16294 #: ../src/guestfs-actions.pod:6843
16295 msgid "guestfs_vgs_full"
16299 #: ../src/guestfs-actions.pod:6845
16302 " struct guestfs_lvm_vg_list *\n"
16303 " guestfs_vgs_full (guestfs_h *g);\n"
16308 #: ../src/guestfs-actions.pod:6848 ../fish/guestfish-actions.pod:4567
16310 "List all the volumes groups detected. This is the equivalent of the "
16311 "L<vgs(8)> command. The \"full\" version includes all fields."
16315 #: ../src/guestfs-actions.pod:6851
16317 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
16318 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
16323 #: ../src/guestfs-actions.pod:6857
16324 msgid "guestfs_vgscan"
16328 #: ../src/guestfs-actions.pod:6859
16332 " guestfs_vgscan (guestfs_h *g);\n"
16337 #: ../src/guestfs-actions.pod:6862 ../fish/guestfish-actions.pod:4574
16339 "This rescans all block devices and rebuilds the list of LVM physical "
16340 "volumes, volume groups and logical volumes."
16344 #: ../src/guestfs-actions.pod:6869
16345 msgid "guestfs_vguuid"
16349 #: ../src/guestfs-actions.pod:6871
16353 " guestfs_vguuid (guestfs_h *g,\n"
16354 " const char *vgname);\n"
16359 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4581
16360 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16364 #: ../src/guestfs-actions.pod:6882
16365 msgid "guestfs_wait_ready"
16369 #: ../src/guestfs-actions.pod:6884
16373 " guestfs_wait_ready (guestfs_h *g);\n"
16378 #: ../src/guestfs-actions.pod:6887
16379 msgid "This function is a no op."
16383 #: ../src/guestfs-actions.pod:6889
16385 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
16386 "calling C<guestfs_launch> to wait for the launch to complete. However this "
16387 "is no longer necessary because C<guestfs_launch> now does the waiting."
16391 #: ../src/guestfs-actions.pod:6894
16393 "If you see any calls to this function in code then you can just remove them, "
16394 "unless you want to retain compatibility with older versions of the API."
16398 #: ../src/guestfs-actions.pod:6902
16399 msgid "guestfs_wc_c"
16403 #: ../src/guestfs-actions.pod:6904
16407 " guestfs_wc_c (guestfs_h *g,\n"
16408 " const char *path);\n"
16413 #: ../src/guestfs-actions.pod:6908 ../fish/guestfish-actions.pod:4587
16415 "This command counts the characters in a file, using the C<wc -c> external "
16420 #: ../src/guestfs-actions.pod:6915
16421 msgid "guestfs_wc_l"
16425 #: ../src/guestfs-actions.pod:6917
16429 " guestfs_wc_l (guestfs_h *g,\n"
16430 " const char *path);\n"
16435 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4594
16437 "This command counts the lines in a file, using the C<wc -l> external "
16442 #: ../src/guestfs-actions.pod:6928
16443 msgid "guestfs_wc_w"
16447 #: ../src/guestfs-actions.pod:6930
16451 " guestfs_wc_w (guestfs_h *g,\n"
16452 " const char *path);\n"
16457 #: ../src/guestfs-actions.pod:6934 ../fish/guestfish-actions.pod:4601
16459 "This command counts the words in a file, using the C<wc -w> external "
16464 #: ../src/guestfs-actions.pod:6941
16465 msgid "guestfs_write"
16469 #: ../src/guestfs-actions.pod:6943
16473 " guestfs_write (guestfs_h *g,\n"
16474 " const char *path,\n"
16475 " const char *content,\n"
16476 " size_t content_size);\n"
16481 #: ../src/guestfs-actions.pod:6949 ../fish/guestfish-actions.pod:4608
16483 "This call creates a file called C<path>. The content of the file is the "
16484 "string C<content> (which can contain any 8 bit data)."
16488 #: ../src/guestfs-actions.pod:6959
16489 msgid "guestfs_write_file"
16493 #: ../src/guestfs-actions.pod:6961
16497 " guestfs_write_file (guestfs_h *g,\n"
16498 " const char *path,\n"
16499 " const char *content,\n"
16505 #: ../src/guestfs-actions.pod:6967 ../fish/guestfish-actions.pod:4618
16507 "This call creates a file called C<path>. The contents of the file is the "
16508 "string C<content> (which can contain any 8 bit data), with length C<size>."
16512 #: ../src/guestfs-actions.pod:6971 ../fish/guestfish-actions.pod:4622
16514 "As a special case, if C<size> is C<0> then the length is calculated using "
16515 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16519 #: ../src/guestfs-actions.pod:6975 ../fish/guestfish-actions.pod:4626
16521 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16522 "I<not> work, even if the length is specified."
16526 #: ../src/guestfs-actions.pod:6983
16528 "This function is deprecated. In new code, use the L</guestfs_write> call "
16533 #: ../src/guestfs-actions.pod:6992
16534 msgid "guestfs_zegrep"
16538 #: ../src/guestfs-actions.pod:6994
16542 " guestfs_zegrep (guestfs_h *g,\n"
16543 " const char *regex,\n"
16544 " const char *path);\n"
16549 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4643
16550 msgid "This calls the external C<zegrep> program and returns the matching lines."
16554 #: ../src/guestfs-actions.pod:7011
16555 msgid "guestfs_zegrepi"
16559 #: ../src/guestfs-actions.pod:7013
16563 " guestfs_zegrepi (guestfs_h *g,\n"
16564 " const char *regex,\n"
16565 " const char *path);\n"
16570 #: ../src/guestfs-actions.pod:7018 ../fish/guestfish-actions.pod:4653
16571 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16575 #: ../src/guestfs-actions.pod:7030
16576 msgid "guestfs_zero"
16580 #: ../src/guestfs-actions.pod:7032
16584 " guestfs_zero (guestfs_h *g,\n"
16585 " const char *device);\n"
16590 #: ../src/guestfs-actions.pod:7036 ../fish/guestfish-actions.pod:4663
16591 msgid "This command writes zeroes over the first few blocks of C<device>."
16595 #: ../src/guestfs-actions.pod:7038 ../fish/guestfish-actions.pod:4665
16597 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16598 "securely wipe the device). It should be sufficient to remove any partition "
16599 "tables, filesystem superblocks and so on."
16603 #: ../src/guestfs-actions.pod:7042
16604 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16608 #: ../src/guestfs-actions.pod:7053
16609 msgid "guestfs_zero_device"
16613 #: ../src/guestfs-actions.pod:7055
16617 " guestfs_zero_device (guestfs_h *g,\n"
16618 " const char *device);\n"
16623 #: ../src/guestfs-actions.pod:7059
16625 "This command writes zeroes over the entire C<device>. Compare with "
16626 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16630 #: ../src/guestfs-actions.pod:7073
16631 msgid "(Added in 1.3.1)"
16635 #: ../src/guestfs-actions.pod:7075
16636 msgid "guestfs_zerofree"
16640 #: ../src/guestfs-actions.pod:7077
16644 " guestfs_zerofree (guestfs_h *g,\n"
16645 " const char *device);\n"
16650 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4686
16652 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16653 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16654 "possible to compress the filesystem more effectively."
16658 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4691
16659 msgid "You should B<not> run this program if the filesystem is mounted."
16663 #: ../src/guestfs-actions.pod:7089 ../fish/guestfish-actions.pod:4694
16665 "It is possible that using this program can damage the filesystem or data on "
16670 #: ../src/guestfs-actions.pod:7096
16671 msgid "guestfs_zfgrep"
16675 #: ../src/guestfs-actions.pod:7098
16679 " guestfs_zfgrep (guestfs_h *g,\n"
16680 " const char *pattern,\n"
16681 " const char *path);\n"
16686 #: ../src/guestfs-actions.pod:7103 ../fish/guestfish-actions.pod:4701
16687 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16691 #: ../src/guestfs-actions.pod:7115
16692 msgid "guestfs_zfgrepi"
16696 #: ../src/guestfs-actions.pod:7117
16700 " guestfs_zfgrepi (guestfs_h *g,\n"
16701 " const char *pattern,\n"
16702 " const char *path);\n"
16707 #: ../src/guestfs-actions.pod:7122 ../fish/guestfish-actions.pod:4711
16708 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16712 #: ../src/guestfs-actions.pod:7134
16713 msgid "guestfs_zfile"
16717 #: ../src/guestfs-actions.pod:7136
16721 " guestfs_zfile (guestfs_h *g,\n"
16722 " const char *meth,\n"
16723 " const char *path);\n"
16728 #: ../src/guestfs-actions.pod:7141 ../fish/guestfish-actions.pod:4721
16729 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16733 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:4724
16734 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16738 #: ../src/guestfs-actions.pod:7146
16740 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16745 #: ../src/guestfs-actions.pod:7152
16747 "This function is deprecated. In new code, use the L</guestfs_file> call "
16752 #: ../src/guestfs-actions.pod:7161
16753 msgid "guestfs_zgrep"
16757 #: ../src/guestfs-actions.pod:7163
16761 " guestfs_zgrep (guestfs_h *g,\n"
16762 " const char *regex,\n"
16763 " const char *path);\n"
16768 #: ../src/guestfs-actions.pod:7168 ../fish/guestfish-actions.pod:4740
16769 msgid "This calls the external C<zgrep> program and returns the matching lines."
16773 #: ../src/guestfs-actions.pod:7180
16774 msgid "guestfs_zgrepi"
16778 #: ../src/guestfs-actions.pod:7182
16782 " guestfs_zgrepi (guestfs_h *g,\n"
16783 " const char *regex,\n"
16784 " const char *path);\n"
16789 #: ../src/guestfs-actions.pod:7187 ../fish/guestfish-actions.pod:4750
16790 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16794 #: ../src/guestfs-availability.pod:3
16799 #: ../src/guestfs-availability.pod:5
16801 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
16802 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
16803 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
16804 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
16805 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
16809 #: ../src/guestfs-availability.pod:21
16814 #: ../src/guestfs-availability.pod:23
16816 "The following functions: L</guestfs_inotify_add_watch> "
16817 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
16818 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16822 #: ../src/guestfs-availability.pod:31
16823 msgid "B<linuxfsuuid>"
16827 #: ../src/guestfs-availability.pod:33
16829 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
16830 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16834 #: ../src/guestfs-availability.pod:40
16835 msgid "B<linuxmodules>"
16839 #: ../src/guestfs-availability.pod:42
16840 msgid "The following functions: L</guestfs_modprobe>"
16844 #: ../src/guestfs-availability.pod:45
16845 msgid "B<linuxxattrs>"
16849 #: ../src/guestfs-availability.pod:47
16851 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
16852 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
16853 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
16854 "L</guestfs_setxattr>"
16858 #: ../src/guestfs-availability.pod:58
16863 #: ../src/guestfs-availability.pod:60
16865 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
16866 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
16867 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16871 #: ../src/guestfs-availability.pod:69
16876 #: ../src/guestfs-availability.pod:71
16878 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
16879 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
16880 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
16881 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
16882 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
16883 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
16884 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
16885 "L</guestfs_vgs_full>"
16889 #: ../src/guestfs-availability.pod:94
16894 #: ../src/guestfs-availability.pod:96
16896 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
16897 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
16901 #: ../src/guestfs-availability.pod:102
16906 #: ../src/guestfs-availability.pod:104
16907 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16911 #: ../src/guestfs-availability.pod:107
16912 msgid "B<ntfsprogs>"
16916 #: ../src/guestfs-availability.pod:109
16917 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16921 #: ../src/guestfs-availability.pod:113
16922 msgid "B<realpath>"
16926 #: ../src/guestfs-availability.pod:115
16927 msgid "The following functions: L</guestfs_realpath>"
16931 #: ../src/guestfs-availability.pod:118
16936 #: ../src/guestfs-availability.pod:120
16938 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
16939 "L</guestfs_scrub_freespace>"
16943 #: ../src/guestfs-availability.pod:125
16948 #: ../src/guestfs-availability.pod:127
16949 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16953 #: ../src/guestfs-availability.pod:131
16958 #: ../src/guestfs-availability.pod:133
16959 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16963 #: ../src/guestfs-availability.pod:137
16964 msgid "B<zerofree>"
16968 #: ../src/guestfs-availability.pod:139
16969 msgid "The following functions: L</guestfs_zerofree>"
16973 #: ../src/guestfs-structs.pod:1
16974 msgid "guestfs_int_bool"
16978 #: ../src/guestfs-structs.pod:3
16981 " struct guestfs_int_bool {\n"
16989 #: ../src/guestfs-structs.pod:8
16992 " struct guestfs_int_bool_list {\n"
16993 " uint32_t len; /* Number of elements in list. */\n"
16994 " struct guestfs_int_bool *val; /* Elements. */\n"
17000 #: ../src/guestfs-structs.pod:13
17003 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
17004 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
17009 #: ../src/guestfs-structs.pod:16
17010 msgid "guestfs_lvm_pv"
17014 #: ../src/guestfs-structs.pod:18
17017 " struct guestfs_lvm_pv {\n"
17018 " char *pv_name;\n"
17019 " /* The next field is NOT nul-terminated, be careful when printing it: "
17021 " char pv_uuid[32];\n"
17023 " uint64_t pv_size;\n"
17024 " uint64_t dev_size;\n"
17025 " uint64_t pv_free;\n"
17026 " uint64_t pv_used;\n"
17027 " char *pv_attr;\n"
17028 " int64_t pv_pe_count;\n"
17029 " int64_t pv_pe_alloc_count;\n"
17030 " char *pv_tags;\n"
17031 " uint64_t pe_start;\n"
17032 " int64_t pv_mda_count;\n"
17033 " uint64_t pv_mda_free;\n"
17039 #: ../src/guestfs-structs.pod:36
17042 " struct guestfs_lvm_pv_list {\n"
17043 " uint32_t len; /* Number of elements in list. */\n"
17044 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17050 #: ../src/guestfs-structs.pod:41
17053 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17054 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17059 #: ../src/guestfs-structs.pod:44
17060 msgid "guestfs_lvm_vg"
17064 #: ../src/guestfs-structs.pod:46
17067 " struct guestfs_lvm_vg {\n"
17068 " char *vg_name;\n"
17069 " /* The next field is NOT nul-terminated, be careful when printing it: "
17071 " char vg_uuid[32];\n"
17073 " char *vg_attr;\n"
17074 " uint64_t vg_size;\n"
17075 " uint64_t vg_free;\n"
17076 " char *vg_sysid;\n"
17077 " uint64_t vg_extent_size;\n"
17078 " int64_t vg_extent_count;\n"
17079 " int64_t vg_free_count;\n"
17080 " int64_t max_lv;\n"
17081 " int64_t max_pv;\n"
17082 " int64_t pv_count;\n"
17083 " int64_t lv_count;\n"
17084 " int64_t snap_count;\n"
17085 " int64_t vg_seqno;\n"
17086 " char *vg_tags;\n"
17087 " int64_t vg_mda_count;\n"
17088 " uint64_t vg_mda_free;\n"
17094 #: ../src/guestfs-structs.pod:69
17097 " struct guestfs_lvm_vg_list {\n"
17098 " uint32_t len; /* Number of elements in list. */\n"
17099 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17105 #: ../src/guestfs-structs.pod:74
17108 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17109 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17114 #: ../src/guestfs-structs.pod:77
17115 msgid "guestfs_lvm_lv"
17119 #: ../src/guestfs-structs.pod:79
17122 " struct guestfs_lvm_lv {\n"
17123 " char *lv_name;\n"
17124 " /* The next field is NOT nul-terminated, be careful when printing it: "
17126 " char lv_uuid[32];\n"
17127 " char *lv_attr;\n"
17128 " int64_t lv_major;\n"
17129 " int64_t lv_minor;\n"
17130 " int64_t lv_kernel_major;\n"
17131 " int64_t lv_kernel_minor;\n"
17132 " uint64_t lv_size;\n"
17133 " int64_t seg_count;\n"
17135 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17136 " float snap_percent;\n"
17137 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17138 " float copy_percent;\n"
17139 " char *move_pv;\n"
17140 " char *lv_tags;\n"
17141 " char *mirror_log;\n"
17142 " char *modules;\n"
17148 #: ../src/guestfs-structs.pod:101
17151 " struct guestfs_lvm_lv_list {\n"
17152 " uint32_t len; /* Number of elements in list. */\n"
17153 " struct guestfs_lvm_lv *val; /* Elements. */\n"
17159 #: ../src/guestfs-structs.pod:106
17162 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
17163 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
17168 #: ../src/guestfs-structs.pod:111
17171 " struct guestfs_stat {\n"
17175 " int64_t nlink;\n"
17180 " int64_t blksize;\n"
17181 " int64_t blocks;\n"
17182 " int64_t atime;\n"
17183 " int64_t mtime;\n"
17184 " int64_t ctime;\n"
17190 #: ../src/guestfs-structs.pod:127
17193 " struct guestfs_stat_list {\n"
17194 " uint32_t len; /* Number of elements in list. */\n"
17195 " struct guestfs_stat *val; /* Elements. */\n"
17201 #: ../src/guestfs-structs.pod:132
17204 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
17205 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
17210 #: ../src/guestfs-structs.pod:137
17213 " struct guestfs_statvfs {\n"
17214 " int64_t bsize;\n"
17215 " int64_t frsize;\n"
17216 " int64_t blocks;\n"
17217 " int64_t bfree;\n"
17218 " int64_t bavail;\n"
17219 " int64_t files;\n"
17220 " int64_t ffree;\n"
17221 " int64_t favail;\n"
17224 " int64_t namemax;\n"
17230 #: ../src/guestfs-structs.pod:151
17233 " struct guestfs_statvfs_list {\n"
17234 " uint32_t len; /* Number of elements in list. */\n"
17235 " struct guestfs_statvfs *val; /* Elements. */\n"
17241 #: ../src/guestfs-structs.pod:156
17244 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
17245 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
17250 #: ../src/guestfs-structs.pod:159
17251 msgid "guestfs_dirent"
17255 #: ../src/guestfs-structs.pod:161
17258 " struct guestfs_dirent {\n"
17267 #: ../src/guestfs-structs.pod:167
17270 " struct guestfs_dirent_list {\n"
17271 " uint32_t len; /* Number of elements in list. */\n"
17272 " struct guestfs_dirent *val; /* Elements. */\n"
17278 #: ../src/guestfs-structs.pod:172
17281 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
17282 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
17287 #: ../src/guestfs-structs.pod:177
17290 " struct guestfs_version {\n"
17291 " int64_t major;\n"
17292 " int64_t minor;\n"
17293 " int64_t release;\n"
17300 #: ../src/guestfs-structs.pod:184
17303 " struct guestfs_version_list {\n"
17304 " uint32_t len; /* Number of elements in list. */\n"
17305 " struct guestfs_version *val; /* Elements. */\n"
17311 #: ../src/guestfs-structs.pod:189
17314 " void guestfs_free_version (struct guestfs_free_version *);\n"
17315 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
17320 #: ../src/guestfs-structs.pod:192
17321 msgid "guestfs_xattr"
17325 #: ../src/guestfs-structs.pod:194
17328 " struct guestfs_xattr {\n"
17329 " char *attrname;\n"
17330 " /* The next two fields describe a byte array. */\n"
17331 " uint32_t attrval_len;\n"
17332 " char *attrval;\n"
17338 #: ../src/guestfs-structs.pod:201
17341 " struct guestfs_xattr_list {\n"
17342 " uint32_t len; /* Number of elements in list. */\n"
17343 " struct guestfs_xattr *val; /* Elements. */\n"
17349 #: ../src/guestfs-structs.pod:206
17352 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
17353 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
17358 #: ../src/guestfs-structs.pod:209
17359 msgid "guestfs_inotify_event"
17363 #: ../src/guestfs-structs.pod:211
17366 " struct guestfs_inotify_event {\n"
17367 " int64_t in_wd;\n"
17368 " uint32_t in_mask;\n"
17369 " uint32_t in_cookie;\n"
17370 " char *in_name;\n"
17376 #: ../src/guestfs-structs.pod:218
17379 " struct guestfs_inotify_event_list {\n"
17380 " uint32_t len; /* Number of elements in list. */\n"
17381 " struct guestfs_inotify_event *val; /* Elements. */\n"
17387 #: ../src/guestfs-structs.pod:223
17390 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
17391 " void guestfs_free_inotify_event_list (struct "
17392 "guestfs_free_inotify_event_list *);\n"
17397 #: ../src/guestfs-structs.pod:226
17398 msgid "guestfs_partition"
17402 #: ../src/guestfs-structs.pod:228
17405 " struct guestfs_partition {\n"
17406 " int32_t part_num;\n"
17407 " uint64_t part_start;\n"
17408 " uint64_t part_end;\n"
17409 " uint64_t part_size;\n"
17415 #: ../src/guestfs-structs.pod:235
17418 " struct guestfs_partition_list {\n"
17419 " uint32_t len; /* Number of elements in list. */\n"
17420 " struct guestfs_partition *val; /* Elements. */\n"
17426 #: ../src/guestfs-structs.pod:240
17429 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
17430 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
17435 #: ../src/guestfs-structs.pod:243
17436 msgid "guestfs_application"
17440 #: ../src/guestfs-structs.pod:245
17443 " struct guestfs_application {\n"
17444 " char *app_name;\n"
17445 " char *app_display_name;\n"
17446 " int32_t app_epoch;\n"
17447 " char *app_version;\n"
17448 " char *app_release;\n"
17449 " char *app_install_path;\n"
17450 " char *app_trans_path;\n"
17451 " char *app_publisher;\n"
17452 " char *app_url;\n"
17453 " char *app_source_package;\n"
17454 " char *app_summary;\n"
17455 " char *app_description;\n"
17461 #: ../src/guestfs-structs.pod:260
17464 " struct guestfs_application_list {\n"
17465 " uint32_t len; /* Number of elements in list. */\n"
17466 " struct guestfs_application *val; /* Elements. */\n"
17472 #: ../src/guestfs-structs.pod:265
17475 " void guestfs_free_application (struct guestfs_free_application *);\n"
17476 " void guestfs_free_application_list (struct guestfs_free_application_list "
17482 #: ../fish/guestfish.pod:5
17483 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17487 #: ../fish/guestfish.pod:9
17490 " guestfish [--options] [commands]\n"
17495 #: ../fish/guestfish.pod:11
17503 #: ../fish/guestfish.pod:13
17506 " guestfish [--ro|--rw] -a disk.img\n"
17511 #: ../fish/guestfish.pod:15
17514 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17519 #: ../fish/guestfish.pod:17
17522 " guestfish -d libvirt-domain\n"
17527 #: ../fish/guestfish.pod:19
17530 " guestfish [--ro|--rw] -a disk.img -i\n"
17535 #: ../fish/guestfish.pod:21
17538 " guestfish -d libvirt-domain -i\n"
17543 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
17548 #: ../fish/guestfish.pod:25
17550 "Using guestfish in read/write mode on live virtual machines can be "
17551 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17552 "option to use guestfish safely if the disk image or virtual machine might be "
17557 #: ../fish/guestfish.pod:32
17559 "Guestfish is a shell and command-line tool for examining and modifying "
17560 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17561 "functionality of the guestfs API, see L<guestfs(3)>."
17565 #: ../fish/guestfish.pod:36
17567 "Guestfish gives you structured access to the libguestfs API, from shell "
17568 "scripts or the command line or interactively. If you want to rescue a "
17569 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17574 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:908 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
17579 #: ../fish/guestfish.pod:43
17580 msgid "As an interactive shell"
17584 #: ../fish/guestfish.pod:45
17592 #: ../fish/guestfish.pod:47
17595 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17596 " editing virtual machine filesystems.\n"
17601 #: ../fish/guestfish.pod:50
17604 " Type: 'help' for a list of commands\n"
17605 " 'man' to read the manual\n"
17606 " 'quit' to quit the shell\n"
17611 #: ../fish/guestfish.pod:54
17614 " ><fs> add-ro disk.img\n"
17616 " ><fs> list-filesystems\n"
17617 " /dev/sda1: ext4\n"
17618 " /dev/vg_guest/lv_root: ext4\n"
17619 " /dev/vg_guest/lv_swap: swap\n"
17620 " ><fs> mount /dev/vg_guest/lv_root /\n"
17621 " ><fs> cat /etc/fstab\n"
17623 " # Created by anaconda\n"
17630 #: ../fish/guestfish.pod:67
17631 msgid "From shell scripts"
17635 #: ../fish/guestfish.pod:69
17636 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17640 #: ../fish/guestfish.pod:71
17643 " guestfish <<_EOF_\n"
17646 " mount /dev/vg_guest/lv_root /\n"
17647 " write /etc/motd \"Welcome, new users\"\n"
17653 #: ../fish/guestfish.pod:78
17654 msgid "List the LVM logical volumes in a disk image:"
17658 #: ../fish/guestfish.pod:80
17661 " guestfish -a disk.img --ro <<_EOF_\n"
17669 #: ../fish/guestfish.pod:85
17670 msgid "List all the filesystems in a disk image:"
17674 #: ../fish/guestfish.pod:87
17677 " guestfish -a disk.img --ro <<_EOF_\n"
17679 " list-filesystems\n"
17685 #: ../fish/guestfish.pod:92
17686 msgid "On one command line"
17690 #: ../fish/guestfish.pod:94
17691 msgid "Update C</etc/resolv.conf> in a guest:"
17695 #: ../fish/guestfish.pod:96
17699 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17700 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17705 #: ../fish/guestfish.pod:100
17706 msgid "Edit C</boot/grub/grub.conf> interactively:"
17710 #: ../fish/guestfish.pod:102
17713 " guestfish --rw --add disk.img \\\n"
17714 " --mount /dev/vg_guest/lv_root \\\n"
17715 " --mount /dev/sda1:/boot \\\n"
17716 " edit /boot/grub/grub.conf\n"
17721 #: ../fish/guestfish.pod:107
17722 msgid "Mount disks automatically"
17726 #: ../fish/guestfish.pod:109
17728 "Use the I<-i> option to automatically mount the disks from a virtual "
17733 #: ../fish/guestfish.pod:112
17736 " guestfish --ro -a disk.img -i cat /etc/group\n"
17741 #: ../fish/guestfish.pod:114
17744 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17749 #: ../fish/guestfish.pod:116
17750 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17754 #: ../fish/guestfish.pod:118
17757 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17762 #: ../fish/guestfish.pod:120
17763 msgid "As a script interpreter"
17767 #: ../fish/guestfish.pod:122
17768 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17772 #: ../fish/guestfish.pod:124
17775 " #!/usr/bin/guestfish -f\n"
17776 " sparse test1.img 100M\n"
17778 " part-disk /dev/sda mbr\n"
17779 " mkfs ext2 /dev/sda1\n"
17784 #: ../fish/guestfish.pod:130
17785 msgid "Start with a prepared disk"
17789 #: ../fish/guestfish.pod:132
17791 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17792 "single ext2-formatted partition:"
17796 #: ../fish/guestfish.pod:135
17799 " guestfish -N fs\n"
17804 #: ../fish/guestfish.pod:137
17805 msgid "To list what is available do:"
17809 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:899
17812 " guestfish -N help | less\n"
17817 #: ../fish/guestfish.pod:141
17818 msgid "Remote control"
17822 #: ../fish/guestfish.pod:143
17825 " eval \"`guestfish --listen`\"\n"
17826 " guestfish --remote add-ro disk.img\n"
17827 " guestfish --remote run\n"
17828 " guestfish --remote lvs\n"
17833 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:77 ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
17838 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:85 ../tools/virt-win-reg.pl:104 ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
17843 #: ../fish/guestfish.pod:154
17844 msgid "Displays general help on options."
17848 #: ../fish/guestfish.pod:156
17853 #: ../fish/guestfish.pod:158
17854 msgid "B<--cmd-help>"
17858 #: ../fish/guestfish.pod:160
17859 msgid "Lists all available guestfish commands."
17863 #: ../fish/guestfish.pod:162
17868 #: ../fish/guestfish.pod:164
17869 msgid "B<--cmd-help cmd>"
17873 #: ../fish/guestfish.pod:166
17874 msgid "Displays detailed help on a single command C<cmd>."
17878 #: ../fish/guestfish.pod:168
17879 msgid "B<-a image>"
17883 #: ../fish/guestfish.pod:170
17884 msgid "B<--add image>"
17888 #: ../fish/guestfish.pod:172
17889 msgid "Add a block device or virtual machine image to the shell."
17893 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
17895 "The format of the disk image is auto-detected. To override this and force a "
17896 "particular format use the I<--format=..> option."
17900 #: ../fish/guestfish.pod:177
17902 "Using this flag is mostly equivalent to using the C<add> command, with "
17903 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17904 "the I<--format=...> flag was given."
17908 #: ../fish/guestfish.pod:181
17913 #: ../fish/guestfish.pod:183
17914 msgid "B<--connect URI>"
17918 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
17920 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17921 "URI to use. The default is to use the default libvirt connection."
17925 #: ../fish/guestfish.pod:189
17930 #: ../fish/guestfish.pod:191
17932 "If using the I<--listen> option and a csh-like shell, use this option. See "
17933 "section L</REMOTE CONTROL AND CSH> below."
17937 #: ../fish/guestfish.pod:194
17938 msgid "B<-d libvirt-domain>"
17942 #: ../fish/guestfish.pod:196
17943 msgid "B<--domain libvirt-domain>"
17947 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
17949 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17950 "used, then any libvirt domain can be used. However in write mode, only "
17951 "libvirt domains which are shut down can be named here."
17955 #: ../fish/guestfish.pod:202
17957 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17958 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17959 "if the I<--format:...> flag was given."
17963 #: ../fish/guestfish.pod:206
17968 #: ../fish/guestfish.pod:208
17969 msgid "B<--no-dest-paths>"
17973 #: ../fish/guestfish.pod:210
17975 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17976 "to hit the tab key to complete paths on the guest filesystem, but this "
17977 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17978 "allow this feature to be disabled."
17982 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
17983 msgid "B<--echo-keys>"
17987 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
17989 "When prompting for keys and passphrases, guestfish normally turns echoing "
17990 "off so you cannot see what you are typing. If you are not worried about "
17991 "Tempest attacks and there is no one else in the room you can specify this "
17992 "flag to see what you are typing."
17996 #: ../fish/guestfish.pod:222
18001 #: ../fish/guestfish.pod:224
18002 msgid "B<--file file>"
18006 #: ../fish/guestfish.pod:226
18007 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
18011 #: ../fish/guestfish.pod:229
18014 " #!/usr/bin/guestfish -f\n"
18019 #: ../fish/guestfish.pod:231
18020 msgid "B<--format=raw|qcow2|..>"
18024 #: ../fish/guestfish.pod:233
18025 msgid "B<--format>"
18029 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
18031 "The default for the I<-a> option is to auto-detect the format of the disk "
18032 "image. Using this forces the disk format for I<-a> options which follow on "
18033 "the command line. Using I<--format> with no argument switches back to "
18034 "auto-detection for subsequent I<-a> options."
18038 #: ../fish/guestfish.pod:242
18041 " guestfish --format=raw -a disk.img\n"
18046 #: ../fish/guestfish.pod:244
18047 msgid "forces raw format (no auto-detection) for C<disk.img>."
18051 #: ../fish/guestfish.pod:246
18054 " guestfish --format=raw -a disk.img --format -a another.img\n"
18059 #: ../fish/guestfish.pod:248
18061 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18062 "auto-detection for C<another.img>."
18066 #: ../fish/guestfish.pod:251
18068 "If you have untrusted raw-format guest disk images, you should use this "
18069 "option to specify the disk format. This avoids a possible security problem "
18070 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18074 #: ../fish/guestfish.pod:256
18079 #: ../fish/guestfish.pod:258
18080 msgid "B<--inspector>"
18084 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18086 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18087 "system and mount filesystems as they would be mounted on the real virtual "
18092 #: ../fish/guestfish.pod:264
18093 msgid "Typical usage is either:"
18097 #: ../fish/guestfish.pod:266
18100 " guestfish -d myguest -i\n"
18105 #: ../fish/guestfish.pod:268
18106 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18110 #: ../fish/guestfish.pod:270
18113 " guestfish --ro -d myguest -i\n"
18118 #: ../fish/guestfish.pod:272
18119 msgid "(for active domains, readonly), or specify the block device directly:"
18123 #: ../fish/guestfish.pod:274
18126 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18131 #: ../fish/guestfish.pod:276
18133 "Note that the command line syntax changed slightly over older versions of "
18134 "guestfish. You can still use the old syntax:"
18138 #: ../fish/guestfish.pod:279
18141 " guestfish [--ro] -i disk.img\n"
18146 #: ../fish/guestfish.pod:281
18149 " guestfish [--ro] -i libvirt-domain\n"
18154 #: ../fish/guestfish.pod:283
18156 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
18157 "then using other commands to mount the filesystems that were found."
18161 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
18162 msgid "B<--keys-from-stdin>"
18166 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
18168 "Read key or passphrase parameters from stdin. The default is to try to read "
18169 "passphrases from the user by opening C</dev/tty>."
18173 #: ../fish/guestfish.pod:292
18174 msgid "B<--listen>"
18178 #: ../fish/guestfish.pod:294
18180 "Fork into the background and listen for remote commands. See section "
18181 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18185 #: ../fish/guestfish.pod:297
18186 msgid "B<-m dev[:mountpoint]>"
18190 #: ../fish/guestfish.pod:299
18191 msgid "B<--mount dev[:mountpoint]>"
18195 #: ../fish/guestfish.pod:301
18196 msgid "Mount the named partition or logical volume on the given mountpoint."
18200 #: ../fish/guestfish.pod:303
18201 msgid "If the mountpoint is omitted, it defaults to C</>."
18205 #: ../fish/guestfish.pod:305
18206 msgid "You have to mount something on C</> before most commands will work."
18210 #: ../fish/guestfish.pod:307
18212 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18217 #: ../fish/guestfish.pod:310
18219 "If you don't know what filesystems a disk image contains, you can either run "
18220 "guestfish without this option, then list the partitions, filesystems and LVs "
18221 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18222 "commands), or you can use the L<virt-filesystems(1)> program."
18226 #: ../fish/guestfish.pod:316
18228 "Using this flag is mostly equivalent to using the C<mount-options> command "
18229 "or the C<mount-ro> command if the I<--ro> flag was given."
18233 #: ../fish/guestfish.pod:319
18238 #: ../fish/guestfish.pod:321
18239 msgid "B<--no-sync>"
18243 #: ../fish/guestfish.pod:323
18245 "Disable autosync. This is enabled by default. See the discussion of "
18246 "autosync in the L<guestfs(3)> manpage."
18250 #: ../fish/guestfish.pod:326
18255 #: ../fish/guestfish.pod:328
18256 msgid "B<--new type>"
18260 #: ../fish/guestfish.pod:330
18265 #: ../fish/guestfish.pod:332
18267 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18268 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18269 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18274 #: ../fish/guestfish.pod:337
18275 msgid "B<--progress-bars>"
18279 #: ../fish/guestfish.pod:339
18280 msgid "Enable progress bars, even when guestfish is used non-interactively."
18284 #: ../fish/guestfish.pod:341
18286 "Progress bars are enabled by default when guestfish is used as an "
18287 "interactive shell."
18291 #: ../fish/guestfish.pod:344
18292 msgid "B<--no-progress-bars>"
18296 #: ../fish/guestfish.pod:346
18297 msgid "Disable progress bars."
18301 #: ../fish/guestfish.pod:348
18302 msgid "B<--remote[=pid]>"
18306 #: ../fish/guestfish.pod:350
18308 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18309 "CONTROL GUESTFISH OVER A SOCKET> below."
18313 #: ../fish/guestfish.pod:353
18318 #: ../fish/guestfish.pod:355
18323 #: ../fish/guestfish.pod:357
18325 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18326 "mounts are done read-only."
18330 #: ../fish/guestfish.pod:360
18332 "The option must always be used if the disk image or virtual machine might be "
18333 "running, and is generally recommended in cases where you don't need write "
18334 "access to the disk."
18338 #: ../fish/guestfish.pod:364
18340 "Note that prepared disk images created with I<-N> are not affected by this "
18341 "option. Also commands like C<add> are not affected - you have to specify "
18342 "the C<readonly:true> option explicitly if you need it."
18346 #: ../fish/guestfish.pod:368
18347 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18351 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
18352 msgid "B<--selinux>"
18356 #: ../fish/guestfish.pod:372
18357 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18361 #: ../fish/guestfish.pod:374
18366 #: ../fish/guestfish.pod:376
18367 msgid "B<--verbose>"
18371 #: ../fish/guestfish.pod:378
18373 "Enable very verbose messages. This is particularly useful if you find a "
18378 #: ../fish/guestfish.pod:381
18383 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:93 ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
18384 msgid "B<--version>"
18388 #: ../fish/guestfish.pod:385
18389 msgid "Display the guestfish / libguestfs version number and exit."
18393 #: ../fish/guestfish.pod:387
18398 #: ../fish/guestfish.pod:389
18403 #: ../fish/guestfish.pod:391
18405 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
18410 #: ../fish/guestfish.pod:394
18415 #: ../fish/guestfish.pod:396
18416 msgid "Echo each command before executing it."
18420 #: ../fish/guestfish.pod:400
18421 msgid "COMMANDS ON COMMAND LINE"
18425 #: ../fish/guestfish.pod:402
18426 msgid "Any additional (non-option) arguments are treated as commands to execute."
18430 #: ../fish/guestfish.pod:405
18432 "Commands to execute should be separated by a colon (C<:>), where the colon "
18433 "is a separate parameter. Thus:"
18437 #: ../fish/guestfish.pod:408
18440 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18445 #: ../fish/guestfish.pod:410
18447 "If there are no additional arguments, then we enter a shell, either an "
18448 "interactive shell with a prompt (if the input is a terminal) or a "
18449 "non-interactive shell."
18453 #: ../fish/guestfish.pod:414
18455 "In either command line mode or non-interactive shell, the first command that "
18456 "gives an error causes the whole shell to exit. In interactive mode (with a "
18457 "prompt) if a command fails, you can continue to enter commands."
18461 #: ../fish/guestfish.pod:419
18462 msgid "USING launch (OR run)"
18466 #: ../fish/guestfish.pod:421
18468 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18469 "then launch it, then mount any disks you need, and finally issue "
18470 "actions/commands. So the general order of the day is:"
18474 #: ../fish/guestfish.pod:429
18475 msgid "add or -a/--add"
18479 #: ../fish/guestfish.pod:433
18480 msgid "launch (aka run)"
18484 #: ../fish/guestfish.pod:437
18485 msgid "mount or -m/--mount"
18489 #: ../fish/guestfish.pod:441
18490 msgid "any other commands"
18494 #: ../fish/guestfish.pod:445
18496 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18497 "guest before mounting or performing any other commands."
18501 #: ../fish/guestfish.pod:448
18503 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18504 "I<--new> options were given then C<run> is done automatically, simply "
18505 "because guestfish can't perform the action you asked for without doing this."
18509 #: ../fish/guestfish.pod:453
18510 msgid "OPENING DISKS FOR READ AND WRITE"
18514 #: ../fish/guestfish.pod:455
18516 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
18517 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
18518 "open disk images read-only or for writing."
18522 #: ../fish/guestfish.pod:459
18524 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
18525 "disk images supplied on the command line for write. To open a disk image "
18526 "read-only you have to do I<-a image --ro>."
18530 #: ../fish/guestfish.pod:463
18532 "This matters: If you accidentally open a live VM disk image writable then "
18533 "you will cause irreversible disk corruption."
18537 #: ../fish/guestfish.pod:466
18539 "By libguestfs 1.10 we intend to change the default the other way. Disk "
18540 "images will be opened read-only. You will have to either specify "
18541 "I<guestfish --rw> or change a configuration file in order to get write "
18542 "access for disk images specified by those other command line options."
18546 #: ../fish/guestfish.pod:471
18548 "This version of guestfish has a I<--rw> option which does nothing (it is "
18549 "already the default). However it is highly recommended that you use this "
18550 "option to indicate that guestfish needs write access, and to prepare your "
18551 "scripts for the day when this option will be required for write access."
18555 #: ../fish/guestfish.pod:477
18557 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18558 "other libguestfs program apart from guestfish and guestmount."
18562 #: ../fish/guestfish.pod:480
18567 #: ../fish/guestfish.pod:482
18569 "You can quote ordinary parameters using either single or double quotes. For "
18574 #: ../fish/guestfish.pod:485
18577 " add \"file with a space.img\"\n"
18582 #: ../fish/guestfish.pod:487
18585 " rm '/file name'\n"
18590 #: ../fish/guestfish.pod:489
18598 #: ../fish/guestfish.pod:491
18600 "A few commands require a list of strings to be passed. For these, use a "
18601 "whitespace-separated list, enclosed in quotes. Strings containing "
18602 "whitespace to be passed through must be enclosed in single quotes. A "
18603 "literal single quote must be escaped with a backslash."
18607 #: ../fish/guestfish.pod:496
18610 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18611 " command \"/bin/echo 'foo bar'\"\n"
18612 " command \"/bin/echo \\'foo\\'\"\n"
18617 #: ../fish/guestfish.pod:500
18618 msgid "OPTIONAL ARGUMENTS"
18622 #: ../fish/guestfish.pod:502
18624 "Some commands take optional arguments. These arguments appear in this "
18625 "documentation as C<[argname:..]>. You can use them as in these examples:"
18629 #: ../fish/guestfish.pod:506
18632 " add-drive-opts filename\n"
18637 #: ../fish/guestfish.pod:508
18640 " add-drive-opts filename readonly:true\n"
18645 #: ../fish/guestfish.pod:510
18648 " add-drive-opts filename format:qcow2 readonly:false\n"
18653 #: ../fish/guestfish.pod:512
18655 "Each optional argument can appear at most once. All optional arguments must "
18656 "appear after the required ones."
18660 #: ../fish/guestfish.pod:515
18665 #: ../fish/guestfish.pod:517
18666 msgid "This section applies to all commands which can take integers as parameters."
18670 #: ../fish/guestfish.pod:520
18671 msgid "SIZE SUFFIX"
18675 #: ../fish/guestfish.pod:522
18677 "When the command takes a parameter measured in bytes, you can use one of the "
18678 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18682 #: ../fish/guestfish.pod:528
18683 msgid "B<k> or B<K> or B<KiB>"
18687 #: ../fish/guestfish.pod:530
18688 msgid "The size in kilobytes (multiplied by 1024)."
18692 #: ../fish/guestfish.pod:532
18697 #: ../fish/guestfish.pod:534
18698 msgid "The size in SI 1000 byte units."
18702 #: ../fish/guestfish.pod:536
18703 msgid "B<M> or B<MiB>"
18707 #: ../fish/guestfish.pod:538
18708 msgid "The size in megabytes (multiplied by 1048576)."
18712 #: ../fish/guestfish.pod:540
18717 #: ../fish/guestfish.pod:542
18718 msgid "The size in SI 1000000 byte units."
18722 #: ../fish/guestfish.pod:544
18723 msgid "B<G> or B<GiB>"
18727 #: ../fish/guestfish.pod:546
18728 msgid "The size in gigabytes (multiplied by 2**30)."
18732 #: ../fish/guestfish.pod:548
18737 #: ../fish/guestfish.pod:550
18738 msgid "The size in SI 10**9 byte units."
18742 #: ../fish/guestfish.pod:552
18743 msgid "B<T> or B<TiB>"
18747 #: ../fish/guestfish.pod:554
18748 msgid "The size in terabytes (multiplied by 2**40)."
18752 #: ../fish/guestfish.pod:556
18757 #: ../fish/guestfish.pod:558
18758 msgid "The size in SI 10**12 byte units."
18762 #: ../fish/guestfish.pod:560
18763 msgid "B<P> or B<PiB>"
18767 #: ../fish/guestfish.pod:562
18768 msgid "The size in petabytes (multiplied by 2**50)."
18772 #: ../fish/guestfish.pod:564
18777 #: ../fish/guestfish.pod:566
18778 msgid "The size in SI 10**15 byte units."
18782 #: ../fish/guestfish.pod:568
18783 msgid "B<E> or B<EiB>"
18787 #: ../fish/guestfish.pod:570
18788 msgid "The size in exabytes (multiplied by 2**60)."
18792 #: ../fish/guestfish.pod:572
18797 #: ../fish/guestfish.pod:574
18798 msgid "The size in SI 10**18 byte units."
18802 #: ../fish/guestfish.pod:576
18803 msgid "B<Z> or B<ZiB>"
18807 #: ../fish/guestfish.pod:578
18808 msgid "The size in zettabytes (multiplied by 2**70)."
18812 #: ../fish/guestfish.pod:580
18817 #: ../fish/guestfish.pod:582
18818 msgid "The size in SI 10**21 byte units."
18822 #: ../fish/guestfish.pod:584
18823 msgid "B<Y> or B<YiB>"
18827 #: ../fish/guestfish.pod:586
18828 msgid "The size in yottabytes (multiplied by 2**80)."
18832 #: ../fish/guestfish.pod:588
18837 #: ../fish/guestfish.pod:590
18838 msgid "The size in SI 10**24 byte units."
18842 #: ../fish/guestfish.pod:596
18845 " truncate-size /file 1G\n"
18850 #: ../fish/guestfish.pod:598
18851 msgid "would truncate the file to 1 gigabyte."
18855 #: ../fish/guestfish.pod:600
18857 "Be careful because a few commands take sizes in kilobytes or megabytes "
18858 "(eg. the parameter to L</memsize> is specified in megabytes already). "
18859 "Adding a suffix will probably not do what you expect."
18863 #: ../fish/guestfish.pod:604
18864 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18868 #: ../fish/guestfish.pod:606
18870 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18871 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18875 #: ../fish/guestfish.pod:609
18878 " 1234 decimal number 1234\n"
18879 " 02322 octal number, equivalent to decimal 1234\n"
18880 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18885 #: ../fish/guestfish.pod:613
18887 "When using the C<chmod> command, you almost always want to specify an octal "
18888 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18889 "L<chmod(1)> program):"
18893 #: ../fish/guestfish.pod:617
18896 " chmod 0777 /public # OK\n"
18897 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18902 #: ../fish/guestfish.pod:620
18904 "Commands that return numbers usually print them in decimal, but some "
18905 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18906 "octal, preceeded by C<0>)."
18910 #: ../fish/guestfish.pod:624
18911 msgid "WILDCARDS AND GLOBBING"
18915 #: ../fish/guestfish.pod:626
18917 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18918 "(globbing) by default. So for example the following will not do what you "
18923 #: ../fish/guestfish.pod:630
18931 #: ../fish/guestfish.pod:632
18933 "Assuming you don't have a directory called literally C</home/*> then the "
18934 "above command will return an error."
18938 #: ../fish/guestfish.pod:635
18939 msgid "To perform wildcard expansion, use the C<glob> command."
18943 #: ../fish/guestfish.pod:637
18946 " glob rm-rf /home/*\n"
18951 #: ../fish/guestfish.pod:639
18953 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18954 "many times), equivalent to:"
18958 #: ../fish/guestfish.pod:642
18961 " rm-rf /home/jim\n"
18962 " rm-rf /home/joe\n"
18963 " rm-rf /home/mary\n"
18968 #: ../fish/guestfish.pod:646
18969 msgid "C<glob> only works on simple guest paths and not on device names."
18973 #: ../fish/guestfish.pod:648
18975 "If you have several parameters, each containing a wildcard, then glob will "
18976 "perform a Cartesian product."
18980 #: ../fish/guestfish.pod:651
18985 #: ../fish/guestfish.pod:653
18987 "Any line which starts with a I<#> character is treated as a comment and "
18988 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18989 "a command. For example:"
18993 #: ../fish/guestfish.pod:657
18996 " # this is a comment\n"
18997 " # this is a comment\n"
18998 " foo # NOT a comment\n"
19003 #: ../fish/guestfish.pod:661
19004 msgid "Blank lines are also ignored."
19008 #: ../fish/guestfish.pod:663
19009 msgid "RUNNING COMMANDS LOCALLY"
19013 #: ../fish/guestfish.pod:665
19015 "Any line which starts with a I<!> character is treated as a command sent to "
19016 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
19020 #: ../fish/guestfish.pod:669
19024 " tgz-out /remote local/remote-data.tar.gz\n"
19029 #: ../fish/guestfish.pod:672
19031 "will create a directory C<local> on the host, and then export the contents "
19032 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
19033 "(See C<tgz-out>)."
19037 #: ../fish/guestfish.pod:676
19039 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
19040 "effect, due to the way that subprocesses work in Unix."
19044 #: ../fish/guestfish.pod:679
19049 #: ../fish/guestfish.pod:681
19051 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19052 "command (a guestfish command) to the second command (any host command). For "
19057 #: ../fish/guestfish.pod:685
19060 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19065 #: ../fish/guestfish.pod:687
19067 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19068 "program). The above command would list all accounts in the guest filesystem "
19069 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19073 #: ../fish/guestfish.pod:692
19076 " hexdump /bin/ls | head\n"
19077 " list-devices | tail -1\n"
19078 " tgz-out / - | tar ztf -\n"
19083 #: ../fish/guestfish.pod:696
19085 "The space before the pipe symbol is required, any space after the pipe "
19086 "symbol is optional. Everything after the pipe symbol is just passed "
19087 "straight to the host shell, so it can contain redirections, globs and "
19088 "anything else that makes sense on the host side."
19092 #: ../fish/guestfish.pod:701
19094 "To use a literal argument which begins with a pipe symbol, you have to quote "
19099 #: ../fish/guestfish.pod:704
19107 #: ../fish/guestfish.pod:706
19108 msgid "HOME DIRECTORIES"
19112 #: ../fish/guestfish.pod:708
19114 "If a parameter starts with the character C<~> then the tilde may be expanded "
19115 "as a home directory path (either C<~> for the current user's home directory, "
19116 "or C<~user> for another user)."
19120 #: ../fish/guestfish.pod:712
19122 "Note that home directory expansion happens for users known I<on the host>, "
19123 "not in the guest filesystem."
19127 #: ../fish/guestfish.pod:715
19129 "To use a literal argument which begins with a tilde, you have to quote it, "
19134 #: ../fish/guestfish.pod:718
19142 #: ../fish/guestfish.pod:722
19144 "Libguestfs has some support for Linux guests encrypted according to the "
19145 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19146 "disk encryption systems used by modern Linux guests. Currently only "
19147 "LVM-on-LUKS is supported."
19151 #: ../fish/guestfish.pod:727
19152 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19156 #: ../fish/guestfish.pod:729
19159 " ><fs> vfs-type /dev/sda2\n"
19165 #: ../fish/guestfish.pod:732
19167 "Then open those devices using L</luks-open>. This creates a device-mapper "
19168 "device called C</dev/mapper/luksdev>."
19172 #: ../fish/guestfish.pod:735
19175 " ><fs> luks-open /dev/sda2 luksdev\n"
19176 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19181 #: ../fish/guestfish.pod:738
19183 "Finally you have to tell LVM to scan for volume groups on the newly created "
19188 #: ../fish/guestfish.pod:741
19192 " vg-activate-all true\n"
19197 #: ../fish/guestfish.pod:744
19198 msgid "The logical volume(s) can now be mounted in the usual way."
19202 #: ../fish/guestfish.pod:746
19204 "Before closing a LUKS device you must unmount any logical volumes on it and "
19205 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19206 "one. Then you can close the mapper device:"
19210 #: ../fish/guestfish.pod:750
19213 " vg-activate false /dev/VG\n"
19214 " luks-close /dev/mapper/luksdev\n"
19219 #: ../fish/guestfish.pod:753
19220 msgid "WINDOWS PATHS"
19224 #: ../fish/guestfish.pod:755
19226 "If a path is prefixed with C<win:> then you can use Windows-style paths "
19227 "(with some limitations). The following commands are equivalent:"
19231 #: ../fish/guestfish.pod:758
19234 " file /WINDOWS/system32/config/system.LOG\n"
19239 #: ../fish/guestfish.pod:760
19242 " file win:/windows/system32/config/system.log\n"
19247 #: ../fish/guestfish.pod:762
19250 " file win:\\windows\\system32\\config\\system.log\n"
19255 #: ../fish/guestfish.pod:764
19258 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
19263 #: ../fish/guestfish.pod:766
19265 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
19266 "handles case insensitivity like Windows would. This only works in argument "
19267 "positions that expect a path."
19271 #: ../fish/guestfish.pod:770
19272 msgid "UPLOADING AND DOWNLOADING FILES"
19276 #: ../fish/guestfish.pod:772
19278 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19279 "others which upload from or download to a local file, you can use the "
19280 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19284 #: ../fish/guestfish.pod:776
19292 #: ../fish/guestfish.pod:778
19293 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19297 #: ../fish/guestfish.pod:781
19300 " tar-out /etc - | tar tf -\n"
19305 #: ../fish/guestfish.pod:783
19307 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19308 "command (see L</PIPES>)."
19312 #: ../fish/guestfish.pod:786
19314 "When using C<-> to read from stdin, the input is read up to the end of "
19315 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19316 "some arbitrary end marker:"
19320 #: ../fish/guestfish.pod:790
19323 " upload -<<END /foo\n"
19332 #: ../fish/guestfish.pod:796
19334 "Any string of characters can be used instead of C<END>. The end marker must "
19335 "appear on a line of its own, without any preceeding or following characters "
19336 "(not even spaces)."
19340 #: ../fish/guestfish.pod:800
19342 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19343 "upload local files (so-called \"FileIn\" parameters in the generator)."
19347 #: ../fish/guestfish.pod:803
19348 msgid "EXIT ON ERROR BEHAVIOUR"
19352 #: ../fish/guestfish.pod:805
19354 "By default, guestfish will ignore any errors when in interactive mode "
19355 "(ie. taking commands from a human over a tty), and will exit on the first "
19356 "error in non-interactive mode (scripts, commands given on the command line)."
19360 #: ../fish/guestfish.pod:810
19362 "If you prefix a command with a I<-> character, then that command will not "
19363 "cause guestfish to exit, even if that (one) command returns an error."
19367 #: ../fish/guestfish.pod:814
19368 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19372 #: ../fish/guestfish.pod:816
19374 "Guestfish can be remote-controlled over a socket. This is useful "
19375 "particularly in shell scripts where you want to make several different "
19376 "changes to a filesystem, but you don't want the overhead of starting up a "
19377 "guestfish process each time."
19381 #: ../fish/guestfish.pod:821
19382 msgid "Start a guestfish server process using:"
19386 #: ../fish/guestfish.pod:823
19389 " eval \"`guestfish --listen`\"\n"
19394 #: ../fish/guestfish.pod:825
19395 msgid "and then send it commands by doing:"
19399 #: ../fish/guestfish.pod:827
19402 " guestfish --remote cmd [...]\n"
19407 #: ../fish/guestfish.pod:829
19408 msgid "To cause the server to exit, send it the exit command:"
19412 #: ../fish/guestfish.pod:831
19415 " guestfish --remote exit\n"
19420 #: ../fish/guestfish.pod:833
19422 "Note that the server will normally exit if there is an error in a command. "
19423 "You can change this in the usual way. See section L</EXIT ON ERROR "
19428 #: ../fish/guestfish.pod:837
19429 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19433 #: ../fish/guestfish.pod:839
19435 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19436 "is how the I<--remote> option knows where to send the commands. You can "
19437 "have several guestfish listener processes running using:"
19441 #: ../fish/guestfish.pod:843
19444 " eval \"`guestfish --listen`\"\n"
19445 " pid1=$GUESTFISH_PID\n"
19446 " eval \"`guestfish --listen`\"\n"
19447 " pid2=$GUESTFISH_PID\n"
19449 " guestfish --remote=$pid1 cmd\n"
19450 " guestfish --remote=$pid2 cmd\n"
19455 #: ../fish/guestfish.pod:851
19456 msgid "REMOTE CONTROL AND CSH"
19460 #: ../fish/guestfish.pod:853
19462 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19467 #: ../fish/guestfish.pod:856
19470 " eval \"`guestfish --listen --csh`\"\n"
19475 #: ../fish/guestfish.pod:858
19476 msgid "REMOTE CONTROL DETAILS"
19480 #: ../fish/guestfish.pod:860
19482 "Remote control happens over a Unix domain socket called "
19483 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19484 "of the process, and C<$PID> is the process ID of the server."
19488 #: ../fish/guestfish.pod:864
19489 msgid "Guestfish client and server versions must match exactly."
19493 #: ../fish/guestfish.pod:866
19494 msgid "REMOTE CONTROL RUN COMMAND HANGING"
19498 #: ../fish/guestfish.pod:868
19500 "Using the C<run> (or C<launch>) command remotely in a command substitution "
19501 "context hangs, ie. don't do (note the backquotes):"
19505 #: ../fish/guestfish.pod:871
19508 " a=`guestfish --remote run`\n"
19513 #: ../fish/guestfish.pod:873
19515 "Since the C<run> command produces no output on stdout, this is not useful "
19516 "anyway. For further information see "
19517 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
19521 #: ../fish/guestfish.pod:877
19522 msgid "PREPARED DISK IMAGES"
19526 #: ../fish/guestfish.pod:879
19528 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19529 "preformatted disk images that guestfish can make for you to save typing. "
19530 "This is particularly useful for testing purposes. This option is used "
19531 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19532 "can be mixed with I<-a>)."
19536 #: ../fish/guestfish.pod:885
19538 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19539 "the second and so on. Existing files in the current directory are "
19544 #: ../fish/guestfish.pod:889
19546 "The type briefly describes how the disk should be sized, partitioned, how "
19547 "filesystem(s) should be created, and how content should be added. "
19548 "Optionally the type can be followed by extra parameters, separated by C<:> "
19549 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19550 "sparsely-allocated disk, containing a single partition, with the partition "
19551 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19552 "on a 1GB disk instead."
19556 #: ../fish/guestfish.pod:897
19557 msgid "To list the available types and any extra parameters they take, run:"
19561 #: ../fish/guestfish.pod:901
19563 "Note that the prepared filesystem is not mounted. You would usually have to "
19564 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19568 #: ../fish/guestfish.pod:905
19570 "If any I<-N> or I<--new> options are given, the guest is automatically "
19575 #: ../fish/guestfish.pod:910
19576 msgid "Create a 100MB disk with an ext4-formatted partition:"
19580 #: ../fish/guestfish.pod:912
19583 " guestfish -N fs:ext4\n"
19588 #: ../fish/guestfish.pod:914
19589 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19593 #: ../fish/guestfish.pod:916
19596 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19601 #: ../fish/guestfish.pod:918
19602 msgid "Create a blank 200MB disk:"
19606 #: ../fish/guestfish.pod:920
19609 " guestfish -N disk:200M\n"
19614 #: ../fish/guestfish.pod:922
19615 msgid "PROGRESS BARS"
19619 #: ../fish/guestfish.pod:924
19621 "Some (not all) long-running commands send progress notification messages as "
19622 "they are running. Guestfish turns these messages into progress bars."
19626 #: ../fish/guestfish.pod:928
19628 "When a command that supports progress bars takes longer than two seconds to "
19629 "run, and if progress bars are enabled, then you will see one appearing below "
19634 #: ../fish/guestfish.pod:932
19637 " ><fs> copy-size /large-file /another-file 2048M\n"
19638 " / 10% [#####-----------------------------------------] 00:30\n"
19643 #: ../fish/guestfish.pod:935
19645 "The spinner on the left hand side moves round once for every progress "
19646 "notification received from the backend. This is a (reasonably) golden "
19647 "assurance that the command is \"doing something\" even if the progress bar "
19648 "is not moving, because the command is able to send the progress "
19649 "notifications. When the bar reaches 100% and the command finishes, the "
19650 "spinner disappears."
19654 #: ../fish/guestfish.pod:942
19656 "Progress bars are enabled by default when guestfish is used interactively. "
19657 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19658 "and you can disable them completely using I<--no-progress-bars>."
19662 #: ../fish/guestfish.pod:947
19663 msgid "GUESTFISH COMMANDS"
19667 #: ../fish/guestfish.pod:949
19669 "The commands in this section are guestfish convenience commands, in other "
19670 "words, they are not part of the L<guestfs(3)> API."
19674 #: ../fish/guestfish.pod:952
19679 #: ../fish/guestfish.pod:954
19688 #: ../fish/guestfish.pod:957
19689 msgid "Without any parameter, this provides general help."
19693 #: ../fish/guestfish.pod:959
19694 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19698 #: ../fish/guestfish.pod:961
19699 msgid "quit | exit"
19703 #: ../fish/guestfish.pod:963
19704 msgid "This exits guestfish. You can also use C<^D> key."
19708 #: ../fish/guestfish.pod:965
19709 msgid "@FISH_COMMANDS@"
19713 #: ../fish/guestfish.pod:967
19718 #: ../fish/guestfish.pod:971 ../test-tool/libguestfs-test-tool.pod:83
19723 #: ../fish/guestfish.pod:973
19725 "guestfish returns 0 if the commands completed without error, or 1 if there "
19730 #: ../fish/guestfish.pod:980
19735 #: ../fish/guestfish.pod:982
19737 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19742 #: ../fish/guestfish.pod:985
19743 msgid "GUESTFISH_PID"
19747 #: ../fish/guestfish.pod:987
19749 "Used with the I<--remote> option to specify the remote guestfish process to "
19750 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19754 #: ../fish/guestfish.pod:991
19759 #: ../fish/guestfish.pod:993
19761 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19762 "not specified, the external L<hexedit(1)> program is used."
19766 #: ../fish/guestfish.pod:997
19771 #: ../fish/guestfish.pod:999
19773 "If compiled with GNU readline support, various files in the home directory "
19774 "can be used. See L</FILES>."
19778 #: ../fish/guestfish.pod:1008
19780 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19781 "effect as using the B<-v> option."
19785 #: ../fish/guestfish.pod:1020
19787 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19788 "the discussion of paths in L<guestfs(3)>."
19792 #: ../fish/guestfish.pod:1031
19793 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19797 #: ../fish/guestfish.pod:1033
19802 #: ../fish/guestfish.pod:1035
19804 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19809 #: ../fish/guestfish.pod:1050 ../test-tool/libguestfs-test-tool.pod:88
19814 #: ../fish/guestfish.pod:1054
19815 msgid "$HOME/.guestfish"
19819 #: ../fish/guestfish.pod:1056
19821 "If compiled with GNU readline support, then the command history is saved in "
19826 #: ../fish/guestfish.pod:1059
19827 msgid "$HOME/.inputrc"
19831 #: ../fish/guestfish.pod:1061
19832 msgid "/etc/inputrc"
19836 #: ../fish/guestfish.pod:1063
19838 "If compiled with GNU readline support, then these files can be used to "
19839 "configure readline. For further information, please see "
19840 "L<readline(3)/INITIALIZATION FILE>."
19844 #: ../fish/guestfish.pod:1067
19845 msgid "To write rules which only apply to guestfish, use:"
19849 #: ../fish/guestfish.pod:1069
19859 #: ../fish/guestfish.pod:1073
19861 "Variables that you can set in inputrc that change the behaviour of guestfish "
19862 "in useful ways include:"
19866 #: ../fish/guestfish.pod:1078
19867 msgid "completion-ignore-case (default: on)"
19871 #: ../fish/guestfish.pod:1080
19873 "By default, guestfish will ignore case when tab-completing paths on the "
19878 #: ../fish/guestfish.pod:1083
19881 " set completion-ignore-case off\n"
19886 #: ../fish/guestfish.pod:1085
19887 msgid "to make guestfish case sensitive."
19891 #: ../fish/guestfish.pod:1089
19896 #: ../fish/guestfish.pod:1091
19897 msgid "test2.img (etc)"
19901 #: ../fish/guestfish.pod:1093
19903 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19904 "will be created in the file C<test1.img> in the current directory. The "
19905 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19906 "the same name will be overwritten."
19910 #: ../fish/guestfish.pod:1102
19912 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19913 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
19914 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
19915 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
19916 "L<virt-win-reg(1)>, L<hexedit(1)>."
19920 #: ../fish/guestfish.pod:1128 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:415 ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
19922 "This program is free software; you can redistribute it and/or modify it "
19923 "under the terms of the GNU General Public License as published by the Free "
19924 "Software Foundation; either version 2 of the License, or (at your option) "
19925 "any later version."
19929 #: ../fish/guestfish.pod:1133 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:420 ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1517 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
19931 "This program is distributed in the hope that it will be useful, but WITHOUT "
19932 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19933 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19938 #: ../fish/guestfish.pod:1138 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:425 ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1522 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
19940 "You should have received a copy of the GNU General Public License along with "
19941 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19942 "Ave, Cambridge, MA 02139, USA."
19946 #: ../fish/guestfish-actions.pod:1
19951 #: ../fish/guestfish-actions.pod:3
19954 " add-cdrom filename\n"
19959 #: ../fish/guestfish-actions.pod:15
19961 "This call checks for the existence of C<filename>. This stops you from "
19962 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19963 "and C<http:> URLs. To specify those, use the general L</config> call "
19968 #: ../fish/guestfish-actions.pod:22
19970 "If you just want to add an ISO file (often you use this as an efficient way "
19971 "to transfer large files into the guest), then you should probably use "
19972 "L</add-drive-ro> instead."
19976 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
19978 "This function is deprecated. In new code, use the L</add_drive_opts> call "
19983 #: ../fish/guestfish-actions.pod:35
19988 #: ../fish/guestfish-actions.pod:37
19993 #: ../fish/guestfish-actions.pod:39
19996 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
20001 #: ../fish/guestfish-actions.pod:41
20003 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
20004 "It works by connecting to libvirt, requesting the domain and domain XML from "
20005 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
20009 #: ../fish/guestfish-actions.pod:64
20011 "The other optional parameters are passed directly through to "
20012 "L</add-drive-opts>."
20016 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131 ../fish/guestfish-actions.pod:2850
20018 "This command has one or more optional arguments. See L</OPTIONAL "
20023 #: ../fish/guestfish-actions.pod:69
20028 #: ../fish/guestfish-actions.pod:71
20031 " add-drive filename\n"
20036 #: ../fish/guestfish-actions.pod:73
20038 "This function is the equivalent of calling L</add-drive-opts> with no "
20039 "optional parameters, so the disk is added writable, with the format being "
20040 "detected automatically."
20044 #: ../fish/guestfish-actions.pod:77
20046 "Automatic detection of the format opens you up to a potential security hole "
20047 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
20048 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
20049 "you should think about replacing calls to this function with calls to "
20050 "L</add-drive-opts>, and specifying the format."
20054 #: ../fish/guestfish-actions.pod:84
20055 msgid "add-drive-opts"
20059 #: ../fish/guestfish-actions.pod:86
20064 #: ../fish/guestfish-actions.pod:88
20067 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
20072 #: ../fish/guestfish-actions.pod:115
20074 "This forces the image format. If you omit this (or use L</add-drive> or "
20075 "L</add-drive-ro>) then the format is automatically detected. Possible "
20076 "formats include C<raw> and C<qcow2>."
20080 #: ../fish/guestfish-actions.pod:126
20082 "This rarely-used option lets you emulate the behaviour of the deprecated "
20083 "L</add-drive-with-if> call (q.v.)"
20087 #: ../fish/guestfish-actions.pod:133
20088 msgid "add-drive-ro"
20092 #: ../fish/guestfish-actions.pod:135
20097 #: ../fish/guestfish-actions.pod:137
20100 " add-drive-ro filename\n"
20105 #: ../fish/guestfish-actions.pod:139
20107 "This function is the equivalent of calling L</add-drive-opts> with the "
20108 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20109 "is added read-only, with the format being detected automatically."
20113 #: ../fish/guestfish-actions.pod:144
20114 msgid "add-drive-ro-with-if"
20118 #: ../fish/guestfish-actions.pod:146
20121 " add-drive-ro-with-if filename iface\n"
20126 #: ../fish/guestfish-actions.pod:148
20128 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
20129 "interface emulation to use at run time."
20133 #: ../fish/guestfish-actions.pod:158
20134 msgid "add-drive-with-if"
20138 #: ../fish/guestfish-actions.pod:160
20141 " add-drive-with-if filename iface\n"
20146 #: ../fish/guestfish-actions.pod:162
20148 "This is the same as L</add-drive> but it allows you to specify the QEMU "
20149 "interface emulation to use at run time."
20153 #: ../fish/guestfish-actions.pod:172
20158 #: ../fish/guestfish-actions.pod:174
20161 " aug-clear augpath\n"
20166 #: ../fish/guestfish-actions.pod:179
20171 #: ../fish/guestfish-actions.pod:181
20179 #: ../fish/guestfish-actions.pod:183
20181 "Close the current Augeas handle and free up any resources used by it. After "
20182 "calling this, you have to call L</aug-init> again before you can use any "
20183 "other Augeas functions."
20187 #: ../fish/guestfish-actions.pod:188
20188 msgid "aug-defnode"
20192 #: ../fish/guestfish-actions.pod:190
20195 " aug-defnode name expr val\n"
20200 #: ../fish/guestfish-actions.pod:195
20202 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
20203 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
20204 "containing that single node."
20208 #: ../fish/guestfish-actions.pod:203
20213 #: ../fish/guestfish-actions.pod:205
20216 " aug-defvar name expr\n"
20221 #: ../fish/guestfish-actions.pod:214
20226 #: ../fish/guestfish-actions.pod:216
20229 " aug-get augpath\n"
20234 #: ../fish/guestfish-actions.pod:221
20239 #: ../fish/guestfish-actions.pod:223
20242 " aug-init root flags\n"
20247 #: ../fish/guestfish-actions.pod:229
20248 msgid "You must call this before using any other L</aug-*> commands."
20252 #: ../fish/guestfish-actions.pod:254
20254 "This option is only useful when debugging Augeas lenses. Use of this option "
20255 "may require additional memory for the libguestfs appliance. You may need to "
20256 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
20260 #: ../fish/guestfish-actions.pod:269
20261 msgid "Do not load the tree in L</aug-init>."
20265 #: ../fish/guestfish-actions.pod:273
20266 msgid "To close the handle, you can call L</aug-close>."
20270 #: ../fish/guestfish-actions.pod:277
20275 #: ../fish/guestfish-actions.pod:279
20278 " aug-insert augpath label true|false\n"
20283 #: ../fish/guestfish-actions.pod:289
20288 #: ../fish/guestfish-actions.pod:291
20296 #: ../fish/guestfish-actions.pod:298
20301 #: ../fish/guestfish-actions.pod:300
20304 " aug-ls augpath\n"
20309 #: ../fish/guestfish-actions.pod:302
20311 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
20312 "resulting nodes into alphabetical order."
20316 #: ../fish/guestfish-actions.pod:305
20321 #: ../fish/guestfish-actions.pod:307
20324 " aug-match augpath\n"
20329 #: ../fish/guestfish-actions.pod:313
20334 #: ../fish/guestfish-actions.pod:315
20337 " aug-mv src dest\n"
20342 #: ../fish/guestfish-actions.pod:320
20347 #: ../fish/guestfish-actions.pod:322
20350 " aug-rm augpath\n"
20355 #: ../fish/guestfish-actions.pod:328
20360 #: ../fish/guestfish-actions.pod:330
20368 #: ../fish/guestfish-actions.pod:334
20370 "The flags which were passed to L</aug-init> affect exactly how files are "
20375 #: ../fish/guestfish-actions.pod:337
20380 #: ../fish/guestfish-actions.pod:339
20383 " aug-set augpath val\n"
20388 #: ../fish/guestfish-actions.pod:343
20390 "In the Augeas API, it is possible to clear a node by setting the value to "
20391 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
20392 "this call. Instead you must use the L</aug-clear> call."
20396 #: ../fish/guestfish-actions.pod:348
20401 #: ../fish/guestfish-actions.pod:350
20404 " available 'groups ...'\n"
20409 #: ../fish/guestfish-actions.pod:356
20411 "The libguestfs groups, and the functions that those groups correspond to, "
20412 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
20413 "runtime by calling L</available-all-groups>."
20417 #: ../fish/guestfish-actions.pod:380
20418 msgid "You must call L</launch> before calling this function."
20422 #: ../fish/guestfish-actions.pod:402
20424 "This call was added in version C<1.0.80>. In previous versions of "
20425 "libguestfs all you could do would be to speculatively execute a command to "
20426 "find out if the daemon implemented it. See also L</version>."
20430 #: ../fish/guestfish-actions.pod:409
20431 msgid "available-all-groups"
20435 #: ../fish/guestfish-actions.pod:411
20438 " available-all-groups\n"
20443 #: ../fish/guestfish-actions.pod:413
20445 "This command returns a list of all optional groups that this daemon knows "
20446 "about. Note this returns both supported and unsupported groups. To find "
20447 "out which ones the daemon can actually support you have to call "
20448 "L</available> on each member of the returned list."
20452 #: ../fish/guestfish-actions.pod:419
20453 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
20457 #: ../fish/guestfish-actions.pod:421
20462 #: ../fish/guestfish-actions.pod:423
20465 " base64-in (base64file|-) filename\n"
20470 #: ../fish/guestfish-actions.pod:428 ../fish/guestfish-actions.pod:437 ../fish/guestfish-actions.pod:661 ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:849 ../fish/guestfish-actions.pod:1223 ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4226 ../fish/guestfish-actions.pod:4237 ../fish/guestfish-actions.pod:4248 ../fish/guestfish-actions.pod:4300 ../fish/guestfish-actions.pod:4309 ../fish/guestfish-actions.pod:4363 ../fish/guestfish-actions.pod:4386
20471 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
20475 #: ../fish/guestfish-actions.pod:430
20480 #: ../fish/guestfish-actions.pod:432
20483 " base64-out filename (base64file|-)\n"
20488 #: ../fish/guestfish-actions.pod:439
20489 msgid "blockdev-flushbufs"
20493 #: ../fish/guestfish-actions.pod:441
20496 " blockdev-flushbufs device\n"
20501 #: ../fish/guestfish-actions.pod:448
20502 msgid "blockdev-getbsz"
20506 #: ../fish/guestfish-actions.pod:450
20509 " blockdev-getbsz device\n"
20514 #: ../fish/guestfish-actions.pod:459
20515 msgid "blockdev-getro"
20519 #: ../fish/guestfish-actions.pod:461
20522 " blockdev-getro device\n"
20527 #: ../fish/guestfish-actions.pod:468
20528 msgid "blockdev-getsize64"
20532 #: ../fish/guestfish-actions.pod:470
20535 " blockdev-getsize64 device\n"
20540 #: ../fish/guestfish-actions.pod:474
20541 msgid "See also L</blockdev-getsz>."
20545 #: ../fish/guestfish-actions.pod:478
20546 msgid "blockdev-getss"
20550 #: ../fish/guestfish-actions.pod:480
20553 " blockdev-getss device\n"
20558 #: ../fish/guestfish-actions.pod:485
20559 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
20563 #: ../fish/guestfish-actions.pod:490
20564 msgid "blockdev-getsz"
20568 #: ../fish/guestfish-actions.pod:492
20571 " blockdev-getsz device\n"
20576 #: ../fish/guestfish-actions.pod:497
20578 "See also L</blockdev-getss> for the real sector size of the device, and "
20579 "L</blockdev-getsize64> for the more useful I<size in bytes>."
20583 #: ../fish/guestfish-actions.pod:503
20584 msgid "blockdev-rereadpt"
20588 #: ../fish/guestfish-actions.pod:505
20591 " blockdev-rereadpt device\n"
20596 #: ../fish/guestfish-actions.pod:511
20597 msgid "blockdev-setbsz"
20601 #: ../fish/guestfish-actions.pod:513
20604 " blockdev-setbsz device blocksize\n"
20609 #: ../fish/guestfish-actions.pod:522
20610 msgid "blockdev-setro"
20614 #: ../fish/guestfish-actions.pod:524
20617 " blockdev-setro device\n"
20622 #: ../fish/guestfish-actions.pod:530
20623 msgid "blockdev-setrw"
20627 #: ../fish/guestfish-actions.pod:532
20630 " blockdev-setrw device\n"
20635 #: ../fish/guestfish-actions.pod:538
20636 msgid "case-sensitive-path"
20640 #: ../fish/guestfish-actions.pod:540
20643 " case-sensitive-path path\n"
20648 #: ../fish/guestfish-actions.pod:564
20650 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
20651 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
20652 "how the directories were originally created under Windows)."
20656 #: ../fish/guestfish-actions.pod:572
20657 msgid "See also L</realpath>."
20661 #: ../fish/guestfish-actions.pod:574
20666 #: ../fish/guestfish-actions.pod:576
20674 #: ../fish/guestfish-actions.pod:580
20676 "Note that this function cannot correctly handle binary files (specifically, "
20677 "files containing C<\\0> character which is treated as end of string). For "
20678 "those you need to use the L</read-file> or L</download> functions which have "
20679 "a more complex interface."
20683 #: ../fish/guestfish-actions.pod:588
20688 #: ../fish/guestfish-actions.pod:590
20691 " checksum csumtype path\n"
20696 #: ../fish/guestfish-actions.pod:633
20697 msgid "To get the checksum for a device, use L</checksum-device>."
20701 #: ../fish/guestfish-actions.pod:635
20702 msgid "To get the checksums for many files, use L</checksums-out>."
20706 #: ../fish/guestfish-actions.pod:637
20707 msgid "checksum-device"
20711 #: ../fish/guestfish-actions.pod:639
20714 " checksum-device csumtype device\n"
20719 #: ../fish/guestfish-actions.pod:641
20721 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20722 "device named C<device>. For the types of checksums supported see the "
20723 "L</checksum> command."
20727 #: ../fish/guestfish-actions.pod:645
20728 msgid "checksums-out"
20732 #: ../fish/guestfish-actions.pod:647
20735 " checksums-out csumtype directory (sumsfile|-)\n"
20740 #: ../fish/guestfish-actions.pod:663
20745 #: ../fish/guestfish-actions.pod:665
20748 " chmod mode path\n"
20753 #: ../fish/guestfish-actions.pod:676
20758 #: ../fish/guestfish-actions.pod:678
20761 " chown owner group path\n"
20766 #: ../fish/guestfish-actions.pod:686
20771 #: ../fish/guestfish-actions.pod:688
20774 " command 'arguments ...'\n"
20779 #: ../fish/guestfish-actions.pod:695
20781 "The single parameter is an argv-style list of arguments. The first element "
20782 "is the name of the program to run. Subsequent elements are parameters. The "
20783 "list must be non-empty (ie. must contain a program name). Note that the "
20784 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20788 #: ../fish/guestfish-actions.pod:723
20789 msgid "command-lines"
20793 #: ../fish/guestfish-actions.pod:725
20796 " command-lines 'arguments ...'\n"
20801 #: ../fish/guestfish-actions.pod:727
20802 msgid "This is the same as L</command>, but splits the result into a list of lines."
20806 #: ../fish/guestfish-actions.pod:730
20807 msgid "See also: L</sh-lines>"
20811 #: ../fish/guestfish-actions.pod:735
20816 #: ../fish/guestfish-actions.pod:737
20819 " config qemuparam qemuvalue\n"
20824 #: ../fish/guestfish-actions.pod:748
20829 #: ../fish/guestfish-actions.pod:750
20832 " copy-size src dest size\n"
20837 #: ../fish/guestfish-actions.pod:758
20842 #: ../fish/guestfish-actions.pod:760
20850 #: ../fish/guestfish-actions.pod:765
20855 #: ../fish/guestfish-actions.pod:767
20863 #: ../fish/guestfish-actions.pod:772
20868 #: ../fish/guestfish-actions.pod:774
20876 #: ../fish/guestfish-actions.pod:781
20878 "If the destination is a device, it must be as large or larger than the "
20879 "source file or device, otherwise the copy will fail. This command cannot do "
20880 "partial copies (see L</copy-size>)."
20884 #: ../fish/guestfish-actions.pod:785
20889 #: ../fish/guestfish-actions.pod:787
20897 #: ../fish/guestfish-actions.pod:791 ../fish/guestfish-actions.pod:802
20899 "This command is mostly useful for interactive sessions. It is I<not> "
20900 "intended that you try to parse the output string. Use L</statvfs> from "
20905 #: ../fish/guestfish-actions.pod:795
20910 #: ../fish/guestfish-actions.pod:797
20918 #: ../fish/guestfish-actions.pod:806
20923 #: ../fish/guestfish-actions.pod:808
20931 #: ../fish/guestfish-actions.pod:814
20933 "Another way to get the same information is to enable verbose messages with "
20934 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20935 "before running the program."
20939 #: ../fish/guestfish-actions.pod:819
20944 #: ../fish/guestfish-actions.pod:821
20947 " download remotefilename (filename|-)\n"
20952 #: ../fish/guestfish-actions.pod:828
20953 msgid "See also L</upload>, L</cat>."
20957 #: ../fish/guestfish-actions.pod:832
20958 msgid "download-offset"
20962 #: ../fish/guestfish-actions.pod:834
20965 " download-offset remotefilename (filename|-) offset size\n"
20970 #: ../fish/guestfish-actions.pod:842
20972 "Note that there is no limit on the amount of data that can be downloaded "
20973 "with this call, unlike with L</pread>, and this call always reads the full "
20974 "amount unless an error occurs."
20978 #: ../fish/guestfish-actions.pod:847
20979 msgid "See also L</download>, L</pread>."
20983 #: ../fish/guestfish-actions.pod:851
20984 msgid "drop-caches"
20988 #: ../fish/guestfish-actions.pod:853
20991 " drop-caches whattodrop\n"
20996 #: ../fish/guestfish-actions.pod:865
21001 #: ../fish/guestfish-actions.pod:867
21009 #: ../fish/guestfish-actions.pod:879
21014 #: ../fish/guestfish-actions.pod:881
21017 " e2fsck-f device\n"
21022 #: ../fish/guestfish-actions.pod:887
21024 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
21025 "should use L</fsck>."
21029 #: ../fish/guestfish-actions.pod:890
21030 msgid "echo-daemon"
21034 #: ../fish/guestfish-actions.pod:892
21037 " echo-daemon 'words ...'\n"
21042 #: ../fish/guestfish-actions.pod:899
21043 msgid "See also L</ping-daemon>."
21047 #: ../fish/guestfish-actions.pod:901
21052 #: ../fish/guestfish-actions.pod:903
21055 " egrep regex path\n"
21060 #: ../fish/guestfish-actions.pod:911
21065 #: ../fish/guestfish-actions.pod:913
21068 " egrepi regex path\n"
21073 #: ../fish/guestfish-actions.pod:921
21078 #: ../fish/guestfish-actions.pod:923
21081 " equal file1 file2\n"
21086 #: ../fish/guestfish-actions.pod:930
21091 #: ../fish/guestfish-actions.pod:932
21099 #: ../fish/guestfish-actions.pod:937
21100 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21104 #: ../fish/guestfish-actions.pod:939
21109 #: ../fish/guestfish-actions.pod:941
21112 " fallocate path len\n"
21117 #: ../fish/guestfish-actions.pod:951
21119 "This function is deprecated. In new code, use the L</fallocate64> call "
21124 #: ../fish/guestfish-actions.pod:958
21125 msgid "fallocate64"
21129 #: ../fish/guestfish-actions.pod:960
21132 " fallocate64 path len\n"
21137 #: ../fish/guestfish-actions.pod:966
21139 "Note that this call allocates disk blocks for the file. To create a sparse "
21140 "file use L</truncate-size> instead."
21144 #: ../fish/guestfish-actions.pod:969
21146 "The deprecated call L</fallocate> does the same, but owing to an oversight "
21147 "it only allowed 30 bit lengths to be specified, effectively limiting the "
21148 "maximum size of files created through that call to 1GB."
21152 #: ../fish/guestfish-actions.pod:978
21157 #: ../fish/guestfish-actions.pod:980
21160 " fgrep pattern path\n"
21165 #: ../fish/guestfish-actions.pod:988
21170 #: ../fish/guestfish-actions.pod:990
21173 " fgrepi pattern path\n"
21178 #: ../fish/guestfish-actions.pod:998
21183 #: ../fish/guestfish-actions.pod:1000
21191 #: ../fish/guestfish-actions.pod:1016
21193 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
21198 #: ../fish/guestfish-actions.pod:1019
21199 msgid "file-architecture"
21203 #: ../fish/guestfish-actions.pod:1021
21206 " file-architecture filename\n"
21211 #: ../fish/guestfish-actions.pod:1124
21216 #: ../fish/guestfish-actions.pod:1126
21224 #: ../fish/guestfish-actions.pod:1130
21226 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
21227 "L</is-file> etc. To get the size of block devices, use "
21228 "L</blockdev-getsize64>."
21232 #: ../fish/guestfish-actions.pod:1134
21237 #: ../fish/guestfish-actions.pod:1136
21240 " fill c len path\n"
21245 #: ../fish/guestfish-actions.pod:1142
21247 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
21248 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
21249 "L</fill-pattern>."
21253 #: ../fish/guestfish-actions.pod:1147
21254 msgid "fill-pattern"
21258 #: ../fish/guestfish-actions.pod:1149
21261 " fill-pattern pattern len path\n"
21266 #: ../fish/guestfish-actions.pod:1151
21268 "This function is like L</fill> except that it creates a new file of length "
21269 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
21270 "is truncated if necessary to ensure the length of the file is exactly C<len> "
21275 #: ../fish/guestfish-actions.pod:1156
21280 #: ../fish/guestfish-actions.pod:1158
21283 " find directory\n"
21288 #: ../fish/guestfish-actions.pod:1172
21289 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
21293 #: ../fish/guestfish-actions.pod:1185
21294 msgid "See also L</find0>."
21298 #: ../fish/guestfish-actions.pod:1190
21303 #: ../fish/guestfish-actions.pod:1192
21306 " find0 directory (files|-)\n"
21311 #: ../fish/guestfish-actions.pod:1198
21312 msgid "This command works the same way as L</find> with the following exceptions:"
21316 #: ../fish/guestfish-actions.pod:1225
21317 msgid "findfs-label"
21321 #: ../fish/guestfish-actions.pod:1227
21324 " findfs-label label\n"
21329 #: ../fish/guestfish-actions.pod:1233
21330 msgid "To find the label of a filesystem, use L</vfs-label>."
21334 #: ../fish/guestfish-actions.pod:1235
21335 msgid "findfs-uuid"
21339 #: ../fish/guestfish-actions.pod:1237
21342 " findfs-uuid uuid\n"
21347 #: ../fish/guestfish-actions.pod:1243
21348 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
21352 #: ../fish/guestfish-actions.pod:1245
21357 #: ../fish/guestfish-actions.pod:1247
21360 " fsck fstype device\n"
21365 #: ../fish/guestfish-actions.pod:1277
21370 #: ../fish/guestfish-actions.pod:1279
21378 #: ../fish/guestfish-actions.pod:1286
21379 msgid "get-autosync"
21383 #: ../fish/guestfish-actions.pod:1288
21391 #: ../fish/guestfish-actions.pod:1292
21396 #: ../fish/guestfish-actions.pod:1294
21404 #: ../fish/guestfish-actions.pod:1298
21405 msgid "get-e2label"
21409 #: ../fish/guestfish-actions.pod:1300
21412 " get-e2label device\n"
21417 #: ../fish/guestfish-actions.pod:1305
21419 "This function is deprecated. In new code, use the L</vfs_label> call "
21424 #: ../fish/guestfish-actions.pod:1312
21429 #: ../fish/guestfish-actions.pod:1314
21432 " get-e2uuid device\n"
21437 #: ../fish/guestfish-actions.pod:1319
21439 "This function is deprecated. In new code, use the L</vfs_uuid> call "
21444 #: ../fish/guestfish-actions.pod:1326
21445 msgid "get-memsize"
21449 #: ../fish/guestfish-actions.pod:1328
21457 #: ../fish/guestfish-actions.pod:1333
21459 "If L</set-memsize> was not called on this handle, and if "
21460 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
21461 "value for memsize."
21465 #: ../fish/guestfish-actions.pod:1340
21466 msgid "get-network"
21470 #: ../fish/guestfish-actions.pod:1342
21478 #: ../fish/guestfish-actions.pod:1346
21483 #: ../fish/guestfish-actions.pod:1348
21491 #: ../fish/guestfish-actions.pod:1355
21496 #: ../fish/guestfish-actions.pod:1357
21501 #: ../fish/guestfish-actions.pod:1359
21509 #: ../fish/guestfish-actions.pod:1366
21514 #: ../fish/guestfish-actions.pod:1368
21522 #: ../fish/guestfish-actions.pod:1375
21523 msgid "get-recovery-proc"
21527 #: ../fish/guestfish-actions.pod:1377
21530 " get-recovery-proc\n"
21535 #: ../fish/guestfish-actions.pod:1381
21536 msgid "get-selinux"
21540 #: ../fish/guestfish-actions.pod:1383
21548 #: ../fish/guestfish-actions.pod:1385
21550 "This returns the current setting of the selinux flag which is passed to the "
21551 "appliance at boot time. See L</set-selinux>."
21555 #: ../fish/guestfish-actions.pod:1391
21560 #: ../fish/guestfish-actions.pod:1393
21568 #: ../fish/guestfish-actions.pod:1400
21573 #: ../fish/guestfish-actions.pod:1402
21581 #: ../fish/guestfish-actions.pod:1406
21586 #: ../fish/guestfish-actions.pod:1408
21594 #: ../fish/guestfish-actions.pod:1410
21596 "Return the current umask. By default the umask is C<022> unless it has been "
21597 "set by calling L</umask>."
21601 #: ../fish/guestfish-actions.pod:1413
21602 msgid "get-verbose"
21606 #: ../fish/guestfish-actions.pod:1415
21614 #: ../fish/guestfish-actions.pod:1419
21619 #: ../fish/guestfish-actions.pod:1421
21627 #: ../fish/guestfish-actions.pod:1425
21628 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
21632 #: ../fish/guestfish-actions.pod:1428
21637 #: ../fish/guestfish-actions.pod:1430
21640 " getxattr path name\n"
21645 #: ../fish/guestfish-actions.pod:1432
21647 "Get a single extended attribute from file C<path> named C<name>. This call "
21648 "follows symlinks. If you want to lookup an extended attribute for the "
21649 "symlink itself, use L</lgetxattr>."
21653 #: ../fish/guestfish-actions.pod:1436 ../fish/guestfish-actions.pod:2267
21655 "Normally it is better to get all extended attributes from a file in one go "
21656 "by calling L</getxattrs>. However some Linux filesystem implementations are "
21657 "buggy and do not provide a way to list out attributes. For these "
21658 "filesystems (notably ntfs-3g) you have to know the names of the extended "
21659 "attributes you want in advance and call this function."
21663 #: ../fish/guestfish-actions.pod:1446
21664 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
21668 #: ../fish/guestfish-actions.pod:1448
21673 #: ../fish/guestfish-actions.pod:1450
21676 " getxattrs path\n"
21681 #: ../fish/guestfish-actions.pod:1458
21682 msgid "See also: L</lgetxattrs>, L<attr(5)>."
21686 #: ../fish/guestfish-actions.pod:1460
21687 msgid "glob-expand"
21691 #: ../fish/guestfish-actions.pod:1462
21694 " glob-expand pattern\n"
21699 #: ../fish/guestfish-actions.pod:1475
21704 #: ../fish/guestfish-actions.pod:1477
21707 " grep regex path\n"
21712 #: ../fish/guestfish-actions.pod:1485
21717 #: ../fish/guestfish-actions.pod:1487
21720 " grepi regex path\n"
21725 #: ../fish/guestfish-actions.pod:1495
21726 msgid "grub-install"
21730 #: ../fish/guestfish-actions.pod:1497
21733 " grub-install root device\n"
21738 #: ../fish/guestfish-actions.pod:1513
21743 #: ../fish/guestfish-actions.pod:1515
21751 #: ../fish/guestfish-actions.pod:1523
21756 #: ../fish/guestfish-actions.pod:1525
21759 " head-n nrlines path\n"
21764 #: ../fish/guestfish-actions.pod:1538
21769 #: ../fish/guestfish-actions.pod:1540
21777 #: ../fish/guestfish-actions.pod:1548
21782 #: ../fish/guestfish-actions.pod:1550
21785 " initrd-cat initrdpath filename\n"
21790 #: ../fish/guestfish-actions.pod:1562
21791 msgid "See also L</initrd-list>."
21795 #: ../fish/guestfish-actions.pod:1567
21796 msgid "initrd-list"
21800 #: ../fish/guestfish-actions.pod:1569
21803 " initrd-list path\n"
21808 #: ../fish/guestfish-actions.pod:1581
21809 msgid "inotify-add-watch"
21813 #: ../fish/guestfish-actions.pod:1583
21816 " inotify-add-watch path mask\n"
21821 #: ../fish/guestfish-actions.pod:1595
21822 msgid "inotify-close"
21826 #: ../fish/guestfish-actions.pod:1597
21834 #: ../fish/guestfish-actions.pod:1603
21835 msgid "inotify-files"
21839 #: ../fish/guestfish-actions.pod:1605
21847 #: ../fish/guestfish-actions.pod:1607
21849 "This function is a helpful wrapper around L</inotify-read> which just "
21850 "returns a list of pathnames of objects that were touched. The returned "
21851 "pathnames are sorted and deduplicated."
21855 #: ../fish/guestfish-actions.pod:1611
21856 msgid "inotify-init"
21860 #: ../fish/guestfish-actions.pod:1613
21863 " inotify-init maxevents\n"
21868 #: ../fish/guestfish-actions.pod:1619
21870 "C<maxevents> is the maximum number of events which will be queued up between "
21871 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21872 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21873 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21874 "but records the fact that it threw them away by setting a flag "
21875 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21879 #: ../fish/guestfish-actions.pod:1629
21881 "Before any events are generated, you have to add some watches to the "
21882 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21883 "L</inotify-watch-all>."
21887 #: ../fish/guestfish-actions.pod:1635
21889 "Queued up events should be read periodically by calling L</inotify-read> (or "
21890 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21891 "If you don't read the events out often enough then you risk the internal "
21892 "queue overflowing."
21896 #: ../fish/guestfish-actions.pod:1642
21898 "The handle should be closed after use by calling L</inotify-close>. This "
21899 "also removes any watches automatically."
21903 #: ../fish/guestfish-actions.pod:1651
21904 msgid "inotify-read"
21908 #: ../fish/guestfish-actions.pod:1653
21916 #: ../fish/guestfish-actions.pod:1666
21917 msgid "inotify-rm-watch"
21921 #: ../fish/guestfish-actions.pod:1668
21924 " inotify-rm-watch wd\n"
21929 #: ../fish/guestfish-actions.pod:1670
21930 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21934 #: ../fish/guestfish-actions.pod:1673
21935 msgid "inspect-get-arch"
21939 #: ../fish/guestfish-actions.pod:1675
21942 " inspect-get-arch root\n"
21947 #: ../fish/guestfish-actions.pod:1677 ../fish/guestfish-actions.pod:1693 ../fish/guestfish-actions.pod:1767 ../fish/guestfish-actions.pod:1785 ../fish/guestfish-actions.pod:1800 ../fish/guestfish-actions.pod:1821 ../fish/guestfish-actions.pod:1836 ../fish/guestfish-actions.pod:1863 ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1909 ../fish/guestfish-actions.pod:1939 ../fish/guestfish-actions.pod:1974 ../fish/guestfish-actions.pod:1990
21949 "This function should only be called with a root device string as returned by "
21954 #: ../fish/guestfish-actions.pod:1680
21956 "This returns the architecture of the inspected operating system. The "
21957 "possible return values are listed under L</file-architecture>."
21961 #: ../fish/guestfish-actions.pod:1689
21962 msgid "inspect-get-distro"
21966 #: ../fish/guestfish-actions.pod:1691
21969 " inspect-get-distro root\n"
21974 #: ../fish/guestfish-actions.pod:1763
21975 msgid "inspect-get-filesystems"
21979 #: ../fish/guestfish-actions.pod:1765
21982 " inspect-get-filesystems root\n"
21987 #: ../fish/guestfish-actions.pod:1778
21989 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21990 "L</inspect-get-mountpoints>."
21994 #: ../fish/guestfish-actions.pod:1781
21995 msgid "inspect-get-hostname"
21999 #: ../fish/guestfish-actions.pod:1783
22002 " inspect-get-hostname root\n"
22007 #: ../fish/guestfish-actions.pod:1796
22008 msgid "inspect-get-major-version"
22012 #: ../fish/guestfish-actions.pod:1798
22015 " inspect-get-major-version root\n"
22020 #: ../fish/guestfish-actions.pod:1817
22021 msgid "inspect-get-minor-version"
22025 #: ../fish/guestfish-actions.pod:1819
22028 " inspect-get-minor-version root\n"
22033 #: ../fish/guestfish-actions.pod:1829
22035 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22036 "L</inspect-get-major-version>."
22040 #: ../fish/guestfish-actions.pod:1832
22041 msgid "inspect-get-mountpoints"
22045 #: ../fish/guestfish-actions.pod:1834
22048 " inspect-get-mountpoints root\n"
22053 #: ../fish/guestfish-actions.pod:1856
22055 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
22056 "L</inspect-get-filesystems>."
22060 #: ../fish/guestfish-actions.pod:1859
22061 msgid "inspect-get-package-format"
22065 #: ../fish/guestfish-actions.pod:1861
22068 " inspect-get-package-format root\n"
22073 #: ../fish/guestfish-actions.pod:1866
22075 "This function and L</inspect-get-package-management> return the package "
22076 "format and package management tool used by the inspected operating system. "
22077 "For example for Fedora these functions would return C<rpm> (package format) "
22078 "and C<yum> (package management)."
22082 #: ../fish/guestfish-actions.pod:1881
22083 msgid "inspect-get-package-management"
22087 #: ../fish/guestfish-actions.pod:1883
22090 " inspect-get-package-management root\n"
22095 #: ../fish/guestfish-actions.pod:1888
22097 "L</inspect-get-package-format> and this function return the package format "
22098 "and package management tool used by the inspected operating system. For "
22099 "example for Fedora these functions would return C<rpm> (package format) and "
22100 "C<yum> (package management)."
22104 #: ../fish/guestfish-actions.pod:1905
22105 msgid "inspect-get-product-name"
22109 #: ../fish/guestfish-actions.pod:1907
22112 " inspect-get-product-name root\n"
22117 #: ../fish/guestfish-actions.pod:1922
22118 msgid "inspect-get-roots"
22122 #: ../fish/guestfish-actions.pod:1924
22125 " inspect-get-roots\n"
22130 #: ../fish/guestfish-actions.pod:1926
22132 "This function is a convenient way to get the list of root devices, as "
22133 "returned from a previous call to L</inspect-os>, but without redoing the "
22134 "whole inspection process."
22138 #: ../fish/guestfish-actions.pod:1930
22140 "This returns an empty list if either no root devices were found or the "
22141 "caller has not called L</inspect-os>."
22145 #: ../fish/guestfish-actions.pod:1935
22146 msgid "inspect-get-type"
22150 #: ../fish/guestfish-actions.pod:1937
22153 " inspect-get-type root\n"
22158 #: ../fish/guestfish-actions.pod:1970
22159 msgid "inspect-get-windows-systemroot"
22163 #: ../fish/guestfish-actions.pod:1972
22166 " inspect-get-windows-systemroot root\n"
22171 #: ../fish/guestfish-actions.pod:1986
22172 msgid "inspect-list-applications"
22176 #: ../fish/guestfish-actions.pod:1988
22179 " inspect-list-applications root\n"
22184 #: ../fish/guestfish-actions.pod:1995
22186 "I<Note:> This call works differently from other parts of the inspection "
22187 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
22188 "then mount up the disks, before calling this. Listing applications is a "
22189 "significantly more difficult operation which requires access to the full "
22190 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
22191 "are just returning data cached in the libguestfs handle, this call actually "
22192 "reads parts of the mounted filesystems during the call."
22196 #: ../fish/guestfish-actions.pod:2085
22201 #: ../fish/guestfish-actions.pod:2087
22209 #: ../fish/guestfish-actions.pod:2102
22211 "You can pass the root string(s) returned to other L</inspect-get-*> "
22212 "functions in order to query further information about each operating system, "
22213 "such as the name and version."
22217 #: ../fish/guestfish-actions.pod:2107
22219 "This function uses other libguestfs features such as L</mount-ro> and "
22220 "L</umount-all> in order to mount and unmount filesystems and look at the "
22221 "contents. This should be called with no disks currently mounted. The "
22222 "function may also use Augeas, so any existing Augeas handle will be closed."
22226 #: ../fish/guestfish-actions.pod:2119 ../fish/guestfish-actions.pod:2295 ../fish/guestfish-actions.pod:2341
22227 msgid "See also L</list-filesystems>."
22231 #: ../fish/guestfish-actions.pod:2121
22232 msgid "is-blockdev"
22236 #: ../fish/guestfish-actions.pod:2123
22239 " is-blockdev path\n"
22244 #: ../fish/guestfish-actions.pod:2128 ../fish/guestfish-actions.pod:2146 ../fish/guestfish-actions.pod:2165 ../fish/guestfish-actions.pod:2174 ../fish/guestfish-actions.pod:2184 ../fish/guestfish-actions.pod:2218 ../fish/guestfish-actions.pod:2227
22245 msgid "See also L</stat>."
22249 #: ../fish/guestfish-actions.pod:2130
22254 #: ../fish/guestfish-actions.pod:2132
22262 #: ../fish/guestfish-actions.pod:2139
22267 #: ../fish/guestfish-actions.pod:2141
22270 " is-chardev path\n"
22275 #: ../fish/guestfish-actions.pod:2148
22280 #: ../fish/guestfish-actions.pod:2150
22288 #: ../fish/guestfish-actions.pod:2157
22293 #: ../fish/guestfish-actions.pod:2159
22301 #: ../fish/guestfish-actions.pod:2167
22306 #: ../fish/guestfish-actions.pod:2169
22314 #: ../fish/guestfish-actions.pod:2176
22319 #: ../fish/guestfish-actions.pod:2178
22327 #: ../fish/guestfish-actions.pod:2186
22328 msgid "is-launching"
22332 #: ../fish/guestfish-actions.pod:2188
22340 #: ../fish/guestfish-actions.pod:2195
22345 #: ../fish/guestfish-actions.pod:2197
22353 #: ../fish/guestfish-actions.pod:2202
22358 #: ../fish/guestfish-actions.pod:2204
22366 #: ../fish/guestfish-actions.pod:2211
22371 #: ../fish/guestfish-actions.pod:2213
22374 " is-socket path\n"
22379 #: ../fish/guestfish-actions.pod:2220
22384 #: ../fish/guestfish-actions.pod:2222
22387 " is-symlink path\n"
22392 #: ../fish/guestfish-actions.pod:2229
22393 msgid "kill-subprocess"
22397 #: ../fish/guestfish-actions.pod:2231
22400 " kill-subprocess\n"
22405 #: ../fish/guestfish-actions.pod:2235
22410 #: ../fish/guestfish-actions.pod:2237
22415 #: ../fish/guestfish-actions.pod:2239
22423 #: ../fish/guestfish-actions.pod:2247
22428 #: ../fish/guestfish-actions.pod:2249
22431 " lchown owner group path\n"
22436 #: ../fish/guestfish-actions.pod:2251
22438 "Change the file owner to C<owner> and group to C<group>. This is like "
22439 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
22444 #: ../fish/guestfish-actions.pod:2259
22449 #: ../fish/guestfish-actions.pod:2261
22452 " lgetxattr path name\n"
22457 #: ../fish/guestfish-actions.pod:2277
22458 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
22462 #: ../fish/guestfish-actions.pod:2279
22467 #: ../fish/guestfish-actions.pod:2281
22470 " lgetxattrs path\n"
22475 #: ../fish/guestfish-actions.pod:2283
22477 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
22478 "it returns the extended attributes of the link itself."
22482 #: ../fish/guestfish-actions.pod:2287
22483 msgid "list-devices"
22487 #: ../fish/guestfish-actions.pod:2289
22495 #: ../fish/guestfish-actions.pod:2297
22496 msgid "list-filesystems"
22500 #: ../fish/guestfish-actions.pod:2299
22503 " list-filesystems\n"
22508 #: ../fish/guestfish-actions.pod:2318
22510 "This command runs other libguestfs commands, which might include L</mount> "
22511 "and L</umount>, and therefore you should use this soon after launch and only "
22512 "when nothing is mounted."
22516 #: ../fish/guestfish-actions.pod:2322
22518 "Not all of the filesystems returned will be mountable. In particular, swap "
22519 "partitions are returned in the list. Also this command does not check that "
22520 "each filesystem found is valid and mountable, and some filesystems might be "
22521 "mountable but require special options. Filesystems may not all belong to a "
22522 "single logical operating system (use L</inspect-os> to look for OSes)."
22526 #: ../fish/guestfish-actions.pod:2330
22527 msgid "list-partitions"
22531 #: ../fish/guestfish-actions.pod:2332
22534 " list-partitions\n"
22539 #: ../fish/guestfish-actions.pod:2338
22541 "This does not return logical volumes. For that you will need to call "
22546 #: ../fish/guestfish-actions.pod:2343
22551 #: ../fish/guestfish-actions.pod:2345
22559 #: ../fish/guestfish-actions.pod:2353
22564 #: ../fish/guestfish-actions.pod:2355
22567 " ln target linkname\n"
22572 #: ../fish/guestfish-actions.pod:2359
22577 #: ../fish/guestfish-actions.pod:2361
22580 " ln-f target linkname\n"
22585 #: ../fish/guestfish-actions.pod:2366
22590 #: ../fish/guestfish-actions.pod:2368
22593 " ln-s target linkname\n"
22598 #: ../fish/guestfish-actions.pod:2372
22603 #: ../fish/guestfish-actions.pod:2374
22606 " ln-sf target linkname\n"
22611 #: ../fish/guestfish-actions.pod:2379
22612 msgid "lremovexattr"
22616 #: ../fish/guestfish-actions.pod:2381
22619 " lremovexattr xattr path\n"
22624 #: ../fish/guestfish-actions.pod:2383
22626 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
22627 "it removes an extended attribute of the link itself."
22631 #: ../fish/guestfish-actions.pod:2387
22636 #: ../fish/guestfish-actions.pod:2389
22644 #: ../fish/guestfish-actions.pod:2395
22646 "This command is mostly useful for interactive sessions. Programs should "
22647 "probably use L</readdir> instead."
22651 #: ../fish/guestfish-actions.pod:2398
22656 #: ../fish/guestfish-actions.pod:2400
22659 " lsetxattr xattr val vallen path\n"
22664 #: ../fish/guestfish-actions.pod:2402
22666 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
22667 "sets an extended attribute of the link itself."
22671 #: ../fish/guestfish-actions.pod:2406
22676 #: ../fish/guestfish-actions.pod:2408
22684 #: ../fish/guestfish-actions.pod:2412
22686 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
22687 "the link is stat-ed, not the file it refers to."
22691 #: ../fish/guestfish-actions.pod:2418
22696 #: ../fish/guestfish-actions.pod:2420
22699 " lstatlist path 'names ...'\n"
22704 #: ../fish/guestfish-actions.pod:2422
22706 "This call allows you to perform the L</lstat> operation on multiple files, "
22707 "where all files are in the directory C<path>. C<names> is the list of files "
22708 "from this directory."
22712 #: ../fish/guestfish-actions.pod:2431
22714 "This call is intended for programs that want to efficiently list a directory "
22715 "contents without making many round-trips. See also L</lxattrlist> for a "
22716 "similarly efficient call for getting extended attributes. Very long "
22717 "directory listings might cause the protocol message size to be exceeded, "
22718 "causing this call to fail. The caller must split up such requests into "
22719 "smaller groups of names."
22723 #: ../fish/guestfish-actions.pod:2439
22724 msgid "luks-add-key"
22728 #: ../fish/guestfish-actions.pod:2441
22731 " luks-add-key device keyslot\n"
22736 #: ../fish/guestfish-actions.pod:2448
22738 "Note that if C<keyslot> already contains a key, then this command will "
22739 "fail. You have to use L</luks-kill-slot> first to remove that key."
22743 #: ../fish/guestfish-actions.pod:2452 ../fish/guestfish-actions.pod:2474 ../fish/guestfish-actions.pod:2487 ../fish/guestfish-actions.pod:2501 ../fish/guestfish-actions.pod:2524 ../fish/guestfish-actions.pod:2534
22745 "This command has one or more key or passphrase parameters. Guestfish will "
22746 "prompt for these separately."
22750 #: ../fish/guestfish-actions.pod:2455
22755 #: ../fish/guestfish-actions.pod:2457
22758 " luks-close device\n"
22763 #: ../fish/guestfish-actions.pod:2459
22765 "This closes a LUKS device that was created earlier by L</luks-open> or "
22766 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
22767 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
22768 "underlying block device."
22772 #: ../fish/guestfish-actions.pod:2465
22773 msgid "luks-format"
22777 #: ../fish/guestfish-actions.pod:2467
22780 " luks-format device keyslot\n"
22785 #: ../fish/guestfish-actions.pod:2480
22786 msgid "luks-format-cipher"
22790 #: ../fish/guestfish-actions.pod:2482
22793 " luks-format-cipher device keyslot cipher\n"
22798 #: ../fish/guestfish-actions.pod:2484
22800 "This command is the same as L</luks-format> but it also allows you to set "
22801 "the C<cipher> used."
22805 #: ../fish/guestfish-actions.pod:2493
22806 msgid "luks-kill-slot"
22810 #: ../fish/guestfish-actions.pod:2495
22813 " luks-kill-slot device keyslot\n"
22818 #: ../fish/guestfish-actions.pod:2504
22823 #: ../fish/guestfish-actions.pod:2506
22826 " luks-open device mapname\n"
22831 #: ../fish/guestfish-actions.pod:2520
22833 "If this block device contains LVM volume groups, then calling L</vgscan> "
22834 "followed by L</vg-activate-all> will make them visible."
22838 #: ../fish/guestfish-actions.pod:2527
22839 msgid "luks-open-ro"
22843 #: ../fish/guestfish-actions.pod:2529
22846 " luks-open-ro device mapname\n"
22851 #: ../fish/guestfish-actions.pod:2531
22853 "This is the same as L</luks-open> except that a read-only mapping is "
22858 #: ../fish/guestfish-actions.pod:2537
22863 #: ../fish/guestfish-actions.pod:2539
22866 " lvcreate logvol volgroup mbytes\n"
22871 #: ../fish/guestfish-actions.pod:2544
22872 msgid "lvm-canonical-lv-name"
22876 #: ../fish/guestfish-actions.pod:2546
22879 " lvm-canonical-lv-name lvname\n"
22884 #: ../fish/guestfish-actions.pod:2555
22885 msgid "See also L</is-lv>."
22889 #: ../fish/guestfish-actions.pod:2557
22890 msgid "lvm-clear-filter"
22894 #: ../fish/guestfish-actions.pod:2559
22897 " lvm-clear-filter\n"
22902 #: ../fish/guestfish-actions.pod:2561
22904 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22909 #: ../fish/guestfish-actions.pod:2567
22910 msgid "lvm-remove-all"
22914 #: ../fish/guestfish-actions.pod:2569
22917 " lvm-remove-all\n"
22922 #: ../fish/guestfish-actions.pod:2577
22923 msgid "lvm-set-filter"
22927 #: ../fish/guestfish-actions.pod:2579
22930 " lvm-set-filter 'devices ...'\n"
22935 #: ../fish/guestfish-actions.pod:2604
22940 #: ../fish/guestfish-actions.pod:2606
22943 " lvremove device\n"
22948 #: ../fish/guestfish-actions.pod:2614
22953 #: ../fish/guestfish-actions.pod:2616
22956 " lvrename logvol newlogvol\n"
22961 #: ../fish/guestfish-actions.pod:2620
22966 #: ../fish/guestfish-actions.pod:2622
22969 " lvresize device mbytes\n"
22974 #: ../fish/guestfish-actions.pod:2628
22975 msgid "lvresize-free"
22979 #: ../fish/guestfish-actions.pod:2630
22982 " lvresize-free lv percent\n"
22987 #: ../fish/guestfish-actions.pod:2638
22992 #: ../fish/guestfish-actions.pod:2640
23000 #: ../fish/guestfish-actions.pod:2648
23001 msgid "See also L</lvs-full>, L</list-filesystems>."
23005 #: ../fish/guestfish-actions.pod:2650
23010 #: ../fish/guestfish-actions.pod:2652
23018 #: ../fish/guestfish-actions.pod:2657
23023 #: ../fish/guestfish-actions.pod:2659
23031 #: ../fish/guestfish-actions.pod:2663
23036 #: ../fish/guestfish-actions.pod:2665
23039 " lxattrlist path 'names ...'\n"
23044 #: ../fish/guestfish-actions.pod:2681
23046 "This call is intended for programs that want to efficiently list a directory "
23047 "contents without making many round-trips. See also L</lstatlist> for a "
23048 "similarly efficient call for getting standard stats. Very long directory "
23049 "listings might cause the protocol message size to be exceeded, causing this "
23050 "call to fail. The caller must split up such requests into smaller groups of "
23055 #: ../fish/guestfish-actions.pod:2689
23060 #: ../fish/guestfish-actions.pod:2691
23068 #: ../fish/guestfish-actions.pod:2695
23073 #: ../fish/guestfish-actions.pod:2697
23076 " mkdir-mode path mode\n"
23081 #: ../fish/guestfish-actions.pod:2706
23082 msgid "See also L</mkdir>, L</umask>"
23086 #: ../fish/guestfish-actions.pod:2708
23091 #: ../fish/guestfish-actions.pod:2710
23099 #: ../fish/guestfish-actions.pod:2715
23104 #: ../fish/guestfish-actions.pod:2717
23107 " mkdtemp template\n"
23112 #: ../fish/guestfish-actions.pod:2738
23117 #: ../fish/guestfish-actions.pod:2740
23120 " mke2fs-J fstype blocksize device journal\n"
23125 #: ../fish/guestfish-actions.pod:2748
23126 msgid "See also L</mke2journal>."
23130 #: ../fish/guestfish-actions.pod:2750
23135 #: ../fish/guestfish-actions.pod:2752
23138 " mke2fs-JL fstype blocksize device label\n"
23143 #: ../fish/guestfish-actions.pod:2757
23144 msgid "See also L</mke2journal-L>."
23148 #: ../fish/guestfish-actions.pod:2759
23153 #: ../fish/guestfish-actions.pod:2761
23156 " mke2fs-JU fstype blocksize device uuid\n"
23161 #: ../fish/guestfish-actions.pod:2766
23162 msgid "See also L</mke2journal-U>."
23166 #: ../fish/guestfish-actions.pod:2768
23167 msgid "mke2journal"
23171 #: ../fish/guestfish-actions.pod:2770
23174 " mke2journal blocksize device\n"
23179 #: ../fish/guestfish-actions.pod:2777
23180 msgid "mke2journal-L"
23184 #: ../fish/guestfish-actions.pod:2779
23187 " mke2journal-L blocksize label device\n"
23192 #: ../fish/guestfish-actions.pod:2783
23193 msgid "mke2journal-U"
23197 #: ../fish/guestfish-actions.pod:2785
23200 " mke2journal-U blocksize uuid device\n"
23205 #: ../fish/guestfish-actions.pod:2789
23210 #: ../fish/guestfish-actions.pod:2791
23213 " mkfifo mode path\n"
23218 #: ../fish/guestfish-actions.pod:2793
23220 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
23221 "is just a convenient wrapper around L</mknod>."
23225 #: ../fish/guestfish-actions.pod:2799
23230 #: ../fish/guestfish-actions.pod:2801
23233 " mkfs fstype device\n"
23238 #: ../fish/guestfish-actions.pod:2807
23243 #: ../fish/guestfish-actions.pod:2809
23246 " mkfs-b fstype blocksize device\n"
23251 #: ../fish/guestfish-actions.pod:2811
23253 "This call is similar to L</mkfs>, but it allows you to control the block "
23254 "size of the resulting filesystem. Supported block sizes depend on the "
23255 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
23259 #: ../fish/guestfish-actions.pod:2819
23261 "This function is deprecated. In new code, use the L</mkfs_opts> call "
23266 #: ../fish/guestfish-actions.pod:2826
23271 #: ../fish/guestfish-actions.pod:2828
23274 " mkfs-opts fstype device [blocksize:..]\n"
23279 #: ../fish/guestfish-actions.pod:2852
23280 msgid "mkmountpoint"
23284 #: ../fish/guestfish-actions.pod:2854
23287 " mkmountpoint exemptpath\n"
23292 #: ../fish/guestfish-actions.pod:2856
23294 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
23295 "to create extra mountpoints before mounting the first filesystem."
23299 #: ../fish/guestfish-actions.pod:2880
23301 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
23302 "unexpected errors if you try to mix these calls. It is safest to manually "
23303 "unmount filesystems and remove mountpoints after use."
23307 #: ../fish/guestfish-actions.pod:2884
23309 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
23310 "for this to work for manual mountpoints, you must ensure that the innermost "
23311 "mountpoints have the longest pathnames, as in the example code above."
23315 #: ../fish/guestfish-actions.pod:2891
23317 "Autosync [see L</set-autosync>, this is set by default on handles] means "
23318 "that L</umount-all> is called when the handle is closed which can also "
23319 "trigger these issues."
23323 #: ../fish/guestfish-actions.pod:2895
23328 #: ../fish/guestfish-actions.pod:2897
23331 " mknod mode devmajor devminor path\n"
23336 #: ../fish/guestfish-actions.pod:2907
23338 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
23339 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
23340 "regular file). These constants are available in the standard Linux header "
23341 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
23342 "wrappers around this command which bitwise OR in the appropriate constant "
23347 #: ../fish/guestfish-actions.pod:2917
23352 #: ../fish/guestfish-actions.pod:2919
23355 " mknod-b mode devmajor devminor path\n"
23360 #: ../fish/guestfish-actions.pod:2921
23362 "This call creates a block device node called C<path> with mode C<mode> and "
23363 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23364 "wrapper around L</mknod>."
23368 #: ../fish/guestfish-actions.pod:2927
23373 #: ../fish/guestfish-actions.pod:2929
23376 " mknod-c mode devmajor devminor path\n"
23381 #: ../fish/guestfish-actions.pod:2931
23383 "This call creates a char device node called C<path> with mode C<mode> and "
23384 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23385 "wrapper around L</mknod>."
23389 #: ../fish/guestfish-actions.pod:2937
23394 #: ../fish/guestfish-actions.pod:2939
23402 #: ../fish/guestfish-actions.pod:2943
23407 #: ../fish/guestfish-actions.pod:2945
23410 " mkswap-L label device\n"
23415 #: ../fish/guestfish-actions.pod:2953
23420 #: ../fish/guestfish-actions.pod:2955
23423 " mkswap-U uuid device\n"
23428 #: ../fish/guestfish-actions.pod:2959
23429 msgid "mkswap-file"
23433 #: ../fish/guestfish-actions.pod:2961
23436 " mkswap-file path\n"
23441 #: ../fish/guestfish-actions.pod:2965
23443 "This command just writes a swap file signature to an existing file. To "
23444 "create the file itself, use something like L</fallocate>."
23448 #: ../fish/guestfish-actions.pod:2968
23453 #: ../fish/guestfish-actions.pod:2970
23456 " modprobe modulename\n"
23461 #: ../fish/guestfish-actions.pod:2977
23466 #: ../fish/guestfish-actions.pod:2979
23469 " mount device mountpoint\n"
23474 #: ../fish/guestfish-actions.pod:2995
23476 "B<Important note:> When you use this call, the filesystem options C<sync> "
23477 "and C<noatime> are set implicitly. This was originally done because we "
23478 "thought it would improve reliability, but it turns out that I<-o sync> has a "
23479 "very large negative performance impact and negligible effect on "
23480 "reliability. Therefore we recommend that you avoid using L</mount> in any "
23481 "code that needs performance, and instead use L</mount-options> (use an empty "
23482 "string for the first parameter if you don't want any options)."
23486 #: ../fish/guestfish-actions.pod:3005
23491 #: ../fish/guestfish-actions.pod:3007
23494 " mount-loop file mountpoint\n"
23499 #: ../fish/guestfish-actions.pod:3013
23500 msgid "mount-options"
23504 #: ../fish/guestfish-actions.pod:3015
23507 " mount-options options device mountpoint\n"
23512 #: ../fish/guestfish-actions.pod:3017
23514 "This is the same as the L</mount> command, but it allows you to set the "
23515 "mount options as for the L<mount(8)> I<-o> flag."
23519 #: ../fish/guestfish-actions.pod:3025
23524 #: ../fish/guestfish-actions.pod:3027
23527 " mount-ro device mountpoint\n"
23532 #: ../fish/guestfish-actions.pod:3029
23534 "This is the same as the L</mount> command, but it mounts the filesystem with "
23535 "the read-only (I<-o ro>) flag."
23539 #: ../fish/guestfish-actions.pod:3032
23544 #: ../fish/guestfish-actions.pod:3034
23547 " mount-vfs options vfstype device mountpoint\n"
23552 #: ../fish/guestfish-actions.pod:3036
23554 "This is the same as the L</mount> command, but it allows you to set both the "
23555 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
23559 #: ../fish/guestfish-actions.pod:3040
23560 msgid "mountpoints"
23564 #: ../fish/guestfish-actions.pod:3042
23572 #: ../fish/guestfish-actions.pod:3044
23574 "This call is similar to L</mounts>. That call returns a list of devices. "
23575 "This one returns a hash table (map) of device name to directory where the "
23576 "device is mounted."
23580 #: ../fish/guestfish-actions.pod:3048
23585 #: ../fish/guestfish-actions.pod:3050
23593 #: ../fish/guestfish-actions.pod:3057
23594 msgid "See also: L</mountpoints>"
23598 #: ../fish/guestfish-actions.pod:3059
23603 #: ../fish/guestfish-actions.pod:3061
23611 #: ../fish/guestfish-actions.pod:3066
23612 msgid "ntfs-3g-probe"
23616 #: ../fish/guestfish-actions.pod:3068
23619 " ntfs-3g-probe true|false device\n"
23624 #: ../fish/guestfish-actions.pod:3082
23629 #: ../fish/guestfish-actions.pod:3084
23632 " ntfsresize device\n"
23637 #: ../fish/guestfish-actions.pod:3099
23638 msgid "ntfsresize-size"
23642 #: ../fish/guestfish-actions.pod:3101
23645 " ntfsresize-size device size\n"
23650 #: ../fish/guestfish-actions.pod:3103
23652 "This command is the same as L</ntfsresize> except that it allows you to "
23653 "specify the new size (in bytes) explicitly."
23657 #: ../fish/guestfish-actions.pod:3106
23662 #: ../fish/guestfish-actions.pod:3108
23665 " part-add device prlogex startsect endsect\n"
23670 #: ../fish/guestfish-actions.pod:3110
23672 "This command adds a partition to C<device>. If there is no partition table "
23673 "on the device, call L</part-init> first."
23677 #: ../fish/guestfish-actions.pod:3122
23679 "Creating a partition which covers the whole disk is not so easy. Use "
23680 "L</part-disk> to do that."
23684 #: ../fish/guestfish-actions.pod:3125
23689 #: ../fish/guestfish-actions.pod:3127
23692 " part-del device partnum\n"
23697 #: ../fish/guestfish-actions.pod:3135
23702 #: ../fish/guestfish-actions.pod:3137
23705 " part-disk device parttype\n"
23710 #: ../fish/guestfish-actions.pod:3139
23712 "This command is simply a combination of L</part-init> followed by "
23713 "L</part-add> to create a single primary partition covering the whole disk."
23717 #: ../fish/guestfish-actions.pod:3143
23719 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
23720 "possible values are described in L</part-init>."
23724 #: ../fish/guestfish-actions.pod:3149
23725 msgid "part-get-bootable"
23729 #: ../fish/guestfish-actions.pod:3151
23732 " part-get-bootable device partnum\n"
23737 #: ../fish/guestfish-actions.pod:3156
23738 msgid "See also L</part-set-bootable>."
23742 #: ../fish/guestfish-actions.pod:3158
23743 msgid "part-get-mbr-id"
23747 #: ../fish/guestfish-actions.pod:3160
23750 " part-get-mbr-id device partnum\n"
23755 #: ../fish/guestfish-actions.pod:3165 ../fish/guestfish-actions.pod:3303
23757 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
23758 "undefined results for other partition table types (see "
23759 "L</part-get-parttype>)."
23763 #: ../fish/guestfish-actions.pod:3169
23764 msgid "part-get-parttype"
23768 #: ../fish/guestfish-actions.pod:3171
23771 " part-get-parttype device\n"
23776 #: ../fish/guestfish-actions.pod:3176
23778 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
23779 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
23780 "possible, although unusual. See L</part-init> for a full list."
23784 #: ../fish/guestfish-actions.pod:3181
23789 #: ../fish/guestfish-actions.pod:3183
23792 " part-init device parttype\n"
23797 #: ../fish/guestfish-actions.pod:3189
23799 "Initially there are no partitions. Following this, you should call "
23800 "L</part-add> for each partition required."
23804 #: ../fish/guestfish-actions.pod:3252
23809 #: ../fish/guestfish-actions.pod:3254
23812 " part-list device\n"
23817 #: ../fish/guestfish-actions.pod:3269
23819 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23820 "the device's sector size, see L</blockdev-getss>."
23824 #: ../fish/guestfish-actions.pod:3282
23825 msgid "part-set-bootable"
23829 #: ../fish/guestfish-actions.pod:3284
23832 " part-set-bootable device partnum true|false\n"
23837 #: ../fish/guestfish-actions.pod:3293
23838 msgid "part-set-mbr-id"
23842 #: ../fish/guestfish-actions.pod:3295
23845 " part-set-mbr-id device partnum idbyte\n"
23850 #: ../fish/guestfish-actions.pod:3307
23851 msgid "part-set-name"
23855 #: ../fish/guestfish-actions.pod:3309
23858 " part-set-name device partnum name\n"
23863 #: ../fish/guestfish-actions.pod:3317
23864 msgid "part-to-dev"
23868 #: ../fish/guestfish-actions.pod:3319
23871 " part-to-dev partition\n"
23876 #: ../fish/guestfish-actions.pod:3325
23878 "The named partition must exist, for example as a string returned from "
23879 "L</list-partitions>."
23883 #: ../fish/guestfish-actions.pod:3328
23884 msgid "ping-daemon"
23888 #: ../fish/guestfish-actions.pod:3330
23896 #: ../fish/guestfish-actions.pod:3337
23901 #: ../fish/guestfish-actions.pod:3339
23904 " pread path count offset\n"
23909 #: ../fish/guestfish-actions.pod:3347
23910 msgid "See also L</pwrite>, L</pread-device>."
23914 #: ../fish/guestfish-actions.pod:3352
23915 msgid "pread-device"
23919 #: ../fish/guestfish-actions.pod:3354
23922 " pread-device device count offset\n"
23927 #: ../fish/guestfish-actions.pod:3362
23928 msgid "See also L</pread>."
23932 #: ../fish/guestfish-actions.pod:3367
23937 #: ../fish/guestfish-actions.pod:3369
23940 " pvcreate device\n"
23945 #: ../fish/guestfish-actions.pod:3375
23950 #: ../fish/guestfish-actions.pod:3377
23953 " pvremove device\n"
23958 #: ../fish/guestfish-actions.pod:3386
23963 #: ../fish/guestfish-actions.pod:3388
23966 " pvresize device\n"
23971 #: ../fish/guestfish-actions.pod:3393
23972 msgid "pvresize-size"
23976 #: ../fish/guestfish-actions.pod:3395
23979 " pvresize-size device size\n"
23984 #: ../fish/guestfish-actions.pod:3397
23986 "This command is the same as L</pvresize> except that it allows you to "
23987 "specify the new size (in bytes) explicitly."
23991 #: ../fish/guestfish-actions.pod:3400
23996 #: ../fish/guestfish-actions.pod:3402
24004 #: ../fish/guestfish-actions.pod:3410
24005 msgid "See also L</pvs-full>."
24009 #: ../fish/guestfish-actions.pod:3412
24014 #: ../fish/guestfish-actions.pod:3414
24022 #: ../fish/guestfish-actions.pod:3419
24027 #: ../fish/guestfish-actions.pod:3421
24035 #: ../fish/guestfish-actions.pod:3425
24040 #: ../fish/guestfish-actions.pod:3427
24043 " pwrite path content offset\n"
24048 #: ../fish/guestfish-actions.pod:3438
24049 msgid "See also L</pread>, L</pwrite-device>."
24053 #: ../fish/guestfish-actions.pod:3443
24054 msgid "pwrite-device"
24058 #: ../fish/guestfish-actions.pod:3445
24061 " pwrite-device device content offset\n"
24066 #: ../fish/guestfish-actions.pod:3455
24067 msgid "See also L</pwrite>."
24071 #: ../fish/guestfish-actions.pod:3460
24076 #: ../fish/guestfish-actions.pod:3462
24079 " read-file path\n"
24084 #: ../fish/guestfish-actions.pod:3467
24086 "Unlike L</cat>, this function can correctly handle files that contain "
24087 "embedded ASCII NUL characters. However unlike L</download>, this function "
24088 "is limited in the total size of file that can be handled."
24092 #: ../fish/guestfish-actions.pod:3475
24097 #: ../fish/guestfish-actions.pod:3477
24100 " read-lines path\n"
24105 #: ../fish/guestfish-actions.pod:3484
24107 "Note that this function cannot correctly handle binary files (specifically, "
24108 "files containing C<\\0> character which is treated as end of line). For "
24109 "those you need to use the L</read-file> function which has a more complex "
24114 #: ../fish/guestfish-actions.pod:3489
24119 #: ../fish/guestfish-actions.pod:3491
24127 #: ../fish/guestfish-actions.pod:3543
24129 "This function is primarily intended for use by programs. To get a simple "
24130 "list of names, use L</ls>. To get a printable directory for human "
24131 "consumption, use L</ll>."
24135 #: ../fish/guestfish-actions.pod:3547
24140 #: ../fish/guestfish-actions.pod:3549
24148 #: ../fish/guestfish-actions.pod:3553
24149 msgid "readlinklist"
24153 #: ../fish/guestfish-actions.pod:3555
24156 " readlinklist path 'names ...'\n"
24161 #: ../fish/guestfish-actions.pod:3579
24166 #: ../fish/guestfish-actions.pod:3581
24174 #: ../fish/guestfish-actions.pod:3586
24175 msgid "removexattr"
24179 #: ../fish/guestfish-actions.pod:3588
24182 " removexattr xattr path\n"
24187 #: ../fish/guestfish-actions.pod:3593
24188 msgid "See also: L</lremovexattr>, L<attr(5)>."
24192 #: ../fish/guestfish-actions.pod:3595
24197 #: ../fish/guestfish-actions.pod:3597
24200 " resize2fs device\n"
24205 #: ../fish/guestfish-actions.pod:3602
24207 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
24208 "before calling this command. For unknown reasons C<resize2fs> sometimes "
24209 "gives an error about this and sometimes not. In any case, it is always safe "
24210 "to call L</e2fsck-f> before calling this function."
24214 #: ../fish/guestfish-actions.pod:3608
24215 msgid "resize2fs-size"
24219 #: ../fish/guestfish-actions.pod:3610
24222 " resize2fs-size device size\n"
24227 #: ../fish/guestfish-actions.pod:3612
24229 "This command is the same as L</resize2fs> except that it allows you to "
24230 "specify the new size (in bytes) explicitly."
24234 #: ../fish/guestfish-actions.pod:3615
24239 #: ../fish/guestfish-actions.pod:3617
24247 #: ../fish/guestfish-actions.pod:3621
24252 #: ../fish/guestfish-actions.pod:3623
24260 #: ../fish/guestfish-actions.pod:3629
24265 #: ../fish/guestfish-actions.pod:3631
24273 #: ../fish/guestfish-actions.pod:3635
24274 msgid "rmmountpoint"
24278 #: ../fish/guestfish-actions.pod:3637
24281 " rmmountpoint exemptpath\n"
24286 #: ../fish/guestfish-actions.pod:3639
24288 "This calls removes a mountpoint that was previously created with "
24289 "L</mkmountpoint>. See L</mkmountpoint> for full details."
24293 #: ../fish/guestfish-actions.pod:3643
24294 msgid "scrub-device"
24298 #: ../fish/guestfish-actions.pod:3645
24301 " scrub-device device\n"
24306 #: ../fish/guestfish-actions.pod:3656
24311 #: ../fish/guestfish-actions.pod:3658
24314 " scrub-file file\n"
24319 #: ../fish/guestfish-actions.pod:3668
24320 msgid "scrub-freespace"
24324 #: ../fish/guestfish-actions.pod:3670
24327 " scrub-freespace dir\n"
24332 #: ../fish/guestfish-actions.pod:3672
24334 "This command creates the directory C<dir> and then fills it with files until "
24335 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
24336 "deletes them. The intention is to scrub any free space on the partition "
24337 "containing C<dir>."
24341 #: ../fish/guestfish-actions.pod:3681
24346 #: ../fish/guestfish-actions.pod:3683
24351 #: ../fish/guestfish-actions.pod:3685
24354 " set-append append\n"
24359 #: ../fish/guestfish-actions.pod:3696
24360 msgid "set-autosync"
24364 #: ../fish/guestfish-actions.pod:3698
24369 #: ../fish/guestfish-actions.pod:3700
24372 " set-autosync true|false\n"
24377 #: ../fish/guestfish-actions.pod:3702
24379 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
24380 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
24381 "closed (also if the program exits without closing handles)."
24385 #: ../fish/guestfish-actions.pod:3710
24390 #: ../fish/guestfish-actions.pod:3712
24395 #: ../fish/guestfish-actions.pod:3714
24398 " set-direct true|false\n"
24403 #: ../fish/guestfish-actions.pod:3720
24405 "One consequence of this is that log messages aren't caught by the library "
24406 "and handled by L</set-log-message-callback>, but go straight to stdout."
24410 #: ../fish/guestfish-actions.pod:3729
24411 msgid "set-e2label"
24415 #: ../fish/guestfish-actions.pod:3731
24418 " set-e2label device label\n"
24423 #: ../fish/guestfish-actions.pod:3737
24425 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
24426 "label on a filesystem."
24430 #: ../fish/guestfish-actions.pod:3740
24435 #: ../fish/guestfish-actions.pod:3742
24438 " set-e2uuid device uuid\n"
24443 #: ../fish/guestfish-actions.pod:3749
24445 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
24446 "UUID of a filesystem."
24450 #: ../fish/guestfish-actions.pod:3752
24451 msgid "set-memsize"
24455 #: ../fish/guestfish-actions.pod:3754
24460 #: ../fish/guestfish-actions.pod:3756
24463 " set-memsize memsize\n"
24468 #: ../fish/guestfish-actions.pod:3758
24470 "This sets the memory size in megabytes allocated to the qemu subprocess. "
24471 "This only has any effect if called before L</launch>."
24475 #: ../fish/guestfish-actions.pod:3769
24476 msgid "set-network"
24480 #: ../fish/guestfish-actions.pod:3771
24485 #: ../fish/guestfish-actions.pod:3773
24488 " set-network true|false\n"
24493 #: ../fish/guestfish-actions.pod:3781
24494 msgid "You must call this before calling L</launch>, otherwise it has no effect."
24498 #: ../fish/guestfish-actions.pod:3784
24503 #: ../fish/guestfish-actions.pod:3786
24508 #: ../fish/guestfish-actions.pod:3788
24511 " set-path searchpath\n"
24516 #: ../fish/guestfish-actions.pod:3797
24521 #: ../fish/guestfish-actions.pod:3799
24526 #: ../fish/guestfish-actions.pod:3801
24534 #: ../fish/guestfish-actions.pod:3821
24535 msgid "set-recovery-proc"
24539 #: ../fish/guestfish-actions.pod:3823
24540 msgid "recovery-proc"
24544 #: ../fish/guestfish-actions.pod:3825
24547 " set-recovery-proc true|false\n"
24552 #: ../fish/guestfish-actions.pod:3827
24554 "If this is called with the parameter C<false> then L</launch> does not "
24555 "create a recovery process. The purpose of the recovery process is to stop "
24556 "runaway qemu processes in the case where the main program aborts abruptly."
24560 #: ../fish/guestfish-actions.pod:3832
24562 "This only has any effect if called before L</launch>, and the default is "
24567 #: ../fish/guestfish-actions.pod:3841
24568 msgid "set-selinux"
24572 #: ../fish/guestfish-actions.pod:3843
24577 #: ../fish/guestfish-actions.pod:3845
24580 " set-selinux true|false\n"
24585 #: ../fish/guestfish-actions.pod:3856
24590 #: ../fish/guestfish-actions.pod:3858
24595 #: ../fish/guestfish-actions.pod:3860
24598 " set-trace true|false\n"
24603 #: ../fish/guestfish-actions.pod:3876
24604 msgid "set-verbose"
24608 #: ../fish/guestfish-actions.pod:3878
24613 #: ../fish/guestfish-actions.pod:3880
24616 " set-verbose true|false\n"
24621 #: ../fish/guestfish-actions.pod:3887
24626 #: ../fish/guestfish-actions.pod:3889
24629 " setcon context\n"
24634 #: ../fish/guestfish-actions.pod:3896
24639 #: ../fish/guestfish-actions.pod:3898
24642 " setxattr xattr val vallen path\n"
24647 #: ../fish/guestfish-actions.pod:3904
24648 msgid "See also: L</lsetxattr>, L<attr(5)>."
24652 #: ../fish/guestfish-actions.pod:3906
24657 #: ../fish/guestfish-actions.pod:3908
24660 " sfdisk device cyls heads sectors 'lines ...'\n"
24665 #: ../fish/guestfish-actions.pod:3930
24666 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
24670 #: ../fish/guestfish-actions.pod:3936
24675 #: ../fish/guestfish-actions.pod:3938
24678 " sfdiskM device 'lines ...'\n"
24683 #: ../fish/guestfish-actions.pod:3940
24685 "This is a simplified interface to the L</sfdisk> command, where partition "
24686 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
24687 "you don't need to specify the cyls, heads and sectors parameters which were "
24688 "rarely if ever used anyway."
24692 #: ../fish/guestfish-actions.pod:3946
24693 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
24697 #: ../fish/guestfish-actions.pod:3952
24702 #: ../fish/guestfish-actions.pod:3954
24705 " sfdisk-N device partnum cyls heads sectors line\n"
24710 #: ../fish/guestfish-actions.pod:3959
24712 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
24713 "cyls/heads/sectors parameters."
24717 #: ../fish/guestfish-actions.pod:3962
24718 msgid "See also: L</part-add>"
24722 #: ../fish/guestfish-actions.pod:3967
24723 msgid "sfdisk-disk-geometry"
24727 #: ../fish/guestfish-actions.pod:3969
24730 " sfdisk-disk-geometry device\n"
24735 #: ../fish/guestfish-actions.pod:3971
24737 "This displays the disk geometry of C<device> read from the partition table. "
24738 "Especially in the case where the underlying block device has been resized, "
24739 "this can be different from the kernel's idea of the geometry (see "
24740 "L</sfdisk-kernel-geometry>)."
24744 #: ../fish/guestfish-actions.pod:3979
24745 msgid "sfdisk-kernel-geometry"
24749 #: ../fish/guestfish-actions.pod:3981
24752 " sfdisk-kernel-geometry device\n"
24757 #: ../fish/guestfish-actions.pod:3988
24762 #: ../fish/guestfish-actions.pod:3990
24765 " sfdisk-l device\n"
24770 #: ../fish/guestfish-actions.pod:3996
24771 msgid "See also: L</part-list>"
24775 #: ../fish/guestfish-actions.pod:3998
24780 #: ../fish/guestfish-actions.pod:4000
24788 #: ../fish/guestfish-actions.pod:4005
24789 msgid "This is like L</command>, but passes the command to:"
24793 #: ../fish/guestfish-actions.pod:4013
24794 msgid "All the provisos about L</command> apply to this call."
24798 #: ../fish/guestfish-actions.pod:4015
24803 #: ../fish/guestfish-actions.pod:4017
24806 " sh-lines command\n"
24811 #: ../fish/guestfish-actions.pod:4019
24812 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24816 #: ../fish/guestfish-actions.pod:4022
24817 msgid "See also: L</command-lines>"
24821 #: ../fish/guestfish-actions.pod:4024
24826 #: ../fish/guestfish-actions.pod:4026
24834 #: ../fish/guestfish-actions.pod:4030
24839 #: ../fish/guestfish-actions.pod:4032
24847 #: ../fish/guestfish-actions.pod:4038
24852 #: ../fish/guestfish-actions.pod:4040
24860 #: ../fish/guestfish-actions.pod:4048
24865 #: ../fish/guestfish-actions.pod:4050
24873 #: ../fish/guestfish-actions.pod:4058
24878 #: ../fish/guestfish-actions.pod:4060
24881 " strings-e encoding path\n"
24886 #: ../fish/guestfish-actions.pod:4062
24888 "This is like the L</strings> command, but allows you to specify the encoding "
24889 "of strings that are looked for in the source file C<path>."
24893 #: ../fish/guestfish-actions.pod:4072
24895 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24896 "ISO-8859-X (this is what L</strings> uses)."
24900 #: ../fish/guestfish-actions.pod:4104
24901 msgid "swapoff-device"
24905 #: ../fish/guestfish-actions.pod:4106
24908 " swapoff-device device\n"
24913 #: ../fish/guestfish-actions.pod:4108
24915 "This command disables the libguestfs appliance swap device or partition "
24916 "named C<device>. See L</swapon-device>."
24920 #: ../fish/guestfish-actions.pod:4112
24921 msgid "swapoff-file"
24925 #: ../fish/guestfish-actions.pod:4114
24928 " swapoff-file file\n"
24933 #: ../fish/guestfish-actions.pod:4118
24934 msgid "swapoff-label"
24938 #: ../fish/guestfish-actions.pod:4120
24941 " swapoff-label label\n"
24946 #: ../fish/guestfish-actions.pod:4125
24947 msgid "swapoff-uuid"
24951 #: ../fish/guestfish-actions.pod:4127
24954 " swapoff-uuid uuid\n"
24959 #: ../fish/guestfish-actions.pod:4132
24960 msgid "swapon-device"
24964 #: ../fish/guestfish-actions.pod:4134
24967 " swapon-device device\n"
24972 #: ../fish/guestfish-actions.pod:4136
24974 "This command enables the libguestfs appliance to use the swap device or "
24975 "partition named C<device>. The increased memory is made available for all "
24976 "commands, for example those run using L</command> or L</sh>."
24980 #: ../fish/guestfish-actions.pod:4148
24981 msgid "swapon-file"
24985 #: ../fish/guestfish-actions.pod:4150
24988 " swapon-file file\n"
24993 #: ../fish/guestfish-actions.pod:4152
24994 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
24998 #: ../fish/guestfish-actions.pod:4155
24999 msgid "swapon-label"
25003 #: ../fish/guestfish-actions.pod:4157
25006 " swapon-label label\n"
25011 #: ../fish/guestfish-actions.pod:4159
25013 "This command enables swap to a labeled swap partition. See "
25014 "L</swapon-device> for other notes."
25018 #: ../fish/guestfish-actions.pod:4162
25019 msgid "swapon-uuid"
25023 #: ../fish/guestfish-actions.pod:4164
25026 " swapon-uuid uuid\n"
25031 #: ../fish/guestfish-actions.pod:4166
25033 "This command enables swap to a swap partition with the given UUID. See "
25034 "L</swapon-device> for other notes."
25038 #: ../fish/guestfish-actions.pod:4169
25043 #: ../fish/guestfish-actions.pod:4171
25051 #: ../fish/guestfish-actions.pod:4179
25056 #: ../fish/guestfish-actions.pod:4181
25064 #: ../fish/guestfish-actions.pod:4189
25069 #: ../fish/guestfish-actions.pod:4191
25072 " tail-n nrlines path\n"
25077 #: ../fish/guestfish-actions.pod:4204
25082 #: ../fish/guestfish-actions.pod:4206
25085 " tar-in (tarfile|-) directory\n"
25090 #: ../fish/guestfish-actions.pod:4211
25091 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
25095 #: ../fish/guestfish-actions.pod:4216
25100 #: ../fish/guestfish-actions.pod:4218
25103 " tar-out directory (tarfile|-)\n"
25108 #: ../fish/guestfish-actions.pod:4223
25109 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
25113 #: ../fish/guestfish-actions.pod:4228
25118 #: ../fish/guestfish-actions.pod:4230
25121 " tgz-in (tarball|-) directory\n"
25126 #: ../fish/guestfish-actions.pod:4235
25127 msgid "To upload an uncompressed tarball, use L</tar-in>."
25131 #: ../fish/guestfish-actions.pod:4239
25136 #: ../fish/guestfish-actions.pod:4241
25139 " tgz-out directory (tarball|-)\n"
25144 #: ../fish/guestfish-actions.pod:4246
25145 msgid "To download an uncompressed tarball, use L</tar-out>."
25149 #: ../fish/guestfish-actions.pod:4250
25154 #: ../fish/guestfish-actions.pod:4252
25162 #: ../fish/guestfish-actions.pod:4261
25167 #: ../fish/guestfish-actions.pod:4263
25175 #: ../fish/guestfish-actions.pod:4268
25176 msgid "truncate-size"
25180 #: ../fish/guestfish-actions.pod:4270
25183 " truncate-size path size\n"
25188 #: ../fish/guestfish-actions.pod:4275
25190 "If the current file size is less than C<size> then the file is extended to "
25191 "the required size with zero bytes. This creates a sparse file (ie. disk "
25192 "blocks are not allocated for the file until you write to it). To create a "
25193 "non-sparse file of zeroes, use L</fallocate64> instead."
25197 #: ../fish/guestfish-actions.pod:4281
25202 #: ../fish/guestfish-actions.pod:4283
25205 " tune2fs-l device\n"
25210 #: ../fish/guestfish-actions.pod:4293
25215 #: ../fish/guestfish-actions.pod:4295
25218 " txz-in (tarball|-) directory\n"
25223 #: ../fish/guestfish-actions.pod:4302
25228 #: ../fish/guestfish-actions.pod:4304
25231 " txz-out directory (tarball|-)\n"
25236 #: ../fish/guestfish-actions.pod:4311
25241 #: ../fish/guestfish-actions.pod:4313
25249 #: ../fish/guestfish-actions.pod:4327
25250 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
25254 #: ../fish/guestfish-actions.pod:4332
25259 #: ../fish/guestfish-actions.pod:4334
25264 #: ../fish/guestfish-actions.pod:4336
25267 " umount pathordevice\n"
25272 #: ../fish/guestfish-actions.pod:4342
25277 #: ../fish/guestfish-actions.pod:4344
25278 msgid "unmount-all"
25282 #: ../fish/guestfish-actions.pod:4346
25290 #: ../fish/guestfish-actions.pod:4352
25295 #: ../fish/guestfish-actions.pod:4354
25298 " upload (filename|-) remotefilename\n"
25303 #: ../fish/guestfish-actions.pod:4361
25304 msgid "See also L</download>."
25308 #: ../fish/guestfish-actions.pod:4365
25309 msgid "upload-offset"
25313 #: ../fish/guestfish-actions.pod:4367
25316 " upload-offset (filename|-) remotefilename offset\n"
25321 #: ../fish/guestfish-actions.pod:4379
25323 "Note that there is no limit on the amount of data that can be uploaded with "
25324 "this call, unlike with L</pwrite>, and this call always writes the full "
25325 "amount unless an error occurs."
25329 #: ../fish/guestfish-actions.pod:4384
25330 msgid "See also L</upload>, L</pwrite>."
25334 #: ../fish/guestfish-actions.pod:4388
25339 #: ../fish/guestfish-actions.pod:4390
25342 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
25347 #: ../fish/guestfish-actions.pod:4409
25352 #: ../fish/guestfish-actions.pod:4411
25360 #: ../fish/guestfish-actions.pod:4438
25362 "I<Note:> Don't use this call to test for availability of features. In "
25363 "enterprise distributions we backport features from later versions into "
25364 "earlier versions, making this an unreliable way to test for features. Use "
25365 "L</available> instead."
25369 #: ../fish/guestfish-actions.pod:4444
25374 #: ../fish/guestfish-actions.pod:4446
25377 " vfs-label device\n"
25382 #: ../fish/guestfish-actions.pod:4453
25383 msgid "To find a filesystem from the label, use L</findfs-label>."
25387 #: ../fish/guestfish-actions.pod:4455
25392 #: ../fish/guestfish-actions.pod:4457
25395 " vfs-type device\n"
25400 #: ../fish/guestfish-actions.pod:4467
25405 #: ../fish/guestfish-actions.pod:4469
25408 " vfs-uuid device\n"
25413 #: ../fish/guestfish-actions.pod:4476
25414 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
25418 #: ../fish/guestfish-actions.pod:4478
25419 msgid "vg-activate"
25423 #: ../fish/guestfish-actions.pod:4480
25426 " vg-activate true|false 'volgroups ...'\n"
25431 #: ../fish/guestfish-actions.pod:4493
25432 msgid "vg-activate-all"
25436 #: ../fish/guestfish-actions.pod:4495
25439 " vg-activate-all true|false\n"
25444 #: ../fish/guestfish-actions.pod:4505
25449 #: ../fish/guestfish-actions.pod:4507
25452 " vgcreate volgroup 'physvols ...'\n"
25457 #: ../fish/guestfish-actions.pod:4512
25462 #: ../fish/guestfish-actions.pod:4514
25465 " vglvuuids vgname\n"
25470 #: ../fish/guestfish-actions.pod:4519
25472 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
25473 "logical volumes and volume groups."
25477 #: ../fish/guestfish-actions.pod:4522
25478 msgid "See also L</vgpvuuids>."
25482 #: ../fish/guestfish-actions.pod:4524
25487 #: ../fish/guestfish-actions.pod:4526
25490 " vgpvuuids vgname\n"
25495 #: ../fish/guestfish-actions.pod:4531
25497 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
25498 "physical volumes and volume groups."
25502 #: ../fish/guestfish-actions.pod:4534
25503 msgid "See also L</vglvuuids>."
25507 #: ../fish/guestfish-actions.pod:4536
25512 #: ../fish/guestfish-actions.pod:4538
25515 " vgremove vgname\n"
25520 #: ../fish/guestfish-actions.pod:4545
25525 #: ../fish/guestfish-actions.pod:4547
25528 " vgrename volgroup newvolgroup\n"
25533 #: ../fish/guestfish-actions.pod:4551
25538 #: ../fish/guestfish-actions.pod:4553
25546 #: ../fish/guestfish-actions.pod:4561
25547 msgid "See also L</vgs-full>."
25551 #: ../fish/guestfish-actions.pod:4563
25556 #: ../fish/guestfish-actions.pod:4565
25564 #: ../fish/guestfish-actions.pod:4570
25569 #: ../fish/guestfish-actions.pod:4572
25577 #: ../fish/guestfish-actions.pod:4577
25582 #: ../fish/guestfish-actions.pod:4579
25590 #: ../fish/guestfish-actions.pod:4583
25595 #: ../fish/guestfish-actions.pod:4585
25603 #: ../fish/guestfish-actions.pod:4590
25608 #: ../fish/guestfish-actions.pod:4592
25616 #: ../fish/guestfish-actions.pod:4597
25621 #: ../fish/guestfish-actions.pod:4599
25629 #: ../fish/guestfish-actions.pod:4604
25634 #: ../fish/guestfish-actions.pod:4606
25637 " write path content\n"
25642 #: ../fish/guestfish-actions.pod:4614
25647 #: ../fish/guestfish-actions.pod:4616
25650 " write-file path content size\n"
25655 #: ../fish/guestfish-actions.pod:4632
25656 msgid "This function is deprecated. In new code, use the L</write> call instead."
25660 #: ../fish/guestfish-actions.pod:4639
25665 #: ../fish/guestfish-actions.pod:4641
25668 " zegrep regex path\n"
25673 #: ../fish/guestfish-actions.pod:4649
25678 #: ../fish/guestfish-actions.pod:4651
25681 " zegrepi regex path\n"
25686 #: ../fish/guestfish-actions.pod:4659
25691 #: ../fish/guestfish-actions.pod:4661
25699 #: ../fish/guestfish-actions.pod:4669
25700 msgid "See also: L</zero-device>, L</scrub-device>."
25704 #: ../fish/guestfish-actions.pod:4671
25705 msgid "zero-device"
25709 #: ../fish/guestfish-actions.pod:4673
25712 " zero-device device\n"
25717 #: ../fish/guestfish-actions.pod:4675
25719 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
25720 "which just zeroes the first few blocks of a device."
25724 #: ../fish/guestfish-actions.pod:4682
25729 #: ../fish/guestfish-actions.pod:4684
25732 " zerofree device\n"
25737 #: ../fish/guestfish-actions.pod:4697
25742 #: ../fish/guestfish-actions.pod:4699
25745 " zfgrep pattern path\n"
25750 #: ../fish/guestfish-actions.pod:4707
25755 #: ../fish/guestfish-actions.pod:4709
25758 " zfgrepi pattern path\n"
25763 #: ../fish/guestfish-actions.pod:4717
25768 #: ../fish/guestfish-actions.pod:4719
25771 " zfile meth path\n"
25776 #: ../fish/guestfish-actions.pod:4726
25777 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
25781 #: ../fish/guestfish-actions.pod:4729
25782 msgid "This function is deprecated. In new code, use the L</file> call instead."
25786 #: ../fish/guestfish-actions.pod:4736
25791 #: ../fish/guestfish-actions.pod:4738
25794 " zgrep regex path\n"
25799 #: ../fish/guestfish-actions.pod:4746
25804 #: ../fish/guestfish-actions.pod:4748
25807 " zgrepi regex path\n"
25812 #: ../fish/guestfish-commands.pod:1
25817 #: ../fish/guestfish-commands.pod:3
25822 #: ../fish/guestfish-commands.pod:5
25825 " alloc filename size\n"
25830 #: ../fish/guestfish-commands.pod:7
25832 "This creates an empty (zeroed) file of the given size, and then adds so it "
25833 "can be further examined."
25837 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25838 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25842 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25843 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25847 #: ../fish/guestfish-commands.pod:14
25849 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25850 "image, see L</PREPARED DISK IMAGES>."
25854 #: ../fish/guestfish-commands.pod:17
25859 #: ../fish/guestfish-commands.pod:19
25862 " copy-in local [local ...] /remotedir\n"
25867 #: ../fish/guestfish-commands.pod:21
25869 "C<copy-in> copies local files or directories recursively into the disk "
25870 "image, placing them in the directory called C</remotedir> (which must "
25871 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25872 "other commands as necessary."
25876 #: ../fish/guestfish-commands.pod:26
25878 "Multiple local files and directories can be specified, but the last "
25879 "parameter must always be a remote directory. Wildcards cannot be used."
25883 #: ../fish/guestfish-commands.pod:30
25888 #: ../fish/guestfish-commands.pod:32
25891 " copy-out remote [remote ...] localdir\n"
25896 #: ../fish/guestfish-commands.pod:34
25898 "C<copy-out> copies remote files or directories recursively out of the disk "
25899 "image, placing them on the host disk in a local directory called C<localdir> "
25900 "(which must exist). This guestfish meta-command turns into a sequence of "
25901 "L</download>, L</tar-out> and other commands as necessary."
25905 #: ../fish/guestfish-commands.pod:40
25907 "Multiple remote files and directories can be specified, but the last "
25908 "parameter must always be a local directory. To download to the current "
25909 "directory, use C<.> as in:"
25913 #: ../fish/guestfish-commands.pod:44
25916 " copy-out /home .\n"
25921 #: ../fish/guestfish-commands.pod:46
25923 "Wildcards cannot be used in the ordinary command, but you can use them with "
25924 "the help of L</glob> like this:"
25928 #: ../fish/guestfish-commands.pod:49
25931 " glob copy-out /home/* .\n"
25936 #: ../fish/guestfish-commands.pod:51
25941 #: ../fish/guestfish-commands.pod:53
25944 " echo [params ...]\n"
25949 #: ../fish/guestfish-commands.pod:55
25950 msgid "This echos the parameters to the terminal."
25954 #: ../fish/guestfish-commands.pod:57
25959 #: ../fish/guestfish-commands.pod:59
25964 #: ../fish/guestfish-commands.pod:61
25969 #: ../fish/guestfish-commands.pod:63
25977 #: ../fish/guestfish-commands.pod:65
25979 "This is used to edit a file. It downloads the file, edits it locally using "
25980 "your editor, then uploads the result."
25984 #: ../fish/guestfish-commands.pod:68
25986 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25987 "or C<emacs> you will get those corresponding editors."
25991 #: ../fish/guestfish-commands.pod:72
25996 #: ../fish/guestfish-commands.pod:74
25999 " glob command args...\n"
26004 #: ../fish/guestfish-commands.pod:76
26006 "Expand wildcards in any paths in the args list, and run C<command> "
26007 "repeatedly on each matching path."
26011 #: ../fish/guestfish-commands.pod:79
26012 msgid "See L</WILDCARDS AND GLOBBING>."
26016 #: ../fish/guestfish-commands.pod:81
26021 #: ../fish/guestfish-commands.pod:83
26024 " hexedit <filename|device>\n"
26025 " hexedit <filename|device> <max>\n"
26026 " hexedit <filename|device> <start> <max>\n"
26031 #: ../fish/guestfish-commands.pod:87
26033 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
26038 #: ../fish/guestfish-commands.pod:90
26040 "This command works by downloading potentially the whole file or device, "
26041 "editing it locally, then uploading it. If the file or device is large, you "
26042 "have to specify which part you wish to edit by using C<max> and/or C<start> "
26043 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
26044 "usual modifiers allowed such as C<1M> (1 megabyte)."
26048 #: ../fish/guestfish-commands.pod:97
26049 msgid "For example to edit the first few sectors of a disk you might do:"
26053 #: ../fish/guestfish-commands.pod:100
26056 " hexedit /dev/sda 1M\n"
26061 #: ../fish/guestfish-commands.pod:102
26063 "which would allow you to edit anywhere within the first megabyte of the "
26068 #: ../fish/guestfish-commands.pod:105
26069 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
26073 #: ../fish/guestfish-commands.pod:107
26076 " hexedit /dev/sda1 0x400 0x400\n"
26081 #: ../fish/guestfish-commands.pod:109
26082 msgid "(assuming the superblock is in the standard location)."
26086 #: ../fish/guestfish-commands.pod:111
26088 "This command requires the external L<hexedit(1)> program. You can specify "
26089 "another program to use by setting the C<HEXEDITOR> environment variable."
26093 #: ../fish/guestfish-commands.pod:115
26094 msgid "See also L</hexdump>."
26098 #: ../fish/guestfish-commands.pod:117
26103 #: ../fish/guestfish-commands.pod:119
26111 #: ../fish/guestfish-commands.pod:121
26112 msgid "Change the local directory, ie. the current directory of guestfish itself."
26116 #: ../fish/guestfish-commands.pod:124
26117 msgid "Note that C<!cd> won't do what you might expect."
26121 #: ../fish/guestfish-commands.pod:126
26126 #: ../fish/guestfish-commands.pod:128
26131 #: ../fish/guestfish-commands.pod:130
26139 #: ../fish/guestfish-commands.pod:132
26140 msgid "Opens the manual page for guestfish."
26144 #: ../fish/guestfish-commands.pod:134
26149 #: ../fish/guestfish-commands.pod:136
26154 #: ../fish/guestfish-commands.pod:138
26162 #: ../fish/guestfish-commands.pod:140
26170 #: ../fish/guestfish-commands.pod:142
26171 msgid "This is used to view a file."
26175 #: ../fish/guestfish-commands.pod:144
26177 "The default viewer is C<$PAGER>. However if you use the alternate command "
26178 "C<less> you will get the C<less> command specifically."
26182 #: ../fish/guestfish-commands.pod:147
26187 #: ../fish/guestfish-commands.pod:149
26195 #: ../fish/guestfish-commands.pod:151
26197 "Close and reopen the libguestfs handle. It is not necessary to use this "
26198 "normally, because the handle is closed properly when guestfish exits. "
26199 "However this is occasionally useful for testing."
26203 #: ../fish/guestfish-commands.pod:155
26208 #: ../fish/guestfish-commands.pod:157
26211 " sparse filename size\n"
26216 #: ../fish/guestfish-commands.pod:159
26218 "This creates an empty sparse file of the given size, and then adds so it can "
26219 "be further examined."
26223 #: ../fish/guestfish-commands.pod:162
26225 "In all respects it works the same as the L</alloc> command, except that the "
26226 "image file is allocated sparsely, which means that disk blocks are not "
26227 "assigned to the file until they are needed. Sparse disk files only use "
26228 "space when written to, but they are slower and there is a danger you could "
26229 "run out of real disk space during a write operation."
26233 #: ../fish/guestfish-commands.pod:172
26238 #: ../fish/guestfish-commands.pod:174
26246 #: ../fish/guestfish-commands.pod:176
26248 "This command returns a list of the optional groups known to the daemon, and "
26249 "indicates which ones are supported by this build of the libguestfs "
26254 #: ../fish/guestfish-commands.pod:180
26255 msgid "See also L<guestfs(3)/AVAILABILITY>."
26259 #: ../fish/guestfish-commands.pod:182
26264 #: ../fish/guestfish-commands.pod:184
26267 " time command args...\n"
26272 #: ../fish/guestfish-commands.pod:186
26274 "Run the command as usual, but print the elapsed time afterwards. This can "
26275 "be useful for benchmarking operations."
26279 #: ../test-tool/libguestfs-test-tool.pod:5
26280 msgid "libguestfs-test-tool - End user tests for libguestfs"
26284 #: ../test-tool/libguestfs-test-tool.pod:9
26287 " libguestfs-test-tool [--options]\n"
26292 #: ../test-tool/libguestfs-test-tool.pod:13
26294 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
26295 "and developers, to allow them to check basic libguestfs functionality is "
26296 "working. This is needed because libguestfs occasionally breaks for reasons "
26297 "beyond our control: usually because of changes in the underlying qemu or "
26298 "kernel packages, or the host environment."
26302 #: ../test-tool/libguestfs-test-tool.pod:20
26303 msgid "If you suspect a problem in libguestfs, then just run:"
26307 #: ../test-tool/libguestfs-test-tool.pod:22
26310 " libguestfs-test-tool\n"
26315 #: ../test-tool/libguestfs-test-tool.pod:24
26316 msgid "It will print lots of diagnostic messages."
26320 #: ../test-tool/libguestfs-test-tool.pod:26
26321 msgid "If it runs to completion successfully, you will see this near the end:"
26325 #: ../test-tool/libguestfs-test-tool.pod:28
26328 " ===== TEST FINISHED OK =====\n"
26333 #: ../test-tool/libguestfs-test-tool.pod:30
26334 msgid "and the test tool will exit with code 0."
26338 #: ../test-tool/libguestfs-test-tool.pod:32
26340 "If it fails (and/or exits with non-zero error code), please paste the "
26341 "B<complete, unedited> output of the test tool into a bug report. More "
26342 "information about reporting bugs can be found on the "
26343 "L<http://libguestfs.org/> website."
26347 #: ../test-tool/libguestfs-test-tool.pod:41
26352 #: ../test-tool/libguestfs-test-tool.pod:43
26353 msgid "Display short usage information and exit."
26357 #: ../test-tool/libguestfs-test-tool.pod:45
26358 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
26362 #: ../test-tool/libguestfs-test-tool.pod:47
26364 "Pass an alternate name for the helper program. libguestfs-test-tool will "
26365 "normally look in the C<$libexec> directory that was configured when the tool "
26370 #: ../test-tool/libguestfs-test-tool.pod:51
26371 msgid "I<--qemu qemu_binary>"
26375 #: ../test-tool/libguestfs-test-tool.pod:53
26377 "If you have downloaded another qemu binary, point this option at the full "
26378 "path of the binary to try it."
26382 #: ../test-tool/libguestfs-test-tool.pod:56
26383 msgid "I<--qemudir qemu_source_dir>"
26387 #: ../test-tool/libguestfs-test-tool.pod:58
26389 "If you have compiled qemu from source, point this option at the source "
26390 "directory to try it."
26394 #: ../test-tool/libguestfs-test-tool.pod:61
26395 msgid "I<--timeout N>"
26399 #: ../test-tool/libguestfs-test-tool.pod:63
26401 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
26402 "does not usually need to be adjusted unless your machine is very slow."
26406 #: ../test-tool/libguestfs-test-tool.pod:69
26407 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
26411 #: ../test-tool/libguestfs-test-tool.pod:71
26413 "If you have compiled another version of qemu from source and would like to "
26414 "try that, then you can use the I<--qemudir> option to point to the qemu "
26415 "source directory."
26419 #: ../test-tool/libguestfs-test-tool.pod:75
26421 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
26422 "option to point to the binary."
26426 #: ../test-tool/libguestfs-test-tool.pod:78
26428 "When using an alternate qemu with libguestfs, usually you would need to "
26429 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
26430 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
26431 "when you use either of the I<--qemudir> or I<--qemu> options."
26435 #: ../test-tool/libguestfs-test-tool.pod:85
26437 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
26438 "I<1> if there was an error."
26442 #: ../test-tool/libguestfs-test-tool.pod:92
26443 msgid "/usr/libexec/libguestfs-test-tool-helper"
26447 #: ../test-tool/libguestfs-test-tool.pod:94
26449 "This helper program is run inside the appliance and provides additional "
26454 #: ../test-tool/libguestfs-test-tool.pod:97
26455 msgid "/usr/bin/mkisofs"
26459 #: ../test-tool/libguestfs-test-tool.pod:99
26461 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
26462 "which is used as part of the tests."
26466 #: ../test-tool/libguestfs-test-tool.pod:106
26468 "For the full list of environment variables which may affect libguestfs, "
26469 "please see the L<guestfs(3)> manual page."
26473 #: ../test-tool/libguestfs-test-tool.pod:111
26474 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
26478 #: ../test-tool/libguestfs-test-tool.pod:121
26479 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
26483 #: ../fuse/guestmount.pod:5
26484 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
26488 #: ../fuse/guestmount.pod:9
26491 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
26496 #: ../fuse/guestmount.pod:11
26499 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
26504 #: ../fuse/guestmount.pod:13
26507 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
26512 #: ../fuse/guestmount.pod:17
26514 "You must I<not> use C<guestmount> in read-write mode on live virtual "
26515 "machines. If you do this, you risk disk corruption in the VM."
26519 #: ../fuse/guestmount.pod:22
26521 "The guestmount program can be used to mount virtual machine filesystems and "
26522 "other disk images on the host. It uses libguestfs for access to the guest "
26523 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
26524 "a mountable device."
26528 #: ../fuse/guestmount.pod:27
26530 "Along with other options, you have to give at least one device (I<-a> "
26531 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
26532 "option) or use the I<-i> inspection option. How this works is better "
26533 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
26538 #: ../fuse/guestmount.pod:33
26540 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
26541 "by you, and the filesystem will not be visible to any other users unless you "
26542 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
26543 "the filesystem, use the C<fusermount -u> command."
26547 #: ../fuse/guestmount.pod:41
26549 "For a typical Windows guest which has its main filesystem on the first "
26554 #: ../fuse/guestmount.pod:44
26557 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
26562 #: ../fuse/guestmount.pod:46
26564 "For a typical Linux guest which has a /boot filesystem on the first "
26565 "partition, and the root filesystem on a logical volume:"
26569 #: ../fuse/guestmount.pod:49
26572 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
26577 #: ../fuse/guestmount.pod:51
26578 msgid "To get libguestfs to detect guest mountpoints for you:"
26582 #: ../fuse/guestmount.pod:53
26585 " guestmount -a guest.img -i --ro /mnt\n"
26590 #: ../fuse/guestmount.pod:55
26591 msgid "For a libvirt guest called \"Guest\" you could do:"
26595 #: ../fuse/guestmount.pod:57
26598 " guestmount -d Guest -i --ro /mnt\n"
26603 #: ../fuse/guestmount.pod:59
26605 "If you don't know what filesystems are contained in a guest or disk image, "
26606 "use L<virt-filesystems(1)> first:"
26610 #: ../fuse/guestmount.pod:62
26613 " virt-filesystems MyGuest\n"
26618 #: ../fuse/guestmount.pod:64
26620 "If you want to trace the libguestfs calls but without excessive debugging "
26621 "information, we recommend:"
26625 #: ../fuse/guestmount.pod:67
26628 " guestmount [...] --trace /mnt\n"
26633 #: ../fuse/guestmount.pod:69
26634 msgid "If you want to debug the program, we recommend:"
26638 #: ../fuse/guestmount.pod:71
26641 " guestmount [...] --trace --verbose /mnt\n"
26646 #: ../fuse/guestmount.pod:77
26647 msgid "B<-a image> | B<--add image>"
26651 #: ../fuse/guestmount.pod:79
26652 msgid "Add a block device or virtual machine image."
26656 #: ../fuse/guestmount.pod:84
26657 msgid "B<-c URI> | B<--connect URI>"
26661 #: ../fuse/guestmount.pod:90
26662 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
26666 #: ../fuse/guestmount.pod:96
26667 msgid "B<--dir-cache-timeout N>"
26671 #: ../fuse/guestmount.pod:98
26673 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
26674 "seconds. The readdir cache [actually, there are several semi-independent "
26675 "caches] is populated after a readdir(2) call with the stat and extended "
26676 "attributes of the files in the directory, in anticipation that they will be "
26677 "requested soon after."
26681 #: ../fuse/guestmount.pod:104
26683 "There is also a different attribute cache implemented by FUSE (see the FUSE "
26684 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
26685 "requests, only cache existing ones."
26689 #: ../fuse/guestmount.pod:115
26690 msgid "B<--format=raw|qcow2|..> | B<--format>"
26694 #: ../fuse/guestmount.pod:122
26696 "If you have untrusted raw-format guest disk images, you should use this "
26697 "option to specify the disk format. This avoids a possible security problem "
26698 "with malicious guests (CVE-2010-3851). See also "
26699 "L<guestfs(3)/guestfs_add_drive_opts>."
26703 #: ../fuse/guestmount.pod:127
26704 msgid "B<--fuse-help>"
26708 #: ../fuse/guestmount.pod:129
26709 msgid "Display help on special FUSE options (see I<-o> below)."
26713 #: ../fuse/guestmount.pod:133
26714 msgid "Display brief help and exit."
26718 #: ../fuse/guestmount.pod:135
26719 msgid "B<-i> | B<--inspector>"
26723 #: ../fuse/guestmount.pod:146
26724 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
26728 #: ../fuse/guestmount.pod:148
26730 "Mount the named partition or logical volume on the given mountpoint B<in the "
26731 "guest> (this has nothing to do with mountpoints in the host)."
26735 #: ../fuse/guestmount.pod:151
26737 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
26738 "something on C</>."
26742 #: ../fuse/guestmount.pod:154
26743 msgid "B<-n> | B<--no-sync>"
26747 #: ../fuse/guestmount.pod:156
26749 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
26750 "unmounted. If you specify this option, then we don't attempt to sync the "
26751 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
26755 #: ../fuse/guestmount.pod:161
26756 msgid "B<-o option> | B<--option option>"
26760 #: ../fuse/guestmount.pod:163
26761 msgid "Pass extra options to FUSE."
26765 #: ../fuse/guestmount.pod:165
26767 "To get a list of all the extra options supported by FUSE, use the command "
26768 "below. Note that only the FUSE I<-o> options can be passed, and only some "
26769 "of them are a good idea."
26773 #: ../fuse/guestmount.pod:169
26776 " guestmount --fuse-help\n"
26781 #: ../fuse/guestmount.pod:171
26782 msgid "Some potentially useful FUSE options:"
26786 #: ../fuse/guestmount.pod:175
26787 msgid "B<-o allow_other>"
26791 #: ../fuse/guestmount.pod:177
26792 msgid "Allow other users to see the filesystem."
26796 #: ../fuse/guestmount.pod:179
26797 msgid "B<-o attr_timeout=N>"
26801 #: ../fuse/guestmount.pod:181
26802 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
26806 #: ../fuse/guestmount.pod:183
26807 msgid "B<-o kernel_cache>"
26811 #: ../fuse/guestmount.pod:185
26813 "Allow the kernel to cache files (reduces the number of reads that have to go "
26814 "through the L<guestfs(3)> API). This is generally a good idea if you can "
26815 "afford the extra memory usage."
26819 #: ../fuse/guestmount.pod:189
26820 msgid "B<-o uid=N> B<-o gid=N>"
26824 #: ../fuse/guestmount.pod:191
26826 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
26827 "the chosen values."
26831 #: ../fuse/guestmount.pod:196
26832 msgid "B<-r> | B<--ro>"
26836 #: ../fuse/guestmount.pod:198
26838 "Add devices and mount everything read-only. Also disallow writes and make "
26839 "the disk appear read-only to FUSE."
26843 #: ../fuse/guestmount.pod:201
26845 "This is highly recommended if you are not going to edit the guest disk. If "
26846 "the guest is running and this option is I<not> supplied, then there is a "
26847 "strong risk of disk corruption in the guest. We try to prevent this from "
26848 "happening, but it is not always possible."
26852 #: ../fuse/guestmount.pod:206
26853 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26857 #: ../fuse/guestmount.pod:210
26858 msgid "Enable SELinux support for the guest."
26862 #: ../fuse/guestmount.pod:212
26863 msgid "B<-v> | B<--verbose>"
26867 #: ../fuse/guestmount.pod:214
26868 msgid "Enable verbose messages from underlying libguestfs."
26872 #: ../fuse/guestmount.pod:216
26873 msgid "B<-V> | B<--version>"
26877 #: ../fuse/guestmount.pod:218
26878 msgid "Display the program version and exit."
26882 #: ../fuse/guestmount.pod:220
26883 msgid "B<-w> | B<--rw>"
26887 #: ../fuse/guestmount.pod:222
26889 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26890 "FOR READ AND WRITE>."
26894 #: ../fuse/guestmount.pod:225
26895 msgid "B<-x> | B<--trace>"
26899 #: ../fuse/guestmount.pod:227
26900 msgid "Trace libguestfs calls and entry into each FUSE function."
26904 #: ../fuse/guestmount.pod:229
26905 msgid "This also stops the daemon from forking into the background."
26909 #: ../fuse/guestmount.pod:235
26911 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26912 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
26913 "L<http://fuse.sf.net/>."
26917 #: ../tools/virt-edit.pl:34
26918 msgid "virt-edit - Edit a file in a virtual machine"
26922 #: ../tools/virt-edit.pl:38
26925 " virt-edit [--options] domname file\n"
26930 #: ../tools/virt-edit.pl:40
26933 " virt-edit [--options] disk.img [disk.img ...] file\n"
26938 #: ../tools/virt-edit.pl:42
26941 " virt-edit [domname|disk.img] file -e 'expr'\n"
26946 #: ../tools/virt-edit.pl:46
26948 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26949 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26950 "doing this, but doesn't catch all cases."
26954 #: ../tools/virt-edit.pl:52
26956 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26957 "the named virtual machine (or disk image)."
26961 #: ../tools/virt-edit.pl:55
26962 msgid "If you want to just view a file, use L<virt-cat(1)>."
26966 #: ../tools/virt-edit.pl:57
26968 "For more complex cases you should look at the L<guestfish(1)> tool (see "
26969 "L</USING GUESTFISH> below)."
26973 #: ../tools/virt-edit.pl:60
26975 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
26976 "files. L<guestfish(1)> can do that and much more."
26980 #: ../tools/virt-edit.pl:65
26981 msgid "Edit the named files interactively:"
26985 #: ../tools/virt-edit.pl:67
26988 " virt-edit mydomain /boot/grub/grub.conf\n"
26993 #: ../tools/virt-edit.pl:69
26996 " virt-edit mydomain /etc/passwd\n"
27001 #: ../tools/virt-edit.pl:71
27003 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
27004 "below). To change the init default level to 5:"
27008 #: ../tools/virt-edit.pl:75
27011 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
27016 #: ../tools/virt-edit.pl:87 ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
27017 msgid "Display brief help."
27021 #: ../tools/virt-edit.pl:95 ../tools/virt-win-reg.pl:114 ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
27022 msgid "Display version number and exit."
27026 #: ../tools/virt-edit.pl:101
27027 msgid "B<--backup extension> | B<-b extension>"
27031 #: ../tools/virt-edit.pl:103
27033 "Create a backup of the original file I<in the guest disk image>. The backup "
27034 "has the original filename with C<extension> added."
27038 #: ../tools/virt-edit.pl:106
27040 "Usually the first character of C<extension> would be a dot C<.> so you would "
27045 #: ../tools/virt-edit.pl:109
27048 " virt-edit -b .orig [etc]\n"
27053 #: ../tools/virt-edit.pl:111
27054 msgid "By default, no backup file is made."
27058 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122 ../tools/virt-list-partitions.pl:78
27059 msgid "B<--connect URI> | B<-c URI>"
27063 #: ../tools/virt-edit.pl:119 ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124 ../tools/virt-list-partitions.pl:80
27065 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
27066 "to the default libvirt hypervisor."
27070 #: ../tools/virt-edit.pl:122 ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:83
27072 "If you specify guest block devices directly, then libvirt is not used at "
27077 #: ../tools/virt-edit.pl:129 ../tools/virt-win-reg.pl:140 ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
27078 msgid "B<--format> raw"
27082 #: ../tools/virt-edit.pl:131 ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136 ../tools/virt-list-partitions.pl:92
27084 "Specify the format of disk images given on the command line. If this is "
27085 "omitted then the format is autodetected from the content of the disk image."
27089 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140 ../tools/virt-list-partitions.pl:96
27091 "If disk images are requested from libvirt, then this program asks libvirt "
27092 "for this information. In this case, the value of the format parameter is "
27097 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:150 ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144 ../tools/virt-list-partitions.pl:100
27099 "If working with untrusted raw-format guest disk images, you should ensure "
27100 "the format is always specified."
27104 #: ../tools/virt-edit.pl:146
27105 msgid "B<--expr EXPR> | B<-e EXPR>"
27109 #: ../tools/virt-edit.pl:148
27111 "Instead of launching the external editor, non-interactively apply the Perl "
27112 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
27117 #: ../tools/virt-edit.pl:152
27119 "Be careful to properly quote the expression to prevent it from being altered "
27124 #: ../tools/virt-edit.pl:272
27125 msgid "NON-INTERACTIVE EDITING"
27129 #: ../tools/virt-edit.pl:274
27131 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
27132 "administrator can interactively edit the file."
27136 #: ../tools/virt-edit.pl:277
27138 "There are two ways also to use C<virt-edit> from scripts in order to make "
27139 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
27140 "like this, it's less error-prone to write scripts directly using the "
27141 "libguestfs API and Augeas for configuration file editing.)"
27145 #: ../tools/virt-edit.pl:283
27147 "The first method is to temporarily set C<$EDITOR> to any script or program "
27148 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
27149 "update C<tmpfile> in place however it likes."
27153 #: ../tools/virt-edit.pl:287
27155 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
27156 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
27157 "instances of C<foo> with C<bar> in a file:"
27161 #: ../tools/virt-edit.pl:291
27164 " virt-edit domname filename -e 's/foo/bar/'\n"
27169 #: ../tools/virt-edit.pl:293
27171 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
27172 "For example to delete root's password you could do:"
27176 #: ../tools/virt-edit.pl:296
27179 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
27184 #: ../tools/virt-edit.pl:298
27186 "What really happens is that the snippet is evaluated as a Perl expression "
27187 "for each line of the file. The line, including the final C<\\n>, is passed "
27188 "in C<$_> and the expression should update C<$_> or leave it unchanged."
27192 #: ../tools/virt-edit.pl:303
27194 "To delete a line, set C<$_> to the empty string. For example, to delete the "
27195 "C<apache> user account from the password file you can do:"
27199 #: ../tools/virt-edit.pl:306
27202 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
27207 #: ../tools/virt-edit.pl:308
27209 "To insert a line, prepend or append it to C<$_>. However appending lines to "
27210 "the end of the file is rather difficult this way since there is no concept "
27211 "of \"last line of the file\" - your expression just doesn't get called "
27212 "again. You might want to use the first method (setting C<$EDITOR>) if you "
27217 #: ../tools/virt-edit.pl:314
27219 "The variable C<$lineno> contains the current line number. As is "
27220 "traditional, the first line in the file is number C<1>."
27224 #: ../tools/virt-edit.pl:317
27226 "The return value from the expression is ignored, but the expression may call "
27227 "C<die> in order to abort the whole program, leaving the original file "
27232 #: ../tools/virt-edit.pl:321
27234 "Remember when matching the end of a line that C<$_> may contain the final "
27235 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
27236 "newline then neither of these. Thus to match or substitute some text at the "
27237 "end of a line, use this regular expression:"
27241 #: ../tools/virt-edit.pl:326
27244 " /some text(\\r?\\n)?$/\n"
27249 #: ../tools/virt-edit.pl:328
27251 "Alternately, use the perl C<chomp> function, being careful not to chomp "
27252 "C<$_> itself (since that would remove all newlines from the file):"
27256 #: ../tools/virt-edit.pl:332
27259 " my $m = $_; chomp $m; $m =~ /some text$/\n"
27264 #: ../tools/virt-edit.pl:334
27265 msgid "USING GUESTFISH"
27269 #: ../tools/virt-edit.pl:336
27271 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
27272 "C<virt-edit> doesn't work."
27276 #: ../tools/virt-edit.pl:339
27277 msgid "Using C<virt-edit> is approximately equivalent to doing:"
27281 #: ../tools/virt-edit.pl:341
27284 " guestfish --rw -i -d domname edit /file\n"
27289 #: ../tools/virt-edit.pl:343
27291 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
27292 "path to the file."
27296 #: ../tools/virt-edit.pl:346
27298 "The command above uses libguestfs's guest inspection feature and so does not "
27299 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
27300 "disk images that don't contain guests. To edit a file on a disk image "
27305 #: ../tools/virt-edit.pl:351
27308 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
27313 #: ../tools/virt-edit.pl:353
27315 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
27316 "the disk image to edit, and C</file> is the full path to the file."
27320 #: ../tools/virt-edit.pl:357
27322 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
27323 "C<write> or C<upload> instead:"
27327 #: ../tools/virt-edit.pl:360
27330 " guestfish --rw -i -d domname touch /newfile\n"
27335 #: ../tools/virt-edit.pl:362
27338 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
27343 #: ../tools/virt-edit.pl:364
27346 " guestfish --rw -i -d domname upload localfile /newfile\n"
27351 #: ../tools/virt-edit.pl:366
27352 msgid "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
27356 #: ../tools/virt-edit.pl:369
27359 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
27364 #: ../tools/virt-edit.pl:379
27369 #: ../tools/virt-edit.pl:381
27371 "If set, this string is used as the editor. It may contain arguments, "
27372 "eg. C<\"emacs -nw\">"
27376 #: ../tools/virt-edit.pl:384
27377 msgid "If not set, C<vi> is used."
27381 #: ../tools/virt-edit.pl:388 ../tools/virt-win-reg.pl:559 ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274 ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
27382 msgid "SHELL QUOTING"
27386 #: ../tools/virt-edit.pl:390 ../tools/virt-win-reg.pl:567 ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
27388 "Libvirt guest names can contain arbitrary characters, some of which have "
27389 "meaning to the shell such as C<#> and space. You may need to quote or "
27390 "escape these characters on the command line. See the shell manual page "
27391 "L<sh(1)> for details."
27395 #: ../tools/virt-edit.pl:397
27397 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27398 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
27399 "L<perl(1)>, L<perlre(1)>."
27403 #: ../tools/virt-edit.pl:407 ../tools/virt-win-reg.pl:598 ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
27408 #: ../tools/virt-edit.pl:409 ../tools/virt-win-reg.pl:600 ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
27409 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
27413 #: ../tools/virt-edit.pl:413
27414 msgid "Copyright (C) 2009-2011 Red Hat Inc."
27418 #: ../tools/virt-win-reg.pl:37
27420 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
27425 #: ../tools/virt-win-reg.pl:41
27428 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
27433 #: ../tools/virt-win-reg.pl:43
27436 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
27441 #: ../tools/virt-win-reg.pl:45
27444 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
27449 #: ../tools/virt-win-reg.pl:47
27452 " virt-win-reg --merge domname [input.reg ...]\n"
27457 #: ../tools/virt-win-reg.pl:49
27460 " virt-win-reg [--options] disk.img ... # instead of domname\n"
27465 #: ../tools/virt-win-reg.pl:53
27467 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
27468 "virtual machines. If you do this, you I<will> get irreversible disk "
27469 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
27470 "but doesn't catch all cases."
27474 #: ../tools/virt-win-reg.pl:58
27476 "Modifying the Windows Registry is an inherently risky operation. The format "
27477 "is deliberately obscure and undocumented, and Registry changes can leave the "
27478 "system unbootable. Therefore when using the C<--merge> option, make sure "
27479 "you have a reliable backup first."
27483 #: ../tools/virt-win-reg.pl:65
27485 "This program can export and merge Windows Registry entries from a Windows "
27490 #: ../tools/virt-win-reg.pl:68
27492 "The first parameter is the libvirt guest name or the raw disk image of a "
27497 #: ../tools/virt-win-reg.pl:71
27499 "If C<--merge> is I<not> specified, then the chosen registry key is "
27500 "displayed/exported (recursively). For example:"
27504 #: ../tools/virt-win-reg.pl:74
27507 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
27512 #: ../tools/virt-win-reg.pl:76
27513 msgid "You can also display single values from within registry keys, for example:"
27517 #: ../tools/virt-win-reg.pl:79
27520 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
27521 " $ virt-win-reg Windows7 $cvkey ProductName\n"
27522 " Windows 7 Enterprise\n"
27527 #: ../tools/virt-win-reg.pl:83
27529 "With C<--merge>, you can merge a textual regedit file into the Windows "
27534 #: ../tools/virt-win-reg.pl:86
27537 " $ virt-win-reg --merge Windows7 changes.reg\n"
27542 #: ../tools/virt-win-reg.pl:88
27547 #: ../tools/virt-win-reg.pl:90
27549 "This program is only meant for simple access to the registry. If you want "
27550 "to do complicated things with the registry, we suggest you download the "
27551 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27552 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27553 "L<hivexregedit(1)>."
27557 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
27562 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
27563 msgid "Enable debugging messages."
27567 #: ../tools/virt-win-reg.pl:157
27572 #: ../tools/virt-win-reg.pl:159
27574 "In merge mode, this merges a textual regedit file into the Windows Registry "
27575 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27576 "displays or exports Registry entries instead."
27580 #: ../tools/virt-win-reg.pl:163
27582 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27583 "result in disk corruption. However exporting (without this flag) is always "
27588 #: ../tools/virt-win-reg.pl:171
27589 msgid "B<--encoding> UTF-16LE|ASCII"
27593 #: ../tools/virt-win-reg.pl:173
27595 "When merging (only), you may need to specify the encoding for strings to be "
27596 "used in the hive file. This is explained in detail in "
27597 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
27601 #: ../tools/virt-win-reg.pl:177
27603 "The default is to use UTF-16LE, which should work with recent versions of "
27608 #: ../tools/virt-win-reg.pl:402
27609 msgid "SUPPORTED SYSTEMS"
27613 #: ../tools/virt-win-reg.pl:404
27615 "The program currently supports Windows NT-derived guests starting with "
27616 "Windows XP through to at least Windows 7."
27620 #: ../tools/virt-win-reg.pl:407
27622 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
27623 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
27624 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
27628 #: ../tools/virt-win-reg.pl:411
27630 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
27635 #: ../tools/virt-win-reg.pl:414
27637 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
27642 #: ../tools/virt-win-reg.pl:417
27647 #: ../tools/virt-win-reg.pl:419
27649 "C<virt-win-reg> expects that regedit files have already been reencoded in "
27650 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
27651 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
27652 "with Windows-style line endings, you may need to reencode the whole file "
27653 "before or after processing."
27657 #: ../tools/virt-win-reg.pl:425
27659 "To reencode a file from Windows format to Linux (before processing it with "
27660 "the C<--merge> option), you would do something like this:"
27664 #: ../tools/virt-win-reg.pl:428
27667 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
27672 #: ../tools/virt-win-reg.pl:430
27674 "To go in the opposite direction, after exporting and before sending the file "
27675 "to a Windows user, do something like this:"
27679 #: ../tools/virt-win-reg.pl:433
27682 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
27687 #: ../tools/virt-win-reg.pl:435
27688 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
27692 #: ../tools/virt-win-reg.pl:437
27694 "If you are unsure about the current encoding, use the L<file(1)> command. "
27695 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
27696 "Windows-style (CRLF) line endings, like this:"
27700 #: ../tools/virt-win-reg.pl:441
27703 " $ file software.reg\n"
27704 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
27705 " with CRLF line terminators\n"
27710 #: ../tools/virt-win-reg.pl:445
27711 msgid "This file would need conversion before you could C<--merge> it."
27715 #: ../tools/virt-win-reg.pl:447
27716 msgid "CurrentControlSet etc."
27720 #: ../tools/virt-win-reg.pl:449
27722 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
27723 "Registry at the level of the hive file, and therefore you cannot modify "
27728 #: ../tools/virt-win-reg.pl:453
27730 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
27731 "circumstances it might refer to another control set. The way to find out is "
27732 "to look at the C<HKLM\\SYSTEM\\Select> key:"
27736 #: ../tools/virt-win-reg.pl:457
27739 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
27740 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
27741 " \"Current\"=dword:00000001\n"
27742 " \"Default\"=dword:00000001\n"
27743 " \"Failed\"=dword:00000000\n"
27744 " \"LastKnownGood\"=dword:00000002\n"
27749 #: ../tools/virt-win-reg.pl:464
27750 msgid "\"Current\" is the one which Windows will choose when it boots."
27754 #: ../tools/virt-win-reg.pl:466
27755 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
27759 #: ../tools/virt-win-reg.pl:469
27760 msgid "WINDOWS TIPS"
27764 #: ../tools/virt-win-reg.pl:471
27766 "Note that some of these tips modify the guest disk image. The guest I<must> "
27767 "be shut off, else you will get disk corruption."
27771 #: ../tools/virt-win-reg.pl:474
27772 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
27776 #: ../tools/virt-win-reg.pl:476
27778 "Prepare a DOS batch script, VBScript or executable. Upload this using "
27779 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
27780 "is uploaded into C<C:\\>:"
27784 #: ../tools/virt-win-reg.pl:480
27787 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
27792 #: ../tools/virt-win-reg.pl:482
27793 msgid "Prepare a regedit file containing the registry change:"
27797 #: ../tools/virt-win-reg.pl:484
27800 " cat > test.reg <<'EOF'\n"
27801 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
27802 " \"Test\"=\"c:\\\\test.bat\"\n"
27808 #: ../tools/virt-win-reg.pl:489
27810 "In this example we use the key C<RunOnce> which means that the script will "
27811 "run precisely once when the first user logs in. If you want it to run every "
27812 "time a user logs in, replace C<RunOnce> with C<Run>."
27816 #: ../tools/virt-win-reg.pl:493
27817 msgid "Now update the registry:"
27821 #: ../tools/virt-win-reg.pl:495
27824 " virt-win-reg --merge WindowsGuest test.reg\n"
27829 #: ../tools/virt-win-reg.pl:497
27830 msgid "INSTALLING A SERVICE"
27834 #: ../tools/virt-win-reg.pl:499
27836 "This section assumes you are familiar with Windows services, and you either "
27837 "have a program which handles the Windows Service Control Protocol directly "
27838 "or you want to run any program using a service wrapper like SrvAny or the "
27843 #: ../tools/virt-win-reg.pl:504
27845 "First upload the program and optionally the service wrapper. In this case "
27846 "the test program is called C<test.exe> and we are using the RHSrvAny "
27851 #: ../tools/virt-win-reg.pl:508
27854 " guestfish -i -d WindowsGuest <<EOF\n"
27855 " upload rhsrvany.exe /rhsrvany.exe\n"
27856 " upload test.exe /test.exe\n"
27862 #: ../tools/virt-win-reg.pl:513
27864 "Prepare a regedit file containing the registry changes. In this example, "
27865 "the first registry change is needed for the service itself or the service "
27866 "wrapper (if used). The second registry change is only needed because I am "
27867 "using the RHSrvAny service wrapper."
27871 #: ../tools/virt-win-reg.pl:518
27874 " cat > service.reg <<'EOF'\n"
27875 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
27876 " \"Type\"=dword:00000010\n"
27877 " \"Start\"=dword:00000002\n"
27878 " \"ErrorControl\"=dword:00000001\n"
27879 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
27880 " \"DisplayName\"=\"RHSrvAny\"\n"
27881 " \"ObjectName\"=\"NetworkService\"\n"
27886 #: ../tools/virt-win-reg.pl:527
27889 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
27890 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
27891 " \"PWD\"=\"c:\\\\Temp\"\n"
27897 #: ../tools/virt-win-reg.pl:538
27899 "For use of C<ControlSet001> see the section above in this manual page. You "
27900 "may need to adjust this according to the control set that is in use by the "
27905 #: ../tools/virt-win-reg.pl:544
27907 "C<\"ObjectName\"> controls the privileges that the service will have. An "
27908 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
27909 "privileged account."
27913 #: ../tools/virt-win-reg.pl:550
27915 "For the meaning of the magic numbers, see this Microsoft KB article: "
27916 "L<http://support.microsoft.com/kb/103000>."
27920 #: ../tools/virt-win-reg.pl:555
27921 msgid "Update the registry:"
27925 #: ../tools/virt-win-reg.pl:557
27928 " virt-win-reg --merge WindowsGuest service.reg\n"
27933 #: ../tools/virt-win-reg.pl:561
27935 "Be careful when passing parameters containing C<\\> (backslash) in the "
27936 "shell. Usually you will have to use 'single quotes' or double backslashes "
27937 "(but not both) to protect them from the shell."
27941 #: ../tools/virt-win-reg.pl:565
27942 msgid "Paths and value names are case-insensitive."
27946 #: ../tools/virt-win-reg.pl:574
27948 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
27949 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27950 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
27951 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27955 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
27957 "When reporting bugs, please enable debugging and capture the I<complete> "
27962 #: ../tools/virt-win-reg.pl:592
27965 " export LIBGUESTFS_DEBUG=1\n"
27966 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
27971 #: ../tools/virt-win-reg.pl:595
27973 "Attach /tmp/virt-win-reg.log to a new bug report at "
27974 "L<https://bugzilla.redhat.com/>"
27978 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:570
27979 msgid "Copyright (C) 2010 Red Hat Inc."
27983 #: ../tools/virt-resize.pl:42
27984 msgid "virt-resize - Resize a virtual machine disk"
27988 #: ../tools/virt-resize.pl:46
27991 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27992 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27993 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27998 #: ../tools/virt-resize.pl:52
28000 "Virt-resize is a tool which can resize a virtual machine disk, making it "
28001 "larger or smaller overall, and resizing or deleting any partitions contained "
28006 #: ../tools/virt-resize.pl:56
28008 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
28009 "not> be used on live virtual machines - for consistent results, shut the "
28010 "virtual machine down before resizing it."
28014 #: ../tools/virt-resize.pl:60
28016 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
28017 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
28021 #: ../tools/virt-resize.pl:66
28023 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
28024 "fill the extra 5GB of space."
28028 #: ../tools/virt-resize.pl:69
28031 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
28032 " virt-filesystems --long -h --all -a olddisk\n"
28033 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
28034 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
28039 #: ../tools/virt-resize.pl:74
28041 "As above, but make the /boot partition 200MB bigger, while giving the "
28042 "remaining space to /dev/sda2:"
28046 #: ../tools/virt-resize.pl:77
28049 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
28054 #: ../tools/virt-resize.pl:79
28055 msgid "As above, but the output format will be uncompressed qcow2:"
28059 #: ../tools/virt-resize.pl:81
28062 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
28063 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
28068 #: ../tools/virt-resize.pl:84
28069 msgid "DETAILED USAGE"
28073 #: ../tools/virt-resize.pl:86
28074 msgid "EXPANDING A VIRTUAL MACHINE DISK"
28078 #: ../tools/virt-resize.pl:90
28079 msgid "1. Shut down the virtual machine"
28083 #: ../tools/virt-resize.pl:92
28084 msgid "2. Locate input disk image"
28088 #: ../tools/virt-resize.pl:94
28090 "Locate the input disk image (ie. the file or device on the host containing "
28091 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
28092 "dumpxml> like this to find the disk image name:"
28096 #: ../tools/virt-resize.pl:98
28099 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
28100 " Found 1 nodes:\n"
28102 " <source dev=\"/dev/vg/lv_guest\" />\n"
28107 #: ../tools/virt-resize.pl:103
28108 msgid "3. Look at current sizing"
28112 #: ../tools/virt-resize.pl:105
28113 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
28117 #: ../tools/virt-resize.pl:108
28120 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
28121 " Name Type Size Parent\n"
28122 " /dev/sda1 partition 101M /dev/sda\n"
28123 " /dev/sda2 partition 7.9G /dev/sda\n"
28124 " /dev/sda device 8.0G -\n"
28129 #: ../tools/virt-resize.pl:114
28131 "(This example is a virtual machine with an 8 GB disk which we would like to "
28132 "expand up to 10 GB)."
28136 #: ../tools/virt-resize.pl:117
28137 msgid "4. Create output disk"
28141 #: ../tools/virt-resize.pl:119
28143 "Virt-resize cannot do in-place disk modifications. You have to have space "
28144 "to store the resized output disk."
28148 #: ../tools/virt-resize.pl:122
28149 msgid "To store the resized disk image in a file, create a file of a suitable size:"
28153 #: ../tools/virt-resize.pl:125
28156 " # rm -f outdisk\n"
28157 " # truncate -s 10G outdisk\n"
28162 #: ../tools/virt-resize.pl:128
28163 msgid "Or use L<lvcreate(1)> to create a logical volume:"
28167 #: ../tools/virt-resize.pl:130
28170 " # lvcreate -L 10G -n lv_name vg_name\n"
28175 #: ../tools/virt-resize.pl:132
28176 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
28180 #: ../tools/virt-resize.pl:134
28183 " # virsh pool-list\n"
28184 " # virsh vol-create-as poolname newvol 10G\n"
28189 #: ../tools/virt-resize.pl:137
28194 #: ../tools/virt-resize.pl:139
28196 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
28197 "file) and the output disk. The output disk is the one created in the "
28202 #: ../tools/virt-resize.pl:143
28205 " # virt-resize indisk outdisk\n"
28210 #: ../tools/virt-resize.pl:145
28212 "This command just copies disk image C<indisk> to disk image C<outdisk> "
28213 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
28214 "larger, then an extra, empty partition is created at the end of the disk "
28215 "covering the extra space. If C<outdisk> is smaller, then it will give an "
28220 #: ../tools/virt-resize.pl:151
28222 "More realistically you'd want to expand existing partitions in the disk "
28223 "image by passing extra options (for the full list see the L</OPTIONS> "
28228 #: ../tools/virt-resize.pl:155
28230 "L</--expand> is the most useful option. It expands the named partition "
28231 "within the disk to fill any extra space:"
28235 #: ../tools/virt-resize.pl:158
28238 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
28243 #: ../tools/virt-resize.pl:160
28245 "(In this case, an extra partition is I<not> created at the end of the disk, "
28246 "because there will be no unused space)."
28250 #: ../tools/virt-resize.pl:163
28252 "L</--resize> is the other commonly used option. The following would "
28253 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
28254 "rest of the available space:"
28258 #: ../tools/virt-resize.pl:167
28261 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
28262 " indisk outdisk\n"
28267 #: ../tools/virt-resize.pl:170
28269 "If the expanded partition in the image contains a filesystem or LVM PV, then "
28270 "if virt-resize knows how, it will resize the contents, the equivalent of "
28271 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
28272 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
28273 "filesystems, so you would have to online resize them after booting the "
28278 #: ../tools/virt-resize.pl:177
28279 msgid "Other options are covered below."
28283 #: ../tools/virt-resize.pl:179
28288 #: ../tools/virt-resize.pl:181
28289 msgid "Thoroughly test the new disk image I<before> discarding the old one."
28293 #: ../tools/virt-resize.pl:183
28294 msgid "If you are using libvirt, edit the XML to point at the new disk:"
28298 #: ../tools/virt-resize.pl:185
28301 " # virsh edit guestname\n"
28306 #: ../tools/virt-resize.pl:187
28308 "Change E<lt>source ...E<gt>, see "
28309 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
28313 #: ../tools/virt-resize.pl:190
28314 msgid "Then start up the domain with the new, resized disk:"
28318 #: ../tools/virt-resize.pl:192
28321 " # virsh start guestname\n"
28326 #: ../tools/virt-resize.pl:194
28328 "and check that it still works. See also the L</NOTES> section below for "
28329 "additional information."
28333 #: ../tools/virt-resize.pl:197
28334 msgid "7. Resize LVs etc inside the guest"
28338 #: ../tools/virt-resize.pl:199
28339 msgid "(This can also be done offline using L<guestfish(1)>)"
28343 #: ../tools/virt-resize.pl:201
28345 "Once the guest has booted you should see the new space available, at least "
28346 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
28347 "may need to resize LVs inside PVs, and also resize filesystem types that "
28348 "virt-resize does not know how to expand."
28352 #: ../tools/virt-resize.pl:208
28353 msgid "SHRINKING A VIRTUAL MACHINE DISK"
28357 #: ../tools/virt-resize.pl:210
28359 "Shrinking is somewhat more complex than expanding, and only an overview is "
28364 #: ../tools/virt-resize.pl:213
28366 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
28367 "filesystems). The user has to shrink content before passing the disk image "
28368 "to virt-resize, and virt-resize will check that the content has been shrunk "
28373 #: ../tools/virt-resize.pl:218
28374 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28378 #: ../tools/virt-resize.pl:220
28380 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28381 "steps 3 and 4 above to allocate a new disk image."
28385 #: ../tools/virt-resize.pl:223
28386 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28390 #: ../tools/virt-resize.pl:226
28391 msgid "IGNORING OR DELETING PARTITIONS"
28395 #: ../tools/virt-resize.pl:228
28397 "virt-resize also gives a convenient way to ignore or delete partitions when "
28398 "copying from the input disk to the output disk. Ignoring a partition speeds "
28399 "up the copy where you don't care about the existing contents of a "
28400 "partition. Deleting a partition removes it completely, but note that it "
28401 "also renumbers any partitions after the one which is deleted, which can "
28402 "leave some guests unbootable."
28406 #: ../tools/virt-resize.pl:235
28407 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28411 #: ../tools/virt-resize.pl:237
28413 "If the input disk is in qcow2 format, then you may prefer that the output is "
28414 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28415 "the fly. The output format is simply determined by the format of the empty "
28416 "output container that you provide. Thus to create qcow2 output, use:"
28420 #: ../tools/virt-resize.pl:243
28423 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28428 #: ../tools/virt-resize.pl:245
28429 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28433 #: ../tools/virt-resize.pl:247
28434 msgid "Similarly, to get non-sparse raw output use:"
28438 #: ../tools/virt-resize.pl:249
28441 " fallocate -l size outdisk\n"
28446 #: ../tools/virt-resize.pl:251
28448 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
28449 "if=/dev/zero of=outdisk bs=1M count=..>)"
28453 #: ../tools/virt-resize.pl:264
28454 msgid "Display help."
28458 #: ../tools/virt-resize.pl:278
28459 msgid "B<--resize part=size>"
28463 #: ../tools/virt-resize.pl:280
28465 "Resize the named partition (expanding or shrinking it) so that it has the "
28470 #: ../tools/virt-resize.pl:283
28472 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28473 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28474 "Exabytes; or as a percentage of the current size; or as a relative number or "
28475 "percentage. For example:"
28479 #: ../tools/virt-resize.pl:288
28482 " --resize /dev/sda2=10G\n"
28487 #: ../tools/virt-resize.pl:290
28490 " --resize /dev/sda4=90%\n"
28495 #: ../tools/virt-resize.pl:292
28498 " --resize /dev/sda2=+1G\n"
28503 #: ../tools/virt-resize.pl:294
28506 " --resize /dev/sda2=-200M\n"
28511 #: ../tools/virt-resize.pl:296
28514 " --resize /dev/sda1=+128K\n"
28519 #: ../tools/virt-resize.pl:298
28522 " --resize /dev/sda1=+10%\n"
28527 #: ../tools/virt-resize.pl:300
28530 " --resize /dev/sda1=-10%\n"
28535 #: ../tools/virt-resize.pl:302
28537 "You can increase the size of any partition. Virt-resize will expand the "
28538 "direct content of the partition if it knows how (see C<--expand> below)."
28542 #: ../tools/virt-resize.pl:306
28544 "You can only I<decrease> the size of partitions that contain filesystems or "
28545 "PVs which have already been shrunk. Virt-resize will check this has been "
28546 "done before proceeding, or else will print an error (see also "
28547 "C<--resize-force>)."
28551 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
28552 msgid "You can give this option multiple times."
28556 #: ../tools/virt-resize.pl:317
28557 msgid "B<--resize-force part=size>"
28561 #: ../tools/virt-resize.pl:319
28563 "This is the same as C<--resize> except that it will let you decrease the "
28564 "size of any partition. Generally this means you will lose any data which "
28565 "was at the end of the partition you shrink, but you may not care about that "
28566 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28567 "as a swap partition)."
28571 #: ../tools/virt-resize.pl:325
28572 msgid "See also the C<--ignore> option."
28576 #: ../tools/virt-resize.pl:331
28577 msgid "B<--expand part>"
28581 #: ../tools/virt-resize.pl:333
28583 "Expand the named partition so it uses up all extra space (space left over "
28584 "after any other resize changes that you request have been done)."
28588 #: ../tools/virt-resize.pl:336
28590 "If virt-resize knows how, it will expand the direct content of the "
28591 "partition. For example, if the partition is an LVM PV, it will expand the "
28592 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28593 "content it doesn't know about alone."
28597 #: ../tools/virt-resize.pl:341
28598 msgid "Currently virt-resize can resize:"
28602 #: ../tools/virt-resize.pl:347
28604 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28609 #: ../tools/virt-resize.pl:352
28611 "NTFS filesystems contained directly in a partition, if libguestfs was "
28612 "compiled with support for NTFS."
28616 #: ../tools/virt-resize.pl:355
28618 "The filesystem must have been shut down consistently last time it was used. "
28619 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
28620 "consistency check, so at the first boot after resizing Windows will check "
28625 #: ../tools/virt-resize.pl:362
28627 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
28628 "inside the PV, but see the C<--LV-expand> option. The user could also "
28629 "resize LVs as desired after boot."
28633 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
28634 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
28638 #: ../tools/virt-resize.pl:374
28639 msgid "B<--shrink part>"
28643 #: ../tools/virt-resize.pl:376
28645 "Shrink the named partition until the overall disk image fits in the "
28646 "destination. The named partition B<must> contain a filesystem or PV which "
28647 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
28648 "online tools). Virt-resize will check this and give an error if it has not "
28653 #: ../tools/virt-resize.pl:382
28655 "The amount by which the overall disk must be shrunk (after carrying out all "
28656 "other operations requested by the user) is called the \"deficit\". For "
28657 "example, a straight copy (assume no other operations) from a 5GB disk image "
28658 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
28659 "would give an error unless the user specified a partition to shrink and that "
28660 "partition had more than a gigabyte of free space."
28664 #: ../tools/virt-resize.pl:396
28665 msgid "B<--ignore part>"
28669 #: ../tools/virt-resize.pl:398
28671 "Ignore the named partition. Effectively this means the partition is "
28672 "allocated on the destination disk, but the content is not copied across from "
28673 "the source disk. The content of the partition will be blank (all zero "
28678 #: ../tools/virt-resize.pl:409
28679 msgid "B<--delete part>"
28683 #: ../tools/virt-resize.pl:411
28685 "Delete the named partition. It would be more accurate to describe this as "
28686 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
28687 "the original disk image is left intact."
28691 #: ../tools/virt-resize.pl:415
28693 "Note that when you delete a partition, then anything contained in the "
28694 "partition is also deleted. Furthermore, this causes any partitions that "
28695 "come after to be I<renumbered>, which can easily make your guest unbootable."
28699 #: ../tools/virt-resize.pl:426
28700 msgid "B<--LV-expand logvol>"
28704 #: ../tools/virt-resize.pl:428
28706 "This takes the logical volume and, as a final step, expands it to fill all "
28707 "the space available in its volume group. A typical usage, assuming a Linux "
28708 "guest with a single PV C</dev/sda2> and a root device called "
28709 "C</dev/vg_guest/lv_root> would be:"
28713 #: ../tools/virt-resize.pl:433
28716 " virt-resize indisk outdisk \\\n"
28717 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
28722 #: ../tools/virt-resize.pl:436
28724 "This would first expand the partition (and PV), and then expand the root "
28725 "device to fill the extra space in the PV."
28729 #: ../tools/virt-resize.pl:439
28731 "The contents of the LV are also resized if virt-resize knows how to do "
28732 "that. You can stop virt-resize from trying to expand the content by using "
28733 "the option C<--no-expand-content>."
28737 #: ../tools/virt-resize.pl:443
28738 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
28742 #: ../tools/virt-resize.pl:446
28744 "You can give this option multiple times, I<but> it doesn't make sense to do "
28745 "this unless the logical volumes you specify are all in different volume "
28750 #: ../tools/virt-resize.pl:454
28751 msgid "B<--no-copy-boot-loader>"
28755 #: ../tools/virt-resize.pl:456
28757 "By default, virt-resize copies over some sectors at the start of the disk "
28758 "(up to the beginning of the first partition). Commonly these sectors "
28759 "contain the Master Boot Record (MBR) and the boot loader, and are required "
28760 "in order for the guest to boot correctly."
28764 #: ../tools/virt-resize.pl:461
28766 "If you specify this flag, then this initial copy is not done. You may need "
28767 "to reinstall the boot loader in this case."
28771 #: ../tools/virt-resize.pl:469
28772 msgid "B<--no-extra-partition>"
28776 #: ../tools/virt-resize.pl:471
28778 "By default, virt-resize creates an extra partition if there is any extra, "
28779 "unused space after all resizing has happened. Use this option to prevent "
28780 "the extra partition from being created. If you do this then the extra space "
28781 "will be inaccessible until you run fdisk, parted, or some other partitioning "
28782 "tool in the guest."
28786 #: ../tools/virt-resize.pl:477
28788 "Note that if the surplus space is smaller than 10 MB, no extra partition "
28793 #: ../tools/virt-resize.pl:484
28794 msgid "B<--no-expand-content>"
28798 #: ../tools/virt-resize.pl:486
28800 "By default, virt-resize will try to expand the direct contents of "
28801 "partitions, if it knows how (see C<--expand> option above)."
28805 #: ../tools/virt-resize.pl:489
28807 "If you give the C<--no-expand-content> option then virt-resize will not "
28812 #: ../tools/virt-resize.pl:496
28813 msgid "B<-d> | B<--debug>"
28817 #: ../tools/virt-resize.pl:504
28818 msgid "B<-n> | B<--dryrun>"
28822 #: ../tools/virt-resize.pl:506
28823 msgid "Print a summary of what would be done, but don't do anything."
28827 #: ../tools/virt-resize.pl:512
28828 msgid "B<-q> | B<--quiet>"
28832 #: ../tools/virt-resize.pl:514
28833 msgid "Don't print the summary."
28837 #: ../tools/virt-resize.pl:522
28839 "Specify the format of the input disk image. If this flag is not given then "
28840 "it is auto-detected from the image itself."
28844 #: ../tools/virt-resize.pl:528
28846 "Note that this option I<does not> affect the output format. See L</QCOW2 "
28847 "AND NON-SPARSE RAW FORMATS>."
28851 #: ../tools/virt-resize.pl:535
28852 msgid "B<--output-format> raw"
28856 #: ../tools/virt-resize.pl:537
28858 "Specify the format of the output disk image. If this flag is not given then "
28859 "it is auto-detected from the image itself."
28863 #: ../tools/virt-resize.pl:543
28865 "Note that you still need to create the output disk with the right format. "
28866 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28870 #: ../tools/virt-resize.pl:1419
28875 #: ../tools/virt-resize.pl:1421
28876 msgid "\"Partition 1 does not end on cylinder boundary.\""
28880 #: ../tools/virt-resize.pl:1423
28882 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28883 "means the partitions will not be aligned to the ancient CHS geometry. "
28884 "However CHS geometry is meaningless for disks manufactured since the early "
28885 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28886 "cylinders is not required by any modern operating system."
28890 #: ../tools/virt-resize.pl:1430
28891 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28895 #: ../tools/virt-resize.pl:1432
28897 "In Windows Vista and later versions, Microsoft switched to using a separate "
28898 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28899 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28900 "the boot partition. Doing so seems to break the guest completely. However "
28901 "expanding the second partition (ie. C: drive) should work."
28905 #: ../tools/virt-resize.pl:1439
28907 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28908 "NTFS partitions have been expanded. This is just a safety check and (unless "
28909 "it find errors) is nothing to worry about."
28913 #: ../tools/virt-resize.pl:1443
28914 msgid "GUEST BOOT STUCK AT \"GRUB\""
28918 #: ../tools/virt-resize.pl:1445
28920 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28921 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28922 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28923 "although we think is to do with partition alignment."
28927 #: ../tools/virt-resize.pl:1450
28930 " guestfish -i -a newdisk\n"
28931 " ><fs> cat /boot/grub/device.map\n"
28932 " # check the contents of this file are sensible or\n"
28933 " # edit the file if necessary\n"
28934 " ><fs> grub-install / /dev/vda\n"
28940 #: ../tools/virt-resize.pl:1457
28942 "For more flexible guest reconfiguration, including if you need to specify "
28943 "other parameters to grub-install, use L<virt-rescue(1)>."
28947 #: ../tools/virt-resize.pl:1460
28948 msgid "ALTERNATIVE TOOLS"
28952 #: ../tools/virt-resize.pl:1462
28954 "There are several proprietary tools for resizing partitions. We won't "
28955 "mention any here."
28959 #: ../tools/virt-resize.pl:1465
28961 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28962 "operations on disk images. They can resize and move partitions, but I don't "
28963 "think they can do anything with the contents, and they certainly don't "
28968 #: ../tools/virt-resize.pl:1470
28970 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28971 "but at a much lower level. You will probably end up hand-calculating sector "
28972 "offsets, which is something that virt-resize was designed to avoid. If you "
28973 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
28978 #: ../tools/virt-resize.pl:1485
28980 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
28981 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
28982 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
28983 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
28984 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28988 #: ../tools/virt-list-filesystems.pl:32
28989 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28993 #: ../tools/virt-list-filesystems.pl:36
28996 " virt-list-filesystems [--options] domname\n"
29001 #: ../tools/virt-list-filesystems.pl:38
29004 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29009 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29011 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29016 #: ../tools/virt-list-filesystems.pl:45
29018 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29019 "are contained in a virtual machine or disk image."
29023 #: ../tools/virt-list-filesystems.pl:49
29025 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29026 "functionality. For more complex cases you should look at the "
29027 "L<guestfish(1)> tool."
29031 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29032 msgid "B<-l> | B<--long>"
29036 #: ../tools/virt-list-filesystems.pl:108
29038 "With this option, C<virt-list-filesystems> displays the type of each "
29039 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29043 #: ../tools/virt-list-filesystems.pl:115
29044 msgid "B<-a> | B<--all>"
29048 #: ../tools/virt-list-filesystems.pl:117
29050 "Normally we only show mountable filesystems. If this option is given then "
29051 "swap devices are shown too."
29055 #: ../tools/virt-list-filesystems.pl:191
29057 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29058 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29059 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29063 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
29064 msgid "Copyright (C) 2009 Red Hat Inc."
29068 #: ../tools/virt-tar.pl:33
29069 msgid "virt-tar - Extract or upload files to a virtual machine"
29073 #: ../tools/virt-tar.pl:37
29076 " virt-tar [--options] -x domname directory tarball\n"
29081 #: ../tools/virt-tar.pl:39
29084 " virt-tar [--options] -u domname tarball directory\n"
29089 #: ../tools/virt-tar.pl:41
29092 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29097 #: ../tools/virt-tar.pl:43
29100 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29105 #: ../tools/virt-tar.pl:47
29106 msgid "Download C</home> from the VM into a local tarball:"
29110 #: ../tools/virt-tar.pl:49
29113 " virt-tar -x domname /home home.tar\n"
29118 #: ../tools/virt-tar.pl:51
29121 " virt-tar -zx domname /home home.tar.gz\n"
29126 #: ../tools/virt-tar.pl:53
29127 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29131 #: ../tools/virt-tar.pl:55
29134 " virt-tar -u domname uploadstuff.tar /tmp\n"
29139 #: ../tools/virt-tar.pl:57
29142 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29147 #: ../tools/virt-tar.pl:61
29149 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
29150 "virtual machines. If you do this, you risk disk corruption in the VM. "
29151 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29155 #: ../tools/virt-tar.pl:66
29157 "You can use C<-x> (extract) on live virtual machines, but you might get "
29158 "inconsistent results or errors if there is filesystem activity inside the "
29159 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29160 "work, but the only way to guarantee consistent results is if the virtual "
29161 "machine is shut down."
29165 #: ../tools/virt-tar.pl:74
29167 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29168 "parts of a guest filesystem. There are many possibilities: making backups, "
29169 "uploading data files, snooping on guest activity, fixing or customizing "
29174 #: ../tools/virt-tar.pl:79
29176 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29177 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29178 "should look at the L<guestfish(1)> tool."
29182 #: ../tools/virt-tar.pl:83
29184 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
29185 "its contents (recursively) from the virtual machine into a local tarball. "
29186 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
29187 "virtual machine. You cannot use these two options together."
29191 #: ../tools/virt-tar.pl:89
29193 "In addition, you may need to use the C<-z> (gZip) option to enable "
29194 "compression. When uploading, you have to specify C<-z> if the upload file "
29195 "is compressed because virt-tar won't detect this on its own."
29199 #: ../tools/virt-tar.pl:93
29201 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29202 "example it cannot do PKZip files or bzip2 compression. If you want that "
29203 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29204 "the L<libguestfs(3)> API)."
29208 #: ../tools/virt-tar.pl:151
29209 msgid "B<-x> | B<--extract> | B<--download>"
29213 #: ../tools/virt-tar.pl:153
29214 msgid "B<-u> | B<--upload>"
29218 #: ../tools/virt-tar.pl:155
29220 "Use C<-x> to extract (download) a directory from a virtual machine to a "
29225 #: ../tools/virt-tar.pl:158
29227 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
29228 "Please read the L</WARNING> section above before using this option."
29232 #: ../tools/virt-tar.pl:162
29233 msgid "You must specify exactly one of these options."
29237 #: ../tools/virt-tar.pl:168
29238 msgid "B<-z> | B<--gzip>"
29242 #: ../tools/virt-tar.pl:170
29243 msgid "Specify that the input or output tarball is gzip-compressed."
29247 #: ../tools/virt-tar.pl:283
29249 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29250 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29251 "L<http://libguestfs.org/>."
29255 #: ../tools/virt-make-fs.pl:37
29256 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29260 #: ../tools/virt-make-fs.pl:41
29263 " virt-make-fs [--options] input.tar output.img\n"
29268 #: ../tools/virt-make-fs.pl:43
29271 " virt-make-fs [--options] input.tar.gz output.img\n"
29276 #: ../tools/virt-make-fs.pl:45
29279 " virt-make-fs [--options] directory output.img\n"
29284 #: ../tools/virt-make-fs.pl:49
29286 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29287 "archive or some files in a directory. It is similar to tools like "
29288 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29289 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29290 "useful if you want to attach these filesystems to existing virtual machines "
29291 "(eg. to import large amounts of read-only data to a VM)."
29295 #: ../tools/virt-make-fs.pl:57
29296 msgid "Basic usage is:"
29300 #: ../tools/virt-make-fs.pl:59
29303 " virt-make-fs input output\n"
29308 #: ../tools/virt-make-fs.pl:61
29310 "where C<input> is either a directory containing files that you want to add, "
29311 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29312 "C<output> is a disk image. The input type is detected automatically. The "
29313 "output disk image defaults to a raw ext2 image unless you specify extra "
29314 "flags (see L</OPTIONS> below)."
29318 #: ../tools/virt-make-fs.pl:67
29319 msgid "EXTRA SPACE"
29323 #: ../tools/virt-make-fs.pl:69
29325 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29326 "the files that it contains, but might have extra space. Depending on how "
29327 "you are going to use the output, you might think this extra space is wasted "
29328 "and want to minimize it, or you might want to leave space so that more files "
29329 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29330 "but you can use the C<--size> flag to leave space in the filesystem if you "
29335 #: ../tools/virt-make-fs.pl:77
29337 "An alternative way to leave extra space but not make the output image any "
29338 "bigger is to use an alternative disk image format (instead of the default "
29339 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29340 "image format (check your hypervisor supports this before using it). This "
29341 "allows you to choose a large C<--size> but the extra space won't actually be "
29342 "allocated in the image until you try to store something in it."
29346 #: ../tools/virt-make-fs.pl:85
29348 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29349 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29350 "to build another image from scratch."
29354 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29359 #: ../tools/virt-make-fs.pl:91
29362 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29367 #: ../tools/virt-make-fs.pl:93
29368 msgid "FILESYSTEM TYPE"
29372 #: ../tools/virt-make-fs.pl:95
29374 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29375 "libguestfs supports can be used (but I<not> read-only formats like "
29376 "ISO9660). Here are some of the more common choices:"
29380 #: ../tools/virt-make-fs.pl:101
29385 #: ../tools/virt-make-fs.pl:103
29387 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29388 "you are not going to use the filesystem in a way that requires the journal, "
29389 "then this is just wasted overhead."
29393 #: ../tools/virt-make-fs.pl:107
29394 msgid "I<ntfs> or I<vfat>"
29398 #: ../tools/virt-make-fs.pl:109
29399 msgid "Useful if exporting data to a Windows guest."
29403 #: ../tools/virt-make-fs.pl:111
29405 "I<Note for vfat>: The tar archive or local directory must only contain files "
29406 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29407 "program running within libguestfs is unable to change the ownership of "
29408 "non-root files, since vfat itself does not support this."
29412 #: ../tools/virt-make-fs.pl:116
29417 #: ../tools/virt-make-fs.pl:118
29419 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29420 "total filesystem size."
29424 #: ../tools/virt-make-fs.pl:125
29427 " virt-make-fs --type=minix input minixfs.img\n"
29432 #: ../tools/virt-make-fs.pl:127
29433 msgid "TO PARTITION OR NOT TO PARTITION"
29437 #: ../tools/virt-make-fs.pl:129
29438 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29442 #: ../tools/virt-make-fs.pl:131
29444 "Adding a partition can make the disk image more compatible with certain "
29445 "virtualized operating systems which don't expect to see a filesystem "
29446 "directly located on a block device (Linux doesn't care and will happily "
29447 "handle both types)."
29451 #: ../tools/virt-make-fs.pl:136
29453 "On the other hand, if you have a partition table then the output image is no "
29454 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29455 "directly on a partitioned disk image. (However libguestfs tools such as "
29456 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29460 #: ../tools/virt-make-fs.pl:144
29461 msgid "Add an MBR partition:"
29465 #: ../tools/virt-make-fs.pl:146
29468 " virt-make-fs --partition -- input disk.img\n"
29473 #: ../tools/virt-make-fs.pl:148
29475 "If the output disk image could be terabyte-sized or larger, it's better to "
29476 "use an EFI/GPT-compatible partition table:"
29480 #: ../tools/virt-make-fs.pl:151
29483 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29488 #: ../tools/virt-make-fs.pl:179
29489 msgid "Enable debugging information."
29493 #: ../tools/virt-make-fs.pl:185
29494 msgid "B<--size=E<lt>NE<gt>>"
29498 #: ../tools/virt-make-fs.pl:187
29499 msgid "B<--size=+E<lt>NE<gt>>"
29503 #: ../tools/virt-make-fs.pl:189
29504 msgid "B<-s E<lt>NE<gt>>"
29508 #: ../tools/virt-make-fs.pl:191
29509 msgid "B<-s +E<lt>NE<gt>>"
29513 #: ../tools/virt-make-fs.pl:193
29514 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29518 #: ../tools/virt-make-fs.pl:196
29520 "If this option is I<not> given, then the output image will be just large "
29521 "enough to contain all the files, with not much wasted space."
29525 #: ../tools/virt-make-fs.pl:199
29527 "To choose a fixed size output disk, specify an absolute number followed by "
29528 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29529 "Petabytes or Exabytes. This must be large enough to contain all the input "
29530 "files, else you will get an error."
29534 #: ../tools/virt-make-fs.pl:204
29536 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29537 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29538 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29539 "the input files, and (approximately) an extra 200 MB free space."
29543 #: ../tools/virt-make-fs.pl:210
29545 "Note that virt-make-fs estimates free space, and therefore will not produce "
29546 "filesystems containing precisely the free space requested. (It is much more "
29547 "expensive and time-consuming to produce a filesystem which has precisely the "
29548 "desired free space)."
29552 #: ../tools/virt-make-fs.pl:219
29553 msgid "B<--format=E<lt>fmtE<gt>>"
29557 #: ../tools/virt-make-fs.pl:221
29558 msgid "B<-F E<lt>fmtE<gt>>"
29562 #: ../tools/virt-make-fs.pl:223
29563 msgid "Choose the output disk image format."
29567 #: ../tools/virt-make-fs.pl:225
29568 msgid "The default is C<raw> (raw disk image)."
29572 #: ../tools/virt-make-fs.pl:227
29574 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29575 "that would really make sense here is C<qcow2>."
29579 #: ../tools/virt-make-fs.pl:234
29580 msgid "B<--type=E<lt>fsE<gt>>"
29584 #: ../tools/virt-make-fs.pl:236
29585 msgid "B<-t E<lt>fsE<gt>>"
29589 #: ../tools/virt-make-fs.pl:238
29590 msgid "Choose the output filesystem type."
29594 #: ../tools/virt-make-fs.pl:240
29595 msgid "The default is C<ext2>."
29599 #: ../tools/virt-make-fs.pl:242
29600 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29604 #: ../tools/virt-make-fs.pl:249
29605 msgid "B<--partition>"
29609 #: ../tools/virt-make-fs.pl:251
29610 msgid "B<--partition=E<lt>parttypeE<gt>>"
29614 #: ../tools/virt-make-fs.pl:253
29616 "If specified, this flag adds an MBR partition table to the output disk "
29621 #: ../tools/virt-make-fs.pl:256
29623 "You can change the partition table type, eg. C<--partition=gpt> for large "
29628 #: ../tools/virt-make-fs.pl:259
29630 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29631 "might consider the next parameter to be the partition type. For example:"
29635 #: ../tools/virt-make-fs.pl:263
29638 " virt-make-fs --partition input.tar ...\n"
29643 #: ../tools/virt-make-fs.pl:265
29645 "would cause virt-make-fs to think you wanted to use a partition type of "
29646 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29647 "dash) between options and the input file argument:"
29651 #: ../tools/virt-make-fs.pl:269
29654 " virt-make-fs --partition -- input.tar ...\n"
29659 #: ../tools/virt-make-fs.pl:541
29661 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
29662 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29663 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29667 #: ../tools/virt-make-fs.pl:558
29670 " export LIBGUESTFS_DEBUG=1\n"
29671 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29676 #: ../tools/virt-make-fs.pl:561
29678 "Attach /tmp/virt-make-fs.log to a new bug report at "
29679 "L<https://bugzilla.redhat.com/>"
29683 #: ../tools/virt-list-partitions.pl:32
29684 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29688 #: ../tools/virt-list-partitions.pl:36
29691 " virt-list-partitions [--options] domname\n"
29696 #: ../tools/virt-list-partitions.pl:38
29699 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29704 #: ../tools/virt-list-partitions.pl:45
29706 "C<virt-list-partitions> is a command line tool to list the partitions that "
29707 "are contained in a virtual machine or disk image. It is mainly useful as a "
29708 "first step to using L<virt-resize(1)>."
29712 #: ../tools/virt-list-partitions.pl:50
29714 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29715 "functionality. For more complex cases you should look at the "
29716 "L<guestfish(1)> tool."
29720 #: ../tools/virt-list-partitions.pl:107
29721 msgid "B<-h> | B<--human-readable>"
29725 #: ../tools/virt-list-partitions.pl:109
29726 msgid "Show sizes in human-readable form (eg. \"1G\")."
29730 #: ../tools/virt-list-partitions.pl:117
29732 "With this option, C<virt-list-partitions> displays the type and size of each "
29733 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29737 #: ../tools/virt-list-partitions.pl:124
29738 msgid "B<-t> | B<--total>"
29742 #: ../tools/virt-list-partitions.pl:126
29743 msgid "Display the total size of each block device (as a separate row or rows)."
29747 #: ../tools/virt-list-partitions.pl:259
29749 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29750 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29751 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29755 #: ../tools/virt-list-partitions.pl:275
29756 msgid "Copyright (C) 2009-2010 Red Hat Inc."