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.1\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-01-10 10:10+0000\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:2063 ../src/guestfs.pod:2069 ../src/guestfs.pod:2074 ../src/guestfs.pod:2080 ../src/guestfs.pod:2534 ../src/guestfs.pod:2538 ../src/guestfs.pod:2542 ../src/guestfs.pod:2546 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod: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:373 ../fish/guestfish-actions.pod:381 ../fish/guestfish-actions.pod:388 ../fish/guestfish-actions.pod:395 ../fish/guestfish-actions.pod:1065 ../fish/guestfish-actions.pod:1069 ../fish/guestfish-actions.pod:1073 ../fish/guestfish-actions.pod:1077 ../fish/guestfish-actions.pod:1085 ../fish/guestfish-actions.pod:1089 ../fish/guestfish-actions.pod:1093 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1201 ../fish/guestfish-actions.pod:1205 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1215 ../fish/guestfish-actions.pod:1257 ../fish/guestfish-actions.pod:1261 ../fish/guestfish-actions.pod:1266 ../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:2108
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:2133
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 kernel and initrd.img, 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 " int 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:958
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:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1253 ../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>."
3341 #: ../src/guestfs.pod:1716
3343 "This is to simplify caller code, so callers can easily set the progress "
3344 "indicator to \"100%\" at the end of the operation, without requiring special "
3345 "code to detect this case."
3349 #: ../src/guestfs.pod:1722
3351 "The callback also receives the procedure number and serial number of the "
3352 "call. These are only useful for debugging protocol issues, and the callback "
3353 "can normally ignore them. The callback may want to print these numbers in "
3354 "error messages or debugging messages."
3358 #: ../src/guestfs.pod:1727
3359 msgid "PRIVATE DATA AREA"
3363 #: ../src/guestfs.pod:1729
3365 "You can attach named pieces of private data to the libguestfs handle, and "
3366 "fetch them by name for the lifetime of the handle. This is called the "
3367 "private data area and is only available from the C API."
3371 #: ../src/guestfs.pod:1733
3372 msgid "To attach a named piece of data, use the following call:"
3376 #: ../src/guestfs.pod:1735
3379 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3384 #: ../src/guestfs.pod:1737
3386 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3387 "pointer (which can be C<NULL>). Any previous item with the same name is "
3392 #: ../src/guestfs.pod:1741
3394 "You can use any C<key> you want, but names beginning with an underscore "
3395 "character are reserved for internal libguestfs purposes (for implementing "
3396 "language bindings). It is recommended to prefix the name with some unique "
3397 "string to avoid collisions with other users."
3401 #: ../src/guestfs.pod:1746
3402 msgid "To retrieve the pointer, use:"
3406 #: ../src/guestfs.pod:1748
3409 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3414 #: ../src/guestfs.pod:1750
3416 "This function returns C<NULL> if either no data is found associated with "
3417 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3422 #: ../src/guestfs.pod:1754
3424 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3425 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3426 "all. In particular, libguestfs does I<not> try to free the data when the "
3427 "handle is closed. If the data must be freed, then the caller must either "
3428 "free it before calling L</guestfs_close> or must set up a close callback to "
3429 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3430 "can be registered for a handle)."
3434 #: ../src/guestfs.pod:1762
3436 "The private data area is implemented using a hash table, and should be "
3437 "reasonably efficient for moderate numbers of keys."
3441 #: ../src/guestfs.pod:1765 ../src/guestfs.pod:1770
3446 #: ../src/guestfs.pod:1767
3448 "<!-- old anchor for the next section --> <a "
3449 "name=\"state_machine_and_low_level_event_api\"/>"
3453 #: ../src/guestfs.pod:1772
3454 msgid "ARCHITECTURE"
3458 #: ../src/guestfs.pod:1774
3460 "Internally, libguestfs is implemented by running an appliance (a special "
3461 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3462 "process of the main program."
3466 #: ../src/guestfs.pod:1778
3469 " ___________________\n"
3471 " | main program |\n"
3473 " | | child process / appliance\n"
3474 " | | __________________________\n"
3476 " +-------------------+ RPC | +-----------------+ |\n"
3477 " | libguestfs <--------------------> guestfsd | |\n"
3478 " | | | +-----------------+ |\n"
3479 " \\___________________/ | | Linux kernel | |\n"
3480 " | +--^--------------+ |\n"
3481 " \\_________|________________/\n"
3487 " \\______________/\n"
3492 #: ../src/guestfs.pod:1798
3494 "The library, linked to the main program, creates the child process and hence "
3495 "the appliance in the L</guestfs_launch> function."
3499 #: ../src/guestfs.pod:1801
3501 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3502 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3503 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3504 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3505 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3506 "attached to the qemu process which translates device access by the "
3507 "appliance's Linux kernel into accesses to the image."
3511 #: ../src/guestfs.pod:1810
3513 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3514 "Although the disk image you are attached to might also be used by some "
3515 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3516 "care if both libguestfs's qemu process and your virtual machine are trying "
3517 "to update the disk image at the same time, since these usually results in "
3518 "massive disk corruption)."
3522 #: ../src/guestfs.pod:1817
3523 msgid "STATE MACHINE"
3527 #: ../src/guestfs.pod:1819
3528 msgid "libguestfs uses a state machine to model the child process:"
3532 #: ../src/guestfs.pod:1821
3544 " / | \\ \\ guestfs_launch\n"
3545 " / | _\\__V______\n"
3547 " / | | LAUNCHING |\n"
3548 " / | \\___________/\n"
3550 " / | guestfs_launch\n"
3552 " ______ / __|____V\n"
3553 " / \\ ------> / \\\n"
3554 " | BUSY | | READY |\n"
3555 " \\______/ <------ \\________/\n"
3560 #: ../src/guestfs.pod:1843
3562 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3563 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3564 "(3) alternating between READY and BUSY as commands are issued to, and "
3565 "carried out by, the child process."
3569 #: ../src/guestfs.pod:1848
3571 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3572 "asynchronously at any time (eg. due to some internal error), and that causes "
3573 "the state to transition back to CONFIG."
3577 #: ../src/guestfs.pod:1852
3579 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3580 "issued when in the CONFIG state."
3584 #: ../src/guestfs.pod:1855
3586 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3587 "L</guestfs_launch> blocks until the child process is READY to accept "
3588 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3589 "moves the state from CONFIG to LAUNCHING while it is running."
3593 #: ../src/guestfs.pod:1861
3595 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3596 "state. These API calls block waiting for the command to be carried out "
3597 "(ie. the state to transition to BUSY and then back to READY). There are no "
3598 "non-blocking versions, and no way to issue more than one command per handle "
3603 #: ../src/guestfs.pod:1867
3605 "Finally, the child process sends asynchronous messages back to the main "
3606 "program, such as kernel log messages. You can register a callback to "
3607 "receive these messages."
3611 #: ../src/guestfs.pod:1871
3616 #: ../src/guestfs.pod:1873
3617 msgid "COMMUNICATION PROTOCOL"
3621 #: ../src/guestfs.pod:1875
3623 "Don't rely on using this protocol directly. This section documents how it "
3624 "currently works, but it may change at any time."
3628 #: ../src/guestfs.pod:1878
3630 "The protocol used to talk between the library and the daemon running inside "
3631 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3632 "1014, RFC 1832, RFC 4506)."
3636 #: ../src/guestfs.pod:1882
3638 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3639 "this file is automatically generated)."
3643 #: ../src/guestfs.pod:1885
3645 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3646 "and C<FileOut> parameters, which are handled with very simple request/reply "
3647 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3648 "parameters, which use the same request and reply messages, but they may also "
3649 "be followed by files sent using a chunked encoding."
3653 #: ../src/guestfs.pod:1892
3654 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3658 #: ../src/guestfs.pod:1894
3659 msgid "For ordinary functions, the request message is:"
3663 #: ../src/guestfs.pod:1896
3666 " total length (header + arguments,\n"
3667 " but not including the length word itself)\n"
3668 " struct guestfs_message_header (encoded as XDR)\n"
3669 " struct guestfs_<foo>_args (encoded as XDR)\n"
3674 #: ../src/guestfs.pod:1901
3676 "The total length field allows the daemon to allocate a fixed size buffer "
3677 "into which it slurps the rest of the message. As a result, the total length "
3678 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3679 "effective size of any request is limited to somewhere under this size."
3683 #: ../src/guestfs.pod:1907
3685 "Note also that many functions don't take any arguments, in which case the "
3686 "C<guestfs_I<foo>_args> is completely omitted."
3690 #: ../src/guestfs.pod:1910
3692 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3693 "receiver knows what type of args structure to expect, or none at all."
3697 #: ../src/guestfs.pod:1914
3699 "For functions that take optional arguments, the optional arguments are "
3700 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3701 "arguments. A bitmask in the header indicates which optional arguments are "
3702 "meaningful. The bitmask is also checked to see if it contains bits set "
3703 "which the daemon does not know about (eg. if more optional arguments were "
3704 "added in a later version of the library), and this causes the call to be "
3709 #: ../src/guestfs.pod:1922
3710 msgid "The reply message for ordinary functions is:"
3714 #: ../src/guestfs.pod:1924
3717 " total length (header + ret,\n"
3718 " but not including the length word itself)\n"
3719 " struct guestfs_message_header (encoded as XDR)\n"
3720 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3725 #: ../src/guestfs.pod:1929
3727 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3728 "functions that return no formal return values."
3732 #: ../src/guestfs.pod:1932
3733 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3737 #: ../src/guestfs.pod:1935
3739 "In the case of an error, a flag is set in the header, and the reply message "
3740 "is slightly changed:"
3744 #: ../src/guestfs.pod:1938
3747 " total length (header + error,\n"
3748 " but not including the length word itself)\n"
3749 " struct guestfs_message_header (encoded as XDR)\n"
3750 " struct guestfs_message_error (encoded as XDR)\n"
3755 #: ../src/guestfs.pod:1943
3757 "The C<guestfs_message_error> structure contains the error message as a "
3762 #: ../src/guestfs.pod:1946
3763 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3767 #: ../src/guestfs.pod:1948
3769 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3770 "The normal request message is sent (see above). However this is followed by "
3771 "a sequence of file chunks."
3775 #: ../src/guestfs.pod:1952
3778 " total length (header + arguments,\n"
3779 " but not including the length word itself,\n"
3780 " and not including the chunks)\n"
3781 " struct guestfs_message_header (encoded as XDR)\n"
3782 " struct guestfs_<foo>_args (encoded as XDR)\n"
3783 " sequence of chunks for FileIn param #0\n"
3784 " sequence of chunks for FileIn param #1 etc.\n"
3789 #: ../src/guestfs.pod:1960
3790 msgid "The \"sequence of chunks\" is:"
3794 #: ../src/guestfs.pod:1962
3797 " length of chunk (not including length word itself)\n"
3798 " struct guestfs_chunk (encoded as XDR)\n"
3799 " length of chunk\n"
3800 " struct guestfs_chunk (encoded as XDR)\n"
3802 " length of chunk\n"
3803 " struct guestfs_chunk (with data.data_len == 0)\n"
3808 #: ../src/guestfs.pod:1970
3810 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3811 "is set in the final chunk to indicate either successful completion or early "
3816 #: ../src/guestfs.pod:1974
3818 "At time of writing there are no functions that have more than one FileIn "
3819 "parameter. However this is (theoretically) supported, by sending the "
3820 "sequence of chunks for each FileIn parameter one after another (from left to "
3825 #: ../src/guestfs.pod:1979
3827 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3828 "transfer. The library does this by sending a chunk with a special flag set "
3829 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3830 "RPC, does I<not> send any reply, and goes back to reading the next request."
3834 #: ../src/guestfs.pod:1985
3836 "The daemon may also cancel. It does this by writing a special word "
3837 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3838 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3839 "cancel chunk). The special word is chosen so that even if cancellation "
3840 "happens right at the end of the transfer (after the library has finished "
3841 "writing and has started listening for the reply), the \"spurious\" cancel "
3842 "flag will not be confused with the reply message."
3846 #: ../src/guestfs.pod:1994
3848 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3849 "limit), and also files where the size is not known in advance (eg. from "
3850 "pipes or sockets). However the chunks are rather small "
3851 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3852 "to keep much in memory."
3856 #: ../src/guestfs.pod:2000
3857 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3861 #: ../src/guestfs.pod:2002
3863 "The protocol for FileOut parameters is exactly the same as for FileIn "
3864 "parameters, but with the roles of daemon and library reversed."
3868 #: ../src/guestfs.pod:2005
3871 " total length (header + ret,\n"
3872 " but not including the length word itself,\n"
3873 " and not including the chunks)\n"
3874 " struct guestfs_message_header (encoded as XDR)\n"
3875 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3876 " sequence of chunks for FileOut param #0\n"
3877 " sequence of chunks for FileOut param #1 etc.\n"
3882 #: ../src/guestfs.pod:2013
3883 msgid "INITIAL MESSAGE"
3887 #: ../src/guestfs.pod:2015
3889 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3890 "which indicates that the guest and daemon is alive. This is what "
3891 "L</guestfs_launch> waits for."
3895 #: ../src/guestfs.pod:2019
3896 msgid "PROGRESS NOTIFICATION MESSAGES"
3900 #: ../src/guestfs.pod:2021
3902 "The daemon may send progress notification messages at any time. These are "
3903 "distinguished by the normal length word being replaced by "
3904 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3908 #: ../src/guestfs.pod:2025
3910 "The library turns them into progress callbacks (see "
3911 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3912 "discards them if not."
3916 #: ../src/guestfs.pod:2029
3918 "The daemon self-limits the frequency of progress messages it sends (see "
3919 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3924 #: ../src/guestfs.pod:2033
3925 msgid "LIBGUESTFS VERSION NUMBERS"
3929 #: ../src/guestfs.pod:2035
3931 "Since April 2010, libguestfs has started to make separate development and "
3932 "stable releases, along with corresponding branches in our git repository. "
3933 "These separate releases can be identified by version number:"
3937 #: ../src/guestfs.pod:2040
3940 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3941 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3947 " | `-------- sub-version\n"
3949 " `------ always '1' because we don't change the ABI\n"
3954 #: ../src/guestfs.pod:2051
3955 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3959 #: ../src/guestfs.pod:2053
3961 "As time passes we cherry pick fixes from the development branch and backport "
3962 "those into the stable branch, the effect being that the stable branch should "
3963 "get more stable and less buggy over time. So the stable releases are ideal "
3964 "for people who don't need new features but would just like the software to "
3969 #: ../src/guestfs.pod:2059
3970 msgid "Our criteria for backporting changes are:"
3974 #: ../src/guestfs.pod:2065
3976 "Documentation changes which don't affect any code are backported unless the "
3977 "documentation refers to a future feature which is not in stable."
3981 #: ../src/guestfs.pod:2071
3983 "Bug fixes which are not controversial, fix obvious problems, and have been "
3984 "well tested are backported."
3988 #: ../src/guestfs.pod:2076
3990 "Simple rearrangements of code which shouldn't affect how it works get "
3991 "backported. This is so that the code in the two branches doesn't get too "
3992 "far out of step, allowing us to backport future fixes more easily."
3996 #: ../src/guestfs.pod:2082
3998 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3999 "exceptional case: the new feature is required in order to implement an "
4000 "important bug fix."
4004 #: ../src/guestfs.pod:2088
4006 "A new stable branch starts when we think the new features in development are "
4007 "substantial and compelling enough over the current stable branch to warrant "
4008 "it. When that happens we create new stable and development versions 1.N.0 "
4009 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4010 "stable at this point, but by backporting fixes from development, that branch "
4011 "will stabilize over time."
4015 #: ../src/guestfs.pod:2096
4016 msgid "EXTENDING LIBGUESTFS"
4020 #: ../src/guestfs.pod:2098
4021 msgid "ADDING A NEW API ACTION"
4025 #: ../src/guestfs.pod:2100
4027 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4028 "documentation) are generated, and this makes it easy to extend the "
4033 #: ../src/guestfs.pod:2104
4034 msgid "To add a new API action there are two changes:"
4038 #: ../src/guestfs.pod:2110
4040 "You need to add a description of the call (name, parameters, return type, "
4041 "tests, documentation) to C<generator/generator_actions.ml>."
4045 #: ../src/guestfs.pod:2113
4047 "There are two sorts of API action, depending on whether the call goes "
4048 "through to the daemon in the appliance, or is serviced entirely by the "
4049 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4050 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4051 "an example of the latter, since a trace flag is maintained in the handle and "
4052 "all tracing is done on the library side."
4056 #: ../src/guestfs.pod:2121
4058 "Most new actions are of the first type, and get added to the "
4059 "C<daemon_functions> list. Each function has a unique procedure number used "
4060 "in the RPC protocol which is assigned to that action when we publish "
4061 "libguestfs and cannot be reused. Take the latest procedure number and "
4066 #: ../src/guestfs.pod:2127
4068 "For library-only actions of the second type, add to the "
4069 "C<non_daemon_functions> list. Since these functions are serviced by the "
4070 "library and do not travel over the RPC mechanism to the daemon, these "
4071 "functions do not need a procedure number, and so the procedure number is set "
4076 #: ../src/guestfs.pod:2135
4077 msgid "Implement the action (in C):"
4081 #: ../src/guestfs.pod:2137
4083 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4084 "C<daemon/> directory."
4088 #: ../src/guestfs.pod:2140
4090 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4091 "(note: double underscore) in the C<src/> directory."
4095 #: ../src/guestfs.pod:2143
4096 msgid "In either case, use another function as an example of what to do."
4100 #: ../src/guestfs.pod:2147
4101 msgid "After making these changes, use C<make> to compile."
4105 #: ../src/guestfs.pod:2149
4107 "Note that you don't need to implement the RPC, language bindings, manual "
4108 "pages or anything else. It's all automatically generated from the OCaml "
4113 #: ../src/guestfs.pod:2153
4114 msgid "ADDING TESTS FOR AN API ACTION"
4118 #: ../src/guestfs.pod:2155
4120 "You can supply zero or as many tests as you want per API call. The tests "
4121 "can either be added as part of the API description "
4122 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4123 "drop a script into C<regressions/>. Note that adding a script to "
4124 "C<regressions/> is slower, so if possible use the first method."
4128 #: ../src/guestfs.pod:2161
4130 "The following describes the test environment used when you add an API test "
4131 "in C<generator_actions.ml>."
4135 #: ../src/guestfs.pod:2164
4136 msgid "The test environment has 4 block devices:"
4140 #: ../src/guestfs.pod:2168
4141 msgid "C</dev/sda> 500MB"
4145 #: ../src/guestfs.pod:2170
4146 msgid "General block device for testing."
4150 #: ../src/guestfs.pod:2172
4151 msgid "C</dev/sdb> 50MB"
4155 #: ../src/guestfs.pod:2174
4157 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4162 #: ../src/guestfs.pod:2177
4163 msgid "C</dev/sdc> 10MB"
4167 #: ../src/guestfs.pod:2179
4168 msgid "Used in a few tests where two block devices are needed."
4172 #: ../src/guestfs.pod:2181
4177 #: ../src/guestfs.pod:2183
4178 msgid "ISO with fixed content (see C<images/test.iso>)."
4182 #: ../src/guestfs.pod:2187
4184 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4185 "appliance and block devices are reused between tests. So don't try testing "
4186 "L</guestfs_kill_subprocess> :-x"
4190 #: ../src/guestfs.pod:2191
4192 "Each test starts with an initial scenario, selected using one of the "
4193 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4194 "initialize the disks mentioned above in a particular way as documented in "
4195 "C<generator_types.ml>. You should not assume anything about the previous "
4196 "contents of other disks that are not initialized."
4200 #: ../src/guestfs.pod:2197
4202 "You can add a prerequisite clause to any individual test. This is a "
4203 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4204 "if testing a command which might not work on all variations of libguestfs "
4205 "builds. A test that has prerequisite of C<Always> means to run "
4210 #: ../src/guestfs.pod:2203
4212 "In addition, packagers can skip individual tests by setting environment "
4213 "variables before running C<make check>."
4217 #: ../src/guestfs.pod:2206
4220 " SKIP_TEST_<CMD>_<NUM>=1\n"
4225 #: ../src/guestfs.pod:2208
4226 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4230 #: ../src/guestfs.pod:2210
4235 #: ../src/guestfs.pod:2212
4238 " SKIP_TEST_<CMD>=1\n"
4243 #: ../src/guestfs.pod:2214
4244 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4248 #: ../src/guestfs.pod:2216
4249 msgid "Packagers can run only certain tests by setting for example:"
4253 #: ../src/guestfs.pod:2218
4256 " TEST_ONLY=\"vfs_type zerofree\"\n"
4261 #: ../src/guestfs.pod:2220
4263 "See C<capitests/tests.c> for more details of how these environment variables "
4268 #: ../src/guestfs.pod:2223
4269 msgid "DEBUGGING NEW API ACTIONS"
4273 #: ../src/guestfs.pod:2225
4274 msgid "Test new actions work before submitting them."
4278 #: ../src/guestfs.pod:2227
4279 msgid "You can use guestfish to try out new commands."
4283 #: ../src/guestfs.pod:2229
4285 "Debugging the daemon is a problem because it runs inside a minimal "
4286 "environment. However you can fprintf messages in the daemon to stderr, and "
4287 "they will show up if you use C<guestfish -v>."
4291 #: ../src/guestfs.pod:2233
4292 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4296 #: ../src/guestfs.pod:2235
4298 "Our C source code generally adheres to some basic code-formatting "
4299 "conventions. The existing code base is not totally consistent on this "
4300 "front, but we do prefer that contributed code be formatted similarly. In "
4301 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4302 "indentation level, and other than that, follow the K&R style."
4306 #: ../src/guestfs.pod:2241
4308 "If you use Emacs, add the following to one of one of your start-up files "
4309 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4313 #: ../src/guestfs.pod:2244
4316 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4317 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4318 " (add-hook 'find-file-hook\n"
4319 " '(lambda () (if (and buffer-file-name\n"
4320 " (string-match \"/libguestfs\\\\>\"\n"
4321 " (buffer-file-name))\n"
4322 " (not (string-equal mode-name \"Change Log\"))\n"
4323 " (not (string-equal mode-name \"Makefile\")))\n"
4324 " (setq indent-tabs-mode nil))))\n"
4329 #: ../src/guestfs.pod:2254
4332 " ;;; When editing C sources in libguestfs, use this style.\n"
4333 " (defun libguestfs-c-mode ()\n"
4334 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4336 " (c-set-style \"K&R\")\n"
4337 " (setq c-indent-level 2)\n"
4338 " (setq c-basic-offset 2))\n"
4339 " (add-hook 'c-mode-hook\n"
4340 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4341 " (buffer-file-name))\n"
4342 " (libguestfs-c-mode))))\n"
4347 #: ../src/guestfs.pod:2266
4348 msgid "Enable warnings when compiling (and fix any problems this finds):"
4352 #: ../src/guestfs.pod:2269
4355 " ./configure --enable-gcc-warnings\n"
4360 #: ../src/guestfs.pod:2271
4361 msgid "Useful targets are:"
4365 #: ../src/guestfs.pod:2273
4368 " make syntax-check # checks the syntax of the C code\n"
4369 " make check # runs the test suite\n"
4374 #: ../src/guestfs.pod:2276
4375 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4379 #: ../src/guestfs.pod:2278
4381 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4382 "which are used to do shell quoting."
4386 #: ../src/guestfs.pod:2283
4391 #: ../src/guestfs.pod:2285
4393 "Simple shell quoted string. Any spaces or other shell characters are "
4398 #: ../src/guestfs.pod:2288
4403 #: ../src/guestfs.pod:2290
4405 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4410 #: ../src/guestfs.pod:2295 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4411 msgid "For example:"
4415 #: ../src/guestfs.pod:2297
4418 " asprintf (&cmd, \"cat %R\", path);\n"
4423 #: ../src/guestfs.pod:2299
4424 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4428 #: ../src/guestfs.pod:2301
4430 "I<Note:> Do I<not> use these when you are passing parameters to the "
4431 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4432 "because they are not passed via the shell (instead, straight to exec). You "
4433 "probably want to use the C<sysroot_path()> function however."
4437 #: ../src/guestfs.pod:2307
4438 msgid "SUBMITTING YOUR NEW API ACTIONS"
4442 #: ../src/guestfs.pod:2309
4444 "Submit patches to the mailing list: "
4445 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
4446 "L<rjones@redhat.com>."
4450 #: ../src/guestfs.pod:2313
4451 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
4455 #: ../src/guestfs.pod:2315
4456 msgid "We support i18n (gettext anyhow) in the library."
4460 #: ../src/guestfs.pod:2317
4462 "However many messages come from the daemon, and we don't translate those at "
4463 "the moment. One reason is that the appliance generally has all locale files "
4464 "removed from it, because they take up a lot of space. So we'd have to readd "
4465 "some of those, as well as copying our PO files into the appliance."
4469 #: ../src/guestfs.pod:2323
4471 "Debugging messages are never translated, since they are intended for the "
4476 #: ../src/guestfs.pod:2326
4477 msgid "SOURCE CODE SUBDIRECTORIES"
4481 #: ../src/guestfs.pod:2330
4482 msgid "C<appliance>"
4486 #: ../src/guestfs.pod:2332
4487 msgid "The libguestfs appliance, build scripts and so on."
4491 #: ../src/guestfs.pod:2334
4492 msgid "C<capitests>"
4496 #: ../src/guestfs.pod:2336
4497 msgid "Automated tests of the C API."
4501 #: ../src/guestfs.pod:2338
4506 #: ../src/guestfs.pod:2340
4508 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
4513 #: ../src/guestfs.pod:2343
4518 #: ../src/guestfs.pod:2345
4519 msgid "Outside contributions, experimental parts."
4523 #: ../src/guestfs.pod:2347
4528 #: ../src/guestfs.pod:2349
4530 "The daemon that runs inside the libguestfs appliance and carries out "
4535 #: ../src/guestfs.pod:2352
4540 #: ../src/guestfs.pod:2354
4541 msgid "L<virt-df(1)> command and documentation."
4545 #: ../src/guestfs.pod:2356
4550 #: ../src/guestfs.pod:2358
4551 msgid "C API example code."
4555 #: ../src/guestfs.pod:2360
4560 #: ../src/guestfs.pod:2362
4561 msgid "L<guestfish(1)>, the command-line shell."
4565 #: ../src/guestfs.pod:2364
4570 #: ../src/guestfs.pod:2366
4571 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
4575 #: ../src/guestfs.pod:2368
4576 msgid "C<generator>"
4580 #: ../src/guestfs.pod:2370
4582 "The crucially important generator, used to automatically generate large "
4583 "amounts of boilerplate C code for things like RPC and bindings."
4587 #: ../src/guestfs.pod:2373
4592 #: ../src/guestfs.pod:2375
4593 msgid "Files used by the test suite."
4597 #: ../src/guestfs.pod:2377
4598 msgid "Some \"phony\" guest images which we test against."
4602 #: ../src/guestfs.pod:2379
4603 msgid "C<inspector>"
4607 #: ../src/guestfs.pod:2381
4608 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
4612 #: ../src/guestfs.pod:2383
4617 #: ../src/guestfs.pod:2385
4618 msgid "M4 macros used by autoconf."
4622 #: ../src/guestfs.pod:2387
4627 #: ../src/guestfs.pod:2389
4628 msgid "Translations of simple gettext strings."
4632 #: ../src/guestfs.pod:2391
4637 #: ../src/guestfs.pod:2393
4639 "The build infrastructure and PO files for translations of manpages and POD "
4640 "files. Eventually this will be combined with the C<po> directory, but that "
4641 "is rather complicated."
4645 #: ../src/guestfs.pod:2397
4646 msgid "C<regressions>"
4650 #: ../src/guestfs.pod:2399
4651 msgid "Regression tests."
4655 #: ../src/guestfs.pod:2401
4660 #: ../src/guestfs.pod:2403
4661 msgid "L<virt-rescue(1)> command and documentation."
4665 #: ../src/guestfs.pod:2405
4670 #: ../src/guestfs.pod:2407
4671 msgid "Source code to the C library."
4675 #: ../src/guestfs.pod:2409
4680 #: ../src/guestfs.pod:2411
4681 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
4685 #: ../src/guestfs.pod:2413
4686 msgid "C<test-tool>"
4690 #: ../src/guestfs.pod:2415
4692 "Test tool for end users to test if their qemu/kernel combination will work "
4697 #: ../src/guestfs.pod:2418
4702 #: ../src/guestfs.pod:2420
4707 #: ../src/guestfs.pod:2422
4712 #: ../src/guestfs.pod:2424
4717 #: ../src/guestfs.pod:2426
4722 #: ../src/guestfs.pod:2428
4727 #: ../src/guestfs.pod:2430
4732 #: ../src/guestfs.pod:2432
4737 #: ../src/guestfs.pod:2434
4738 msgid "Language bindings."
4742 #: ../src/guestfs.pod:2438 ../fish/guestfish.pod:965 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
4743 msgid "ENVIRONMENT VARIABLES"
4747 #: ../src/guestfs.pod:2442 ../fish/guestfish.pod:991
4748 msgid "LIBGUESTFS_APPEND"
4752 #: ../src/guestfs.pod:2444 ../fish/guestfish.pod:993
4753 msgid "Pass additional options to the guest kernel."
4757 #: ../src/guestfs.pod:2446 ../fish/guestfish.pod:995
4758 msgid "LIBGUESTFS_DEBUG"
4762 #: ../src/guestfs.pod:2448
4764 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
4765 "effect as calling C<guestfs_set_verbose (g, 1)>."
4769 #: ../src/guestfs.pod:2451 ../fish/guestfish.pod:1000
4770 msgid "LIBGUESTFS_MEMSIZE"
4774 #: ../src/guestfs.pod:2453 ../fish/guestfish.pod:1002
4775 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
4779 #: ../src/guestfs.pod:2456 ../fish/guestfish.pod:1005
4782 " LIBGUESTFS_MEMSIZE=700\n"
4787 #: ../src/guestfs.pod:2458 ../fish/guestfish.pod:1007
4788 msgid "LIBGUESTFS_PATH"
4792 #: ../src/guestfs.pod:2460
4794 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
4795 "the discussion of paths in section PATH above."
4799 #: ../src/guestfs.pod:2463 ../fish/guestfish.pod:1012
4800 msgid "LIBGUESTFS_QEMU"
4804 #: ../src/guestfs.pod:2465 ../fish/guestfish.pod:1014
4806 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4807 "which was found at compile time by the configure script is used."
4811 #: ../src/guestfs.pod:2469
4812 msgid "See also L</QEMU WRAPPERS> above."
4816 #: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1018
4817 msgid "LIBGUESTFS_TRACE"
4821 #: ../src/guestfs.pod:2473
4823 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4824 "effect as calling C<guestfs_set_trace (g, 1)>."
4828 #: ../src/guestfs.pod:2476 ../fish/guestfish.pod:1027
4833 #: ../src/guestfs.pod:2478 ../fish/guestfish.pod:1029
4834 msgid "Location of temporary directory, defaults to C</tmp>."
4838 #: ../src/guestfs.pod:2480 ../fish/guestfish.pod:1031
4840 "If libguestfs was compiled to use the supermin appliance then the real "
4841 "appliance is cached in this directory, shared between all handles belonging "
4842 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4843 "use in case C</tmp> is not large enough."
4847 #: ../src/guestfs.pod:2488 ../fish/guestfish.pod:1089 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../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:534 ../tools/virt-list-partitions.pl:257
4852 #: ../src/guestfs.pod:2490
4854 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4855 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4856 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
4857 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4858 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4859 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4860 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4864 #: ../src/guestfs.pod:2513
4866 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4867 "L<lvm(8)>, L<disktype(1)>."
4871 #: ../src/guestfs.pod:2520 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:548
4876 #: ../src/guestfs.pod:2522
4877 msgid "To get a list of bugs against libguestfs use this link:"
4881 #: ../src/guestfs.pod:2524
4882 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4886 #: ../src/guestfs.pod:2526
4887 msgid "To report a new bug against libguestfs use this link:"
4891 #: ../src/guestfs.pod:2528
4892 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4896 #: ../src/guestfs.pod:2530
4897 msgid "When reporting a bug, please check:"
4901 #: ../src/guestfs.pod:2536
4902 msgid "That the bug hasn't been reported already."
4906 #: ../src/guestfs.pod:2540
4907 msgid "That you are testing a recent version."
4911 #: ../src/guestfs.pod:2544
4912 msgid "Describe the bug accurately, and give a way to reproduce it."
4916 #: ../src/guestfs.pod:2548
4918 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4923 #: ../src/guestfs.pod:2553 ../fish/guestfish.pod:1108 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4928 #: ../src/guestfs.pod:2555 ../fish/guestfish.pod:1110 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4929 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4933 #: ../src/guestfs.pod:2557 ../fish/guestfish.pod:1112 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:366 ../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:563 ../tools/virt-list-partitions.pl:273
4938 #: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1114 ../fuse/guestmount.pod:250
4939 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4943 #: ../src/guestfs.pod:2562
4945 "This library is free software; you can redistribute it and/or modify it "
4946 "under the terms of the GNU Lesser General Public License as published by the "
4947 "Free Software Foundation; either version 2 of the License, or (at your "
4948 "option) any later version."
4952 #: ../src/guestfs.pod:2567
4954 "This library is distributed in the hope that it will be useful, but WITHOUT "
4955 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4956 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4961 #: ../src/guestfs.pod:2572
4963 "You should have received a copy of the GNU Lesser General Public License "
4964 "along with this library; if not, write to the Free Software Foundation, "
4965 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4969 #: ../src/guestfs-actions.pod:1
4970 msgid "guestfs_add_cdrom"
4974 #: ../src/guestfs-actions.pod:3
4978 " guestfs_add_cdrom (guestfs_h *g,\n"
4979 " const char *filename);\n"
4984 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4985 msgid "This function adds a virtual CD-ROM disk image to the guest."
4989 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4990 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4994 #: ../src/guestfs-actions.pod:17
4996 "This call checks for the existence of C<filename>. This stops you from "
4997 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4998 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5003 #: ../src/guestfs-actions.pod:24
5005 "If you just want to add an ISO file (often you use this as an efficient way "
5006 "to transfer large files into the guest), then you should probably use "
5007 "C<guestfs_add_drive_ro> instead."
5011 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262 ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2448 ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3237 ../src/guestfs-actions.pod:3257 ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:3439 ../src/guestfs-actions.pod:3453 ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:3504 ../src/guestfs-actions.pod:3576 ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3613 ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:3729 ../src/guestfs-actions.pod:3764 ../src/guestfs-actions.pod:3776 ../src/guestfs-actions.pod:3812 ../src/guestfs-actions.pod:3828 ../src/guestfs-actions.pod:3841 ../src/guestfs-actions.pod:3856 ../src/guestfs-actions.pod:3873 ../src/guestfs-actions.pod:3966 ../src/guestfs-actions.pod:3986 ../src/guestfs-actions.pod:3999 ../src/guestfs-actions.pod:4050 ../src/guestfs-actions.pod:4068 ../src/guestfs-actions.pod:4086 ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:4116 ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4147 ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:4226 ../src/guestfs-actions.pod:4299 ../src/guestfs-actions.pod:4330 ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:4368 ../src/guestfs-actions.pod:4380 ../src/guestfs-actions.pod:4397 ../src/guestfs-actions.pod:4410 ../src/guestfs-actions.pod:4425 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4475 ../src/guestfs-actions.pod:4490 ../src/guestfs-actions.pod:4510 ../src/guestfs-actions.pod:4524 ../src/guestfs-actions.pod:4541 ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4627 ../src/guestfs-actions.pod:4641 ../src/guestfs-actions.pod:4669 ../src/guestfs-actions.pod:4686 ../src/guestfs-actions.pod:4704 ../src/guestfs-actions.pod:4838 ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4935 ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:5033 ../src/guestfs-actions.pod:5050 ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5077 ../src/guestfs-actions.pod:5366 ../src/guestfs-actions.pod:5385 ../src/guestfs-actions.pod:5399 ../src/guestfs-actions.pod:5411 ../src/guestfs-actions.pod:5425 ../src/guestfs-actions.pod:5437 ../src/guestfs-actions.pod:5451 ../src/guestfs-actions.pod:5467 ../src/guestfs-actions.pod:5488 ../src/guestfs-actions.pod:5507 ../src/guestfs-actions.pod:5526 ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5567 ../src/guestfs-actions.pod:5585 ../src/guestfs-actions.pod:5604 ../src/guestfs-actions.pod:5625 ../src/guestfs-actions.pod:5644 ../src/guestfs-actions.pod:5661 ../src/guestfs-actions.pod:5689 ../src/guestfs-actions.pod:5713 ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:5756 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5786 ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:5842 ../src/guestfs-actions.pod:5865 ../src/guestfs-actions.pod:5891 ../src/guestfs-actions.pod:5999 ../src/guestfs-actions.pod:6120 ../src/guestfs-actions.pod:6132 ../src/guestfs-actions.pod:6145 ../src/guestfs-actions.pod:6158 ../src/guestfs-actions.pod:6180 ../src/guestfs-actions.pod:6193 ../src/guestfs-actions.pod:6206 ../src/guestfs-actions.pod:6219 ../src/guestfs-actions.pod:6234 ../src/guestfs-actions.pod:6293 ../src/guestfs-actions.pod:6310 ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6342 ../src/guestfs-actions.pod:6359 ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6392 ../src/guestfs-actions.pod:6428 ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6483 ../src/guestfs-actions.pod:6496 ../src/guestfs-actions.pod:6514 ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:6584 ../src/guestfs-actions.pod:6703 ../src/guestfs-actions.pod:6721 ../src/guestfs-actions.pod:6735 ../src/guestfs-actions.pod:6790 ../src/guestfs-actions.pod:6803 ../src/guestfs-actions.pod:6848 ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:6961 ../src/guestfs-actions.pod:7027 ../src/guestfs-actions.pod:7046 ../src/guestfs-actions.pod:7075
5012 msgid "This function returns 0 on success or -1 on error."
5016 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:151 ../fish/guestfish-actions.pod:165
5018 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5023 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942 ../src/guestfs-actions.pod:4187 ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:7138 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168 ../fish/guestfish-actions.pod:949 ../fish/guestfish-actions.pod:1306 ../fish/guestfish-actions.pod:1320 ../fish/guestfish-actions.pod:2816 ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4715
5025 "Deprecated functions will not be removed from the API, but the fact that "
5026 "they are deprecated indicates that there are problems with correct use of "
5031 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3239 ../src/guestfs-actions.pod:4477 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5663 ../src/guestfs-actions.pod:5773 ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6361 ../src/guestfs-actions.pod:6883
5032 msgid "(Added in 0.3)"
5036 #: ../src/guestfs-actions.pod:41
5037 msgid "guestfs_add_domain"
5041 #: ../src/guestfs-actions.pod:43
5045 " guestfs_add_domain (guestfs_h *g,\n"
5046 " const char *dom,\n"
5052 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137 ../src/guestfs-actions.pod:4201
5054 "You may supply a list of optional arguments to this call. Use zero or more "
5055 "of the following pairs of parameters, and terminate the list with C<-1> on "
5056 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5060 #: ../src/guestfs-actions.pod:53
5063 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5064 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5065 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5070 #: ../src/guestfs-actions.pod:57
5072 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5073 "It works by connecting to libvirt, requesting the domain and domain XML from "
5074 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5079 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5081 "The number of disks added is returned. This operation is atomic: if an "
5082 "error is returned, then no disks are added."
5086 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5088 "This function does some minimal checks to make sure the libvirt domain is "
5089 "not running (unless C<readonly> is true). In a future version we will try "
5090 "to acquire the libvirt lock on each disk."
5094 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5096 "Disks must be accessible locally. This often means that adding disks from a "
5097 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5098 "unless those disks are accessible via the same device path locally too."
5102 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5104 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5105 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5106 "default libvirt URI (or one set through an environment variable, see the "
5107 "libvirt documentation for full details)."
5111 #: ../src/guestfs-actions.pod:80
5113 "The other optional parameters are passed directly through to "
5114 "C<guestfs_add_drive_opts>."
5118 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003 ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2662 ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:4613 ../src/guestfs-actions.pod:4741 ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5173 ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6907 ../src/guestfs-actions.pod:6920
5119 msgid "On error this function returns -1."
5123 #: ../src/guestfs-actions.pod:85
5124 msgid "(Added in 1.7.4)"
5128 #: ../src/guestfs-actions.pod:87
5129 msgid "guestfs_add_domain_va"
5133 #: ../src/guestfs-actions.pod:89
5137 " guestfs_add_domain_va (guestfs_h *g,\n"
5138 " const char *dom,\n"
5144 #: ../src/guestfs-actions.pod:94
5145 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5149 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211 ../src/guestfs-actions.pod:4240 ../src/guestfs-actions.pod:4252
5150 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5154 #: ../src/guestfs-actions.pod:98
5155 msgid "guestfs_add_domain_argv"
5159 #: ../src/guestfs-actions.pod:100
5163 " guestfs_add_domain_argv (guestfs_h *g,\n"
5164 " const char *dom,\n"
5165 " const struct guestfs_add_domain_argv *optargs);\n"
5170 #: ../src/guestfs-actions.pod:105
5171 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5175 #: ../src/guestfs-actions.pod:109
5176 msgid "guestfs_add_drive"
5180 #: ../src/guestfs-actions.pod:111
5184 " guestfs_add_drive (guestfs_h *g,\n"
5185 " const char *filename);\n"
5190 #: ../src/guestfs-actions.pod:115
5192 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5193 "optional parameters, so the disk is added writable, with the format being "
5194 "detected automatically."
5198 #: ../src/guestfs-actions.pod:119
5200 "Automatic detection of the format opens you up to a potential security hole "
5201 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5202 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5203 "you should think about replacing calls to this function with calls to "
5204 "C<guestfs_add_drive_opts>, and specifying the format."
5208 #: ../src/guestfs-actions.pod:130
5209 msgid "guestfs_add_drive_opts"
5213 #: ../src/guestfs-actions.pod:132
5217 " guestfs_add_drive_opts (guestfs_h *g,\n"
5218 " const char *filename,\n"
5224 #: ../src/guestfs-actions.pod:142
5227 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
5228 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
5229 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
5234 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
5236 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5237 "The first time you call this function, the disk appears as C</dev/sda>, the "
5238 "second time as C</dev/sdb>, and so on."
5242 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
5244 "You don't necessarily need to be root when using libguestfs. However you "
5245 "obviously do need sufficient permissions to access the filename for whatever "
5246 "operations you want to perform (ie. read access if you just want to read the "
5247 "image or write access if you want to modify the image)."
5251 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
5252 msgid "This call checks that C<filename> exists."
5256 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4211 ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2827
5257 msgid "The optional arguments are:"
5261 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
5266 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
5268 "If true then the image is treated as read-only. Writes are still allowed, "
5269 "but they are stored in a temporary snapshot overlay which is discarded at "
5270 "the end. The disk that you add is not modified."
5274 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
5279 #: ../src/guestfs-actions.pod:171
5281 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
5282 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
5283 "Possible formats include C<raw> and C<qcow2>."
5287 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
5289 "Automatic detection of the format opens you up to a potential security hole "
5290 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5291 "RHBZ#642934. Specifying the format closes this security hole."
5295 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
5300 #: ../src/guestfs-actions.pod:182
5302 "This rarely-used option lets you emulate the behaviour of the deprecated "
5303 "C<guestfs_add_drive_with_if> call (q.v.)"
5307 #: ../src/guestfs-actions.pod:189
5308 msgid "(Added in 1.5.23)"
5312 #: ../src/guestfs-actions.pod:191
5313 msgid "guestfs_add_drive_opts_va"
5317 #: ../src/guestfs-actions.pod:193
5321 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
5322 " const char *filename,\n"
5328 #: ../src/guestfs-actions.pod:198
5329 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
5333 #: ../src/guestfs-actions.pod:202
5334 msgid "guestfs_add_drive_opts_argv"
5338 #: ../src/guestfs-actions.pod:204
5342 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
5343 " const char *filename,\n"
5344 " const struct guestfs_add_drive_opts_argv "
5350 #: ../src/guestfs-actions.pod:209
5351 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
5355 #: ../src/guestfs-actions.pod:213
5356 msgid "guestfs_add_drive_ro"
5360 #: ../src/guestfs-actions.pod:215
5364 " guestfs_add_drive_ro (guestfs_h *g,\n"
5365 " const char *filename);\n"
5370 #: ../src/guestfs-actions.pod:219
5372 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
5373 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
5374 "disk is added read-only, with the format being detected automatically."
5378 #: ../src/guestfs-actions.pod:226
5379 msgid "(Added in 1.0.38)"
5383 #: ../src/guestfs-actions.pod:228
5384 msgid "guestfs_add_drive_ro_with_if"
5388 #: ../src/guestfs-actions.pod:230
5392 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
5393 " const char *filename,\n"
5394 " const char *iface);\n"
5399 #: ../src/guestfs-actions.pod:235
5401 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
5402 "QEMU interface emulation to use at run time."
5406 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2333
5407 msgid "(Added in 1.0.84)"
5411 #: ../src/guestfs-actions.pod:249
5412 msgid "guestfs_add_drive_with_if"
5416 #: ../src/guestfs-actions.pod:251
5420 " guestfs_add_drive_with_if (guestfs_h *g,\n"
5421 " const char *filename,\n"
5422 " const char *iface);\n"
5427 #: ../src/guestfs-actions.pod:256
5429 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
5430 "QEMU interface emulation to use at run time."
5434 #: ../src/guestfs-actions.pod:270
5435 msgid "guestfs_aug_clear"
5439 #: ../src/guestfs-actions.pod:272
5443 " guestfs_aug_clear (guestfs_h *g,\n"
5444 " const char *augpath);\n"
5449 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
5451 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5452 "L<augtool(1)> C<clear> command."
5456 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
5457 msgid "(Added in 1.3.4)"
5461 #: ../src/guestfs-actions.pod:283
5462 msgid "guestfs_aug_close"
5466 #: ../src/guestfs-actions.pod:285
5470 " guestfs_aug_close (guestfs_h *g);\n"
5475 #: ../src/guestfs-actions.pod:288
5477 "Close the current Augeas handle and free up any resources used by it. After "
5478 "calling this, you have to call C<guestfs_aug_init> again before you can use "
5479 "any other Augeas functions."
5483 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:5224
5484 msgid "(Added in 0.7)"
5488 #: ../src/guestfs-actions.pod:297
5489 msgid "guestfs_aug_defnode"
5493 #: ../src/guestfs-actions.pod:299
5496 " struct guestfs_int_bool *\n"
5497 " guestfs_aug_defnode (guestfs_h *g,\n"
5498 " const char *name,\n"
5499 " const char *expr,\n"
5500 " const char *val);\n"
5505 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
5506 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5510 #: ../src/guestfs-actions.pod:308
5512 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5513 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
5514 "containing that single node."
5518 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
5520 "On success this returns a pair containing the number of nodes in the "
5521 "nodeset, and a boolean flag if a node was created."
5525 #: ../src/guestfs-actions.pod:316
5527 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
5528 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
5532 #: ../src/guestfs-actions.pod:322
5533 msgid "guestfs_aug_defvar"
5537 #: ../src/guestfs-actions.pod:324
5541 " guestfs_aug_defvar (guestfs_h *g,\n"
5542 " const char *name,\n"
5543 " const char *expr);\n"
5548 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
5550 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5551 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5555 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
5557 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5558 "evaluates to something which is not a nodeset."
5562 #: ../src/guestfs-actions.pod:340
5563 msgid "guestfs_aug_get"
5567 #: ../src/guestfs-actions.pod:342
5571 " guestfs_aug_get (guestfs_h *g,\n"
5572 " const char *augpath);\n"
5577 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
5579 "Look up the value associated with C<path>. If C<path> matches exactly one "
5580 "node, the C<value> is returned."
5584 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341 ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2744 ../src/guestfs-actions.pod:2775 ../src/guestfs-actions.pod:2799 ../src/guestfs-actions.pod:2861 ../src/guestfs-actions.pod:2884 ../src/guestfs-actions.pod:3398 ../src/guestfs-actions.pod:3748 ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4759 ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:5122 ../src/guestfs-actions.pod:5300 ../src/guestfs-actions.pod:5349 ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:5928 ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5969 ../src/guestfs-actions.pod:6643 ../src/guestfs-actions.pod:6662 ../src/guestfs-actions.pod:6680 ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:7132
5586 "This function returns a string, or NULL on error. I<The caller must free "
5587 "the returned string after use>."
5591 #: ../src/guestfs-actions.pod:354
5592 msgid "guestfs_aug_init"
5596 #: ../src/guestfs-actions.pod:356
5600 " guestfs_aug_init (guestfs_h *g,\n"
5601 " const char *root,\n"
5607 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
5609 "Create a new Augeas handle for editing configuration files. If there was "
5610 "any previous Augeas handle associated with this guestfs session, then it is "
5615 #: ../src/guestfs-actions.pod:365
5616 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5620 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
5621 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5625 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
5627 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5628 "logical I<or> of the following integers:"
5632 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
5633 msgid "C<AUG_SAVE_BACKUP> = 1"
5637 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
5638 msgid "Keep the original file with a C<.augsave> extension."
5642 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
5643 msgid "C<AUG_SAVE_NEWFILE> = 2"
5647 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
5649 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5650 "original. Overrides C<AUG_SAVE_BACKUP>."
5654 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
5655 msgid "C<AUG_TYPE_CHECK> = 4"
5659 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
5660 msgid "Typecheck lenses (can be expensive)."
5664 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
5665 msgid "C<AUG_NO_STDINC> = 8"
5669 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
5670 msgid "Do not use standard load path for modules."
5674 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
5675 msgid "C<AUG_SAVE_NOOP> = 16"
5679 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
5680 msgid "Make save a no-op, just record what would have been changed."
5684 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
5685 msgid "C<AUG_NO_LOAD> = 32"
5689 #: ../src/guestfs-actions.pod:400
5690 msgid "Do not load the tree in C<guestfs_aug_init>."
5694 #: ../src/guestfs-actions.pod:404
5695 msgid "To close the handle, you can call C<guestfs_aug_close>."
5699 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:270
5700 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5704 #: ../src/guestfs-actions.pod:412
5705 msgid "guestfs_aug_insert"
5709 #: ../src/guestfs-actions.pod:414
5713 " guestfs_aug_insert (guestfs_h *g,\n"
5714 " const char *augpath,\n"
5715 " const char *label,\n"
5721 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:276
5723 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5724 "or after C<path> (depending on the boolean flag C<before>)."
5728 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:280
5730 "C<path> must match exactly one existing node in the tree, and C<label> must "
5731 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5735 #: ../src/guestfs-actions.pod:432
5736 msgid "guestfs_aug_load"
5740 #: ../src/guestfs-actions.pod:434
5744 " guestfs_aug_load (guestfs_h *g);\n"
5749 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:288
5750 msgid "Load files into the tree."
5754 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
5755 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5759 #: ../src/guestfs-actions.pod:446
5760 msgid "guestfs_aug_ls"
5764 #: ../src/guestfs-actions.pod:448
5768 " guestfs_aug_ls (guestfs_h *g,\n"
5769 " const char *augpath);\n"
5774 #: ../src/guestfs-actions.pod:452
5776 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5777 "sorting the resulting nodes into alphabetical order."
5781 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471 ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2178 ../src/guestfs-actions.pod:2194 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:2351 ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:2611 ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3033 ../src/guestfs-actions.pod:3318 ../src/guestfs-actions.pod:3380 ../src/guestfs-actions.pod:3485 ../src/guestfs-actions.pod:3890 ../src/guestfs-actions.pod:4574 ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5220 ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5985 ../src/guestfs-actions.pod:6046 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6271 ../src/guestfs-actions.pod:6753 ../src/guestfs-actions.pod:6773 ../src/guestfs-actions.pod:6820 ../src/guestfs-actions.pod:6985 ../src/guestfs-actions.pod:7004 ../src/guestfs-actions.pod:7089 ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7154 ../src/guestfs-actions.pod:7173
5783 "This function returns a NULL-terminated array of strings (like "
5784 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
5785 "strings and the array after use>."
5789 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3731 ../src/guestfs-actions.pod:3781 ../src/guestfs-actions.pod:3968 ../src/guestfs-actions.pod:4001 ../src/guestfs-actions.pod:4164 ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:5413 ../src/guestfs-actions.pod:5427 ../src/guestfs-actions.pod:5439 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6737 ../src/guestfs-actions.pod:6973
5790 msgid "(Added in 0.8)"
5794 #: ../src/guestfs-actions.pod:461
5795 msgid "guestfs_aug_match"
5799 #: ../src/guestfs-actions.pod:463
5803 " guestfs_aug_match (guestfs_h *g,\n"
5804 " const char *augpath);\n"
5809 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:304
5811 "Returns a list of paths which match the path expression C<path>. The "
5812 "returned paths are sufficiently qualified so that they match exactly one "
5813 "node in the current tree."
5817 #: ../src/guestfs-actions.pod:477
5818 msgid "guestfs_aug_mv"
5822 #: ../src/guestfs-actions.pod:479
5826 " guestfs_aug_mv (guestfs_h *g,\n"
5827 " const char *src,\n"
5828 " const char *dest);\n"
5833 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:312
5835 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5836 "C<dest> is overwritten if it exists."
5840 #: ../src/guestfs-actions.pod:491
5841 msgid "guestfs_aug_rm"
5845 #: ../src/guestfs-actions.pod:493
5849 " guestfs_aug_rm (guestfs_h *g,\n"
5850 " const char *augpath);\n"
5855 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:319
5856 msgid "Remove C<path> and all of its children."
5860 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5861 msgid "On success this returns the number of entries which were removed."
5865 #: ../src/guestfs-actions.pod:505
5866 msgid "guestfs_aug_save"
5870 #: ../src/guestfs-actions.pod:507
5874 " guestfs_aug_save (guestfs_h *g);\n"
5879 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:327
5880 msgid "This writes all pending changes to disk."
5884 #: ../src/guestfs-actions.pod:512
5886 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5891 #: ../src/guestfs-actions.pod:519
5892 msgid "guestfs_aug_set"
5896 #: ../src/guestfs-actions.pod:521
5900 " guestfs_aug_set (guestfs_h *g,\n"
5901 " const char *augpath,\n"
5902 " const char *val);\n"
5907 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:336
5908 msgid "Set the value associated with C<path> to C<val>."
5912 #: ../src/guestfs-actions.pod:528
5914 "In the Augeas API, it is possible to clear a node by setting the value to "
5915 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5916 "this call. Instead you must use the C<guestfs_aug_clear> call."
5920 #: ../src/guestfs-actions.pod:537
5921 msgid "guestfs_available"
5925 #: ../src/guestfs-actions.pod:539
5929 " guestfs_available (guestfs_h *g,\n"
5930 " char *const *groups);\n"
5935 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:347
5937 "This command is used to check the availability of some groups of "
5938 "functionality in the appliance, which not all builds of the libguestfs "
5939 "appliance will be able to provide."
5943 #: ../src/guestfs-actions.pod:547
5945 "The libguestfs groups, and the functions that those groups correspond to, "
5946 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5947 "runtime by calling C<guestfs_available_all_groups>."
5951 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:356
5953 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5954 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5955 "and Augeas (configuration file editing) functions."
5959 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
5960 msgid "The command returns no error if I<all> requested groups are available."
5964 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
5966 "It fails with an error if one or more of the requested groups is unavailable "
5971 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
5973 "If an unknown group name is included in the list of groups then an error is "
5978 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:369
5983 #: ../src/guestfs-actions.pod:571
5984 msgid "You must call C<guestfs_launch> before calling this function."
5988 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:377
5990 "The reason is because we don't know what groups are supported by the "
5991 "appliance/daemon until it is running and can be queried."
5995 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:383
5997 "If a group of functions is available, this does not necessarily mean that "
5998 "they will work. You still have to check for errors when calling individual "
5999 "API functions even if they are available."
6003 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:390
6005 "It is usually the job of distro packagers to build complete functionality "
6006 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6007 "with all requirements satisfied, will support everything."
6011 #: ../src/guestfs-actions.pod:593
6013 "This call was added in version C<1.0.80>. In previous versions of "
6014 "libguestfs all you could do would be to speculatively execute a command to "
6015 "find out if the daemon implemented it. See also C<guestfs_version>."
6019 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
6020 msgid "(Added in 1.0.80)"
6024 #: ../src/guestfs-actions.pod:604
6025 msgid "guestfs_available_all_groups"
6029 #: ../src/guestfs-actions.pod:606
6033 " guestfs_available_all_groups (guestfs_h *g);\n"
6038 #: ../src/guestfs-actions.pod:609
6040 "This command returns a list of all optional groups that this daemon knows "
6041 "about. Note this returns both supported and unsupported groups. To find "
6042 "out which ones the daemon can actually support you have to call "
6043 "C<guestfs_available> on each member of the returned list."
6047 #: ../src/guestfs-actions.pod:615
6048 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6052 #: ../src/guestfs-actions.pod:621
6053 msgid "(Added in 1.3.15)"
6057 #: ../src/guestfs-actions.pod:623
6058 msgid "guestfs_base64_in"
6062 #: ../src/guestfs-actions.pod:625
6066 " guestfs_base64_in (guestfs_h *g,\n"
6067 " const char *base64file,\n"
6068 " const char *filename);\n"
6073 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:420
6074 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6078 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
6079 msgid "(Added in 1.3.5)"
6083 #: ../src/guestfs-actions.pod:637
6084 msgid "guestfs_base64_out"
6088 #: ../src/guestfs-actions.pod:639
6092 " guestfs_base64_out (guestfs_h *g,\n"
6093 " const char *filename,\n"
6094 " const char *base64file);\n"
6099 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:429
6101 "This command downloads the contents of C<filename>, writing it out to local "
6102 "file C<base64file> encoded as base64."
6106 #: ../src/guestfs-actions.pod:651
6107 msgid "guestfs_blockdev_flushbufs"
6111 #: ../src/guestfs-actions.pod:653
6115 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6116 " const char *device);\n"
6121 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:438
6122 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6126 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:441 ../fish/guestfish-actions.pod:452 ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:471 ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:496 ../fish/guestfish-actions.pod:504 ../fish/guestfish-actions.pod:515 ../fish/guestfish-actions.pod:523 ../fish/guestfish-actions.pod:531
6127 msgid "This uses the L<blockdev(8)> command."
6131 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
6132 msgid "(Added in 0.9.3)"
6136 #: ../src/guestfs-actions.pod:666
6137 msgid "guestfs_blockdev_getbsz"
6141 #: ../src/guestfs-actions.pod:668
6145 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6146 " const char *device);\n"
6151 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:447
6152 msgid "This returns the block size of a device."
6156 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:512
6158 "(Note this is different from both I<size in blocks> and I<filesystem block "
6163 #: ../src/guestfs-actions.pod:683
6164 msgid "guestfs_blockdev_getro"
6168 #: ../src/guestfs-actions.pod:685
6172 " guestfs_blockdev_getro (guestfs_h *g,\n"
6173 " const char *device);\n"
6178 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:458
6180 "Returns a boolean indicating if the block device is read-only (true if "
6181 "read-only, false if not)."
6185 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:3050 ../src/guestfs-actions.pod:3064 ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3093 ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3140 ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3167 ../src/guestfs-actions.pod:3181 ../src/guestfs-actions.pod:3196 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:4723
6186 msgid "This function returns a C truth value on success or -1 on error."
6190 #: ../src/guestfs-actions.pod:698
6191 msgid "guestfs_blockdev_getsize64"
6195 #: ../src/guestfs-actions.pod:700
6199 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
6200 " const char *device);\n"
6205 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:467
6206 msgid "This returns the size of the device in bytes."
6210 #: ../src/guestfs-actions.pod:706
6211 msgid "See also C<guestfs_blockdev_getsz>."
6215 #: ../src/guestfs-actions.pod:714
6216 msgid "guestfs_blockdev_getss"
6220 #: ../src/guestfs-actions.pod:716
6224 " guestfs_blockdev_getss (guestfs_h *g,\n"
6225 " const char *device);\n"
6230 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:477
6232 "This returns the size of sectors on a block device. Usually 512, but can be "
6233 "larger for modern devices."
6237 #: ../src/guestfs-actions.pod:723
6239 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
6244 #: ../src/guestfs-actions.pod:732
6245 msgid "guestfs_blockdev_getsz"
6249 #: ../src/guestfs-actions.pod:734
6253 " guestfs_blockdev_getsz (guestfs_h *g,\n"
6254 " const char *device);\n"
6259 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:489
6261 "This returns the size of the device in units of 512-byte sectors (even if "
6262 "the sectorsize isn't 512 bytes ... weird)."
6266 #: ../src/guestfs-actions.pod:741
6268 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
6269 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
6273 #: ../src/guestfs-actions.pod:751
6274 msgid "guestfs_blockdev_rereadpt"
6278 #: ../src/guestfs-actions.pod:753
6282 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
6283 " const char *device);\n"
6288 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:502
6289 msgid "Reread the partition table on C<device>."
6293 #: ../src/guestfs-actions.pod:765
6294 msgid "guestfs_blockdev_setbsz"
6298 #: ../src/guestfs-actions.pod:767
6302 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
6303 " const char *device,\n"
6304 " int blocksize);\n"
6309 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:510
6310 msgid "This sets the block size of a device."
6314 #: ../src/guestfs-actions.pod:783
6315 msgid "guestfs_blockdev_setro"
6319 #: ../src/guestfs-actions.pod:785
6323 " guestfs_blockdev_setro (guestfs_h *g,\n"
6324 " const char *device);\n"
6329 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:521
6330 msgid "Sets the block device named C<device> to read-only."
6334 #: ../src/guestfs-actions.pod:797
6335 msgid "guestfs_blockdev_setrw"
6339 #: ../src/guestfs-actions.pod:799
6343 " guestfs_blockdev_setrw (guestfs_h *g,\n"
6344 " const char *device);\n"
6349 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:529
6350 msgid "Sets the block device named C<device> to read-write."
6354 #: ../src/guestfs-actions.pod:811
6355 msgid "guestfs_case_sensitive_path"
6359 #: ../src/guestfs-actions.pod:813
6363 " guestfs_case_sensitive_path (guestfs_h *g,\n"
6364 " const char *path);\n"
6369 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:537
6371 "This can be used to resolve case insensitive paths on a filesystem which is "
6372 "case sensitive. The use case is to resolve paths which you have read from "
6373 "Windows configuration files or the Windows Registry, to the true path."
6377 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
6379 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6380 "(and probably others), which is that although the underlying filesystem is "
6381 "case-insensitive, the driver exports the filesystem to Linux as "
6386 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
6388 "One consequence of this is that special directories such as C<c:\\windows> "
6389 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6390 "precise details of how they were created. In Windows itself this would not "
6395 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:553
6397 "Bug or feature? You decide: "
6398 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
6402 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:556
6404 "This function resolves the true case of each element in the path and returns "
6405 "the case-sensitive path."
6409 #: ../src/guestfs-actions.pod:839
6411 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
6412 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
6413 "how the directories were originally created under Windows)."
6417 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:564
6418 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6422 #: ../src/guestfs-actions.pod:847
6423 msgid "See also C<guestfs_realpath>."
6427 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6665
6428 msgid "(Added in 1.0.75)"
6432 #: ../src/guestfs-actions.pod:854
6437 #: ../src/guestfs-actions.pod:856
6441 " guestfs_cat (guestfs_h *g,\n"
6442 " const char *path);\n"
6447 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:3462
6448 msgid "Return the contents of the file named C<path>."
6452 #: ../src/guestfs-actions.pod:862
6454 "Note that this function cannot correctly handle binary files (specifically, "
6455 "files containing C<\\0> character which is treated as end of string). For "
6456 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
6457 "functions which have a more complex interface."
6461 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:2198 ../src/guestfs-actions.pod:2217 ../src/guestfs-actions.pod:2260 ../src/guestfs-actions.pod:2284 ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:4992 ../src/guestfs-actions.pod:5018 ../src/guestfs-actions.pod:5149 ../src/guestfs-actions.pod:5175 ../src/guestfs-actions.pod:5199 ../src/guestfs-actions.pod:6050 ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6251 ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6937 ../src/guestfs-actions.pod:6963 ../src/guestfs-actions.pod:6989 ../src/guestfs-actions.pod:7008 ../src/guestfs-actions.pod:7093 ../src/guestfs-actions.pod:7112 ../src/guestfs-actions.pod:7158 ../src/guestfs-actions.pod:7177 ../fish/guestfish-actions.pod:580 ../fish/guestfish-actions.pod:715 ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:903 ../fish/guestfish-actions.pod:913 ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990 ../fish/guestfish-actions.pod:1185 ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:1490 ../fish/guestfish-actions.pod:1518 ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:1543 ../fish/guestfish-actions.pod:1562 ../fish/guestfish-actions.pod:3332 ../fish/guestfish-actions.pod:3347 ../fish/guestfish-actions.pod:3423 ../fish/guestfish-actions.pod:3440 ../fish/guestfish-actions.pod:3455 ../fish/guestfish-actions.pod:4038 ../fish/guestfish-actions.pod:4084 ../fish/guestfish-actions.pod:4169 ../fish/guestfish-actions.pod:4184 ../fish/guestfish-actions.pod:4594 ../fish/guestfish-actions.pod:4612 ../fish/guestfish-actions.pod:4629 ../fish/guestfish-actions.pod:4639 ../fish/guestfish-actions.pod:4687 ../fish/guestfish-actions.pod:4697 ../fish/guestfish-actions.pod:4726 ../fish/guestfish-actions.pod:4736
6463 "Because of the message protocol, there is a transfer limit of somewhere "
6464 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6468 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3384 ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3489 ../src/guestfs-actions.pod:3894 ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:6824 ../src/guestfs-actions.pod:6838
6469 msgid "(Added in 0.4)"
6473 #: ../src/guestfs-actions.pod:875
6474 msgid "guestfs_checksum"
6478 #: ../src/guestfs-actions.pod:877
6482 " guestfs_checksum (guestfs_h *g,\n"
6483 " const char *csumtype,\n"
6484 " const char *path);\n"
6489 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:587
6490 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6494 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:590
6496 "The type of checksum to compute is given by the C<csumtype> parameter which "
6497 "must have one of the following values:"
6501 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
6506 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
6508 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6513 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
6518 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
6519 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6523 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
6528 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
6529 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6533 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
6538 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
6539 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6543 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
6548 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
6549 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6553 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
6558 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
6559 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6563 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
6568 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
6569 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6573 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:626
6574 msgid "The checksum is returned as a printable string."
6578 #: ../src/guestfs-actions.pod:923
6579 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6583 #: ../src/guestfs-actions.pod:925
6584 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6588 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3066 ../src/guestfs-actions.pod:3095 ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3183 ../src/guestfs-actions.pod:6521
6589 msgid "(Added in 1.0.2)"
6593 #: ../src/guestfs-actions.pod:932
6594 msgid "guestfs_checksum_device"
6598 #: ../src/guestfs-actions.pod:934
6602 " guestfs_checksum_device (guestfs_h *g,\n"
6603 " const char *csumtype,\n"
6604 " const char *device);\n"
6609 #: ../src/guestfs-actions.pod:939
6611 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6612 "device named C<device>. For the types of checksums supported see the "
6613 "C<guestfs_checksum> command."
6617 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4629 ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4725 ../src/guestfs-actions.pod:4743 ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:6430 ../src/guestfs-actions.pod:6444 ../src/guestfs-actions.pod:6850
6618 msgid "(Added in 1.3.2)"
6622 #: ../src/guestfs-actions.pod:948
6623 msgid "guestfs_checksums_out"
6627 #: ../src/guestfs-actions.pod:950
6631 " guestfs_checksums_out (guestfs_h *g,\n"
6632 " const char *csumtype,\n"
6633 " const char *directory,\n"
6634 " const char *sumsfile);\n"
6639 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:644
6641 "This command computes the checksums of all regular files in C<directory> and "
6642 "then emits a list of those checksums to the local output file C<sumsfile>."
6646 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:648
6648 "This can be used for verifying the integrity of a virtual machine. However "
6649 "to be properly secure you should pay attention to the output of the checksum "
6650 "command (it uses the ones from GNU coreutils). In particular when the "
6651 "filename is not printable, coreutils uses a special backslash syntax. For "
6652 "more information, see the GNU coreutils info file."
6656 #: ../src/guestfs-actions.pod:970
6657 msgid "(Added in 1.3.7)"
6661 #: ../src/guestfs-actions.pod:972
6662 msgid "guestfs_chmod"
6666 #: ../src/guestfs-actions.pod:974
6670 " guestfs_chmod (guestfs_h *g,\n"
6672 " const char *path);\n"
6677 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:662
6679 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6684 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:665
6686 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6687 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6692 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4145 ../src/guestfs-actions.pod:4328 ../src/guestfs-actions.pod:4347 ../src/guestfs-actions.pod:4366 ../fish/guestfish-actions.pod:669 ../fish/guestfish-actions.pod:2791 ../fish/guestfish-actions.pod:2907 ../fish/guestfish-actions.pod:2917 ../fish/guestfish-actions.pod:2927
6693 msgid "The mode actually set is affected by the umask."
6697 #: ../src/guestfs-actions.pod:992
6698 msgid "guestfs_chown"
6702 #: ../src/guestfs-actions.pod:994
6706 " guestfs_chown (guestfs_h *g,\n"
6709 " const char *path);\n"
6714 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:675
6715 msgid "Change the file owner to C<owner> and group to C<group>."
6719 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3253 ../fish/guestfish-actions.pod:677 ../fish/guestfish-actions.pod:2249
6721 "Only numeric uid and gid are supported. If you want to use names, you will "
6722 "need to locate and parse the password file yourself (Augeas support makes "
6723 "this relatively easy)."
6727 #: ../src/guestfs-actions.pod:1010
6728 msgid "guestfs_command"
6732 #: ../src/guestfs-actions.pod:1012
6736 " guestfs_command (guestfs_h *g,\n"
6737 " char *const *arguments);\n"
6742 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:685
6744 "This call runs a command from the guest filesystem. The filesystem must be "
6745 "mounted, and must contain a compatible operating system (ie. something "
6746 "Linux, with the same or compatible processor architecture)."
6750 #: ../src/guestfs-actions.pod:1021
6752 "The single parameter is an argv-style list of arguments. The first element "
6753 "is the name of the program to run. Subsequent elements are parameters. The "
6754 "list must be non-empty (ie. must contain a program name). Note that the "
6755 "command runs directly, and is I<not> invoked via the shell (see "
6760 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:697
6761 msgid "The return value is anything printed to I<stdout> by the command."
6765 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:700
6767 "If the command returns a non-zero exit status, then this function returns an "
6768 "error message. The error message string is the content of I<stderr> from "
6773 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:704
6775 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
6776 "C</bin>. If you require a program from another location, you should provide "
6777 "the full path in the first parameter."
6781 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
6783 "Shared libraries and data files required by the program must be available on "
6784 "filesystems which are mounted in the correct places. It is the caller's "
6785 "responsibility to ensure all filesystems that are needed are mounted at the "
6790 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072 ../src/guestfs-actions.pod:1535
6791 msgid "(Added in 0.9.1)"
6795 #: ../src/guestfs-actions.pod:1054
6796 msgid "guestfs_command_lines"
6800 #: ../src/guestfs-actions.pod:1056
6804 " guestfs_command_lines (guestfs_h *g,\n"
6805 " char *const *arguments);\n"
6810 #: ../src/guestfs-actions.pod:1060
6812 "This is the same as C<guestfs_command>, but splits the result into a list of "
6817 #: ../src/guestfs-actions.pod:1063
6818 msgid "See also: C<guestfs_sh_lines>"
6822 #: ../src/guestfs-actions.pod:1074
6823 msgid "guestfs_config"
6827 #: ../src/guestfs-actions.pod:1076
6831 " guestfs_config (guestfs_h *g,\n"
6832 " const char *qemuparam,\n"
6833 " const char *qemuvalue);\n"
6838 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:734
6840 "This can be used to add arbitrary qemu command line parameters of the form "
6841 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6842 "setting some parameters which would interfere with parameters that we use."
6846 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
6847 msgid "The first character of C<param> string must be a C<-> (dash)."
6851 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
6852 msgid "C<value> can be NULL."
6856 #: ../src/guestfs-actions.pod:1094
6857 msgid "guestfs_copy_size"
6861 #: ../src/guestfs-actions.pod:1096
6865 " guestfs_copy_size (guestfs_h *g,\n"
6866 " const char *src,\n"
6867 " const char *dest,\n"
6873 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:747
6875 "This command copies exactly C<size> bytes from one source device or file "
6876 "C<src> to another destination device or file C<dest>."
6880 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:750
6882 "Note this will fail if the source is too short or if the destination is not "
6887 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6516 ../src/guestfs-actions.pod:6550 ../src/guestfs-actions.pod:7029 ../src/guestfs-actions.pod:7048
6889 "This long-running command can generate progress notification messages so "
6890 "that the caller can display a progress bar or indicator. To receive these "
6891 "messages, the caller must register a progress callback. See "
6892 "L<guestfs(3)/guestfs_set_progress_callback>."
6896 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3921 ../src/guestfs-actions.pod:5125 ../src/guestfs-actions.pod:6757 ../src/guestfs-actions.pod:6777 ../src/guestfs-actions.pod:6863
6897 msgid "(Added in 1.0.87)"
6901 #: ../src/guestfs-actions.pod:1117
6906 #: ../src/guestfs-actions.pod:1119
6910 " guestfs_cp (guestfs_h *g,\n"
6911 " const char *src,\n"
6912 " const char *dest);\n"
6917 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:757
6919 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6920 "destination filename or destination directory."
6924 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4592 ../src/guestfs-actions.pod:4969
6925 msgid "(Added in 1.0.18)"
6929 #: ../src/guestfs-actions.pod:1131
6930 msgid "guestfs_cp_a"
6934 #: ../src/guestfs-actions.pod:1133
6938 " guestfs_cp_a (guestfs_h *g,\n"
6939 " const char *src,\n"
6940 " const char *dest);\n"
6945 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:764
6947 "This copies a file or directory from C<src> to C<dest> recursively using the "
6952 #: ../src/guestfs-actions.pod:1145
6957 #: ../src/guestfs-actions.pod:1147
6961 " guestfs_dd (guestfs_h *g,\n"
6962 " const char *src,\n"
6963 " const char *dest);\n"
6968 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:771
6970 "This command copies from one source device or file C<src> to another "
6971 "destination device or file C<dest>. Normally you would use this to copy to "
6972 "or from a device or partition, for example to duplicate a filesystem."
6976 #: ../src/guestfs-actions.pod:1157
6978 "If the destination is a device, it must be as large or larger than the "
6979 "source file or device, otherwise the copy will fail. This command cannot do "
6980 "partial copies (see C<guestfs_copy_size>)."
6984 #: ../src/guestfs-actions.pod:1165
6989 #: ../src/guestfs-actions.pod:1167
6993 " guestfs_df (guestfs_h *g);\n"
6998 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:784
6999 msgid "This command runs the C<df> command to report disk space used."
7003 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
7005 "This command is mostly useful for interactive sessions. It is I<not> "
7006 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7011 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2263 ../src/guestfs-actions.pod:2287 ../src/guestfs-actions.pod:2355 ../src/guestfs-actions.pod:4031 ../src/guestfs-actions.pod:4492 ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6278 ../src/guestfs-actions.pod:6896 ../src/guestfs-actions.pod:6909 ../src/guestfs-actions.pod:6922
7012 msgid "(Added in 1.0.54)"
7016 #: ../src/guestfs-actions.pod:1181
7017 msgid "guestfs_df_h"
7021 #: ../src/guestfs-actions.pod:1183
7025 " guestfs_df_h (guestfs_h *g);\n"
7030 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:794
7032 "This command runs the C<df -h> command to report disk space used in "
7033 "human-readable format."
7037 #: ../src/guestfs-actions.pod:1198
7038 msgid "guestfs_dmesg"
7042 #: ../src/guestfs-actions.pod:1200
7046 " guestfs_dmesg (guestfs_h *g);\n"
7051 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:805
7053 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7054 "This is sometimes useful for extended debugging of problems."
7058 #: ../src/guestfs-actions.pod:1207
7060 "Another way to get the same information is to enable verbose messages with "
7061 "C<guestfs_set_verbose> or by setting the environment variable "
7062 "C<LIBGUESTFS_DEBUG=1> before running the program."
7066 #: ../src/guestfs-actions.pod:1217
7067 msgid "guestfs_download"
7071 #: ../src/guestfs-actions.pod:1219
7075 " guestfs_download (guestfs_h *g,\n"
7076 " const char *remotefilename,\n"
7077 " const char *filename);\n"
7082 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249 ../fish/guestfish-actions.pod:818 ../fish/guestfish-actions.pod:831
7084 "Download file C<remotefilename> and save it as C<filename> on the local "
7089 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6510 ../fish/guestfish-actions.pod:821 ../fish/guestfish-actions.pod:4342
7090 msgid "C<filename> can also be a named pipe."
7094 #: ../src/guestfs-actions.pod:1229
7095 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7099 #: ../src/guestfs-actions.pod:1240
7100 msgid "guestfs_download_offset"
7104 #: ../src/guestfs-actions.pod:1242
7108 " guestfs_download_offset (guestfs_h *g,\n"
7109 " const char *remotefilename,\n"
7110 " const char *filename,\n"
7111 " int64_t offset,\n"
7117 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:834
7119 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7120 "region must be within the file or device)."
7124 #: ../src/guestfs-actions.pod:1255
7126 "Note that there is no limit on the amount of data that can be downloaded "
7127 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7128 "full amount unless an error occurs."
7132 #: ../src/guestfs-actions.pod:1260
7133 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7137 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6555
7138 msgid "(Added in 1.5.17)"
7142 #: ../src/guestfs-actions.pod:1271
7143 msgid "guestfs_drop_caches"
7147 #: ../src/guestfs-actions.pod:1273
7151 " guestfs_drop_caches (guestfs_h *g,\n"
7152 " int whattodrop);\n"
7157 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:850
7159 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7160 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7161 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7165 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
7166 msgid "Setting C<whattodrop> to 3 should drop everything."
7170 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
7172 "This automatically calls L<sync(2)> before the operation, so that the "
7173 "maximum guest memory is freed."
7177 #: ../src/guestfs-actions.pod:1291
7182 #: ../src/guestfs-actions.pod:1293
7186 " guestfs_du (guestfs_h *g,\n"
7187 " const char *path);\n"
7192 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:864
7194 "This command runs the C<du -s> command to estimate file space usage for "
7199 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:867
7201 "C<path> can be a file or a directory. If C<path> is a directory then the "
7202 "estimate includes the contents of the directory and all subdirectories "
7207 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:871
7208 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7212 #: ../src/guestfs-actions.pod:1311
7213 msgid "guestfs_e2fsck_f"
7217 #: ../src/guestfs-actions.pod:1313
7221 " guestfs_e2fsck_f (guestfs_h *g,\n"
7222 " const char *device);\n"
7227 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:878
7229 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7230 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
7235 #: ../src/guestfs-actions.pod:1321
7237 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
7238 "Normally you should use C<guestfs_fsck>."
7242 #: ../src/guestfs-actions.pod:1326
7243 msgid "(Added in 1.0.29)"
7247 #: ../src/guestfs-actions.pod:1328
7248 msgid "guestfs_echo_daemon"
7252 #: ../src/guestfs-actions.pod:1330
7256 " guestfs_echo_daemon (guestfs_h *g,\n"
7257 " char *const *words);\n"
7262 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:889
7264 "This command concatenates the list of C<words> passed with single spaces "
7265 "between them and returns the resulting string."
7269 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:892
7270 msgid "You can use this command to test the connection through to the daemon."
7274 #: ../src/guestfs-actions.pod:1339
7275 msgid "See also C<guestfs_ping_daemon>."
7279 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:5758
7280 msgid "(Added in 1.0.69)"
7284 #: ../src/guestfs-actions.pod:1346
7285 msgid "guestfs_egrep"
7289 #: ../src/guestfs-actions.pod:1348
7293 " guestfs_egrep (guestfs_h *g,\n"
7294 " const char *regex,\n"
7295 " const char *path);\n"
7300 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:900
7301 msgid "This calls the external C<egrep> program and returns the matching lines."
7305 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2201 ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:2404 ../src/guestfs-actions.pod:2450 ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:3414 ../src/guestfs-actions.pod:3428 ../src/guestfs-actions.pod:3441 ../src/guestfs-actions.pod:3455 ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:5303 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6134 ../src/guestfs-actions.pod:6147 ../src/guestfs-actions.pod:6160 ../src/guestfs-actions.pod:6182 ../src/guestfs-actions.pod:6195 ../src/guestfs-actions.pod:6208 ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6992 ../src/guestfs-actions.pod:7011 ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7115 ../src/guestfs-actions.pod:7161 ../src/guestfs-actions.pod:7180
7306 msgid "(Added in 1.0.66)"
7310 #: ../src/guestfs-actions.pod:1365
7311 msgid "guestfs_egrepi"
7315 #: ../src/guestfs-actions.pod:1367
7319 " guestfs_egrepi (guestfs_h *g,\n"
7320 " const char *regex,\n"
7321 " const char *path);\n"
7326 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:910
7327 msgid "This calls the external C<egrep -i> program and returns the matching lines."
7331 #: ../src/guestfs-actions.pod:1384
7332 msgid "guestfs_equal"
7336 #: ../src/guestfs-actions.pod:1386
7340 " guestfs_equal (guestfs_h *g,\n"
7341 " const char *file1,\n"
7342 " const char *file2);\n"
7347 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:920
7349 "This compares the two files C<file1> and C<file2> and returns true if their "
7350 "content is exactly equal, or false otherwise."
7354 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:923
7355 msgid "The external L<cmp(1)> program is used for the comparison."
7359 #: ../src/guestfs-actions.pod:1400
7360 msgid "guestfs_exists"
7364 #: ../src/guestfs-actions.pod:1402
7368 " guestfs_exists (guestfs_h *g,\n"
7369 " const char *path);\n"
7374 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:929
7376 "This returns C<true> if and only if there is a file, directory (or anything) "
7377 "with the given C<path> name."
7381 #: ../src/guestfs-actions.pod:1409
7382 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
7386 #: ../src/guestfs-actions.pod:1415
7387 msgid "guestfs_fallocate"
7391 #: ../src/guestfs-actions.pod:1417
7395 " guestfs_fallocate (guestfs_h *g,\n"
7396 " const char *path,\n"
7402 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:938 ../fish/guestfish-actions.pod:957
7404 "This command preallocates a file (containing zero bytes) named C<path> of "
7405 "size C<len> bytes. If the file exists already, it is overwritten."
7409 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:942
7411 "Do not confuse this with the guestfish-specific C<alloc> command which "
7412 "allocates a file in the host and attaches it as a device."
7416 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:946
7418 "This function is deprecated. In new code, use the C<fallocate64> call "
7423 #: ../src/guestfs-actions.pod:1441
7424 msgid "guestfs_fallocate64"
7428 #: ../src/guestfs-actions.pod:1443
7432 " guestfs_fallocate64 (guestfs_h *g,\n"
7433 " const char *path,\n"
7439 #: ../src/guestfs-actions.pod:1452
7441 "Note that this call allocates disk blocks for the file. To create a sparse "
7442 "file use C<guestfs_truncate_size> instead."
7446 #: ../src/guestfs-actions.pod:1455
7448 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
7449 "oversight it only allowed 30 bit lengths to be specified, effectively "
7450 "limiting the maximum size of files created through that call to 1GB."
7454 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:969
7456 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
7457 "commands which create a file in the host and attach it as a device."
7461 #: ../src/guestfs-actions.pod:1466
7462 msgid "(Added in 1.3.17)"
7466 #: ../src/guestfs-actions.pod:1468
7467 msgid "guestfs_fgrep"
7471 #: ../src/guestfs-actions.pod:1470
7475 " guestfs_fgrep (guestfs_h *g,\n"
7476 " const char *pattern,\n"
7477 " const char *path);\n"
7482 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:977
7483 msgid "This calls the external C<fgrep> program and returns the matching lines."
7487 #: ../src/guestfs-actions.pod:1487
7488 msgid "guestfs_fgrepi"
7492 #: ../src/guestfs-actions.pod:1489
7496 " guestfs_fgrepi (guestfs_h *g,\n"
7497 " const char *pattern,\n"
7498 " const char *path);\n"
7503 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:987
7504 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
7508 #: ../src/guestfs-actions.pod:1506
7509 msgid "guestfs_file"
7513 #: ../src/guestfs-actions.pod:1508
7517 " guestfs_file (guestfs_h *g,\n"
7518 " const char *path);\n"
7523 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:997
7525 "This call uses the standard L<file(1)> command to determine the type or "
7526 "contents of the file."
7530 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1000
7532 "This call will also transparently look inside various types of compressed "
7537 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1003
7539 "The exact command which runs is C<file -zb path>. Note in particular that "
7540 "the filename is not prepended to the output (the C<-b> option)."
7544 #: ../src/guestfs-actions.pod:1522
7546 "This command can also be used on C</dev/> devices (and partitions, LV "
7547 "names). You can for example use this to determine if a device contains a "
7548 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7552 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1012
7554 "If the C<path> does not begin with C</dev/> then this command only works for "
7555 "the content of regular files. For other file types (directory, symbolic "
7556 "link etc) it will just return the string C<directory> etc."
7560 #: ../src/guestfs-actions.pod:1537
7561 msgid "guestfs_file_architecture"
7565 #: ../src/guestfs-actions.pod:1539
7569 " guestfs_file_architecture (guestfs_h *g,\n"
7570 " const char *filename);\n"
7575 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1021
7577 "This detects the architecture of the binary C<filename>, and returns it if "
7582 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1024
7583 msgid "Currently defined architectures are:"
7587 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1028
7592 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7594 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7595 "irrespective of the precise processor requirements of the binary."
7599 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1033
7604 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
7605 msgid "64 bit x86-64."
7609 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
7614 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
7615 msgid "32 bit SPARC."
7619 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
7624 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
7625 msgid "64 bit SPARC V9 and above."
7629 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
7634 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
7635 msgid "Intel Itanium."
7639 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
7644 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
7645 msgid "32 bit Power PC."
7649 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
7654 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
7655 msgid "64 bit Power PC."
7659 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1059
7660 msgid "Libguestfs may return other architecture strings in future."
7664 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
7665 msgid "The function works on at least the following types of files:"
7669 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1067
7670 msgid "many types of Un*x and Linux binary"
7674 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1071
7675 msgid "many types of Un*x and Linux shared library"
7679 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1075
7680 msgid "Windows Win32 and Win64 binaries"
7684 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1079
7685 msgid "Windows Win32 and Win64 DLLs"
7689 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
7690 msgid "Win32 binaries and DLLs return C<i386>."
7694 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
7695 msgid "Win64 binaries and DLLs return C<x86_64>."
7699 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1087
7700 msgid "Linux kernel modules"
7704 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1091
7705 msgid "Linux new-style initrd images"
7709 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1095
7710 msgid "some non-x86 Linux vmlinuz kernels"
7714 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1099
7715 msgid "What it can't do currently:"
7719 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1105
7720 msgid "static libraries (libfoo.a)"
7724 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1109
7725 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7729 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1113
7730 msgid "x86 Linux vmlinuz kernels"
7734 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
7736 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7737 "compressed code, and are horribly hard to unpack. If you want to find the "
7738 "architecture of a kernel, use the architecture of the associated initrd or "
7739 "kernel module(s) instead."
7743 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2508 ../src/guestfs-actions.pod:2589 ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:2664 ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:2718 ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:2864 ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3169
7744 msgid "(Added in 1.5.3)"
7748 #: ../src/guestfs-actions.pod:1649
7749 msgid "guestfs_filesize"
7753 #: ../src/guestfs-actions.pod:1651
7757 " guestfs_filesize (guestfs_h *g,\n"
7758 " const char *file);\n"
7763 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1126
7764 msgid "This command returns the size of C<file> in bytes."
7768 #: ../src/guestfs-actions.pod:1657
7770 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7771 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7772 "devices, use C<guestfs_blockdev_getsize64>."
7776 #: ../src/guestfs-actions.pod:1663
7777 msgid "(Added in 1.0.82)"
7781 #: ../src/guestfs-actions.pod:1665
7782 msgid "guestfs_fill"
7786 #: ../src/guestfs-actions.pod:1667
7790 " guestfs_fill (guestfs_h *g,\n"
7793 " const char *path);\n"
7798 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1136
7800 "This command creates a new file called C<path>. The initial content of the "
7801 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
7806 #: ../src/guestfs-actions.pod:1677
7808 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7809 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7810 "bytes use C<guestfs_fill_pattern>."
7814 #: ../src/guestfs-actions.pod:1689
7815 msgid "(Added in 1.0.79)"
7819 #: ../src/guestfs-actions.pod:1691
7820 msgid "guestfs_fill_pattern"
7824 #: ../src/guestfs-actions.pod:1693
7828 " guestfs_fill_pattern (guestfs_h *g,\n"
7829 " const char *pattern,\n"
7831 " const char *path);\n"
7836 #: ../src/guestfs-actions.pod:1699
7838 "This function is like C<guestfs_fill> except that it creates a new file of "
7839 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7840 "pattern is truncated if necessary to ensure the length of the file is "
7841 "exactly C<len> bytes."
7845 #: ../src/guestfs-actions.pod:1711
7846 msgid "(Added in 1.3.12)"
7850 #: ../src/guestfs-actions.pod:1713
7851 msgid "guestfs_find"
7855 #: ../src/guestfs-actions.pod:1715
7859 " guestfs_find (guestfs_h *g,\n"
7860 " const char *directory);\n"
7865 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1158
7867 "This command lists out all files and directories, recursively, starting at "
7868 "C<directory>. It is essentially equivalent to running the shell command "
7869 "C<find directory -print> but some post-processing happens on the output, "
7874 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1163
7876 "This returns a list of strings I<without any prefix>. Thus if the directory "
7881 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1166
7891 #: ../src/guestfs-actions.pod:1731
7892 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7896 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1173
7907 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1178
7908 msgid "If C<directory> is not a directory, then this command returns an error."
7912 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1181
7913 msgid "The returned list is sorted."
7917 #: ../src/guestfs-actions.pod:1744
7918 msgid "See also C<guestfs_find0>."
7922 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3858 ../src/guestfs-actions.pod:5387
7923 msgid "(Added in 1.0.27)"
7927 #: ../src/guestfs-actions.pod:1755
7928 msgid "guestfs_find0"
7932 #: ../src/guestfs-actions.pod:1757
7936 " guestfs_find0 (guestfs_h *g,\n"
7937 " const char *directory,\n"
7938 " const char *files);\n"
7943 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1192
7945 "This command lists out all files and directories, recursively, starting at "
7946 "C<directory>, placing the resulting list in the external file called "
7951 #: ../src/guestfs-actions.pod:1766
7953 "This command works the same way as C<guestfs_find> with the following "
7958 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1203
7959 msgid "The resulting list is written to an external file."
7963 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1207
7965 "Items (filenames) in the result are separated by C<\\0> characters. See "
7966 "L<find(1)> option I<-print0>."
7970 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1212
7971 msgid "This command is not limited in the number of names that it can return."
7975 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1217
7976 msgid "The result list is not sorted."
7980 #: ../src/guestfs-actions.pod:1793
7981 msgid "(Added in 1.0.74)"
7985 #: ../src/guestfs-actions.pod:1795
7986 msgid "guestfs_findfs_label"
7990 #: ../src/guestfs-actions.pod:1797
7994 " guestfs_findfs_label (guestfs_h *g,\n"
7995 " const char *label);\n"
8000 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1227
8002 "This command searches the filesystems and returns the one which has the "
8003 "given label. An error is returned if no such filesystem can be found."
8007 #: ../src/guestfs-actions.pod:1805
8008 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8012 #: ../src/guestfs-actions.pod:1812
8013 msgid "guestfs_findfs_uuid"
8017 #: ../src/guestfs-actions.pod:1814
8021 " guestfs_findfs_uuid (guestfs_h *g,\n"
8022 " const char *uuid);\n"
8027 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1237
8029 "This command searches the filesystems and returns the one which has the "
8030 "given UUID. An error is returned if no such filesystem can be found."
8034 #: ../src/guestfs-actions.pod:1822
8035 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8039 #: ../src/guestfs-actions.pod:1829
8040 msgid "guestfs_fsck"
8044 #: ../src/guestfs-actions.pod:1831
8048 " guestfs_fsck (guestfs_h *g,\n"
8049 " const char *fstype,\n"
8050 " const char *device);\n"
8055 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1247
8057 "This runs the filesystem checker (fsck) on C<device> which should have "
8058 "filesystem type C<fstype>."
8062 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1250
8064 "The returned integer is the status. See L<fsck(8)> for the list of status "
8065 "codes from C<fsck>."
8069 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1259
8070 msgid "Multiple status codes can be summed together."
8074 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1263
8076 "A non-zero return code can mean \"success\", for example if errors have been "
8077 "corrected on the filesystem."
8081 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1268
8082 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8086 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1273
8087 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8091 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:7034
8092 msgid "(Added in 1.0.16)"
8096 #: ../src/guestfs-actions.pod:1868
8097 msgid "guestfs_get_append"
8101 #: ../src/guestfs-actions.pod:1870
8105 " guestfs_get_append (guestfs_h *g);\n"
8110 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1279
8112 "Return the additional kernel options which are added to the guest kernel "
8117 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1282
8118 msgid "If C<NULL> then no options are added."
8122 #: ../src/guestfs-actions.pod:1878
8124 "This function returns a string which may be NULL. There is no way to return "
8125 "an error from this function. The string is owned by the guest handle and "
8126 "must I<not> be freed."
8130 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:5065 ../src/guestfs-actions.pod:5528 ../src/guestfs-actions.pod:5896 ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:5931 ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:6705 ../src/guestfs-actions.pod:6723 ../src/guestfs-actions.pod:7077
8131 msgid "(Added in 1.0.26)"
8135 #: ../src/guestfs-actions.pod:1884
8136 msgid "guestfs_get_autosync"
8140 #: ../src/guestfs-actions.pod:1886
8144 " guestfs_get_autosync (guestfs_h *g);\n"
8149 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
8150 msgid "Get the autosync flag."
8154 #: ../src/guestfs-actions.pod:1895
8155 msgid "guestfs_get_direct"
8159 #: ../src/guestfs-actions.pod:1897
8163 " guestfs_get_direct (guestfs_h *g);\n"
8168 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1294
8169 msgid "Return the direct appliance mode flag."
8173 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5569
8174 msgid "(Added in 1.0.72)"
8178 #: ../src/guestfs-actions.pod:1906
8179 msgid "guestfs_get_e2label"
8183 #: ../src/guestfs-actions.pod:1908
8187 " guestfs_get_e2label (guestfs_h *g,\n"
8188 " const char *device);\n"
8193 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1300
8194 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8198 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1303
8200 "This function is deprecated. In new code, use the C<vfs_label> call "
8205 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:5587 ../src/guestfs-actions.pod:5606
8206 msgid "(Added in 1.0.15)"
8210 #: ../src/guestfs-actions.pod:1927
8211 msgid "guestfs_get_e2uuid"
8215 #: ../src/guestfs-actions.pod:1929
8219 " guestfs_get_e2uuid (guestfs_h *g,\n"
8220 " const char *device);\n"
8225 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1314
8226 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8230 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1317
8231 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
8235 #: ../src/guestfs-actions.pod:1948
8236 msgid "guestfs_get_memsize"
8240 #: ../src/guestfs-actions.pod:1950
8244 " guestfs_get_memsize (guestfs_h *g);\n"
8249 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1328
8250 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
8254 #: ../src/guestfs-actions.pod:1956
8256 "If C<guestfs_set_memsize> was not called on this handle, and if "
8257 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
8258 "value for memsize."
8262 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:5622 ../src/guestfs-actions.pod:5729 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:1386 ../fish/guestfish-actions.pod:3749 ../fish/guestfish-actions.pod:3836
8263 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
8267 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4149 ../src/guestfs-actions.pod:4332 ../src/guestfs-actions.pod:4351 ../src/guestfs-actions.pod:4370 ../src/guestfs-actions.pod:4382 ../src/guestfs-actions.pod:4399 ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:5290 ../src/guestfs-actions.pod:5627 ../src/guestfs-actions.pod:5870 ../src/guestfs-actions.pod:6471
8268 msgid "(Added in 1.0.55)"
8272 #: ../src/guestfs-actions.pod:1967
8273 msgid "guestfs_get_network"
8277 #: ../src/guestfs-actions.pod:1969
8281 " guestfs_get_network (guestfs_h *g);\n"
8286 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1342
8287 msgid "This returns the enable network flag."
8291 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5646
8292 msgid "(Added in 1.5.4)"
8296 #: ../src/guestfs-actions.pod:1978
8297 msgid "guestfs_get_path"
8301 #: ../src/guestfs-actions.pod:1980
8305 " guestfs_get_path (guestfs_h *g);\n"
8310 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1348
8311 msgid "Return the current search path."
8315 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
8317 "This is always non-NULL. If it wasn't set already, then this will return "
8322 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
8324 "This function returns a string, or NULL on error. The string is owned by "
8325 "the guest handle and must I<not> be freed."
8329 #: ../src/guestfs-actions.pod:1993
8330 msgid "guestfs_get_pid"
8334 #: ../src/guestfs-actions.pod:1995
8338 " guestfs_get_pid (guestfs_h *g);\n"
8343 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1359
8345 "Return the process ID of the qemu subprocess. If there is no qemu "
8346 "subprocess, then this will return an error."
8350 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1362
8351 msgid "This is an internal call used for debugging and testing."
8355 #: ../src/guestfs-actions.pod:2005
8356 msgid "(Added in 1.0.56)"
8360 #: ../src/guestfs-actions.pod:2007
8361 msgid "guestfs_get_qemu"
8365 #: ../src/guestfs-actions.pod:2009
8369 " guestfs_get_qemu (guestfs_h *g);\n"
8374 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1368
8375 msgid "Return the current qemu binary."
8379 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
8381 "This is always non-NULL. If it wasn't set already, then this will return "
8382 "the default qemu binary name."
8386 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5691
8387 msgid "(Added in 1.0.6)"
8391 #: ../src/guestfs-actions.pod:2022
8392 msgid "guestfs_get_recovery_proc"
8396 #: ../src/guestfs-actions.pod:2024
8400 " guestfs_get_recovery_proc (guestfs_h *g);\n"
8405 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
8406 msgid "Return the recovery process enabled flag."
8410 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3259 ../src/guestfs-actions.pod:3556 ../src/guestfs-actions.pod:3956 ../src/guestfs-actions.pod:3988 ../src/guestfs-actions.pod:4995 ../src/guestfs-actions.pod:5338 ../src/guestfs-actions.pod:5715 ../src/guestfs-actions.pod:6374 ../src/guestfs-actions.pod:6394 ../src/guestfs-actions.pod:6586
8411 msgid "(Added in 1.0.77)"
8415 #: ../src/guestfs-actions.pod:2033
8416 msgid "guestfs_get_selinux"
8420 #: ../src/guestfs-actions.pod:2035
8424 " guestfs_get_selinux (guestfs_h *g);\n"
8429 #: ../src/guestfs-actions.pod:2038
8431 "This returns the current setting of the selinux flag which is passed to the "
8432 "appliance at boot time. See C<guestfs_set_selinux>."
8436 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109 ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:5788
8437 msgid "(Added in 1.0.67)"
8441 #: ../src/guestfs-actions.pod:2048
8442 msgid "guestfs_get_state"
8446 #: ../src/guestfs-actions.pod:2050
8450 " guestfs_get_state (guestfs_h *g);\n"
8455 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1393
8457 "This returns the current state as an opaque integer. This is only useful "
8458 "for printing debug and internal error messages."
8462 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3062 ../src/guestfs-actions.pod:3091 ../src/guestfs-actions.pod:3152 ../src/guestfs-actions.pod:3179 ../fish/guestfish-actions.pod:1396 ../fish/guestfish-actions.pod:2131 ../fish/guestfish-actions.pod:2149 ../fish/guestfish-actions.pod:2187 ../fish/guestfish-actions.pod:2203
8463 msgid "For more information on states, see L<guestfs(3)>."
8467 #: ../src/guestfs-actions.pod:2062
8468 msgid "guestfs_get_trace"
8472 #: ../src/guestfs-actions.pod:2064
8476 " guestfs_get_trace (guestfs_h *g);\n"
8481 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1402
8482 msgid "Return the command trace flag."
8486 #: ../src/guestfs-actions.pod:2073
8487 msgid "guestfs_get_umask"
8491 #: ../src/guestfs-actions.pod:2075
8495 " guestfs_get_umask (guestfs_h *g);\n"
8500 #: ../src/guestfs-actions.pod:2078
8502 "Return the current umask. By default the umask is C<022> unless it has been "
8503 "set by calling C<guestfs_umask>."
8507 #: ../src/guestfs-actions.pod:2085
8508 msgid "guestfs_get_verbose"
8512 #: ../src/guestfs-actions.pod:2087
8516 " guestfs_get_verbose (guestfs_h *g);\n"
8521 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1415
8522 msgid "This returns the verbose messages flag."
8526 #: ../src/guestfs-actions.pod:2096
8527 msgid "guestfs_getcon"
8531 #: ../src/guestfs-actions.pod:2098
8535 " guestfs_getcon (guestfs_h *g);\n"
8540 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1421
8541 msgid "This gets the SELinux security context of the daemon."
8545 #: ../src/guestfs-actions.pod:2103
8546 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8550 #: ../src/guestfs-actions.pod:2111
8551 msgid "guestfs_getxattr"
8555 #: ../src/guestfs-actions.pod:2113
8559 " guestfs_getxattr (guestfs_h *g,\n"
8560 " const char *path,\n"
8561 " const char *name,\n"
8562 " size_t *size_r);\n"
8567 #: ../src/guestfs-actions.pod:2119
8569 "Get a single extended attribute from file C<path> named C<name>. This call "
8570 "follows symlinks. If you want to lookup an extended attribute for the "
8571 "symlink itself, use C<guestfs_lgetxattr>."
8575 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:3273
8577 "Normally it is better to get all extended attributes from a file in one go "
8578 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
8579 "implementations are buggy and do not provide a way to list out attributes. "
8580 "For these filesystems (notably ntfs-3g) you have to know the names of the "
8581 "extended attributes you want in advance and call this function."
8585 #: ../src/guestfs-actions.pod:2130 ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:1441 ../fish/guestfish-actions.pod:2268
8587 "Extended attribute values are blobs of binary data. If there is no extended "
8588 "attribute named C<name>, this returns an error."
8592 #: ../src/guestfs-actions.pod:2133
8593 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
8597 #: ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:2326 ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:4988 ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5195
8599 "This function returns a buffer, or NULL on error. The size of the returned "
8600 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8605 #: ../src/guestfs-actions.pod:2139 ../src/guestfs-actions.pod:3289
8606 msgid "(Added in 1.7.24)"
8610 #: ../src/guestfs-actions.pod:2141
8611 msgid "guestfs_getxattrs"
8615 #: ../src/guestfs-actions.pod:2143
8618 " struct guestfs_xattr_list *\n"
8619 " guestfs_getxattrs (guestfs_h *g,\n"
8620 " const char *path);\n"
8625 #: ../src/guestfs-actions.pod:2147 ../fish/guestfish-actions.pod:1450
8626 msgid "This call lists the extended attributes of the file or directory C<path>."
8630 #: ../src/guestfs-actions.pod:2150 ../fish/guestfish-actions.pod:1453
8632 "At the system call level, this is a combination of the L<listxattr(2)> and "
8633 "L<getxattr(2)> calls."
8637 #: ../src/guestfs-actions.pod:2153
8638 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8642 #: ../src/guestfs-actions.pod:2155 ../src/guestfs-actions.pod:3301 ../src/guestfs-actions.pod:3952
8644 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8645 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8649 #: ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3305 ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:7142
8650 msgid "(Added in 1.0.59)"
8654 #: ../src/guestfs-actions.pod:2161
8655 msgid "guestfs_glob_expand"
8659 #: ../src/guestfs-actions.pod:2163
8663 " guestfs_glob_expand (guestfs_h *g,\n"
8664 " const char *pattern);\n"
8669 #: ../src/guestfs-actions.pod:2167 ../fish/guestfish-actions.pod:1462
8671 "This command searches for all the pathnames matching C<pattern> according to "
8672 "the wildcard expansion rules used by the shell."
8676 #: ../src/guestfs-actions.pod:2171 ../fish/guestfish-actions.pod:1466
8677 msgid "If no paths match, then this returns an empty list (note: not an error)."
8681 #: ../src/guestfs-actions.pod:2174 ../fish/guestfish-actions.pod:1469
8683 "It is just a wrapper around the C L<glob(3)> function with flags "
8684 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
8688 #: ../src/guestfs-actions.pod:2182 ../src/guestfs-actions.pod:5972 ../src/guestfs-actions.pod:5989
8689 msgid "(Added in 1.0.50)"
8693 #: ../src/guestfs-actions.pod:2184
8694 msgid "guestfs_grep"
8698 #: ../src/guestfs-actions.pod:2186
8702 " guestfs_grep (guestfs_h *g,\n"
8703 " const char *regex,\n"
8704 " const char *path);\n"
8709 #: ../src/guestfs-actions.pod:2191 ../fish/guestfish-actions.pod:1477
8710 msgid "This calls the external C<grep> program and returns the matching lines."
8714 #: ../src/guestfs-actions.pod:2203
8715 msgid "guestfs_grepi"
8719 #: ../src/guestfs-actions.pod:2205
8723 " guestfs_grepi (guestfs_h *g,\n"
8724 " const char *regex,\n"
8725 " const char *path);\n"
8730 #: ../src/guestfs-actions.pod:2210 ../fish/guestfish-actions.pod:1487
8731 msgid "This calls the external C<grep -i> program and returns the matching lines."
8735 #: ../src/guestfs-actions.pod:2222
8736 msgid "guestfs_grub_install"
8740 #: ../src/guestfs-actions.pod:2224
8744 " guestfs_grub_install (guestfs_h *g,\n"
8745 " const char *root,\n"
8746 " const char *device);\n"
8751 #: ../src/guestfs-actions.pod:2229 ../fish/guestfish-actions.pod:1497
8753 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8754 "the root directory being C<root>."
8758 #: ../src/guestfs-actions.pod:2232 ../fish/guestfish-actions.pod:1500
8760 "Note: If grub-install reports the error \"No suitable drive was found in the "
8761 "generated device map.\" it may be that you need to create a "
8762 "C</boot/grub/device.map> file first that contains the mapping between grub "
8763 "device names and Linux device names. It is usually sufficient to create a "
8768 #: ../src/guestfs-actions.pod:2239 ../fish/guestfish-actions.pod:1507
8776 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1509
8777 msgid "replacing C</dev/vda> with the name of the installation device."
8781 #: ../src/guestfs-actions.pod:2245
8782 msgid "(Added in 1.0.17)"
8786 #: ../src/guestfs-actions.pod:2247
8787 msgid "guestfs_head"
8791 #: ../src/guestfs-actions.pod:2249
8795 " guestfs_head (guestfs_h *g,\n"
8796 " const char *path);\n"
8801 #: ../src/guestfs-actions.pod:2253 ../fish/guestfish-actions.pod:1515
8803 "This command returns up to the first 10 lines of a file as a list of "
8808 #: ../src/guestfs-actions.pod:2265
8809 msgid "guestfs_head_n"
8813 #: ../src/guestfs-actions.pod:2267
8817 " guestfs_head_n (guestfs_h *g,\n"
8819 " const char *path);\n"
8824 #: ../src/guestfs-actions.pod:2272 ../fish/guestfish-actions.pod:1525
8826 "If the parameter C<nrlines> is a positive number, this returns the first "
8827 "C<nrlines> lines of the file C<path>."
8831 #: ../src/guestfs-actions.pod:2275 ../fish/guestfish-actions.pod:1528
8833 "If the parameter C<nrlines> is a negative number, this returns lines from "
8834 "the file C<path>, excluding the last C<nrlines> lines."
8838 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6269 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:4182
8839 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8843 #: ../src/guestfs-actions.pod:2289
8844 msgid "guestfs_hexdump"
8848 #: ../src/guestfs-actions.pod:2291
8852 " guestfs_hexdump (guestfs_h *g,\n"
8853 " const char *path);\n"
8858 #: ../src/guestfs-actions.pod:2295 ../fish/guestfish-actions.pod:1540
8860 "This runs C<hexdump -C> on the given C<path>. The result is the "
8861 "human-readable, canonical hex dump of the file."
8865 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6108
8866 msgid "(Added in 1.0.22)"
8870 #: ../src/guestfs-actions.pod:2306
8871 msgid "guestfs_initrd_cat"
8875 #: ../src/guestfs-actions.pod:2308
8879 " guestfs_initrd_cat (guestfs_h *g,\n"
8880 " const char *initrdpath,\n"
8881 " const char *filename,\n"
8882 " size_t *size_r);\n"
8887 #: ../src/guestfs-actions.pod:2314 ../fish/guestfish-actions.pod:1550
8889 "This command unpacks the file C<filename> from the initrd file called "
8890 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8895 #: ../src/guestfs-actions.pod:2318 ../fish/guestfish-actions.pod:1554
8897 "For example, in guestfish you could use the following command to examine the "
8898 "boot script (usually called C</init>) contained in a Linux initrd or "
8903 #: ../src/guestfs-actions.pod:2322 ../fish/guestfish-actions.pod:1558
8906 " initrd-cat /boot/initrd-<version>.img init\n"
8911 #: ../src/guestfs-actions.pod:2324
8912 msgid "See also C<guestfs_initrd_list>."
8916 #: ../src/guestfs-actions.pod:2335
8917 msgid "guestfs_initrd_list"
8921 #: ../src/guestfs-actions.pod:2337
8925 " guestfs_initrd_list (guestfs_h *g,\n"
8926 " const char *path);\n"
8931 #: ../src/guestfs-actions.pod:2341 ../fish/guestfish-actions.pod:1569
8932 msgid "This command lists out files contained in an initrd."
8936 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1571
8938 "The files are listed without any initial C</> character. The files are "
8939 "listed in the order they appear (not necessarily alphabetical). Directory "
8940 "names are listed as separate items."
8944 #: ../src/guestfs-actions.pod:2347 ../fish/guestfish-actions.pod:1575
8946 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8947 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8952 #: ../src/guestfs-actions.pod:2357
8953 msgid "guestfs_inotify_add_watch"
8957 #: ../src/guestfs-actions.pod:2359
8961 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8962 " const char *path,\n"
8968 #: ../src/guestfs-actions.pod:2364 ../fish/guestfish-actions.pod:1583
8969 msgid "Watch C<path> for the events listed in C<mask>."
8973 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1585
8975 "Note that if C<path> is a directory then events within that directory are "
8976 "watched, but this does I<not> happen recursively (in subdirectories)."
8980 #: ../src/guestfs-actions.pod:2370 ../fish/guestfish-actions.pod:1589
8982 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8983 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8987 #: ../src/guestfs-actions.pod:2378
8988 msgid "guestfs_inotify_close"
8992 #: ../src/guestfs-actions.pod:2380
8996 " guestfs_inotify_close (guestfs_h *g);\n"
9001 #: ../src/guestfs-actions.pod:2383 ../fish/guestfish-actions.pod:1597
9003 "This closes the inotify handle which was previously opened by inotify_init. "
9004 "It removes all watches, throws away any pending events, and deallocates all "
9009 #: ../src/guestfs-actions.pod:2391
9010 msgid "guestfs_inotify_files"
9014 #: ../src/guestfs-actions.pod:2393
9018 " guestfs_inotify_files (guestfs_h *g);\n"
9023 #: ../src/guestfs-actions.pod:2396
9025 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9026 "returns a list of pathnames of objects that were touched. The returned "
9027 "pathnames are sorted and deduplicated."
9031 #: ../src/guestfs-actions.pod:2406
9032 msgid "guestfs_inotify_init"
9036 #: ../src/guestfs-actions.pod:2408
9040 " guestfs_inotify_init (guestfs_h *g,\n"
9041 " int maxevents);\n"
9046 #: ../src/guestfs-actions.pod:2412 ../fish/guestfish-actions.pod:1613
9048 "This command creates a new inotify handle. The inotify subsystem can be "
9049 "used to notify events which happen to objects in the guest filesystem."
9053 #: ../src/guestfs-actions.pod:2416
9055 "C<maxevents> is the maximum number of events which will be queued up between "
9056 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9057 "passed as C<0>, then the kernel (or previously set) default is used. For "
9058 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9059 "throws away events, but records the fact that it threw them away by setting "
9060 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9061 "C<guestfs_inotify_read>)."
9065 #: ../src/guestfs-actions.pod:2426
9067 "Before any events are generated, you have to add some watches to the "
9068 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9069 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9073 #: ../src/guestfs-actions.pod:2432
9075 "Queued up events should be read periodically by calling "
9076 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9077 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9078 "often enough then you risk the internal queue overflowing."
9082 #: ../src/guestfs-actions.pod:2439
9084 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9085 "This also removes any watches automatically."
9089 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1644
9091 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9092 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9093 "that there is one global inotify handle per libguestfs instance."
9097 #: ../src/guestfs-actions.pod:2452
9098 msgid "guestfs_inotify_read"
9102 #: ../src/guestfs-actions.pod:2454
9105 " struct guestfs_inotify_event_list *\n"
9106 " guestfs_inotify_read (guestfs_h *g);\n"
9111 #: ../src/guestfs-actions.pod:2457 ../fish/guestfish-actions.pod:1653
9113 "Return the complete queue of events that have happened since the previous "
9118 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1656
9119 msgid "If no events have happened, this returns an empty list."
9123 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1658
9125 "I<Note>: In order to make sure that all events have been read, you must call "
9126 "this function repeatedly until it returns an empty list. The reason is that "
9127 "the call will read events up to the maximum appliance-to-host message size "
9128 "and leave remaining events in the queue."
9132 #: ../src/guestfs-actions.pod:2468
9134 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9135 "there was an error. I<The caller must call "
9136 "C<guestfs_free_inotify_event_list> after use>."
9140 #: ../src/guestfs-actions.pod:2474
9141 msgid "guestfs_inotify_rm_watch"
9145 #: ../src/guestfs-actions.pod:2476
9149 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9155 #: ../src/guestfs-actions.pod:2480
9157 "Remove a previously defined inotify watch. See "
9158 "C<guestfs_inotify_add_watch>."
9162 #: ../src/guestfs-actions.pod:2487
9163 msgid "guestfs_inspect_get_arch"
9167 #: ../src/guestfs-actions.pod:2489
9171 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9172 " const char *root);\n"
9177 #: ../src/guestfs-actions.pod:2493 ../src/guestfs-actions.pod:2516 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2623 ../src/guestfs-actions.pod:2645 ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2726 ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:2786 ../src/guestfs-actions.pod:2830 ../src/guestfs-actions.pod:2872 ../src/guestfs-actions.pod:2895
9179 "This function should only be called with a root device string as returned by "
9180 "C<guestfs_inspect_os>."
9184 #: ../src/guestfs-actions.pod:2496
9186 "This returns the architecture of the inspected operating system. The "
9187 "possible return values are listed under C<guestfs_file_architecture>."
9191 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1682
9193 "If the architecture could not be determined, then the string C<unknown> is "
9198 #: ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:2584 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2742 ../src/guestfs-actions.pod:2773 ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2859 ../src/guestfs-actions.pod:2882 ../src/guestfs-actions.pod:2988 ../src/guestfs-actions.pod:3029 ../fish/guestfish-actions.pod:1685 ../fish/guestfish-actions.pod:1759 ../fish/guestfish-actions.pod:1792 ../fish/guestfish-actions.pod:1813 ../fish/guestfish-actions.pod:1873 ../fish/guestfish-actions.pod:1897 ../fish/guestfish-actions.pod:1914 ../fish/guestfish-actions.pod:1927 ../fish/guestfish-actions.pod:1962 ../fish/guestfish-actions.pod:1978 ../fish/guestfish-actions.pod:2077 ../fish/guestfish-actions.pod:2111
9199 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
9203 #: ../src/guestfs-actions.pod:2510
9204 msgid "guestfs_inspect_get_distro"
9208 #: ../src/guestfs-actions.pod:2512
9212 " guestfs_inspect_get_distro (guestfs_h *g,\n"
9213 " const char *root);\n"
9218 #: ../src/guestfs-actions.pod:2519 ../fish/guestfish-actions.pod:1694
9219 msgid "This returns the distro (distribution) of the inspected operating system."
9223 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1697
9224 msgid "Currently defined distros are:"
9228 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1701
9229 msgid "\"archlinux\""
9233 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1703
9238 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1705
9243 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1707
9248 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1709
9253 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1711
9258 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1713
9263 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1715
9268 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1717
9269 msgid "\"linuxmint\""
9273 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1719
9278 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1721
9279 msgid "\"mandriva\""
9283 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1723
9288 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1725
9293 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1727
9298 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1729
9303 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1731
9308 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1733
9309 msgid "\"redhat-based\""
9313 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1735
9314 msgid "Some Red Hat-derived distro."
9318 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1737
9323 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1739
9324 msgid "Red Hat Enterprise Linux and some derivatives."
9328 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1741
9333 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1743
9338 #: ../src/guestfs-actions.pod:2570 ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1745 ../fish/guestfish-actions.pod:1953
9343 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1747
9344 msgid "The distro could not be determined."
9348 #: ../src/guestfs-actions.pod:2574 ../src/guestfs-actions.pod:2842 ../fish/guestfish-actions.pod:1749 ../fish/guestfish-actions.pod:1945
9353 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1751
9355 "Windows does not have distributions. This string is returned if the OS type "
9360 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2856 ../fish/guestfish-actions.pod:1756 ../fish/guestfish-actions.pod:1959
9362 "Future versions of libguestfs may return other strings here. The caller "
9363 "should be prepared to handle any string."
9367 #: ../src/guestfs-actions.pod:2591
9368 msgid "guestfs_inspect_get_filesystems"
9372 #: ../src/guestfs-actions.pod:2593
9376 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
9377 " const char *root);\n"
9382 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1768
9384 "This returns a list of all the filesystems that we think are associated with "
9385 "this operating system. This includes the root filesystem, other ordinary "
9386 "filesystems, and non-mounted devices like swap partitions."
9390 #: ../src/guestfs-actions.pod:2605 ../fish/guestfish-actions.pod:1773
9392 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
9393 "to be shared between operating systems."
9397 #: ../src/guestfs-actions.pod:2608
9399 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9400 "C<guestfs_inspect_get_mountpoints>."
9404 #: ../src/guestfs-actions.pod:2617
9405 msgid "guestfs_inspect_get_hostname"
9409 #: ../src/guestfs-actions.pod:2619
9413 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
9414 " const char *root);\n"
9419 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1786
9421 "This function returns the hostname of the operating system as found by "
9422 "inspection of the guest's configuration files."
9426 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1789
9428 "If the hostname could not be determined, then the string C<unknown> is "
9433 #: ../src/guestfs-actions.pod:2637
9434 msgid "(Added in 1.7.9)"
9438 #: ../src/guestfs-actions.pod:2639
9439 msgid "guestfs_inspect_get_major_version"
9443 #: ../src/guestfs-actions.pod:2641
9447 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
9448 " const char *root);\n"
9453 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1801
9454 msgid "This returns the major version number of the inspected operating system."
9458 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1804
9460 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9461 "popular public names used by the operating system. Notably the operating "
9462 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9463 "1). You can find out the real versions corresponding to releases of Windows "
9464 "by consulting Wikipedia or MSDN."
9468 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1825
9469 msgid "If the version could not be determined, then C<0> is returned."
9473 #: ../src/guestfs-actions.pod:2666
9474 msgid "guestfs_inspect_get_minor_version"
9478 #: ../src/guestfs-actions.pod:2668
9482 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9483 " const char *root);\n"
9488 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1822
9489 msgid "This returns the minor version number of the inspected operating system."
9493 #: ../src/guestfs-actions.pod:2680
9495 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9496 "C<guestfs_inspect_get_major_version>."
9500 #: ../src/guestfs-actions.pod:2687
9501 msgid "guestfs_inspect_get_mountpoints"
9505 #: ../src/guestfs-actions.pod:2689
9509 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9510 " const char *root);\n"
9515 #: ../src/guestfs-actions.pod:2696 ../fish/guestfish-actions.pod:1837
9517 "This returns a hash of where we think the filesystems associated with this "
9518 "operating system should be mounted. Callers should note that this is at "
9519 "best an educated guess made by reading configuration files such as "
9524 #: ../src/guestfs-actions.pod:2701 ../fish/guestfish-actions.pod:1842
9526 "Each element in the returned hashtable has a key which is the path of the "
9527 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9528 "mounted there (eg. C</dev/sda1>)."
9532 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1847
9533 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
9537 #: ../src/guestfs-actions.pod:2709
9539 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9540 "C<guestfs_inspect_get_filesystems>."
9544 #: ../src/guestfs-actions.pod:2712 ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:6410
9546 "This function returns a NULL-terminated array of strings, or NULL if there "
9547 "was an error. The array of strings will always have length C<2n+1>, where "
9548 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9549 "caller must free the strings and the array after use>."
9553 #: ../src/guestfs-actions.pod:2720
9554 msgid "guestfs_inspect_get_package_format"
9558 #: ../src/guestfs-actions.pod:2722
9562 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9563 " const char *root);\n"
9568 #: ../src/guestfs-actions.pod:2729
9570 "This function and C<guestfs_inspect_get_package_management> return the "
9571 "package format and package management tool used by the inspected operating "
9572 "system. For example for Fedora these functions would return C<rpm> (package "
9573 "format) and C<yum> (package management)."
9577 #: ../src/guestfs-actions.pod:2735 ../fish/guestfish-actions.pod:1866
9579 "This returns the string C<unknown> if we could not determine the package "
9580 "format I<or> if the operating system does not have a real packaging system "
9585 #: ../src/guestfs-actions.pod:2739 ../fish/guestfish-actions.pod:1870
9587 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9588 "Future versions of libguestfs may return other strings."
9592 #: ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:2778
9593 msgid "(Added in 1.7.5)"
9597 #: ../src/guestfs-actions.pod:2749
9598 msgid "guestfs_inspect_get_package_management"
9602 #: ../src/guestfs-actions.pod:2751
9606 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9607 " const char *root);\n"
9612 #: ../src/guestfs-actions.pod:2758
9614 "C<guestfs_inspect_get_package_format> and this function return the package "
9615 "format and package management tool used by the inspected operating system. "
9616 "For example for Fedora these functions would return C<rpm> (package format) "
9617 "and C<yum> (package management)."
9621 #: ../src/guestfs-actions.pod:2764 ../fish/guestfish-actions.pod:1888
9623 "This returns the string C<unknown> if we could not determine the package "
9624 "management tool I<or> if the operating system does not have a real packaging "
9625 "system (eg. Windows)."
9629 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1892
9631 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9632 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9633 "libguestfs may return other strings."
9637 #: ../src/guestfs-actions.pod:2780
9638 msgid "guestfs_inspect_get_product_name"
9642 #: ../src/guestfs-actions.pod:2782
9646 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9647 " const char *root);\n"
9652 #: ../src/guestfs-actions.pod:2789 ../fish/guestfish-actions.pod:1906
9654 "This returns the product name of the inspected operating system. The "
9655 "product name is generally some freeform string which can be displayed to the "
9656 "user, but should not be parsed by programs."
9660 #: ../src/guestfs-actions.pod:2794 ../fish/guestfish-actions.pod:1911
9662 "If the product name could not be determined, then the string C<unknown> is "
9667 #: ../src/guestfs-actions.pod:2804
9668 msgid "guestfs_inspect_get_roots"
9672 #: ../src/guestfs-actions.pod:2806
9676 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9681 #: ../src/guestfs-actions.pod:2809
9683 "This function is a convenient way to get the list of root devices, as "
9684 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9685 "the whole inspection process."
9689 #: ../src/guestfs-actions.pod:2813
9691 "This returns an empty list if either no root devices were found or the "
9692 "caller has not called C<guestfs_inspect_os>."
9696 #: ../src/guestfs-actions.pod:2822
9697 msgid "(Added in 1.7.3)"
9701 #: ../src/guestfs-actions.pod:2824
9702 msgid "guestfs_inspect_get_type"
9706 #: ../src/guestfs-actions.pod:2826
9710 " guestfs_inspect_get_type (guestfs_h *g,\n"
9711 " const char *root);\n"
9716 #: ../src/guestfs-actions.pod:2833 ../fish/guestfish-actions.pod:1936
9718 "This returns the type of the inspected operating system. Currently defined "
9723 #: ../src/guestfs-actions.pod:2838 ../fish/guestfish-actions.pod:1941
9728 #: ../src/guestfs-actions.pod:2840 ../fish/guestfish-actions.pod:1943
9729 msgid "Any Linux-based operating system."
9733 #: ../src/guestfs-actions.pod:2844 ../fish/guestfish-actions.pod:1947
9734 msgid "Any Microsoft Windows operating system."
9738 #: ../src/guestfs-actions.pod:2846 ../fish/guestfish-actions.pod:1949
9743 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1951
9748 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1955
9749 msgid "The operating system type could not be determined."
9753 #: ../src/guestfs-actions.pod:2866
9754 msgid "guestfs_inspect_get_windows_systemroot"
9758 #: ../src/guestfs-actions.pod:2868
9762 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9763 " const char *root);\n"
9768 #: ../src/guestfs-actions.pod:2875 ../fish/guestfish-actions.pod:1971
9770 "This returns the Windows systemroot of the inspected guest. The systemroot "
9771 "is a directory path such as C</WINDOWS>."
9775 #: ../src/guestfs-actions.pod:2878 ../fish/guestfish-actions.pod:1974
9777 "This call assumes that the guest is Windows and that the systemroot could be "
9778 "determined by inspection. If this is not the case then an error is "
9783 #: ../src/guestfs-actions.pod:2887
9784 msgid "(Added in 1.5.25)"
9788 #: ../src/guestfs-actions.pod:2889
9789 msgid "guestfs_inspect_list_applications"
9793 #: ../src/guestfs-actions.pod:2891
9796 " struct guestfs_application_list *\n"
9797 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9798 " const char *root);\n"
9803 #: ../src/guestfs-actions.pod:2898 ../fish/guestfish-actions.pod:1987
9804 msgid "Return the list of applications installed in the operating system."
9808 #: ../src/guestfs-actions.pod:2900
9810 "I<Note:> This call works differently from other parts of the inspection "
9811 "API. You have to call C<guestfs_inspect_os>, then "
9812 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9813 "this. Listing applications is a significantly more difficult operation "
9814 "which requires access to the full filesystem. Also note that unlike the "
9815 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9816 "the libguestfs handle, this call actually reads parts of the mounted "
9817 "filesystems during the call."
9821 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:1999
9823 "This returns an empty list if the inspection code was not able to determine "
9824 "the list of applications."
9828 #: ../src/guestfs-actions.pod:2913 ../fish/guestfish-actions.pod:2002
9829 msgid "The application structure contains the following fields:"
9833 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2006
9838 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2008
9840 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9841 "guests, this is the package name."
9845 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2011
9846 msgid "C<app_display_name>"
9850 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2013
9852 "The display name of the application, sometimes localized to the install "
9853 "language of the guest operating system."
9857 #: ../src/guestfs-actions.pod:2927 ../fish/guestfish-actions.pod:2016
9859 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9860 "to display something can use C<app_name> instead."
9864 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2019
9865 msgid "C<app_epoch>"
9869 #: ../src/guestfs-actions.pod:2932 ../fish/guestfish-actions.pod:2021
9871 "For package managers which use epochs, this contains the epoch of the "
9872 "package (an integer). If unavailable, this is returned as C<0>."
9876 #: ../src/guestfs-actions.pod:2935 ../fish/guestfish-actions.pod:2024
9877 msgid "C<app_version>"
9881 #: ../src/guestfs-actions.pod:2937 ../fish/guestfish-actions.pod:2026
9883 "The version string of the application or package. If unavailable this is "
9884 "returned as an empty string C<\"\">."
9888 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2029
9889 msgid "C<app_release>"
9893 #: ../src/guestfs-actions.pod:2942 ../fish/guestfish-actions.pod:2031
9895 "The release string of the application or package, for package managers that "
9896 "use this. If unavailable this is returned as an empty string C<\"\">."
9900 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2035
9901 msgid "C<app_install_path>"
9905 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2037
9907 "The installation path of the application (on operating systems such as "
9908 "Windows which use installation paths). This path is in the format used by "
9909 "the guest operating system, it is not a libguestfs path."
9913 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2042
9914 msgid "If unavailable this is returned as an empty string C<\"\">."
9918 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2044
9919 msgid "C<app_trans_path>"
9923 #: ../src/guestfs-actions.pod:2957 ../fish/guestfish-actions.pod:2046
9925 "The install path translated into a libguestfs path. If unavailable this is "
9926 "returned as an empty string C<\"\">."
9930 #: ../src/guestfs-actions.pod:2960 ../fish/guestfish-actions.pod:2049
9931 msgid "C<app_publisher>"
9935 #: ../src/guestfs-actions.pod:2962 ../fish/guestfish-actions.pod:2051
9937 "The name of the publisher of the application, for package managers that use "
9938 "this. If unavailable this is returned as an empty string C<\"\">."
9942 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2055
9947 #: ../src/guestfs-actions.pod:2968 ../fish/guestfish-actions.pod:2057
9949 "The URL (eg. upstream URL) of the application. If unavailable this is "
9950 "returned as an empty string C<\"\">."
9954 #: ../src/guestfs-actions.pod:2971 ../fish/guestfish-actions.pod:2060
9955 msgid "C<app_source_package>"
9959 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2062
9961 "For packaging systems which support this, the name of the source package. "
9962 "If unavailable this is returned as an empty string C<\"\">."
9966 #: ../src/guestfs-actions.pod:2976 ../fish/guestfish-actions.pod:2065
9967 msgid "C<app_summary>"
9971 #: ../src/guestfs-actions.pod:2978 ../fish/guestfish-actions.pod:2067
9973 "A short (usually one line) description of the application or package. If "
9974 "unavailable this is returned as an empty string C<\"\">."
9978 #: ../src/guestfs-actions.pod:2981 ../fish/guestfish-actions.pod:2070
9979 msgid "C<app_description>"
9983 #: ../src/guestfs-actions.pod:2983 ../fish/guestfish-actions.pod:2072
9985 "A longer description of the application or package. If unavailable this is "
9986 "returned as an empty string C<\"\">."
9990 #: ../src/guestfs-actions.pod:2990
9992 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9993 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9998 #: ../src/guestfs-actions.pod:2994
9999 msgid "(Added in 1.7.8)"
10003 #: ../src/guestfs-actions.pod:2996
10004 msgid "guestfs_inspect_os"
10008 #: ../src/guestfs-actions.pod:2998
10012 " guestfs_inspect_os (guestfs_h *g);\n"
10017 #: ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:2083
10019 "This function uses other libguestfs functions and certain heuristics to "
10020 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
10021 "for operating systems."
10025 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2087
10026 msgid "The list returned is empty if no operating systems were found."
10030 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2089
10032 "If one operating system was found, then this returns a list with a single "
10033 "element, which is the name of the root filesystem of this operating system. "
10034 "It is also possible for this function to return a list containing more than "
10035 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
10036 "element being the root filesystem of one of the operating systems."
10040 #: ../src/guestfs-actions.pod:3014
10042 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
10043 "functions in order to query further information about each operating system, "
10044 "such as the name and version."
10048 #: ../src/guestfs-actions.pod:3019
10050 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
10051 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
10052 "the contents. This should be called with no disks currently mounted. The "
10053 "function may also use Augeas, so any existing Augeas handle will be closed."
10057 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:2107
10059 "This function cannot decrypt encrypted disks. The caller must do that first "
10060 "(supplying the necessary keys) if the disk is encrypted."
10064 #: ../src/guestfs-actions.pod:3031 ../src/guestfs-actions.pod:3316 ../src/guestfs-actions.pod:3378
10065 msgid "See also C<guestfs_list_filesystems>."
10069 #: ../src/guestfs-actions.pod:3039
10070 msgid "guestfs_is_blockdev"
10074 #: ../src/guestfs-actions.pod:3041
10078 " guestfs_is_blockdev (guestfs_h *g,\n"
10079 " const char *path);\n"
10084 #: ../src/guestfs-actions.pod:3045 ../fish/guestfish-actions.pod:2119
10086 "This returns C<true> if and only if there is a block device with the given "
10091 #: ../src/guestfs-actions.pod:3048 ../src/guestfs-actions.pod:3077 ../src/guestfs-actions.pod:3107 ../src/guestfs-actions.pod:3122 ../src/guestfs-actions.pod:3138 ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3209
10092 msgid "See also C<guestfs_stat>."
10096 #: ../src/guestfs-actions.pod:3052 ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3126 ../src/guestfs-actions.pod:3198 ../src/guestfs-actions.pod:3213
10097 msgid "(Added in 1.5.10)"
10101 #: ../src/guestfs-actions.pod:3054
10102 msgid "guestfs_is_busy"
10106 #: ../src/guestfs-actions.pod:3056
10110 " guestfs_is_busy (guestfs_h *g);\n"
10115 #: ../src/guestfs-actions.pod:3059 ../fish/guestfish-actions.pod:2128
10117 "This returns true iff this handle is busy processing a command (in the "
10122 #: ../src/guestfs-actions.pod:3068
10123 msgid "guestfs_is_chardev"
10127 #: ../src/guestfs-actions.pod:3070
10131 " guestfs_is_chardev (guestfs_h *g,\n"
10132 " const char *path);\n"
10137 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2137
10139 "This returns C<true> if and only if there is a character device with the "
10140 "given C<path> name."
10144 #: ../src/guestfs-actions.pod:3083
10145 msgid "guestfs_is_config"
10149 #: ../src/guestfs-actions.pod:3085
10153 " guestfs_is_config (guestfs_h *g);\n"
10158 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:2146
10160 "This returns true iff this handle is being configured (in the C<CONFIG> "
10165 #: ../src/guestfs-actions.pod:3097
10166 msgid "guestfs_is_dir"
10170 #: ../src/guestfs-actions.pod:3099
10174 " guestfs_is_dir (guestfs_h *g,\n"
10175 " const char *path);\n"
10180 #: ../src/guestfs-actions.pod:3103 ../fish/guestfish-actions.pod:2155
10182 "This returns C<true> if and only if there is a directory with the given "
10183 "C<path> name. Note that it returns false for other objects like files."
10187 #: ../src/guestfs-actions.pod:3113
10188 msgid "guestfs_is_fifo"
10192 #: ../src/guestfs-actions.pod:3115
10196 " guestfs_is_fifo (guestfs_h *g,\n"
10197 " const char *path);\n"
10202 #: ../src/guestfs-actions.pod:3119 ../fish/guestfish-actions.pod:2165
10204 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
10205 "given C<path> name."
10209 #: ../src/guestfs-actions.pod:3128
10210 msgid "guestfs_is_file"
10214 #: ../src/guestfs-actions.pod:3130
10218 " guestfs_is_file (guestfs_h *g,\n"
10219 " const char *path);\n"
10224 #: ../src/guestfs-actions.pod:3134 ../fish/guestfish-actions.pod:2174
10226 "This returns C<true> if and only if there is a regular file with the given "
10227 "C<path> name. Note that it returns false for other objects like "
10232 #: ../src/guestfs-actions.pod:3144
10233 msgid "guestfs_is_launching"
10237 #: ../src/guestfs-actions.pod:3146
10241 " guestfs_is_launching (guestfs_h *g);\n"
10246 #: ../src/guestfs-actions.pod:3149 ../fish/guestfish-actions.pod:2184
10248 "This returns true iff this handle is launching the subprocess (in the "
10249 "C<LAUNCHING> state)."
10253 #: ../src/guestfs-actions.pod:3158
10254 msgid "guestfs_is_lv"
10258 #: ../src/guestfs-actions.pod:3160
10262 " guestfs_is_lv (guestfs_h *g,\n"
10263 " const char *device);\n"
10268 #: ../src/guestfs-actions.pod:3164 ../fish/guestfish-actions.pod:2193
10270 "This command tests whether C<device> is a logical volume, and returns true "
10271 "iff this is the case."
10275 #: ../src/guestfs-actions.pod:3171
10276 msgid "guestfs_is_ready"
10280 #: ../src/guestfs-actions.pod:3173
10284 " guestfs_is_ready (guestfs_h *g);\n"
10289 #: ../src/guestfs-actions.pod:3176 ../fish/guestfish-actions.pod:2200
10291 "This returns true iff this handle is ready to accept commands (in the "
10296 #: ../src/guestfs-actions.pod:3185
10297 msgid "guestfs_is_socket"
10301 #: ../src/guestfs-actions.pod:3187
10305 " guestfs_is_socket (guestfs_h *g,\n"
10306 " const char *path);\n"
10311 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2209
10313 "This returns C<true> if and only if there is a Unix domain socket with the "
10314 "given C<path> name."
10318 #: ../src/guestfs-actions.pod:3200
10319 msgid "guestfs_is_symlink"
10323 #: ../src/guestfs-actions.pod:3202
10327 " guestfs_is_symlink (guestfs_h *g,\n"
10328 " const char *path);\n"
10333 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2218
10335 "This returns C<true> if and only if there is a symbolic link with the given "
10340 #: ../src/guestfs-actions.pod:3215
10341 msgid "guestfs_kill_subprocess"
10345 #: ../src/guestfs-actions.pod:3217
10349 " guestfs_kill_subprocess (guestfs_h *g);\n"
10354 #: ../src/guestfs-actions.pod:3220 ../fish/guestfish-actions.pod:2227
10355 msgid "This kills the qemu subprocess. You should never need to call this."
10359 #: ../src/guestfs-actions.pod:3226
10360 msgid "guestfs_launch"
10364 #: ../src/guestfs-actions.pod:3228
10368 " guestfs_launch (guestfs_h *g);\n"
10373 #: ../src/guestfs-actions.pod:3231 ../fish/guestfish-actions.pod:2235
10375 "Internally libguestfs is implemented by running a virtual machine using "
10380 #: ../src/guestfs-actions.pod:3234 ../fish/guestfish-actions.pod:2238
10382 "You should call this after configuring the handle (eg. adding drives) but "
10383 "before performing any actions."
10387 #: ../src/guestfs-actions.pod:3241
10388 msgid "guestfs_lchown"
10392 #: ../src/guestfs-actions.pod:3243
10396 " guestfs_lchown (guestfs_h *g,\n"
10399 " const char *path);\n"
10404 #: ../src/guestfs-actions.pod:3249
10406 "Change the file owner to C<owner> and group to C<group>. This is like "
10407 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
10408 "changed, not the target."
10412 #: ../src/guestfs-actions.pod:3261
10413 msgid "guestfs_lgetxattr"
10417 #: ../src/guestfs-actions.pod:3263
10421 " guestfs_lgetxattr (guestfs_h *g,\n"
10422 " const char *path,\n"
10423 " const char *name,\n"
10424 " size_t *size_r);\n"
10429 #: ../src/guestfs-actions.pod:3269 ../fish/guestfish-actions.pod:2257
10431 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
10432 "is a symlink, then this call returns an extended attribute from the symlink."
10436 #: ../src/guestfs-actions.pod:3283
10437 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
10441 #: ../src/guestfs-actions.pod:3291
10442 msgid "guestfs_lgetxattrs"
10446 #: ../src/guestfs-actions.pod:3293
10449 " struct guestfs_xattr_list *\n"
10450 " guestfs_lgetxattrs (guestfs_h *g,\n"
10451 " const char *path);\n"
10456 #: ../src/guestfs-actions.pod:3297
10458 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
10459 "then it returns the extended attributes of the link itself."
10463 #: ../src/guestfs-actions.pod:3307
10464 msgid "guestfs_list_devices"
10468 #: ../src/guestfs-actions.pod:3309
10472 " guestfs_list_devices (guestfs_h *g);\n"
10477 #: ../src/guestfs-actions.pod:3312 ../fish/guestfish-actions.pod:2285
10478 msgid "List all the block devices."
10482 #: ../src/guestfs-actions.pod:3314 ../fish/guestfish-actions.pod:2287
10483 msgid "The full block device names are returned, eg. C</dev/sda>."
10487 #: ../src/guestfs-actions.pod:3324
10488 msgid "guestfs_list_filesystems"
10492 #: ../src/guestfs-actions.pod:3326
10496 " guestfs_list_filesystems (guestfs_h *g);\n"
10501 #: ../src/guestfs-actions.pod:3329 ../fish/guestfish-actions.pod:2295
10503 "This inspection command looks for filesystems on partitions, block devices "
10504 "and logical volumes, returning a list of devices containing filesystems and "
10509 #: ../src/guestfs-actions.pod:3333 ../fish/guestfish-actions.pod:2299
10511 "The return value is a hash, where the keys are the devices containing "
10512 "filesystems, and the values are the filesystem types. For example:"
10516 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2303
10519 " \"/dev/sda1\" => \"ntfs\"\n"
10520 " \"/dev/sda2\" => \"ext2\"\n"
10521 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10522 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10527 #: ../src/guestfs-actions.pod:3342 ../fish/guestfish-actions.pod:2308
10529 "The value can have the special value \"unknown\", meaning the content of the "
10530 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10534 #: ../src/guestfs-actions.pod:3346
10536 "This command runs other libguestfs commands, which might include "
10537 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10538 "soon after launch and only when nothing is mounted."
10542 #: ../src/guestfs-actions.pod:3350
10544 "Not all of the filesystems returned will be mountable. In particular, swap "
10545 "partitions are returned in the list. Also this command does not check that "
10546 "each filesystem found is valid and mountable, and some filesystems might be "
10547 "mountable but require special options. Filesystems may not all belong to a "
10548 "single logical operating system (use C<guestfs_inspect_os> to look for "
10553 #: ../src/guestfs-actions.pod:3364 ../src/guestfs-actions.pod:4955
10554 msgid "(Added in 1.5.15)"
10558 #: ../src/guestfs-actions.pod:3366
10559 msgid "guestfs_list_partitions"
10563 #: ../src/guestfs-actions.pod:3368
10567 " guestfs_list_partitions (guestfs_h *g);\n"
10572 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2328
10573 msgid "List all the partitions detected on all block devices."
10577 #: ../src/guestfs-actions.pod:3373 ../fish/guestfish-actions.pod:2330
10578 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10582 #: ../src/guestfs-actions.pod:3375
10584 "This does not return logical volumes. For that you will need to call "
10589 #: ../src/guestfs-actions.pod:3386
10594 #: ../src/guestfs-actions.pod:3388
10598 " guestfs_ll (guestfs_h *g,\n"
10599 " const char *directory);\n"
10604 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2341
10606 "List the files in C<directory> (relative to the root directory, there is no "
10607 "cwd) in the format of 'ls -la'."
10611 #: ../src/guestfs-actions.pod:3395 ../fish/guestfish-actions.pod:2344
10613 "This command is mostly useful for interactive sessions. It is I<not> "
10614 "intended that you try to parse the output string."
10618 #: ../src/guestfs-actions.pod:3403
10623 #: ../src/guestfs-actions.pod:3405
10627 " guestfs_ln (guestfs_h *g,\n"
10628 " const char *target,\n"
10629 " const char *linkname);\n"
10634 #: ../src/guestfs-actions.pod:3410 ../fish/guestfish-actions.pod:2351
10635 msgid "This command creates a hard link using the C<ln> command."
10639 #: ../src/guestfs-actions.pod:3416
10640 msgid "guestfs_ln_f"
10644 #: ../src/guestfs-actions.pod:3418
10648 " guestfs_ln_f (guestfs_h *g,\n"
10649 " const char *target,\n"
10650 " const char *linkname);\n"
10655 #: ../src/guestfs-actions.pod:3423 ../fish/guestfish-actions.pod:2357
10657 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10658 "option removes the link (C<linkname>) if it exists already."
10662 #: ../src/guestfs-actions.pod:3430
10663 msgid "guestfs_ln_s"
10667 #: ../src/guestfs-actions.pod:3432
10671 " guestfs_ln_s (guestfs_h *g,\n"
10672 " const char *target,\n"
10673 " const char *linkname);\n"
10678 #: ../src/guestfs-actions.pod:3437 ../fish/guestfish-actions.pod:2364
10679 msgid "This command creates a symbolic link using the C<ln -s> command."
10683 #: ../src/guestfs-actions.pod:3443
10684 msgid "guestfs_ln_sf"
10688 #: ../src/guestfs-actions.pod:3445
10692 " guestfs_ln_sf (guestfs_h *g,\n"
10693 " const char *target,\n"
10694 " const char *linkname);\n"
10699 #: ../src/guestfs-actions.pod:3450 ../fish/guestfish-actions.pod:2370
10701 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10702 "option removes the link (C<linkname>) if it exists already."
10706 #: ../src/guestfs-actions.pod:3457
10707 msgid "guestfs_lremovexattr"
10711 #: ../src/guestfs-actions.pod:3459
10715 " guestfs_lremovexattr (guestfs_h *g,\n"
10716 " const char *xattr,\n"
10717 " const char *path);\n"
10722 #: ../src/guestfs-actions.pod:3464
10724 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10725 "link, then it removes an extended attribute of the link itself."
10729 #: ../src/guestfs-actions.pod:3472
10734 #: ../src/guestfs-actions.pod:3474
10738 " guestfs_ls (guestfs_h *g,\n"
10739 " const char *directory);\n"
10744 #: ../src/guestfs-actions.pod:3478 ../fish/guestfish-actions.pod:2385
10746 "List the files in C<directory> (relative to the root directory, there is no "
10747 "cwd). The '.' and '..' entries are not returned, but hidden files are "
10752 #: ../src/guestfs-actions.pod:3482
10754 "This command is mostly useful for interactive sessions. Programs should "
10755 "probably use C<guestfs_readdir> instead."
10759 #: ../src/guestfs-actions.pod:3491
10760 msgid "guestfs_lsetxattr"
10764 #: ../src/guestfs-actions.pod:3493
10768 " guestfs_lsetxattr (guestfs_h *g,\n"
10769 " const char *xattr,\n"
10770 " const char *val,\n"
10772 " const char *path);\n"
10777 #: ../src/guestfs-actions.pod:3500
10779 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10780 "then it sets an extended attribute of the link itself."
10784 #: ../src/guestfs-actions.pod:3508
10785 msgid "guestfs_lstat"
10789 #: ../src/guestfs-actions.pod:3510
10792 " struct guestfs_stat *\n"
10793 " guestfs_lstat (guestfs_h *g,\n"
10794 " const char *path);\n"
10799 #: ../src/guestfs-actions.pod:3514 ../src/guestfs-actions.pod:6009 ../fish/guestfish-actions.pod:2404 ../fish/guestfish-actions.pod:4017
10800 msgid "Returns file information for the given C<path>."
10804 #: ../src/guestfs-actions.pod:3516
10806 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10807 "link, then the link is stat-ed, not the file it refers to."
10811 #: ../src/guestfs-actions.pod:3520 ../fish/guestfish-actions.pod:2410
10812 msgid "This is the same as the C<lstat(2)> system call."
10816 #: ../src/guestfs-actions.pod:3522 ../src/guestfs-actions.pod:6013
10818 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10819 "error. I<The caller must call C<guestfs_free_stat> after use>."
10823 #: ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:6017 ../src/guestfs-actions.pod:6035 ../src/guestfs-actions.pod:6416
10824 msgid "(Added in 0.9.2)"
10828 #: ../src/guestfs-actions.pod:3528
10829 msgid "guestfs_lstatlist"
10833 #: ../src/guestfs-actions.pod:3530
10836 " struct guestfs_stat_list *\n"
10837 " guestfs_lstatlist (guestfs_h *g,\n"
10838 " const char *path,\n"
10839 " char *const *names);\n"
10844 #: ../src/guestfs-actions.pod:3535
10846 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10847 "files, where all files are in the directory C<path>. C<names> is the list "
10848 "of files from this directory."
10852 #: ../src/guestfs-actions.pod:3539 ../fish/guestfish-actions.pod:2420
10854 "On return you get a list of stat structs, with a one-to-one correspondence "
10855 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10856 "then the C<ino> field of that structure is set to C<-1>."
10860 #: ../src/guestfs-actions.pod:3544
10862 "This call is intended for programs that want to efficiently list a directory "
10863 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10864 "for a similarly efficient call for getting extended attributes. Very long "
10865 "directory listings might cause the protocol message size to be exceeded, "
10866 "causing this call to fail. The caller must split up such requests into "
10867 "smaller groups of names."
10871 #: ../src/guestfs-actions.pod:3552
10873 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10874 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10878 #: ../src/guestfs-actions.pod:3558
10879 msgid "guestfs_luks_add_key"
10883 #: ../src/guestfs-actions.pod:3560
10887 " guestfs_luks_add_key (guestfs_h *g,\n"
10888 " const char *device,\n"
10889 " const char *key,\n"
10890 " const char *newkey,\n"
10896 #: ../src/guestfs-actions.pod:3567 ../fish/guestfish-actions.pod:2437
10898 "This command adds a new key on LUKS device C<device>. C<key> is any "
10899 "existing key, and is used to access the device. C<newkey> is the new key to "
10900 "add. C<keyslot> is the key slot that will be replaced."
10904 #: ../src/guestfs-actions.pod:3572
10906 "Note that if C<keyslot> already contains a key, then this command will "
10907 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10911 #: ../src/guestfs-actions.pod:3578 ../src/guestfs-actions.pod:3618 ../src/guestfs-actions.pod:3641 ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3693 ../src/guestfs-actions.pod:3712
10913 "This function takes a key or passphrase parameter which could contain "
10914 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10919 #: ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3622 ../src/guestfs-actions.pod:3645 ../src/guestfs-actions.pod:3665
10920 msgid "(Added in 1.5.2)"
10924 #: ../src/guestfs-actions.pod:3584
10925 msgid "guestfs_luks_close"
10929 #: ../src/guestfs-actions.pod:3586
10933 " guestfs_luks_close (guestfs_h *g,\n"
10934 " const char *device);\n"
10939 #: ../src/guestfs-actions.pod:3590
10941 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10942 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10943 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10944 "underlying block device."
10948 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:3697 ../src/guestfs-actions.pod:3716 ../src/guestfs-actions.pod:3766 ../src/guestfs-actions.pod:3814
10949 msgid "(Added in 1.5.1)"
10953 #: ../src/guestfs-actions.pod:3600
10954 msgid "guestfs_luks_format"
10958 #: ../src/guestfs-actions.pod:3602
10962 " guestfs_luks_format (guestfs_h *g,\n"
10963 " const char *device,\n"
10964 " const char *key,\n"
10970 #: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2463
10972 "This command erases existing data on C<device> and formats the device as a "
10973 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10974 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10978 #: ../src/guestfs-actions.pod:3615 ../src/guestfs-actions.pod:3638 ../src/guestfs-actions.pod:3778 ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:5469 ../src/guestfs-actions.pod:5844 ../src/guestfs-actions.pod:5867 ../src/guestfs-actions.pod:5893 ../src/guestfs-actions.pod:7053 ../fish/guestfish-actions.pod:2471 ../fish/guestfish-actions.pod:2484 ../fish/guestfish-actions.pod:2568 ../fish/guestfish-actions.pod:3129 ../fish/guestfish-actions.pod:3636 ../fish/guestfish-actions.pod:3916 ../fish/guestfish-actions.pod:3932 ../fish/guestfish-actions.pod:3947 ../fish/guestfish-actions.pod:4662
10980 "B<This command is dangerous. Without careful use you can easily destroy all "
10985 #: ../src/guestfs-actions.pod:3624
10986 msgid "guestfs_luks_format_cipher"
10990 #: ../src/guestfs-actions.pod:3626
10994 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10995 " const char *device,\n"
10996 " const char *key,\n"
10998 " const char *cipher);\n"
11003 #: ../src/guestfs-actions.pod:3633
11005 "This command is the same as C<guestfs_luks_format> but it also allows you to "
11006 "set the C<cipher> used."
11010 #: ../src/guestfs-actions.pod:3647
11011 msgid "guestfs_luks_kill_slot"
11015 #: ../src/guestfs-actions.pod:3649
11019 " guestfs_luks_kill_slot (guestfs_h *g,\n"
11020 " const char *device,\n"
11021 " const char *key,\n"
11027 #: ../src/guestfs-actions.pod:3655 ../fish/guestfish-actions.pod:2491
11029 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
11030 "device C<device>. C<key> must be one of the I<other> keys."
11034 #: ../src/guestfs-actions.pod:3667
11035 msgid "guestfs_luks_open"
11039 #: ../src/guestfs-actions.pod:3669
11043 " guestfs_luks_open (guestfs_h *g,\n"
11044 " const char *device,\n"
11045 " const char *key,\n"
11046 " const char *mapname);\n"
11051 #: ../src/guestfs-actions.pod:3675 ../fish/guestfish-actions.pod:2502
11053 "This command opens a block device which has been encrypted according to the "
11054 "Linux Unified Key Setup (LUKS) standard."
11058 #: ../src/guestfs-actions.pod:3678 ../fish/guestfish-actions.pod:2505
11059 msgid "C<device> is the encrypted block device or partition."
11063 #: ../src/guestfs-actions.pod:3680 ../fish/guestfish-actions.pod:2507
11065 "The caller must supply one of the keys associated with the LUKS block "
11066 "device, in the C<key> parameter."
11070 #: ../src/guestfs-actions.pod:3683 ../fish/guestfish-actions.pod:2510
11072 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
11073 "writes to this block device are decrypted from and encrypted to the "
11074 "underlying C<device> respectively."
11078 #: ../src/guestfs-actions.pod:3687
11080 "If this block device contains LVM volume groups, then calling "
11081 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
11086 #: ../src/guestfs-actions.pod:3699
11087 msgid "guestfs_luks_open_ro"
11091 #: ../src/guestfs-actions.pod:3701
11095 " guestfs_luks_open_ro (guestfs_h *g,\n"
11096 " const char *device,\n"
11097 " const char *key,\n"
11098 " const char *mapname);\n"
11103 #: ../src/guestfs-actions.pod:3707
11105 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
11110 #: ../src/guestfs-actions.pod:3718
11111 msgid "guestfs_lvcreate"
11115 #: ../src/guestfs-actions.pod:3720
11119 " guestfs_lvcreate (guestfs_h *g,\n"
11120 " const char *logvol,\n"
11121 " const char *volgroup,\n"
11127 #: ../src/guestfs-actions.pod:3726 ../fish/guestfish-actions.pod:2535
11129 "This creates an LVM logical volume called C<logvol> on the volume group "
11130 "C<volgroup>, with C<size> megabytes."
11134 #: ../src/guestfs-actions.pod:3733
11135 msgid "guestfs_lvm_canonical_lv_name"
11139 #: ../src/guestfs-actions.pod:3735
11143 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
11144 " const char *lvname);\n"
11149 #: ../src/guestfs-actions.pod:3739 ../fish/guestfish-actions.pod:2542
11151 "This converts alternative naming schemes for LVs that you might find to the "
11152 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
11157 #: ../src/guestfs-actions.pod:3743 ../fish/guestfish-actions.pod:2546
11159 "This command returns an error if the C<lvname> parameter does not refer to a "
11164 #: ../src/guestfs-actions.pod:3746
11165 msgid "See also C<guestfs_is_lv>."
11169 #: ../src/guestfs-actions.pod:3751
11170 msgid "(Added in 1.5.24)"
11174 #: ../src/guestfs-actions.pod:3753
11175 msgid "guestfs_lvm_clear_filter"
11179 #: ../src/guestfs-actions.pod:3755
11183 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
11188 #: ../src/guestfs-actions.pod:3758
11190 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
11191 "see every block device."
11195 #: ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:3803 ../fish/guestfish-actions.pod:2558 ../fish/guestfish-actions.pod:2589
11196 msgid "This command also clears the LVM cache and performs a volume group scan."
11200 #: ../src/guestfs-actions.pod:3768
11201 msgid "guestfs_lvm_remove_all"
11205 #: ../src/guestfs-actions.pod:3770
11209 " guestfs_lvm_remove_all (guestfs_h *g);\n"
11214 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2565
11216 "This command removes all LVM logical volumes, volume groups and physical "
11221 #: ../src/guestfs-actions.pod:3783
11222 msgid "guestfs_lvm_set_filter"
11226 #: ../src/guestfs-actions.pod:3785
11230 " guestfs_lvm_set_filter (guestfs_h *g,\n"
11231 " char *const *devices);\n"
11236 #: ../src/guestfs-actions.pod:3789 ../fish/guestfish-actions.pod:2575
11238 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
11239 "block devices in the list C<devices>, and will ignore all other attached "
11244 #: ../src/guestfs-actions.pod:3793 ../fish/guestfish-actions.pod:2579
11246 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
11247 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
11248 "there are two types of duplication possible: either cloned PVs/VGs which "
11249 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
11250 "same name. In normal operation you cannot create this situation, but you "
11251 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
11252 "inside the LVM metadata."
11256 #: ../src/guestfs-actions.pod:3806 ../fish/guestfish-actions.pod:2592
11257 msgid "You can filter whole block devices or individual partitions."
11261 #: ../src/guestfs-actions.pod:3808 ../fish/guestfish-actions.pod:2594
11263 "You cannot use this if any VG is currently in use (eg. contains a mounted "
11264 "filesystem), even if you are not filtering out that VG."
11268 #: ../src/guestfs-actions.pod:3816
11269 msgid "guestfs_lvremove"
11273 #: ../src/guestfs-actions.pod:3818
11277 " guestfs_lvremove (guestfs_h *g,\n"
11278 " const char *device);\n"
11283 #: ../src/guestfs-actions.pod:3822 ../fish/guestfish-actions.pod:2602
11285 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
11286 "LV, such as C</dev/VG/LV>."
11290 #: ../src/guestfs-actions.pod:3825 ../fish/guestfish-actions.pod:2605
11292 "You can also remove all LVs in a volume group by specifying the VG name, "
11297 #: ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:6792
11298 msgid "(Added in 1.0.13)"
11302 #: ../src/guestfs-actions.pod:3832
11303 msgid "guestfs_lvrename"
11307 #: ../src/guestfs-actions.pod:3834
11311 " guestfs_lvrename (guestfs_h *g,\n"
11312 " const char *logvol,\n"
11313 " const char *newlogvol);\n"
11318 #: ../src/guestfs-actions.pod:3839 ../fish/guestfish-actions.pod:2612
11319 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
11323 #: ../src/guestfs-actions.pod:3843 ../src/guestfs-actions.pod:6805
11324 msgid "(Added in 1.0.83)"
11328 #: ../src/guestfs-actions.pod:3845
11329 msgid "guestfs_lvresize"
11333 #: ../src/guestfs-actions.pod:3847
11337 " guestfs_lvresize (guestfs_h *g,\n"
11338 " const char *device,\n"
11344 #: ../src/guestfs-actions.pod:3852 ../fish/guestfish-actions.pod:2618
11346 "This resizes (expands or shrinks) an existing LVM logical volume to "
11347 "C<mbytes>. When reducing, data in the reduced part is lost."
11351 #: ../src/guestfs-actions.pod:3860
11352 msgid "guestfs_lvresize_free"
11356 #: ../src/guestfs-actions.pod:3862
11360 " guestfs_lvresize_free (guestfs_h *g,\n"
11361 " const char *lv,\n"
11367 #: ../src/guestfs-actions.pod:3867 ../fish/guestfish-actions.pod:2626
11369 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
11370 "remaining free space in the volume group. Commonly you would call this with "
11371 "pc = 100 which expands the logical volume as much as possible, using all "
11372 "remaining free space in the volume group."
11376 #: ../src/guestfs-actions.pod:3875
11377 msgid "(Added in 1.3.3)"
11381 #: ../src/guestfs-actions.pod:3877
11382 msgid "guestfs_lvs"
11386 #: ../src/guestfs-actions.pod:3879
11390 " guestfs_lvs (guestfs_h *g);\n"
11395 #: ../src/guestfs-actions.pod:3882 ../fish/guestfish-actions.pod:2636
11397 "List all the logical volumes detected. This is the equivalent of the "
11398 "L<lvs(8)> command."
11402 #: ../src/guestfs-actions.pod:3885 ../fish/guestfish-actions.pod:2639
11404 "This returns a list of the logical volume device names "
11405 "(eg. C</dev/VolGroup00/LogVol00>)."
11409 #: ../src/guestfs-actions.pod:3888
11410 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
11414 #: ../src/guestfs-actions.pod:3896
11415 msgid "guestfs_lvs_full"
11419 #: ../src/guestfs-actions.pod:3898
11422 " struct guestfs_lvm_lv_list *\n"
11423 " guestfs_lvs_full (guestfs_h *g);\n"
11428 #: ../src/guestfs-actions.pod:3901 ../fish/guestfish-actions.pod:2648
11430 "List all the logical volumes detected. This is the equivalent of the "
11431 "L<lvs(8)> command. The \"full\" version includes all fields."
11435 #: ../src/guestfs-actions.pod:3904
11437 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
11438 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
11443 #: ../src/guestfs-actions.pod:3910
11444 msgid "guestfs_lvuuid"
11448 #: ../src/guestfs-actions.pod:3912
11452 " guestfs_lvuuid (guestfs_h *g,\n"
11453 " const char *device);\n"
11458 #: ../src/guestfs-actions.pod:3916 ../fish/guestfish-actions.pod:2655
11459 msgid "This command returns the UUID of the LVM LV C<device>."
11463 #: ../src/guestfs-actions.pod:3923
11464 msgid "guestfs_lxattrlist"
11468 #: ../src/guestfs-actions.pod:3925
11471 " struct guestfs_xattr_list *\n"
11472 " guestfs_lxattrlist (guestfs_h *g,\n"
11473 " const char *path,\n"
11474 " char *const *names);\n"
11479 #: ../src/guestfs-actions.pod:3930 ../fish/guestfish-actions.pod:2661
11481 "This call allows you to get the extended attributes of multiple files, where "
11482 "all files are in the directory C<path>. C<names> is the list of files from "
11487 #: ../src/guestfs-actions.pod:3934 ../fish/guestfish-actions.pod:2665
11489 "On return you get a flat list of xattr structs which must be interpreted "
11490 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11491 "C<attrval> in this struct is zero-length to indicate there was an error "
11492 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11493 "number (the number of following attributes for this file, which could be "
11494 "C<\"0\">). Then after the first xattr struct are the zero or more "
11495 "attributes for the first named file. This repeats for the second and "
11496 "subsequent files."
11500 #: ../src/guestfs-actions.pod:3944
11502 "This call is intended for programs that want to efficiently list a directory "
11503 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11504 "a similarly efficient call for getting standard stats. Very long directory "
11505 "listings might cause the protocol message size to be exceeded, causing this "
11506 "call to fail. The caller must split up such requests into smaller groups of "
11511 #: ../src/guestfs-actions.pod:3958
11512 msgid "guestfs_mkdir"
11516 #: ../src/guestfs-actions.pod:3960
11520 " guestfs_mkdir (guestfs_h *g,\n"
11521 " const char *path);\n"
11526 #: ../src/guestfs-actions.pod:3964 ../fish/guestfish-actions.pod:2687
11527 msgid "Create a directory named C<path>."
11531 #: ../src/guestfs-actions.pod:3970
11532 msgid "guestfs_mkdir_mode"
11536 #: ../src/guestfs-actions.pod:3972
11540 " guestfs_mkdir_mode (guestfs_h *g,\n"
11541 " const char *path,\n"
11547 #: ../src/guestfs-actions.pod:3977 ../fish/guestfish-actions.pod:2693
11549 "This command creates a directory, setting the initial permissions of the "
11550 "directory to C<mode>."
11554 #: ../src/guestfs-actions.pod:3980 ../fish/guestfish-actions.pod:2696
11556 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11557 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11562 #: ../src/guestfs-actions.pod:3984
11563 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11567 #: ../src/guestfs-actions.pod:3990
11568 msgid "guestfs_mkdir_p"
11572 #: ../src/guestfs-actions.pod:3992
11576 " guestfs_mkdir_p (guestfs_h *g,\n"
11577 " const char *path);\n"
11582 #: ../src/guestfs-actions.pod:3996 ../fish/guestfish-actions.pod:2706
11584 "Create a directory named C<path>, creating any parent directories as "
11585 "necessary. This is like the C<mkdir -p> shell command."
11589 #: ../src/guestfs-actions.pod:4003
11590 msgid "guestfs_mkdtemp"
11594 #: ../src/guestfs-actions.pod:4005
11598 " guestfs_mkdtemp (guestfs_h *g,\n"
11599 " const char *template);\n"
11604 #: ../src/guestfs-actions.pod:4009 ../fish/guestfish-actions.pod:2713
11606 "This command creates a temporary directory. The C<template> parameter "
11607 "should be a full pathname for the temporary directory name with the final "
11608 "six characters being \"XXXXXX\"."
11612 #: ../src/guestfs-actions.pod:4014 ../fish/guestfish-actions.pod:2718
11614 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11615 "being suitable for Windows filesystems."
11619 #: ../src/guestfs-actions.pod:4017 ../fish/guestfish-actions.pod:2721
11620 msgid "The name of the temporary directory that was created is returned."
11624 #: ../src/guestfs-actions.pod:4020 ../fish/guestfish-actions.pod:2724
11625 msgid "The temporary directory is created with mode 0700 and is owned by root."
11629 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2727
11631 "The caller is responsible for deleting the temporary directory and its "
11632 "contents after use."
11636 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2730
11637 msgid "See also: L<mkdtemp(3)>"
11641 #: ../src/guestfs-actions.pod:4033
11642 msgid "guestfs_mke2fs_J"
11646 #: ../src/guestfs-actions.pod:4035
11650 " guestfs_mke2fs_J (guestfs_h *g,\n"
11651 " const char *fstype,\n"
11652 " int blocksize,\n"
11653 " const char *device,\n"
11654 " const char *journal);\n"
11659 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2736
11661 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11662 "C<journal>. It is equivalent to the command:"
11666 #: ../src/guestfs-actions.pod:4046 ../fish/guestfish-actions.pod:2740
11669 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11674 #: ../src/guestfs-actions.pod:4048
11675 msgid "See also C<guestfs_mke2journal>."
11679 #: ../src/guestfs-actions.pod:4052 ../src/guestfs-actions.pod:4070 ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4104 ../src/guestfs-actions.pod:4118 ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4191 ../src/guestfs-actions.pod:4442
11680 msgid "(Added in 1.0.68)"
11684 #: ../src/guestfs-actions.pod:4054
11685 msgid "guestfs_mke2fs_JL"
11689 #: ../src/guestfs-actions.pod:4056
11693 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11694 " const char *fstype,\n"
11695 " int blocksize,\n"
11696 " const char *device,\n"
11697 " const char *label);\n"
11702 #: ../src/guestfs-actions.pod:4063 ../fish/guestfish-actions.pod:2748
11704 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11705 "the journal labeled C<label>."
11709 #: ../src/guestfs-actions.pod:4066
11710 msgid "See also C<guestfs_mke2journal_L>."
11714 #: ../src/guestfs-actions.pod:4072
11715 msgid "guestfs_mke2fs_JU"
11719 #: ../src/guestfs-actions.pod:4074
11723 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11724 " const char *fstype,\n"
11725 " int blocksize,\n"
11726 " const char *device,\n"
11727 " const char *uuid);\n"
11732 #: ../src/guestfs-actions.pod:4081 ../fish/guestfish-actions.pod:2757
11734 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11735 "the journal with UUID C<uuid>."
11739 #: ../src/guestfs-actions.pod:4084
11740 msgid "See also C<guestfs_mke2journal_U>."
11744 #: ../src/guestfs-actions.pod:4090
11745 msgid "guestfs_mke2journal"
11749 #: ../src/guestfs-actions.pod:4092
11753 " guestfs_mke2journal (guestfs_h *g,\n"
11754 " int blocksize,\n"
11755 " const char *device);\n"
11760 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2766
11762 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11767 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2769
11770 " mke2fs -O journal_dev -b blocksize device\n"
11775 #: ../src/guestfs-actions.pod:4106
11776 msgid "guestfs_mke2journal_L"
11780 #: ../src/guestfs-actions.pod:4108
11784 " guestfs_mke2journal_L (guestfs_h *g,\n"
11785 " int blocksize,\n"
11786 " const char *label,\n"
11787 " const char *device);\n"
11792 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:2775
11793 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11797 #: ../src/guestfs-actions.pod:4120
11798 msgid "guestfs_mke2journal_U"
11802 #: ../src/guestfs-actions.pod:4122
11806 " guestfs_mke2journal_U (guestfs_h *g,\n"
11807 " int blocksize,\n"
11808 " const char *uuid,\n"
11809 " const char *device);\n"
11814 #: ../src/guestfs-actions.pod:4128 ../fish/guestfish-actions.pod:2781
11815 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11819 #: ../src/guestfs-actions.pod:4134
11820 msgid "guestfs_mkfifo"
11824 #: ../src/guestfs-actions.pod:4136
11828 " guestfs_mkfifo (guestfs_h *g,\n"
11830 " const char *path);\n"
11835 #: ../src/guestfs-actions.pod:4141
11837 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11838 "is just a convenient wrapper around C<guestfs_mknod>."
11842 #: ../src/guestfs-actions.pod:4151
11843 msgid "guestfs_mkfs"
11847 #: ../src/guestfs-actions.pod:4153
11851 " guestfs_mkfs (guestfs_h *g,\n"
11852 " const char *fstype,\n"
11853 " const char *device);\n"
11858 #: ../src/guestfs-actions.pod:4158 ../fish/guestfish-actions.pod:2797
11860 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11861 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11865 #: ../src/guestfs-actions.pod:4166
11866 msgid "guestfs_mkfs_b"
11870 #: ../src/guestfs-actions.pod:4168
11874 " guestfs_mkfs_b (guestfs_h *g,\n"
11875 " const char *fstype,\n"
11876 " int blocksize,\n"
11877 " const char *device);\n"
11882 #: ../src/guestfs-actions.pod:4174
11884 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11885 "block size of the resulting filesystem. Supported block sizes depend on the "
11886 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11890 #: ../src/guestfs-actions.pod:4179 ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2810 ../fish/guestfish-actions.pod:2837
11892 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11897 #: ../src/guestfs-actions.pod:4184 ../fish/guestfish-actions.pod:2813
11899 "This function is deprecated. In new code, use the C<mkfs_opts> call "
11904 #: ../src/guestfs-actions.pod:4193
11905 msgid "guestfs_mkfs_opts"
11909 #: ../src/guestfs-actions.pod:4195
11913 " guestfs_mkfs_opts (guestfs_h *g,\n"
11914 " const char *fstype,\n"
11915 " const char *device,\n"
11921 #: ../src/guestfs-actions.pod:4206
11924 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
11929 #: ../src/guestfs-actions.pod:4208 ../fish/guestfish-actions.pod:2824
11931 "This function creates a filesystem on C<device>. The filesystem type is "
11932 "C<fstype>, for example C<ext3>."
11936 #: ../src/guestfs-actions.pod:4215 ../fish/guestfish-actions.pod:2831
11937 msgid "C<blocksize>"
11941 #: ../src/guestfs-actions.pod:4217 ../fish/guestfish-actions.pod:2833
11943 "The filesystem block size. Supported block sizes depend on the filesystem "
11944 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11949 #: ../src/guestfs-actions.pod:4228
11950 msgid "(Added in 1.7.19)"
11954 #: ../src/guestfs-actions.pod:4230
11955 msgid "guestfs_mkfs_opts_va"
11959 #: ../src/guestfs-actions.pod:4232
11963 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
11964 " const char *fstype,\n"
11965 " const char *device,\n"
11966 " va_list args);\n"
11971 #: ../src/guestfs-actions.pod:4238
11972 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
11976 #: ../src/guestfs-actions.pod:4242
11977 msgid "guestfs_mkfs_opts_argv"
11981 #: ../src/guestfs-actions.pod:4244
11985 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
11986 " const char *fstype,\n"
11987 " const char *device,\n"
11988 " const struct guestfs_mkfs_opts_argv *optargs);\n"
11993 #: ../src/guestfs-actions.pod:4250
11994 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
11998 #: ../src/guestfs-actions.pod:4254
11999 msgid "guestfs_mkmountpoint"
12003 #: ../src/guestfs-actions.pod:4256
12007 " guestfs_mkmountpoint (guestfs_h *g,\n"
12008 " const char *exemptpath);\n"
12013 #: ../src/guestfs-actions.pod:4260
12015 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
12016 "that can be used to create extra mountpoints before mounting the first "
12021 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2852
12023 "These calls are I<only> necessary in some very limited circumstances, mainly "
12024 "the case where you want to mount a mix of unrelated and/or read-only "
12025 "filesystems together."
12029 #: ../src/guestfs-actions.pod:4268 ../fish/guestfish-actions.pod:2856
12031 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
12032 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
12033 "inside that. You can unpack this as follows in guestfish:"
12037 #: ../src/guestfs-actions.pod:4273 ../fish/guestfish-actions.pod:2861
12040 " add-ro Fedora-11-i686-Live.iso\n"
12042 " mkmountpoint /cd\n"
12043 " mkmountpoint /sqsh\n"
12044 " mkmountpoint /ext3fs\n"
12045 " mount /dev/sda /cd\n"
12046 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
12047 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
12052 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2870
12053 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
12057 #: ../src/guestfs-actions.pod:4284
12059 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
12060 "may get unexpected errors if you try to mix these calls. It is safest to "
12061 "manually unmount filesystems and remove mountpoints after use."
12065 #: ../src/guestfs-actions.pod:4288
12067 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
12068 "first, so for this to work for manual mountpoints, you must ensure that the "
12069 "innermost mountpoints have the longest pathnames, as in the example code "
12074 #: ../src/guestfs-actions.pod:4293 ../fish/guestfish-actions.pod:2881
12075 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
12079 #: ../src/guestfs-actions.pod:4295
12081 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
12082 "means that C<guestfs_umount_all> is called when the handle is closed which "
12083 "can also trigger these issues."
12087 #: ../src/guestfs-actions.pod:4301 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:5453
12088 msgid "(Added in 1.0.62)"
12092 #: ../src/guestfs-actions.pod:4303
12093 msgid "guestfs_mknod"
12097 #: ../src/guestfs-actions.pod:4305
12101 " guestfs_mknod (guestfs_h *g,\n"
12105 " const char *path);\n"
12110 #: ../src/guestfs-actions.pod:4312 ../fish/guestfish-actions.pod:2891
12112 "This call creates block or character special devices, or named pipes "
12117 #: ../src/guestfs-actions.pod:4315 ../fish/guestfish-actions.pod:2894
12119 "The C<mode> parameter should be the mode, using the standard constants. "
12120 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
12121 "used when creating block and character special devices."
12125 #: ../src/guestfs-actions.pod:4320
12127 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
12128 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
12129 "regular file). These constants are available in the standard Linux header "
12130 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
12131 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
12132 "the appropriate constant for you."
12136 #: ../src/guestfs-actions.pod:4334
12137 msgid "guestfs_mknod_b"
12141 #: ../src/guestfs-actions.pod:4336
12145 " guestfs_mknod_b (guestfs_h *g,\n"
12149 " const char *path);\n"
12154 #: ../src/guestfs-actions.pod:4343
12156 "This call creates a block device node called C<path> with mode C<mode> and "
12157 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12158 "wrapper around C<guestfs_mknod>."
12162 #: ../src/guestfs-actions.pod:4353
12163 msgid "guestfs_mknod_c"
12167 #: ../src/guestfs-actions.pod:4355
12171 " guestfs_mknod_c (guestfs_h *g,\n"
12175 " const char *path);\n"
12180 #: ../src/guestfs-actions.pod:4362
12182 "This call creates a char device node called C<path> with mode C<mode> and "
12183 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
12184 "wrapper around C<guestfs_mknod>."
12188 #: ../src/guestfs-actions.pod:4372
12189 msgid "guestfs_mkswap"
12193 #: ../src/guestfs-actions.pod:4374
12197 " guestfs_mkswap (guestfs_h *g,\n"
12198 " const char *device);\n"
12203 #: ../src/guestfs-actions.pod:4378 ../fish/guestfish-actions.pod:2933
12204 msgid "Create a swap partition on C<device>."
12208 #: ../src/guestfs-actions.pod:4384
12209 msgid "guestfs_mkswap_L"
12213 #: ../src/guestfs-actions.pod:4386
12217 " guestfs_mkswap_L (guestfs_h *g,\n"
12218 " const char *label,\n"
12219 " const char *device);\n"
12224 #: ../src/guestfs-actions.pod:4391 ../fish/guestfish-actions.pod:2939
12225 msgid "Create a swap partition on C<device> with label C<label>."
12229 #: ../src/guestfs-actions.pod:4393 ../fish/guestfish-actions.pod:2941
12231 "Note that you cannot attach a swap label to a block device "
12232 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
12233 "the kernel or swap tools."
12237 #: ../src/guestfs-actions.pod:4401
12238 msgid "guestfs_mkswap_U"
12242 #: ../src/guestfs-actions.pod:4403
12246 " guestfs_mkswap_U (guestfs_h *g,\n"
12247 " const char *uuid,\n"
12248 " const char *device);\n"
12253 #: ../src/guestfs-actions.pod:4408 ../fish/guestfish-actions.pod:2949
12254 msgid "Create a swap partition on C<device> with UUID C<uuid>."
12258 #: ../src/guestfs-actions.pod:4414
12259 msgid "guestfs_mkswap_file"
12263 #: ../src/guestfs-actions.pod:4416
12267 " guestfs_mkswap_file (guestfs_h *g,\n"
12268 " const char *path);\n"
12273 #: ../src/guestfs-actions.pod:4420 ../fish/guestfish-actions.pod:2955
12274 msgid "Create a swap file."
12278 #: ../src/guestfs-actions.pod:4422
12280 "This command just writes a swap file signature to an existing file. To "
12281 "create the file itself, use something like C<guestfs_fallocate>."
12285 #: ../src/guestfs-actions.pod:4429
12286 msgid "guestfs_modprobe"
12290 #: ../src/guestfs-actions.pod:4431
12294 " guestfs_modprobe (guestfs_h *g,\n"
12295 " const char *modulename);\n"
12300 #: ../src/guestfs-actions.pod:4435 ../fish/guestfish-actions.pod:2964
12301 msgid "This loads a kernel module in the appliance."
12305 #: ../src/guestfs-actions.pod:4437 ../fish/guestfish-actions.pod:2966
12307 "The kernel module must have been whitelisted when libguestfs was built (see "
12308 "C<appliance/kmod.whitelist.in> in the source)."
12312 #: ../src/guestfs-actions.pod:4444
12313 msgid "guestfs_mount"
12317 #: ../src/guestfs-actions.pod:4446
12321 " guestfs_mount (guestfs_h *g,\n"
12322 " const char *device,\n"
12323 " const char *mountpoint);\n"
12328 #: ../src/guestfs-actions.pod:4451 ../fish/guestfish-actions.pod:2973
12330 "Mount a guest disk at a position in the filesystem. Block devices are named "
12331 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
12332 "those block devices contain partitions, they will have the usual names "
12333 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
12337 #: ../src/guestfs-actions.pod:4457 ../fish/guestfish-actions.pod:2979
12339 "The rules are the same as for L<mount(2)>: A filesystem must first be "
12340 "mounted on C</> before others can be mounted. Other filesystems can only be "
12341 "mounted on directories which already exist."
12345 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2984
12347 "The mounted filesystem is writable, if we have sufficient permissions on the "
12348 "underlying device."
12352 #: ../src/guestfs-actions.pod:4465
12354 "B<Important note:> When you use this call, the filesystem options C<sync> "
12355 "and C<noatime> are set implicitly. This was originally done because we "
12356 "thought it would improve reliability, but it turns out that I<-o sync> has a "
12357 "very large negative performance impact and negligible effect on "
12358 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
12359 "in any code that needs performance, and instead use C<guestfs_mount_options> "
12360 "(use an empty string for the first parameter if you don't want any options)."
12364 #: ../src/guestfs-actions.pod:4479
12365 msgid "guestfs_mount_loop"
12369 #: ../src/guestfs-actions.pod:4481
12373 " guestfs_mount_loop (guestfs_h *g,\n"
12374 " const char *file,\n"
12375 " const char *mountpoint);\n"
12380 #: ../src/guestfs-actions.pod:4486 ../fish/guestfish-actions.pod:3001
12382 "This command lets you mount C<file> (a filesystem image in a file) on a "
12383 "mount point. It is entirely equivalent to the command C<mount -o loop file "
12388 #: ../src/guestfs-actions.pod:4494
12389 msgid "guestfs_mount_options"
12393 #: ../src/guestfs-actions.pod:4496
12397 " guestfs_mount_options (guestfs_h *g,\n"
12398 " const char *options,\n"
12399 " const char *device,\n"
12400 " const char *mountpoint);\n"
12405 #: ../src/guestfs-actions.pod:4502
12407 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12408 "the mount options as for the L<mount(8)> I<-o> flag."
12412 #: ../src/guestfs-actions.pod:4506 ../fish/guestfish-actions.pod:3013
12414 "If the C<options> parameter is an empty string, then no options are passed "
12415 "(all options default to whatever the filesystem uses)."
12419 #: ../src/guestfs-actions.pod:4512 ../src/guestfs-actions.pod:4526 ../src/guestfs-actions.pod:4543
12420 msgid "(Added in 1.0.10)"
12424 #: ../src/guestfs-actions.pod:4514
12425 msgid "guestfs_mount_ro"
12429 #: ../src/guestfs-actions.pod:4516
12433 " guestfs_mount_ro (guestfs_h *g,\n"
12434 " const char *device,\n"
12435 " const char *mountpoint);\n"
12440 #: ../src/guestfs-actions.pod:4521
12442 "This is the same as the C<guestfs_mount> command, but it mounts the "
12443 "filesystem with the read-only (I<-o ro>) flag."
12447 #: ../src/guestfs-actions.pod:4528
12448 msgid "guestfs_mount_vfs"
12452 #: ../src/guestfs-actions.pod:4530
12456 " guestfs_mount_vfs (guestfs_h *g,\n"
12457 " const char *options,\n"
12458 " const char *vfstype,\n"
12459 " const char *device,\n"
12460 " const char *mountpoint);\n"
12465 #: ../src/guestfs-actions.pod:4537
12467 "This is the same as the C<guestfs_mount> command, but it allows you to set "
12468 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
12473 #: ../src/guestfs-actions.pod:4545
12474 msgid "guestfs_mountpoints"
12478 #: ../src/guestfs-actions.pod:4547
12482 " guestfs_mountpoints (guestfs_h *g);\n"
12487 #: ../src/guestfs-actions.pod:4550
12489 "This call is similar to C<guestfs_mounts>. That call returns a list of "
12490 "devices. This one returns a hash table (map) of device name to directory "
12491 "where the device is mounted."
12495 #: ../src/guestfs-actions.pod:4562
12496 msgid "guestfs_mounts"
12500 #: ../src/guestfs-actions.pod:4564
12504 " guestfs_mounts (guestfs_h *g);\n"
12509 #: ../src/guestfs-actions.pod:4567 ../fish/guestfish-actions.pod:3044
12511 "This returns the list of currently mounted filesystems. It returns the list "
12512 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
12516 #: ../src/guestfs-actions.pod:4570 ../fish/guestfish-actions.pod:3047
12517 msgid "Some internal mounts are not shown."
12521 #: ../src/guestfs-actions.pod:4572
12522 msgid "See also: C<guestfs_mountpoints>"
12526 #: ../src/guestfs-actions.pod:4580
12531 #: ../src/guestfs-actions.pod:4582
12535 " guestfs_mv (guestfs_h *g,\n"
12536 " const char *src,\n"
12537 " const char *dest);\n"
12542 #: ../src/guestfs-actions.pod:4587 ../fish/guestfish-actions.pod:3055
12544 "This moves a file from C<src> to C<dest> where C<dest> is either a "
12545 "destination filename or destination directory."
12549 #: ../src/guestfs-actions.pod:4594
12550 msgid "guestfs_ntfs_3g_probe"
12554 #: ../src/guestfs-actions.pod:4596
12558 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12560 " const char *device);\n"
12565 #: ../src/guestfs-actions.pod:4601 ../fish/guestfish-actions.pod:3062
12567 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12568 "C<device> for mountability. (Not all NTFS volumes can be mounted "
12569 "read-write, and some cannot be mounted at all)."
12573 #: ../src/guestfs-actions.pod:4605 ../fish/guestfish-actions.pod:3066
12575 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12576 "can be mounted read-write. Set it to false if you want to test if the "
12577 "volume can be mounted read-only."
12581 #: ../src/guestfs-actions.pod:4609 ../fish/guestfish-actions.pod:3070
12583 "The return value is an integer which C<0> if the operation would succeed, or "
12584 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12588 #: ../src/guestfs-actions.pod:4615
12589 msgid "(Added in 1.0.43)"
12593 #: ../src/guestfs-actions.pod:4617
12594 msgid "guestfs_ntfsresize"
12598 #: ../src/guestfs-actions.pod:4619
12602 " guestfs_ntfsresize (guestfs_h *g,\n"
12603 " const char *device);\n"
12608 #: ../src/guestfs-actions.pod:4623 ../fish/guestfish-actions.pod:3078
12610 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12611 "size of the underlying device. See also L<ntfsresize(8)>."
12615 #: ../src/guestfs-actions.pod:4631
12616 msgid "guestfs_ntfsresize_size"
12620 #: ../src/guestfs-actions.pod:4633
12624 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12625 " const char *device,\n"
12626 " int64_t size);\n"
12631 #: ../src/guestfs-actions.pod:4638
12633 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12634 "to specify the new size (in bytes) explicitly."
12638 #: ../src/guestfs-actions.pod:4643 ../src/guestfs-actions.pod:5079 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5401 ../src/guestfs-actions.pod:6940
12639 msgid "(Added in 1.3.14)"
12643 #: ../src/guestfs-actions.pod:4645
12644 msgid "guestfs_part_add"
12648 #: ../src/guestfs-actions.pod:4647
12652 " guestfs_part_add (guestfs_h *g,\n"
12653 " const char *device,\n"
12654 " const char *prlogex,\n"
12655 " int64_t startsect,\n"
12656 " int64_t endsect);\n"
12661 #: ../src/guestfs-actions.pod:4654
12663 "This command adds a partition to C<device>. If there is no partition table "
12664 "on the device, call C<guestfs_part_init> first."
12668 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3096
12670 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12671 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12672 "C<logical>) and C<e> (or C<extended>) partition types."
12676 #: ../src/guestfs-actions.pod:4662 ../fish/guestfish-actions.pod:3101
12678 "C<startsect> and C<endsect> are the start and end of the partition in "
12679 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12680 "from the end of the disk (C<-1> is the last sector)."
12684 #: ../src/guestfs-actions.pod:4666
12686 "Creating a partition which covers the whole disk is not so easy. Use "
12687 "C<guestfs_part_disk> to do that."
12691 #: ../src/guestfs-actions.pod:4671 ../src/guestfs-actions.pod:4709 ../src/guestfs-actions.pod:4762 ../src/guestfs-actions.pod:4840 ../src/guestfs-actions.pod:4878 ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4937
12692 msgid "(Added in 1.0.78)"
12696 #: ../src/guestfs-actions.pod:4673
12697 msgid "guestfs_part_del"
12701 #: ../src/guestfs-actions.pod:4675
12705 " guestfs_part_del (guestfs_h *g,\n"
12706 " const char *device,\n"
12712 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3112
12713 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12717 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3114
12719 "Note that in the case of MBR partitioning, deleting an extended partition "
12720 "also deletes any logical partitions it contains."
12724 #: ../src/guestfs-actions.pod:4690
12725 msgid "guestfs_part_disk"
12729 #: ../src/guestfs-actions.pod:4692
12733 " guestfs_part_disk (guestfs_h *g,\n"
12734 " const char *device,\n"
12735 " const char *parttype);\n"
12740 #: ../src/guestfs-actions.pod:4697
12742 "This command is simply a combination of C<guestfs_part_init> followed by "
12743 "C<guestfs_part_add> to create a single primary partition covering the whole "
12748 #: ../src/guestfs-actions.pod:4701
12750 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12751 "possible values are described in C<guestfs_part_init>."
12755 #: ../src/guestfs-actions.pod:4711
12756 msgid "guestfs_part_get_bootable"
12760 #: ../src/guestfs-actions.pod:4713
12764 " guestfs_part_get_bootable (guestfs_h *g,\n"
12765 " const char *device,\n"
12771 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3136
12773 "This command returns true if the partition C<partnum> on C<device> has the "
12774 "bootable flag set."
12778 #: ../src/guestfs-actions.pod:4721
12779 msgid "See also C<guestfs_part_set_bootable>."
12783 #: ../src/guestfs-actions.pod:4727
12784 msgid "guestfs_part_get_mbr_id"
12788 #: ../src/guestfs-actions.pod:4729
12792 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12793 " const char *device,\n"
12799 #: ../src/guestfs-actions.pod:4734 ../fish/guestfish-actions.pod:3145
12801 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12802 "partition C<partnum>."
12806 #: ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:4913
12808 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12809 "undefined results for other partition table types (see "
12810 "C<guestfs_part_get_parttype>)."
12814 #: ../src/guestfs-actions.pod:4745
12815 msgid "guestfs_part_get_parttype"
12819 #: ../src/guestfs-actions.pod:4747
12823 " guestfs_part_get_parttype (guestfs_h *g,\n"
12824 " const char *device);\n"
12829 #: ../src/guestfs-actions.pod:4751 ../fish/guestfish-actions.pod:3156
12831 "This command examines the partition table on C<device> and returns the "
12832 "partition table type (format) being used."
12836 #: ../src/guestfs-actions.pod:4754
12838 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12839 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12840 "possible, although unusual. See C<guestfs_part_init> for a full list."
12844 #: ../src/guestfs-actions.pod:4764
12845 msgid "guestfs_part_init"
12849 #: ../src/guestfs-actions.pod:4766
12853 " guestfs_part_init (guestfs_h *g,\n"
12854 " const char *device,\n"
12855 " const char *parttype);\n"
12860 #: ../src/guestfs-actions.pod:4771 ../fish/guestfish-actions.pod:3168
12862 "This creates an empty partition table on C<device> of one of the partition "
12863 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12864 "(for large disks)."
12868 #: ../src/guestfs-actions.pod:4775
12870 "Initially there are no partitions. Following this, you should call "
12871 "C<guestfs_part_add> for each partition required."
12875 #: ../src/guestfs-actions.pod:4778 ../fish/guestfish-actions.pod:3175
12876 msgid "Possible values for C<parttype> are:"
12880 #: ../src/guestfs-actions.pod:4782 ../fish/guestfish-actions.pod:3179
12881 msgid "B<efi> | B<gpt>"
12885 #: ../src/guestfs-actions.pod:4784 ../fish/guestfish-actions.pod:3181
12886 msgid "Intel EFI / GPT partition table."
12890 #: ../src/guestfs-actions.pod:4786 ../fish/guestfish-actions.pod:3183
12892 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12893 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12894 "the C<mbr> format."
12898 #: ../src/guestfs-actions.pod:4790 ../fish/guestfish-actions.pod:3187
12899 msgid "B<mbr> | B<msdos>"
12903 #: ../src/guestfs-actions.pod:4792 ../fish/guestfish-actions.pod:3189
12905 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12906 "Windows. This partition type will B<only> work for device sizes up to 2 "
12907 "TB. For large disks we recommend using C<gpt>."
12911 #: ../src/guestfs-actions.pod:4799 ../fish/guestfish-actions.pod:3196
12912 msgid "Other partition table types that may work but are not supported include:"
12916 #: ../src/guestfs-actions.pod:4804 ../fish/guestfish-actions.pod:3201
12921 #: ../src/guestfs-actions.pod:4806 ../fish/guestfish-actions.pod:3203
12922 msgid "AIX disk labels."
12926 #: ../src/guestfs-actions.pod:4808 ../fish/guestfish-actions.pod:3205
12927 msgid "B<amiga> | B<rdb>"
12931 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3207
12932 msgid "Amiga \"Rigid Disk Block\" format."
12936 #: ../src/guestfs-actions.pod:4812 ../fish/guestfish-actions.pod:3209
12941 #: ../src/guestfs-actions.pod:4814 ../fish/guestfish-actions.pod:3211
12942 msgid "BSD disk labels."
12946 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3213
12951 #: ../src/guestfs-actions.pod:4818 ../fish/guestfish-actions.pod:3215
12952 msgid "DASD, used on IBM mainframes."
12956 #: ../src/guestfs-actions.pod:4820 ../fish/guestfish-actions.pod:3217
12961 #: ../src/guestfs-actions.pod:4822 ../fish/guestfish-actions.pod:3219
12962 msgid "MIPS/SGI volumes."
12966 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3221
12971 #: ../src/guestfs-actions.pod:4826 ../fish/guestfish-actions.pod:3223
12972 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12976 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3225
12981 #: ../src/guestfs-actions.pod:4830 ../fish/guestfish-actions.pod:3227
12982 msgid "NEC PC-98 format, common in Japan apparently."
12986 #: ../src/guestfs-actions.pod:4832 ../fish/guestfish-actions.pod:3229
12991 #: ../src/guestfs-actions.pod:4834 ../fish/guestfish-actions.pod:3231
12992 msgid "Sun disk labels."
12996 #: ../src/guestfs-actions.pod:4842
12997 msgid "guestfs_part_list"
13001 #: ../src/guestfs-actions.pod:4844
13004 " struct guestfs_partition_list *\n"
13005 " guestfs_part_list (guestfs_h *g,\n"
13006 " const char *device);\n"
13011 #: ../src/guestfs-actions.pod:4848 ../fish/guestfish-actions.pod:3239
13013 "This command parses the partition table on C<device> and returns the list of "
13014 "partitions found."
13018 #: ../src/guestfs-actions.pod:4851 ../fish/guestfish-actions.pod:3242
13019 msgid "The fields in the returned structure are:"
13023 #: ../src/guestfs-actions.pod:4855 ../fish/guestfish-actions.pod:3246
13024 msgid "B<part_num>"
13028 #: ../src/guestfs-actions.pod:4857 ../fish/guestfish-actions.pod:3248
13029 msgid "Partition number, counting from 1."
13033 #: ../src/guestfs-actions.pod:4859 ../fish/guestfish-actions.pod:3250
13034 msgid "B<part_start>"
13038 #: ../src/guestfs-actions.pod:4861
13040 "Start of the partition I<in bytes>. To get sectors you have to divide by "
13041 "the device's sector size, see C<guestfs_blockdev_getss>."
13045 #: ../src/guestfs-actions.pod:4864 ../fish/guestfish-actions.pod:3255
13046 msgid "B<part_end>"
13050 #: ../src/guestfs-actions.pod:4866 ../fish/guestfish-actions.pod:3257
13051 msgid "End of the partition in bytes."
13055 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3259
13056 msgid "B<part_size>"
13060 #: ../src/guestfs-actions.pod:4870 ../fish/guestfish-actions.pod:3261
13061 msgid "Size of the partition in bytes."
13065 #: ../src/guestfs-actions.pod:4874
13067 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
13068 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
13073 #: ../src/guestfs-actions.pod:4880
13074 msgid "guestfs_part_set_bootable"
13078 #: ../src/guestfs-actions.pod:4882
13082 " guestfs_part_set_bootable (guestfs_h *g,\n"
13083 " const char *device,\n"
13085 " int bootable);\n"
13090 #: ../src/guestfs-actions.pod:4888 ../fish/guestfish-actions.pod:3269
13092 "This sets the bootable flag on partition numbered C<partnum> on device "
13093 "C<device>. Note that partitions are numbered from 1."
13097 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3272
13099 "The bootable flag is used by some operating systems (notably Windows) to "
13100 "determine which partition to boot from. It is by no means universally "
13105 #: ../src/guestfs-actions.pod:4899
13106 msgid "guestfs_part_set_mbr_id"
13110 #: ../src/guestfs-actions.pod:4901
13114 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
13115 " const char *device,\n"
13122 #: ../src/guestfs-actions.pod:4907 ../fish/guestfish-actions.pod:3280
13124 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
13125 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
13126 "documentation are in fact hexadecimal numbers, but usually documented "
13127 "without any leading \"0x\" which might be confusing."
13131 #: ../src/guestfs-actions.pod:4921
13132 msgid "guestfs_part_set_name"
13136 #: ../src/guestfs-actions.pod:4923
13140 " guestfs_part_set_name (guestfs_h *g,\n"
13141 " const char *device,\n"
13143 " const char *name);\n"
13148 #: ../src/guestfs-actions.pod:4929 ../fish/guestfish-actions.pod:3294
13150 "This sets the partition name on partition numbered C<partnum> on device "
13151 "C<device>. Note that partitions are numbered from 1."
13155 #: ../src/guestfs-actions.pod:4932 ../fish/guestfish-actions.pod:3297
13157 "The partition name can only be set on certain types of partition table. "
13158 "This works on C<gpt> but not on C<mbr> partitions."
13162 #: ../src/guestfs-actions.pod:4939
13163 msgid "guestfs_part_to_dev"
13167 #: ../src/guestfs-actions.pod:4941
13171 " guestfs_part_to_dev (guestfs_h *g,\n"
13172 " const char *partition);\n"
13177 #: ../src/guestfs-actions.pod:4945 ../fish/guestfish-actions.pod:3304
13179 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
13180 "partition number, returning the device name (eg. \"/dev/sdb\")."
13184 #: ../src/guestfs-actions.pod:4949
13186 "The named partition must exist, for example as a string returned from "
13187 "C<guestfs_list_partitions>."
13191 #: ../src/guestfs-actions.pod:4957
13192 msgid "guestfs_ping_daemon"
13196 #: ../src/guestfs-actions.pod:4959
13200 " guestfs_ping_daemon (guestfs_h *g);\n"
13205 #: ../src/guestfs-actions.pod:4962 ../fish/guestfish-actions.pod:3315
13207 "This is a test probe into the guestfs daemon running inside the qemu "
13208 "subprocess. Calling this function checks that the daemon responds to the "
13209 "ping message, without affecting the daemon or attached block device(s) in "
13214 #: ../src/guestfs-actions.pod:4971
13215 msgid "guestfs_pread"
13219 #: ../src/guestfs-actions.pod:4973
13223 " guestfs_pread (guestfs_h *g,\n"
13224 " const char *path,\n"
13226 " int64_t offset,\n"
13227 " size_t *size_r);\n"
13232 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3324
13234 "This command lets you read part of a file. It reads C<count> bytes of the "
13235 "file, starting at C<offset>, from file C<path>."
13239 #: ../src/guestfs-actions.pod:4983 ../src/guestfs-actions.pod:5009 ../fish/guestfish-actions.pod:3327 ../fish/guestfish-actions.pod:3342
13241 "This may read fewer bytes than requested. For further details see the "
13242 "L<pread(2)> system call."
13246 #: ../src/guestfs-actions.pod:4986
13247 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
13251 #: ../src/guestfs-actions.pod:4997
13252 msgid "guestfs_pread_device"
13256 #: ../src/guestfs-actions.pod:4999
13260 " guestfs_pread_device (guestfs_h *g,\n"
13261 " const char *device,\n"
13263 " int64_t offset,\n"
13264 " size_t *size_r);\n"
13269 #: ../src/guestfs-actions.pod:5006 ../fish/guestfish-actions.pod:3339
13271 "This command lets you read part of a file. It reads C<count> bytes of "
13272 "C<device>, starting at C<offset>."
13276 #: ../src/guestfs-actions.pod:5012
13277 msgid "See also C<guestfs_pread>."
13281 #: ../src/guestfs-actions.pod:5021
13282 msgid "(Added in 1.5.21)"
13286 #: ../src/guestfs-actions.pod:5023
13287 msgid "guestfs_pvcreate"
13291 #: ../src/guestfs-actions.pod:5025
13295 " guestfs_pvcreate (guestfs_h *g,\n"
13296 " const char *device);\n"
13301 #: ../src/guestfs-actions.pod:5029 ../fish/guestfish-actions.pod:3354
13303 "This creates an LVM physical volume on the named C<device>, where C<device> "
13304 "should usually be a partition name such as C</dev/sda1>."
13308 #: ../src/guestfs-actions.pod:5037
13309 msgid "guestfs_pvremove"
13313 #: ../src/guestfs-actions.pod:5039
13317 " guestfs_pvremove (guestfs_h *g,\n"
13318 " const char *device);\n"
13323 #: ../src/guestfs-actions.pod:5043 ../fish/guestfish-actions.pod:3362
13325 "This wipes a physical volume C<device> so that LVM will no longer recognise "
13330 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3365
13332 "The implementation uses the C<pvremove> command which refuses to wipe "
13333 "physical volumes that contain any volume groups, so you have to remove those "
13338 #: ../src/guestfs-actions.pod:5054
13339 msgid "guestfs_pvresize"
13343 #: ../src/guestfs-actions.pod:5056
13347 " guestfs_pvresize (guestfs_h *g,\n"
13348 " const char *device);\n"
13353 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3373
13355 "This resizes (expands or shrinks) an existing LVM physical volume to match "
13356 "the new size of the underlying device."
13360 #: ../src/guestfs-actions.pod:5067
13361 msgid "guestfs_pvresize_size"
13365 #: ../src/guestfs-actions.pod:5069
13369 " guestfs_pvresize_size (guestfs_h *g,\n"
13370 " const char *device,\n"
13371 " int64_t size);\n"
13376 #: ../src/guestfs-actions.pod:5074
13378 "This command is the same as C<guestfs_pvresize> except that it allows you to "
13379 "specify the new size (in bytes) explicitly."
13383 #: ../src/guestfs-actions.pod:5081
13384 msgid "guestfs_pvs"
13388 #: ../src/guestfs-actions.pod:5083
13392 " guestfs_pvs (guestfs_h *g);\n"
13397 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3387
13399 "List all the physical volumes detected. This is the equivalent of the "
13400 "L<pvs(8)> command."
13404 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3390
13406 "This returns a list of just the device names that contain PVs "
13407 "(eg. C</dev/sda2>)."
13411 #: ../src/guestfs-actions.pod:5092
13412 msgid "See also C<guestfs_pvs_full>."
13416 #: ../src/guestfs-actions.pod:5100
13417 msgid "guestfs_pvs_full"
13421 #: ../src/guestfs-actions.pod:5102
13424 " struct guestfs_lvm_pv_list *\n"
13425 " guestfs_pvs_full (guestfs_h *g);\n"
13430 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3399
13432 "List all the physical volumes detected. This is the equivalent of the "
13433 "L<pvs(8)> command. The \"full\" version includes all fields."
13437 #: ../src/guestfs-actions.pod:5108
13439 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
13440 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
13445 #: ../src/guestfs-actions.pod:5114
13446 msgid "guestfs_pvuuid"
13450 #: ../src/guestfs-actions.pod:5116
13454 " guestfs_pvuuid (guestfs_h *g,\n"
13455 " const char *device);\n"
13460 #: ../src/guestfs-actions.pod:5120 ../fish/guestfish-actions.pod:3406
13461 msgid "This command returns the UUID of the LVM PV C<device>."
13465 #: ../src/guestfs-actions.pod:5127
13466 msgid "guestfs_pwrite"
13470 #: ../src/guestfs-actions.pod:5129
13474 " guestfs_pwrite (guestfs_h *g,\n"
13475 " const char *path,\n"
13476 " const char *content,\n"
13477 " size_t content_size,\n"
13478 " int64_t offset);\n"
13483 #: ../src/guestfs-actions.pod:5136 ../fish/guestfish-actions.pod:3412
13485 "This command writes to part of a file. It writes the data buffer C<content> "
13486 "to the file C<path> starting at offset C<offset>."
13490 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3415
13492 "This command implements the L<pwrite(2)> system call, and like that system "
13493 "call it may not write the full data requested. The return value is the "
13494 "number of bytes that were actually written to the file. This could even be "
13495 "0, although short writes are unlikely for regular files in ordinary "
13500 #: ../src/guestfs-actions.pod:5145
13501 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
13505 #: ../src/guestfs-actions.pod:5154
13506 msgid "guestfs_pwrite_device"
13510 #: ../src/guestfs-actions.pod:5156
13514 " guestfs_pwrite_device (guestfs_h *g,\n"
13515 " const char *device,\n"
13516 " const char *content,\n"
13517 " size_t content_size,\n"
13518 " int64_t offset);\n"
13523 #: ../src/guestfs-actions.pod:5163 ../fish/guestfish-actions.pod:3430
13525 "This command writes to part of a device. It writes the data buffer "
13526 "C<content> to C<device> starting at offset C<offset>."
13530 #: ../src/guestfs-actions.pod:5166 ../fish/guestfish-actions.pod:3433
13532 "This command implements the L<pwrite(2)> system call, and like that system "
13533 "call it may not write the full data requested (although short writes to disk "
13534 "devices and partitions are probably impossible with standard Linux kernels)."
13538 #: ../src/guestfs-actions.pod:5171
13539 msgid "See also C<guestfs_pwrite>."
13543 #: ../src/guestfs-actions.pod:5178
13544 msgid "(Added in 1.5.20)"
13548 #: ../src/guestfs-actions.pod:5180
13549 msgid "guestfs_read_file"
13553 #: ../src/guestfs-actions.pod:5182
13557 " guestfs_read_file (guestfs_h *g,\n"
13558 " const char *path,\n"
13559 " size_t *size_r);\n"
13564 #: ../src/guestfs-actions.pod:5187 ../fish/guestfish-actions.pod:3447
13565 msgid "This calls returns the contents of the file C<path> as a buffer."
13569 #: ../src/guestfs-actions.pod:5190
13571 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13572 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13573 "function is limited in the total size of file that can be handled."
13577 #: ../src/guestfs-actions.pod:5202
13578 msgid "(Added in 1.0.63)"
13582 #: ../src/guestfs-actions.pod:5204
13583 msgid "guestfs_read_lines"
13587 #: ../src/guestfs-actions.pod:5206
13591 " guestfs_read_lines (guestfs_h *g,\n"
13592 " const char *path);\n"
13597 #: ../src/guestfs-actions.pod:5212 ../fish/guestfish-actions.pod:3464
13599 "The file contents are returned as a list of lines. Trailing C<LF> and "
13600 "C<CRLF> character sequences are I<not> returned."
13604 #: ../src/guestfs-actions.pod:5215
13606 "Note that this function cannot correctly handle binary files (specifically, "
13607 "files containing C<\\0> character which is treated as end of line). For "
13608 "those you need to use the C<guestfs_read_file> function which has a more "
13609 "complex interface."
13613 #: ../src/guestfs-actions.pod:5226
13614 msgid "guestfs_readdir"
13618 #: ../src/guestfs-actions.pod:5228
13621 " struct guestfs_dirent_list *\n"
13622 " guestfs_readdir (guestfs_h *g,\n"
13623 " const char *dir);\n"
13628 #: ../src/guestfs-actions.pod:5232 ../fish/guestfish-actions.pod:3476
13629 msgid "This returns the list of directory entries in directory C<dir>."
13633 #: ../src/guestfs-actions.pod:5234 ../fish/guestfish-actions.pod:3478
13635 "All entries in the directory are returned, including C<.> and C<..>. The "
13636 "entries are I<not> sorted, but returned in the same order as the underlying "
13641 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3482
13643 "Also this call returns basic file type information about each file. The "
13644 "C<ftyp> field will contain one of the following characters:"
13648 #: ../src/guestfs-actions.pod:5243 ../fish/guestfish-actions.pod:3487
13653 #: ../src/guestfs-actions.pod:5245 ../fish/guestfish-actions.pod:3489
13654 msgid "Block special"
13658 #: ../src/guestfs-actions.pod:5247 ../fish/guestfish-actions.pod:3491
13663 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3493
13664 msgid "Char special"
13668 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3495
13673 #: ../src/guestfs-actions.pod:5253 ../fish/guestfish-actions.pod:3497
13678 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3499
13683 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3501
13684 msgid "FIFO (named pipe)"
13688 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3503
13693 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3505
13694 msgid "Symbolic link"
13698 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3507
13703 #: ../src/guestfs-actions.pod:5265 ../fish/guestfish-actions.pod:3509
13704 msgid "Regular file"
13708 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3511
13713 #: ../src/guestfs-actions.pod:5269 ../fish/guestfish-actions.pod:3513
13718 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3515
13723 #: ../src/guestfs-actions.pod:5273 ../fish/guestfish-actions.pod:3517
13724 msgid "Unknown file type"
13728 #: ../src/guestfs-actions.pod:5275 ../fish/guestfish-actions.pod:3519
13733 #: ../src/guestfs-actions.pod:5277 ../fish/guestfish-actions.pod:3521
13734 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13738 #: ../src/guestfs-actions.pod:5282
13740 "This function is primarily intended for use by programs. To get a simple "
13741 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13742 "consumption, use C<guestfs_ll>."
13746 #: ../src/guestfs-actions.pod:5286
13748 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13749 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
13754 #: ../src/guestfs-actions.pod:5292
13755 msgid "guestfs_readlink"
13759 #: ../src/guestfs-actions.pod:5294
13763 " guestfs_readlink (guestfs_h *g,\n"
13764 " const char *path);\n"
13769 #: ../src/guestfs-actions.pod:5298 ../fish/guestfish-actions.pod:3534
13770 msgid "This command reads the target of a symbolic link."
13774 #: ../src/guestfs-actions.pod:5305
13775 msgid "guestfs_readlinklist"
13779 #: ../src/guestfs-actions.pod:5307
13783 " guestfs_readlinklist (guestfs_h *g,\n"
13784 " const char *path,\n"
13785 " char *const *names);\n"
13790 #: ../src/guestfs-actions.pod:5312 ../fish/guestfish-actions.pod:3540
13792 "This call allows you to do a C<readlink> operation on multiple files, where "
13793 "all files are in the directory C<path>. C<names> is the list of files from "
13798 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3544
13800 "On return you get a list of strings, with a one-to-one correspondence to the "
13801 "C<names> list. Each string is the value of the symbolic link."
13805 #: ../src/guestfs-actions.pod:5320 ../fish/guestfish-actions.pod:3548
13807 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13808 "result string is the empty string C<\"\">. However the whole operation is "
13809 "completed even if there were C<readlink(2)> errors, and so you can call this "
13810 "function with names where you don't know if they are symbolic links already "
13811 "(albeit slightly less efficient)."
13815 #: ../src/guestfs-actions.pod:5327 ../fish/guestfish-actions.pod:3555
13817 "This call is intended for programs that want to efficiently list a directory "
13818 "contents without making many round-trips. Very long directory listings "
13819 "might cause the protocol message size to be exceeded, causing this call to "
13820 "fail. The caller must split up such requests into smaller groups of names."
13824 #: ../src/guestfs-actions.pod:5340
13825 msgid "guestfs_realpath"
13829 #: ../src/guestfs-actions.pod:5342
13833 " guestfs_realpath (guestfs_h *g,\n"
13834 " const char *path);\n"
13839 #: ../src/guestfs-actions.pod:5346 ../fish/guestfish-actions.pod:3566
13841 "Return the canonicalized absolute pathname of C<path>. The returned path "
13842 "has no C<.>, C<..> or symbolic link path elements."
13846 #: ../src/guestfs-actions.pod:5354
13847 msgid "guestfs_removexattr"
13851 #: ../src/guestfs-actions.pod:5356
13855 " guestfs_removexattr (guestfs_h *g,\n"
13856 " const char *xattr,\n"
13857 " const char *path);\n"
13862 #: ../src/guestfs-actions.pod:5361 ../fish/guestfish-actions.pod:3573
13863 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
13867 #: ../src/guestfs-actions.pod:5364
13868 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13872 #: ../src/guestfs-actions.pod:5370
13873 msgid "guestfs_resize2fs"
13877 #: ../src/guestfs-actions.pod:5372
13881 " guestfs_resize2fs (guestfs_h *g,\n"
13882 " const char *device);\n"
13887 #: ../src/guestfs-actions.pod:5376 ../fish/guestfish-actions.pod:3582
13889 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13890 "underlying device."
13894 #: ../src/guestfs-actions.pod:5379
13896 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13897 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13898 "sometimes gives an error about this and sometimes not. In any case, it is "
13899 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13903 #: ../src/guestfs-actions.pod:5389
13904 msgid "guestfs_resize2fs_size"
13908 #: ../src/guestfs-actions.pod:5391
13912 " guestfs_resize2fs_size (guestfs_h *g,\n"
13913 " const char *device,\n"
13914 " int64_t size);\n"
13919 #: ../src/guestfs-actions.pod:5396
13921 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13922 "to specify the new size (in bytes) explicitly."
13926 #: ../src/guestfs-actions.pod:5403
13931 #: ../src/guestfs-actions.pod:5405
13935 " guestfs_rm (guestfs_h *g,\n"
13936 " const char *path);\n"
13941 #: ../src/guestfs-actions.pod:5409 ../fish/guestfish-actions.pod:3602
13942 msgid "Remove the single file C<path>."
13946 #: ../src/guestfs-actions.pod:5415
13947 msgid "guestfs_rm_rf"
13951 #: ../src/guestfs-actions.pod:5417
13955 " guestfs_rm_rf (guestfs_h *g,\n"
13956 " const char *path);\n"
13961 #: ../src/guestfs-actions.pod:5421 ../fish/guestfish-actions.pod:3608
13963 "Remove the file or directory C<path>, recursively removing the contents if "
13964 "its a directory. This is like the C<rm -rf> shell command."
13968 #: ../src/guestfs-actions.pod:5429
13969 msgid "guestfs_rmdir"
13973 #: ../src/guestfs-actions.pod:5431
13977 " guestfs_rmdir (guestfs_h *g,\n"
13978 " const char *path);\n"
13983 #: ../src/guestfs-actions.pod:5435 ../fish/guestfish-actions.pod:3616
13984 msgid "Remove the single directory C<path>."
13988 #: ../src/guestfs-actions.pod:5441
13989 msgid "guestfs_rmmountpoint"
13993 #: ../src/guestfs-actions.pod:5443
13997 " guestfs_rmmountpoint (guestfs_h *g,\n"
13998 " const char *exemptpath);\n"
14003 #: ../src/guestfs-actions.pod:5447
14005 "This calls removes a mountpoint that was previously created with "
14006 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
14010 #: ../src/guestfs-actions.pod:5455
14011 msgid "guestfs_scrub_device"
14015 #: ../src/guestfs-actions.pod:5457
14019 " guestfs_scrub_device (guestfs_h *g,\n"
14020 " const char *device);\n"
14025 #: ../src/guestfs-actions.pod:5461 ../fish/guestfish-actions.pod:3630
14027 "This command writes patterns over C<device> to make data retrieval more "
14032 #: ../src/guestfs-actions.pod:5464 ../src/guestfs-actions.pod:5485 ../src/guestfs-actions.pod:5504 ../fish/guestfish-actions.pod:3633 ../fish/guestfish-actions.pod:3648 ../fish/guestfish-actions.pod:3661
14034 "It is an interface to the L<scrub(1)> program. See that manual page for "
14039 #: ../src/guestfs-actions.pod:5472 ../src/guestfs-actions.pod:5490 ../src/guestfs-actions.pod:5509
14040 msgid "(Added in 1.0.52)"
14044 #: ../src/guestfs-actions.pod:5474
14045 msgid "guestfs_scrub_file"
14049 #: ../src/guestfs-actions.pod:5476
14053 " guestfs_scrub_file (guestfs_h *g,\n"
14054 " const char *file);\n"
14059 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3643
14061 "This command writes patterns over a file to make data retrieval more "
14066 #: ../src/guestfs-actions.pod:5483 ../fish/guestfish-actions.pod:3646
14067 msgid "The file is I<removed> after scrubbing."
14071 #: ../src/guestfs-actions.pod:5492
14072 msgid "guestfs_scrub_freespace"
14076 #: ../src/guestfs-actions.pod:5494
14080 " guestfs_scrub_freespace (guestfs_h *g,\n"
14081 " const char *dir);\n"
14086 #: ../src/guestfs-actions.pod:5498
14088 "This command creates the directory C<dir> and then fills it with files until "
14089 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
14090 "and deletes them. The intention is to scrub any free space on the partition "
14091 "containing C<dir>."
14095 #: ../src/guestfs-actions.pod:5511
14096 msgid "guestfs_set_append"
14100 #: ../src/guestfs-actions.pod:5513
14104 " guestfs_set_append (guestfs_h *g,\n"
14105 " const char *append);\n"
14110 #: ../src/guestfs-actions.pod:5517 ../fish/guestfish-actions.pod:3670
14112 "This function is used to add additional options to the guest kernel command "
14117 #: ../src/guestfs-actions.pod:5520 ../fish/guestfish-actions.pod:3673
14119 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
14120 "environment variable."
14124 #: ../src/guestfs-actions.pod:5523 ../fish/guestfish-actions.pod:3676
14126 "Setting C<append> to C<NULL> means I<no> additional options are passed "
14127 "(libguestfs always adds a few of its own)."
14131 #: ../src/guestfs-actions.pod:5530
14132 msgid "guestfs_set_autosync"
14136 #: ../src/guestfs-actions.pod:5532
14140 " guestfs_set_autosync (guestfs_h *g,\n"
14141 " int autosync);\n"
14146 #: ../src/guestfs-actions.pod:5536
14148 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
14149 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
14150 "the handle is closed (also if the program exits without closing handles)."
14154 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3690
14156 "This is enabled by default (since libguestfs 1.5.24, previously it was "
14157 "disabled by default)."
14161 #: ../src/guestfs-actions.pod:5548
14162 msgid "guestfs_set_direct"
14166 #: ../src/guestfs-actions.pod:5550
14170 " guestfs_set_direct (guestfs_h *g,\n"
14176 #: ../src/guestfs-actions.pod:5554 ../fish/guestfish-actions.pod:3699
14178 "If the direct appliance mode flag is enabled, then stdin and stdout are "
14179 "passed directly through to the appliance once it is launched."
14183 #: ../src/guestfs-actions.pod:5558
14185 "One consequence of this is that log messages aren't caught by the library "
14186 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
14191 #: ../src/guestfs-actions.pod:5562 ../fish/guestfish-actions.pod:3707
14192 msgid "You probably don't want to use this unless you know what you are doing."
14196 #: ../src/guestfs-actions.pod:5565 ../fish/guestfish-actions.pod:3710
14197 msgid "The default is disabled."
14201 #: ../src/guestfs-actions.pod:5571
14202 msgid "guestfs_set_e2label"
14206 #: ../src/guestfs-actions.pod:5573
14210 " guestfs_set_e2label (guestfs_h *g,\n"
14211 " const char *device,\n"
14212 " const char *label);\n"
14217 #: ../src/guestfs-actions.pod:5578 ../fish/guestfish-actions.pod:3716
14219 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
14220 "C<label>. Filesystem labels are limited to 16 characters."
14224 #: ../src/guestfs-actions.pod:5582
14226 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
14227 "the existing label on a filesystem."
14231 #: ../src/guestfs-actions.pod:5589
14232 msgid "guestfs_set_e2uuid"
14236 #: ../src/guestfs-actions.pod:5591
14240 " guestfs_set_e2uuid (guestfs_h *g,\n"
14241 " const char *device,\n"
14242 " const char *uuid);\n"
14247 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:3727
14249 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
14250 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
14251 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
14255 #: ../src/guestfs-actions.pod:5601
14257 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
14258 "the existing UUID of a filesystem."
14262 #: ../src/guestfs-actions.pod:5608
14263 msgid "guestfs_set_memsize"
14267 #: ../src/guestfs-actions.pod:5610
14271 " guestfs_set_memsize (guestfs_h *g,\n"
14277 #: ../src/guestfs-actions.pod:5614
14279 "This sets the memory size in megabytes allocated to the qemu subprocess. "
14280 "This only has any effect if called before C<guestfs_launch>."
14284 #: ../src/guestfs-actions.pod:5618 ../fish/guestfish-actions.pod:3745
14286 "You can also change this by setting the environment variable "
14287 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
14291 #: ../src/guestfs-actions.pod:5629
14292 msgid "guestfs_set_network"
14296 #: ../src/guestfs-actions.pod:5631
14300 " guestfs_set_network (guestfs_h *g,\n"
14306 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3758
14308 "If C<network> is true, then the network is enabled in the libguestfs "
14309 "appliance. The default is false."
14313 #: ../src/guestfs-actions.pod:5638 ../fish/guestfish-actions.pod:3761
14315 "This affects whether commands are able to access the network (see "
14316 "L<guestfs(3)/RUNNING COMMANDS>)."
14320 #: ../src/guestfs-actions.pod:5641
14322 "You must call this before calling C<guestfs_launch>, otherwise it has no "
14327 #: ../src/guestfs-actions.pod:5648
14328 msgid "guestfs_set_path"
14332 #: ../src/guestfs-actions.pod:5650
14336 " guestfs_set_path (guestfs_h *g,\n"
14337 " const char *searchpath);\n"
14342 #: ../src/guestfs-actions.pod:5654 ../fish/guestfish-actions.pod:3773
14343 msgid "Set the path that libguestfs searches for kernel and initrd.img."
14347 #: ../src/guestfs-actions.pod:5656 ../fish/guestfish-actions.pod:3775
14349 "The default is C<$libdir/guestfs> unless overridden by setting "
14350 "C<LIBGUESTFS_PATH> environment variable."
14354 #: ../src/guestfs-actions.pod:5659 ../fish/guestfish-actions.pod:3778
14355 msgid "Setting C<path> to C<NULL> restores the default path."
14359 #: ../src/guestfs-actions.pod:5665
14360 msgid "guestfs_set_qemu"
14364 #: ../src/guestfs-actions.pod:5667
14368 " guestfs_set_qemu (guestfs_h *g,\n"
14369 " const char *qemu);\n"
14374 #: ../src/guestfs-actions.pod:5671 ../fish/guestfish-actions.pod:3786
14375 msgid "Set the qemu binary that we will use."
14379 #: ../src/guestfs-actions.pod:5673 ../fish/guestfish-actions.pod:3788
14380 msgid "The default is chosen when the library was compiled by the configure script."
14384 #: ../src/guestfs-actions.pod:5676 ../fish/guestfish-actions.pod:3791
14386 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
14391 #: ../src/guestfs-actions.pod:5679 ../fish/guestfish-actions.pod:3794
14392 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
14396 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3796
14398 "Note that you should call this function as early as possible after creating "
14399 "the handle. This is because some pre-launch operations depend on testing "
14400 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
14401 "don't retest features, and so you might see inconsistent results. Using the "
14402 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
14403 "the qemu binary at the same time as the handle is created."
14407 #: ../src/guestfs-actions.pod:5693
14408 msgid "guestfs_set_recovery_proc"
14412 #: ../src/guestfs-actions.pod:5695
14416 " guestfs_set_recovery_proc (guestfs_h *g,\n"
14417 " int recoveryproc);\n"
14422 #: ../src/guestfs-actions.pod:5699
14424 "If this is called with the parameter C<false> then C<guestfs_launch> does "
14425 "not create a recovery process. The purpose of the recovery process is to "
14426 "stop runaway qemu processes in the case where the main program aborts "
14431 #: ../src/guestfs-actions.pod:5704
14433 "This only has any effect if called before C<guestfs_launch>, and the default "
14438 #: ../src/guestfs-actions.pod:5707 ../fish/guestfish-actions.pod:3818
14440 "About the only time when you would want to disable this is if the main "
14441 "process will fork itself into the background (\"daemonize\" itself). In "
14442 "this case the recovery process thinks that the main program has disappeared "
14443 "and so kills qemu, which is not very helpful."
14447 #: ../src/guestfs-actions.pod:5717
14448 msgid "guestfs_set_selinux"
14452 #: ../src/guestfs-actions.pod:5719
14456 " guestfs_set_selinux (guestfs_h *g,\n"
14462 #: ../src/guestfs-actions.pod:5723 ../fish/guestfish-actions.pod:3830
14464 "This sets the selinux flag that is passed to the appliance at boot time. "
14465 "The default is C<selinux=0> (disabled)."
14469 #: ../src/guestfs-actions.pod:5726 ../fish/guestfish-actions.pod:3833
14471 "Note that if SELinux is enabled, it is always in Permissive mode "
14472 "(C<enforcing=0>)."
14476 #: ../src/guestfs-actions.pod:5736
14477 msgid "guestfs_set_trace"
14481 #: ../src/guestfs-actions.pod:5738
14485 " guestfs_set_trace (guestfs_h *g,\n"
14491 #: ../src/guestfs-actions.pod:5742 ../fish/guestfish-actions.pod:3845
14493 "If the command trace flag is set to 1, then commands are printed on stderr "
14494 "before they are executed in a format which is very similar to the one used "
14495 "by guestfish. In other words, you can run a program with this enabled, and "
14496 "you will get out a script which you can feed to guestfish to perform the "
14497 "same set of actions."
14501 #: ../src/guestfs-actions.pod:5749 ../fish/guestfish-actions.pod:3852
14503 "If you want to trace C API calls into libguestfs (and other libraries) then "
14504 "possibly a better way is to use the external ltrace(1) command."
14508 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3856
14510 "Command traces are disabled unless the environment variable "
14511 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
14515 #: ../src/guestfs-actions.pod:5760
14516 msgid "guestfs_set_verbose"
14520 #: ../src/guestfs-actions.pod:5762
14524 " guestfs_set_verbose (guestfs_h *g,\n"
14530 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3865
14531 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
14535 #: ../src/guestfs-actions.pod:5768 ../fish/guestfish-actions.pod:3867
14537 "Verbose messages are disabled unless the environment variable "
14538 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
14542 #: ../src/guestfs-actions.pod:5775
14543 msgid "guestfs_setcon"
14547 #: ../src/guestfs-actions.pod:5777
14551 " guestfs_setcon (guestfs_h *g,\n"
14552 " const char *context);\n"
14557 #: ../src/guestfs-actions.pod:5781 ../fish/guestfish-actions.pod:3874
14559 "This sets the SELinux security context of the daemon to the string "
14564 #: ../src/guestfs-actions.pod:5784 ../fish/guestfish-actions.pod:3877
14565 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14569 #: ../src/guestfs-actions.pod:5790
14570 msgid "guestfs_setxattr"
14574 #: ../src/guestfs-actions.pod:5792
14578 " guestfs_setxattr (guestfs_h *g,\n"
14579 " const char *xattr,\n"
14580 " const char *val,\n"
14582 " const char *path);\n"
14587 #: ../src/guestfs-actions.pod:5799 ../fish/guestfish-actions.pod:3883
14589 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14590 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14594 #: ../src/guestfs-actions.pod:5803
14595 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14599 #: ../src/guestfs-actions.pod:5809
14600 msgid "guestfs_sfdisk"
14604 #: ../src/guestfs-actions.pod:5811
14608 " guestfs_sfdisk (guestfs_h *g,\n"
14609 " const char *device,\n"
14613 " char *const *lines);\n"
14618 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3893
14620 "This is a direct interface to the L<sfdisk(8)> program for creating "
14621 "partitions on block devices."
14625 #: ../src/guestfs-actions.pod:5822 ../fish/guestfish-actions.pod:3896
14626 msgid "C<device> should be a block device, for example C</dev/sda>."
14630 #: ../src/guestfs-actions.pod:5824 ../fish/guestfish-actions.pod:3898
14632 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14633 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
14634 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14635 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14636 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14637 "the kernel) cannot work out the right geometry and you will need to tell it."
14641 #: ../src/guestfs-actions.pod:5832 ../fish/guestfish-actions.pod:3906
14643 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14644 "refer to the L<sfdisk(8)> manpage."
14648 #: ../src/guestfs-actions.pod:5835 ../fish/guestfish-actions.pod:3909
14650 "To create a single partition occupying the whole disk, you would pass "
14651 "C<lines> as a single element list, when the single element being the string "
14656 #: ../src/guestfs-actions.pod:5839
14657 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14661 #: ../src/guestfs-actions.pod:5849
14662 msgid "guestfs_sfdiskM"
14666 #: ../src/guestfs-actions.pod:5851
14670 " guestfs_sfdiskM (guestfs_h *g,\n"
14671 " const char *device,\n"
14672 " char *const *lines);\n"
14677 #: ../src/guestfs-actions.pod:5856
14679 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14680 "partition sizes are specified in megabytes only (rounded to the nearest "
14681 "cylinder) and you don't need to specify the cyls, heads and sectors "
14682 "parameters which were rarely if ever used anyway."
14686 #: ../src/guestfs-actions.pod:5862
14688 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14689 "C<guestfs_part_disk>"
14693 #: ../src/guestfs-actions.pod:5872
14694 msgid "guestfs_sfdisk_N"
14698 #: ../src/guestfs-actions.pod:5874
14702 " guestfs_sfdisk_N (guestfs_h *g,\n"
14703 " const char *device,\n"
14708 " const char *line);\n"
14713 #: ../src/guestfs-actions.pod:5883 ../fish/guestfish-actions.pod:3939
14715 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14716 "(note: C<n> counts from 1)."
14720 #: ../src/guestfs-actions.pod:5886
14722 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14723 "for the cyls/heads/sectors parameters."
14727 #: ../src/guestfs-actions.pod:5889
14728 msgid "See also: C<guestfs_part_add>"
14732 #: ../src/guestfs-actions.pod:5898
14733 msgid "guestfs_sfdisk_disk_geometry"
14737 #: ../src/guestfs-actions.pod:5900
14741 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14742 " const char *device);\n"
14747 #: ../src/guestfs-actions.pod:5904
14749 "This displays the disk geometry of C<device> read from the partition table. "
14750 "Especially in the case where the underlying block device has been resized, "
14751 "this can be different from the kernel's idea of the geometry (see "
14752 "C<guestfs_sfdisk_kernel_geometry>)."
14756 #: ../src/guestfs-actions.pod:5909 ../src/guestfs-actions.pod:5925 ../fish/guestfish-actions.pod:3959 ../fish/guestfish-actions.pod:3968
14757 msgid "The result is in human-readable format, and not designed to be parsed."
14761 #: ../src/guestfs-actions.pod:5917
14762 msgid "guestfs_sfdisk_kernel_geometry"
14766 #: ../src/guestfs-actions.pod:5919
14770 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14771 " const char *device);\n"
14776 #: ../src/guestfs-actions.pod:5923 ../fish/guestfish-actions.pod:3966
14777 msgid "This displays the kernel's idea of the geometry of C<device>."
14781 #: ../src/guestfs-actions.pod:5933
14782 msgid "guestfs_sfdisk_l"
14786 #: ../src/guestfs-actions.pod:5935
14790 " guestfs_sfdisk_l (guestfs_h *g,\n"
14791 " const char *device);\n"
14796 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:3975
14798 "This displays the partition table on C<device>, in the human-readable output "
14799 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14803 #: ../src/guestfs-actions.pod:5943
14804 msgid "See also: C<guestfs_part_list>"
14808 #: ../src/guestfs-actions.pod:5950
14813 #: ../src/guestfs-actions.pod:5952
14817 " guestfs_sh (guestfs_h *g,\n"
14818 " const char *command);\n"
14823 #: ../src/guestfs-actions.pod:5956 ../fish/guestfish-actions.pod:3985
14825 "This call runs a command from the guest filesystem via the guest's "
14830 #: ../src/guestfs-actions.pod:5959
14831 msgid "This is like C<guestfs_command>, but passes the command to:"
14835 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:3990
14838 " /bin/sh -c \"command\"\n"
14843 #: ../src/guestfs-actions.pod:5963 ../fish/guestfish-actions.pod:3992
14845 "Depending on the guest's shell, this usually results in wildcards being "
14846 "expanded, shell expressions being interpolated and so on."
14850 #: ../src/guestfs-actions.pod:5967
14851 msgid "All the provisos about C<guestfs_command> apply to this call."
14855 #: ../src/guestfs-actions.pod:5974
14856 msgid "guestfs_sh_lines"
14860 #: ../src/guestfs-actions.pod:5976
14864 " guestfs_sh_lines (guestfs_h *g,\n"
14865 " const char *command);\n"
14870 #: ../src/guestfs-actions.pod:5980
14872 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14877 #: ../src/guestfs-actions.pod:5983
14878 msgid "See also: C<guestfs_command_lines>"
14882 #: ../src/guestfs-actions.pod:5991
14883 msgid "guestfs_sleep"
14887 #: ../src/guestfs-actions.pod:5993
14891 " guestfs_sleep (guestfs_h *g,\n"
14897 #: ../src/guestfs-actions.pod:5997 ../fish/guestfish-actions.pod:4011
14898 msgid "Sleep for C<secs> seconds."
14902 #: ../src/guestfs-actions.pod:6001
14903 msgid "(Added in 1.0.41)"
14907 #: ../src/guestfs-actions.pod:6003 ../src/guestfs-structs.pod:109
14908 msgid "guestfs_stat"
14912 #: ../src/guestfs-actions.pod:6005
14915 " struct guestfs_stat *\n"
14916 " guestfs_stat (guestfs_h *g,\n"
14917 " const char *path);\n"
14922 #: ../src/guestfs-actions.pod:6011 ../fish/guestfish-actions.pod:4019
14923 msgid "This is the same as the C<stat(2)> system call."
14927 #: ../src/guestfs-actions.pod:6019 ../src/guestfs-structs.pod:135
14928 msgid "guestfs_statvfs"
14932 #: ../src/guestfs-actions.pod:6021
14935 " struct guestfs_statvfs *\n"
14936 " guestfs_statvfs (guestfs_h *g,\n"
14937 " const char *path);\n"
14942 #: ../src/guestfs-actions.pod:6025 ../fish/guestfish-actions.pod:4025
14944 "Returns file system statistics for any mounted file system. C<path> should "
14945 "be a file or directory in the mounted file system (typically it is the mount "
14946 "point itself, but it doesn't need to be)."
14950 #: ../src/guestfs-actions.pod:6029 ../fish/guestfish-actions.pod:4029
14951 msgid "This is the same as the C<statvfs(2)> system call."
14955 #: ../src/guestfs-actions.pod:6031
14957 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14958 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14962 #: ../src/guestfs-actions.pod:6037
14963 msgid "guestfs_strings"
14967 #: ../src/guestfs-actions.pod:6039
14971 " guestfs_strings (guestfs_h *g,\n"
14972 " const char *path);\n"
14977 #: ../src/guestfs-actions.pod:6043 ../fish/guestfish-actions.pod:4035
14979 "This runs the L<strings(1)> command on a file and returns the list of "
14980 "printable strings found."
14984 #: ../src/guestfs-actions.pod:6055
14985 msgid "guestfs_strings_e"
14989 #: ../src/guestfs-actions.pod:6057
14993 " guestfs_strings_e (guestfs_h *g,\n"
14994 " const char *encoding,\n"
14995 " const char *path);\n"
15000 #: ../src/guestfs-actions.pod:6062
15002 "This is like the C<guestfs_strings> command, but allows you to specify the "
15003 "encoding of strings that are looked for in the source file C<path>."
15007 #: ../src/guestfs-actions.pod:6066 ../fish/guestfish-actions.pod:4049
15008 msgid "Allowed encodings are:"
15012 #: ../src/guestfs-actions.pod:6070 ../fish/guestfish-actions.pod:4053
15017 #: ../src/guestfs-actions.pod:6072
15019 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
15020 "ISO-8859-X (this is what C<guestfs_strings> uses)."
15024 #: ../src/guestfs-actions.pod:6075 ../fish/guestfish-actions.pod:4058
15029 #: ../src/guestfs-actions.pod:6077 ../fish/guestfish-actions.pod:4060
15030 msgid "Single 8-bit-byte characters."
15034 #: ../src/guestfs-actions.pod:6079 ../fish/guestfish-actions.pod:4062
15039 #: ../src/guestfs-actions.pod:6081 ../fish/guestfish-actions.pod:4064
15040 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
15044 #: ../src/guestfs-actions.pod:6084 ../fish/guestfish-actions.pod:4067
15045 msgid "l (lower case letter L)"
15049 #: ../src/guestfs-actions.pod:6086 ../fish/guestfish-actions.pod:4069
15051 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
15052 "examining binaries in Windows guests."
15056 #: ../src/guestfs-actions.pod:6089 ../fish/guestfish-actions.pod:4072
15061 #: ../src/guestfs-actions.pod:6091 ../fish/guestfish-actions.pod:4074
15062 msgid "32-bit big endian such as UCS-4BE."
15066 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4076
15071 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4078
15072 msgid "32-bit little endian such as UCS-4LE."
15076 #: ../src/guestfs-actions.pod:6099 ../fish/guestfish-actions.pod:4082
15077 msgid "The returned strings are transcoded to UTF-8."
15081 #: ../src/guestfs-actions.pod:6110
15082 msgid "guestfs_swapoff_device"
15086 #: ../src/guestfs-actions.pod:6112
15090 " guestfs_swapoff_device (guestfs_h *g,\n"
15091 " const char *device);\n"
15096 #: ../src/guestfs-actions.pod:6116
15098 "This command disables the libguestfs appliance swap device or partition "
15099 "named C<device>. See C<guestfs_swapon_device>."
15103 #: ../src/guestfs-actions.pod:6124
15104 msgid "guestfs_swapoff_file"
15108 #: ../src/guestfs-actions.pod:6126
15112 " guestfs_swapoff_file (guestfs_h *g,\n"
15113 " const char *file);\n"
15118 #: ../src/guestfs-actions.pod:6130 ../fish/guestfish-actions.pod:4099
15119 msgid "This command disables the libguestfs appliance swap on file."
15123 #: ../src/guestfs-actions.pod:6136
15124 msgid "guestfs_swapoff_label"
15128 #: ../src/guestfs-actions.pod:6138
15132 " guestfs_swapoff_label (guestfs_h *g,\n"
15133 " const char *label);\n"
15138 #: ../src/guestfs-actions.pod:6142 ../fish/guestfish-actions.pod:4105
15140 "This command disables the libguestfs appliance swap on labeled swap "
15145 #: ../src/guestfs-actions.pod:6149
15146 msgid "guestfs_swapoff_uuid"
15150 #: ../src/guestfs-actions.pod:6151
15154 " guestfs_swapoff_uuid (guestfs_h *g,\n"
15155 " const char *uuid);\n"
15160 #: ../src/guestfs-actions.pod:6155 ../fish/guestfish-actions.pod:4112
15162 "This command disables the libguestfs appliance swap partition with the given "
15167 #: ../src/guestfs-actions.pod:6162
15168 msgid "guestfs_swapon_device"
15172 #: ../src/guestfs-actions.pod:6164
15176 " guestfs_swapon_device (guestfs_h *g,\n"
15177 " const char *device);\n"
15182 #: ../src/guestfs-actions.pod:6168
15184 "This command enables the libguestfs appliance to use the swap device or "
15185 "partition named C<device>. The increased memory is made available for all "
15186 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
15190 #: ../src/guestfs-actions.pod:6173 ../fish/guestfish-actions.pod:4124
15192 "Note that you should not swap to existing guest swap partitions unless you "
15193 "know what you are doing. They may contain hibernation information, or other "
15194 "information that the guest doesn't want you to trash. You also risk leaking "
15195 "information about the host to the guest this way. Instead, attach a new "
15196 "host device to the guest and swap on that."
15200 #: ../src/guestfs-actions.pod:6184
15201 msgid "guestfs_swapon_file"
15205 #: ../src/guestfs-actions.pod:6186
15209 " guestfs_swapon_file (guestfs_h *g,\n"
15210 " const char *file);\n"
15215 #: ../src/guestfs-actions.pod:6190
15217 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
15222 #: ../src/guestfs-actions.pod:6197
15223 msgid "guestfs_swapon_label"
15227 #: ../src/guestfs-actions.pod:6199
15231 " guestfs_swapon_label (guestfs_h *g,\n"
15232 " const char *label);\n"
15237 #: ../src/guestfs-actions.pod:6203
15239 "This command enables swap to a labeled swap partition. See "
15240 "C<guestfs_swapon_device> for other notes."
15244 #: ../src/guestfs-actions.pod:6210
15245 msgid "guestfs_swapon_uuid"
15249 #: ../src/guestfs-actions.pod:6212
15253 " guestfs_swapon_uuid (guestfs_h *g,\n"
15254 " const char *uuid);\n"
15259 #: ../src/guestfs-actions.pod:6216
15261 "This command enables swap to a swap partition with the given UUID. See "
15262 "C<guestfs_swapon_device> for other notes."
15266 #: ../src/guestfs-actions.pod:6223
15267 msgid "guestfs_sync"
15271 #: ../src/guestfs-actions.pod:6225
15275 " guestfs_sync (guestfs_h *g);\n"
15280 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4156
15282 "This syncs the disk, so that any writes are flushed through to the "
15283 "underlying disk image."
15287 #: ../src/guestfs-actions.pod:6231 ../fish/guestfish-actions.pod:4159
15289 "You should always call this if you have modified a disk image, before "
15290 "closing the handle."
15294 #: ../src/guestfs-actions.pod:6238
15295 msgid "guestfs_tail"
15299 #: ../src/guestfs-actions.pod:6240
15303 " guestfs_tail (guestfs_h *g,\n"
15304 " const char *path);\n"
15309 #: ../src/guestfs-actions.pod:6244 ../fish/guestfish-actions.pod:4166
15310 msgid "This command returns up to the last 10 lines of a file as a list of strings."
15314 #: ../src/guestfs-actions.pod:6256
15315 msgid "guestfs_tail_n"
15319 #: ../src/guestfs-actions.pod:6258
15323 " guestfs_tail_n (guestfs_h *g,\n"
15325 " const char *path);\n"
15330 #: ../src/guestfs-actions.pod:6263 ../fish/guestfish-actions.pod:4176
15332 "If the parameter C<nrlines> is a positive number, this returns the last "
15333 "C<nrlines> lines of the file C<path>."
15337 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4179
15339 "If the parameter C<nrlines> is a negative number, this returns lines from "
15340 "the file C<path>, starting with the C<-nrlines>th line."
15344 #: ../src/guestfs-actions.pod:6280
15345 msgid "guestfs_tar_in"
15349 #: ../src/guestfs-actions.pod:6282
15353 " guestfs_tar_in (guestfs_h *g,\n"
15354 " const char *tarfile,\n"
15355 " const char *directory);\n"
15360 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4191
15362 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
15363 "tar file) into C<directory>."
15367 #: ../src/guestfs-actions.pod:6290
15368 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
15372 #: ../src/guestfs-actions.pod:6295 ../src/guestfs-actions.pod:6312 ../src/guestfs-actions.pod:6328 ../src/guestfs-actions.pod:6344
15373 msgid "(Added in 1.0.3)"
15377 #: ../src/guestfs-actions.pod:6297
15378 msgid "guestfs_tar_out"
15382 #: ../src/guestfs-actions.pod:6299
15386 " guestfs_tar_out (guestfs_h *g,\n"
15387 " const char *directory,\n"
15388 " const char *tarfile);\n"
15393 #: ../src/guestfs-actions.pod:6304 ../fish/guestfish-actions.pod:4203
15395 "This command packs the contents of C<directory> and downloads it to local "
15400 #: ../src/guestfs-actions.pod:6307
15402 "To download a compressed tarball, use C<guestfs_tgz_out> or "
15403 "C<guestfs_txz_out>."
15407 #: ../src/guestfs-actions.pod:6314
15408 msgid "guestfs_tgz_in"
15412 #: ../src/guestfs-actions.pod:6316
15416 " guestfs_tgz_in (guestfs_h *g,\n"
15417 " const char *tarball,\n"
15418 " const char *directory);\n"
15423 #: ../src/guestfs-actions.pod:6321 ../fish/guestfish-actions.pod:4215
15425 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
15426 "tar file) into C<directory>."
15430 #: ../src/guestfs-actions.pod:6324
15431 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
15435 #: ../src/guestfs-actions.pod:6330
15436 msgid "guestfs_tgz_out"
15440 #: ../src/guestfs-actions.pod:6332
15444 " guestfs_tgz_out (guestfs_h *g,\n"
15445 " const char *directory,\n"
15446 " const char *tarball);\n"
15451 #: ../src/guestfs-actions.pod:6337 ../fish/guestfish-actions.pod:4226
15453 "This command packs the contents of C<directory> and downloads it to local "
15458 #: ../src/guestfs-actions.pod:6340
15459 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
15463 #: ../src/guestfs-actions.pod:6346
15464 msgid "guestfs_touch"
15468 #: ../src/guestfs-actions.pod:6348
15472 " guestfs_touch (guestfs_h *g,\n"
15473 " const char *path);\n"
15478 #: ../src/guestfs-actions.pod:6352 ../fish/guestfish-actions.pod:4237
15480 "Touch acts like the L<touch(1)> command. It can be used to update the "
15481 "timestamps on a file, or, if the file does not exist, to create a new "
15482 "zero-length file."
15486 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4241
15488 "This command only works on regular files, and will fail on other file types "
15489 "such as directories, symbolic links, block special etc."
15493 #: ../src/guestfs-actions.pod:6363
15494 msgid "guestfs_truncate"
15498 #: ../src/guestfs-actions.pod:6365
15502 " guestfs_truncate (guestfs_h *g,\n"
15503 " const char *path);\n"
15508 #: ../src/guestfs-actions.pod:6369 ../fish/guestfish-actions.pod:4248
15510 "This command truncates C<path> to a zero-length file. The file must exist "
15515 #: ../src/guestfs-actions.pod:6376
15516 msgid "guestfs_truncate_size"
15520 #: ../src/guestfs-actions.pod:6378
15524 " guestfs_truncate_size (guestfs_h *g,\n"
15525 " const char *path,\n"
15526 " int64_t size);\n"
15531 #: ../src/guestfs-actions.pod:6383 ../fish/guestfish-actions.pod:4255
15533 "This command truncates C<path> to size C<size> bytes. The file must exist "
15538 #: ../src/guestfs-actions.pod:6386
15540 "If the current file size is less than C<size> then the file is extended to "
15541 "the required size with zero bytes. This creates a sparse file (ie. disk "
15542 "blocks are not allocated for the file until you write to it). To create a "
15543 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15547 #: ../src/guestfs-actions.pod:6396
15548 msgid "guestfs_tune2fs_l"
15552 #: ../src/guestfs-actions.pod:6398
15556 " guestfs_tune2fs_l (guestfs_h *g,\n"
15557 " const char *device);\n"
15562 #: ../src/guestfs-actions.pod:6402 ../fish/guestfish-actions.pod:4268
15564 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15569 #: ../src/guestfs-actions.pod:6405 ../fish/guestfish-actions.pod:4271
15571 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15572 "for more details. The list of fields returned isn't clearly defined, and "
15573 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15574 "and the filesystem itself."
15578 #: ../src/guestfs-actions.pod:6418
15579 msgid "guestfs_txz_in"
15583 #: ../src/guestfs-actions.pod:6420
15587 " guestfs_txz_in (guestfs_h *g,\n"
15588 " const char *tarball,\n"
15589 " const char *directory);\n"
15594 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4280
15596 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15597 "tar file) into C<directory>."
15601 #: ../src/guestfs-actions.pod:6432
15602 msgid "guestfs_txz_out"
15606 #: ../src/guestfs-actions.pod:6434
15610 " guestfs_txz_out (guestfs_h *g,\n"
15611 " const char *directory,\n"
15612 " const char *tarball);\n"
15617 #: ../src/guestfs-actions.pod:6439 ../fish/guestfish-actions.pod:4289
15619 "This command packs the contents of C<directory> and downloads it to local "
15620 "file C<tarball> (as an xz compressed tar archive)."
15624 #: ../src/guestfs-actions.pod:6446
15625 msgid "guestfs_umask"
15629 #: ../src/guestfs-actions.pod:6448
15633 " guestfs_umask (guestfs_h *g,\n"
15639 #: ../src/guestfs-actions.pod:6452 ../fish/guestfish-actions.pod:4298
15641 "This function sets the mask used for creating new files and device nodes to "
15646 #: ../src/guestfs-actions.pod:6455 ../fish/guestfish-actions.pod:4301
15648 "Typical umask values would be C<022> which creates new files with "
15649 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15650 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15654 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4306
15656 "The default umask is C<022>. This is important because it means that "
15657 "directories and device nodes will be created with C<0644> or C<0755> mode "
15658 "even if you specify C<0777>."
15662 #: ../src/guestfs-actions.pod:6464
15664 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15665 "C<guestfs_mkdir>."
15669 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4313
15670 msgid "This call returns the previous umask."
15674 #: ../src/guestfs-actions.pod:6473
15675 msgid "guestfs_umount"
15679 #: ../src/guestfs-actions.pod:6475
15683 " guestfs_umount (guestfs_h *g,\n"
15684 " const char *pathordevice);\n"
15689 #: ../src/guestfs-actions.pod:6479 ../fish/guestfish-actions.pod:4321
15691 "This unmounts the given filesystem. The filesystem may be specified either "
15692 "by its mountpoint (path) or the device which contains the filesystem."
15696 #: ../src/guestfs-actions.pod:6487
15697 msgid "guestfs_umount_all"
15701 #: ../src/guestfs-actions.pod:6489
15705 " guestfs_umount_all (guestfs_h *g);\n"
15710 #: ../src/guestfs-actions.pod:6492 ../fish/guestfish-actions.pod:4331
15711 msgid "This unmounts all mounted filesystems."
15715 #: ../src/guestfs-actions.pod:6494 ../fish/guestfish-actions.pod:4333
15716 msgid "Some internal mounts are not unmounted by this call."
15720 #: ../src/guestfs-actions.pod:6500
15721 msgid "guestfs_upload"
15725 #: ../src/guestfs-actions.pod:6502
15729 " guestfs_upload (guestfs_h *g,\n"
15730 " const char *filename,\n"
15731 " const char *remotefilename);\n"
15736 #: ../src/guestfs-actions.pod:6507 ../src/guestfs-actions.pod:6531 ../fish/guestfish-actions.pod:4339 ../fish/guestfish-actions.pod:4352
15737 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15741 #: ../src/guestfs-actions.pod:6512
15742 msgid "See also C<guestfs_download>."
15746 #: ../src/guestfs-actions.pod:6523
15747 msgid "guestfs_upload_offset"
15751 #: ../src/guestfs-actions.pod:6525
15755 " guestfs_upload_offset (guestfs_h *g,\n"
15756 " const char *filename,\n"
15757 " const char *remotefilename,\n"
15758 " int64_t offset);\n"
15763 #: ../src/guestfs-actions.pod:6534 ../fish/guestfish-actions.pod:4355
15765 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15766 "The intention is to overwrite parts of existing files or devices, although "
15767 "if a non-existant file is specified then it is created with a \"hole\" "
15768 "before C<offset>. The size of the data written is implicit in the size of "
15769 "the source C<filename>."
15773 #: ../src/guestfs-actions.pod:6541
15775 "Note that there is no limit on the amount of data that can be uploaded with "
15776 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15777 "full amount unless an error occurs."
15781 #: ../src/guestfs-actions.pod:6546
15782 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15786 #: ../src/guestfs-actions.pod:6557
15787 msgid "guestfs_utimens"
15791 #: ../src/guestfs-actions.pod:6559
15795 " guestfs_utimens (guestfs_h *g,\n"
15796 " const char *path,\n"
15797 " int64_t atsecs,\n"
15798 " int64_t atnsecs,\n"
15799 " int64_t mtsecs,\n"
15800 " int64_t mtnsecs);\n"
15805 #: ../src/guestfs-actions.pod:6567 ../fish/guestfish-actions.pod:4375
15806 msgid "This command sets the timestamps of a file with nanosecond precision."
15810 #: ../src/guestfs-actions.pod:6570 ../fish/guestfish-actions.pod:4378
15812 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15817 #: ../src/guestfs-actions.pod:6573 ../fish/guestfish-actions.pod:4381
15819 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15820 "nanoseconds from the epoch."
15824 #: ../src/guestfs-actions.pod:6576 ../fish/guestfish-actions.pod:4384
15826 "If the C<*nsecs> field contains the special value C<-1> then the "
15827 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15828 "ignored in this case)."
15832 #: ../src/guestfs-actions.pod:6580 ../fish/guestfish-actions.pod:4388
15834 "If the C<*nsecs> field contains the special value C<-2> then the "
15835 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15840 #: ../src/guestfs-actions.pod:6588 ../src/guestfs-structs.pod:175
15841 msgid "guestfs_version"
15845 #: ../src/guestfs-actions.pod:6590
15848 " struct guestfs_version *\n"
15849 " guestfs_version (guestfs_h *g);\n"
15854 #: ../src/guestfs-actions.pod:6593 ../fish/guestfish-actions.pod:4396
15855 msgid "Return the libguestfs version number that the program is linked against."
15859 #: ../src/guestfs-actions.pod:6596 ../fish/guestfish-actions.pod:4399
15861 "Note that because of dynamic linking this is not necessarily the version of "
15862 "libguestfs that you compiled against. You can compile the program, and then "
15863 "at runtime dynamically link against a completely different C<libguestfs.so> "
15868 #: ../src/guestfs-actions.pod:6601 ../fish/guestfish-actions.pod:4404
15870 "This call was added in version C<1.0.58>. In previous versions of "
15871 "libguestfs there was no way to get the version number. From C code you can "
15872 "use dynamic linker functions to find out if this symbol exists (if it "
15873 "doesn't, then it's an earlier version)."
15877 #: ../src/guestfs-actions.pod:6607 ../fish/guestfish-actions.pod:4410
15879 "The call returns a structure with four elements. The first three (C<major>, "
15880 "C<minor> and C<release>) are numbers and correspond to the usual version "
15881 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15882 "but may be used for distro-specific information."
15886 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
15887 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
15891 #: ../src/guestfs-actions.pod:6616 ../fish/guestfish-actions.pod:4419
15892 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15896 #: ../src/guestfs-actions.pod:6618
15898 "I<Note:> Don't use this call to test for availability of features. In "
15899 "enterprise distributions we backport features from later versions into "
15900 "earlier versions, making this an unreliable way to test for features. Use "
15901 "C<guestfs_available> instead."
15905 #: ../src/guestfs-actions.pod:6624
15907 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15908 "error. I<The caller must call C<guestfs_free_version> after use>."
15912 #: ../src/guestfs-actions.pod:6628
15913 msgid "(Added in 1.0.58)"
15917 #: ../src/guestfs-actions.pod:6630
15918 msgid "guestfs_vfs_label"
15922 #: ../src/guestfs-actions.pod:6632
15926 " guestfs_vfs_label (guestfs_h *g,\n"
15927 " const char *device);\n"
15932 #: ../src/guestfs-actions.pod:6636 ../fish/guestfish-actions.pod:4431
15933 msgid "This returns the filesystem label of the filesystem on C<device>."
15937 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4434
15938 msgid "If the filesystem is unlabeled, this returns the empty string."
15942 #: ../src/guestfs-actions.pod:6641
15943 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15947 #: ../src/guestfs-actions.pod:6646 ../src/guestfs-actions.pod:6683
15948 msgid "(Added in 1.3.18)"
15952 #: ../src/guestfs-actions.pod:6648
15953 msgid "guestfs_vfs_type"
15957 #: ../src/guestfs-actions.pod:6650
15961 " guestfs_vfs_type (guestfs_h *g,\n"
15962 " const char *device);\n"
15967 #: ../src/guestfs-actions.pod:6654 ../fish/guestfish-actions.pod:4442
15969 "This command gets the filesystem type corresponding to the filesystem on "
15974 #: ../src/guestfs-actions.pod:6657 ../fish/guestfish-actions.pod:4445
15976 "For most filesystems, the result is the name of the Linux VFS module which "
15977 "would be used to mount this filesystem if you mounted it without specifying "
15978 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15982 #: ../src/guestfs-actions.pod:6667
15983 msgid "guestfs_vfs_uuid"
15987 #: ../src/guestfs-actions.pod:6669
15991 " guestfs_vfs_uuid (guestfs_h *g,\n"
15992 " const char *device);\n"
15997 #: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4454
15998 msgid "This returns the filesystem UUID of the filesystem on C<device>."
16002 #: ../src/guestfs-actions.pod:6676 ../fish/guestfish-actions.pod:4457
16003 msgid "If the filesystem does not have a UUID, this returns the empty string."
16007 #: ../src/guestfs-actions.pod:6678
16008 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
16012 #: ../src/guestfs-actions.pod:6685
16013 msgid "guestfs_vg_activate"
16017 #: ../src/guestfs-actions.pod:6687
16021 " guestfs_vg_activate (guestfs_h *g,\n"
16023 " char *const *volgroups);\n"
16028 #: ../src/guestfs-actions.pod:6692 ../fish/guestfish-actions.pod:4465
16030 "This command activates or (if C<activate> is false) deactivates all logical "
16031 "volumes in the listed volume groups C<volgroups>. If activated, then they "
16032 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
16033 "deactivated, then those devices disappear."
16037 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4471
16038 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
16042 #: ../src/guestfs-actions.pod:6700 ../fish/guestfish-actions.pod:4473
16044 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
16045 "activated or deactivated."
16049 #: ../src/guestfs-actions.pod:6707
16050 msgid "guestfs_vg_activate_all"
16054 #: ../src/guestfs-actions.pod:6709
16058 " guestfs_vg_activate_all (guestfs_h *g,\n"
16059 " int activate);\n"
16064 #: ../src/guestfs-actions.pod:6713 ../fish/guestfish-actions.pod:4480
16066 "This command activates or (if C<activate> is false) deactivates all logical "
16067 "volumes in all volume groups. If activated, then they are made known to the "
16068 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
16069 "those devices disappear."
16073 #: ../src/guestfs-actions.pod:6719 ../fish/guestfish-actions.pod:4486
16074 msgid "This command is the same as running C<vgchange -a y|n>"
16078 #: ../src/guestfs-actions.pod:6725
16079 msgid "guestfs_vgcreate"
16083 #: ../src/guestfs-actions.pod:6727
16087 " guestfs_vgcreate (guestfs_h *g,\n"
16088 " const char *volgroup,\n"
16089 " char *const *physvols);\n"
16094 #: ../src/guestfs-actions.pod:6732 ../fish/guestfish-actions.pod:4492
16096 "This creates an LVM volume group called C<volgroup> from the non-empty list "
16097 "of physical volumes C<physvols>."
16101 #: ../src/guestfs-actions.pod:6739
16102 msgid "guestfs_vglvuuids"
16106 #: ../src/guestfs-actions.pod:6741
16110 " guestfs_vglvuuids (guestfs_h *g,\n"
16111 " const char *vgname);\n"
16116 #: ../src/guestfs-actions.pod:6745 ../fish/guestfish-actions.pod:4499
16118 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
16119 "volumes created in this volume group."
16123 #: ../src/guestfs-actions.pod:6748
16125 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
16126 "associate logical volumes and volume groups."
16130 #: ../src/guestfs-actions.pod:6751
16131 msgid "See also C<guestfs_vgpvuuids>."
16135 #: ../src/guestfs-actions.pod:6759
16136 msgid "guestfs_vgpvuuids"
16140 #: ../src/guestfs-actions.pod:6761
16144 " guestfs_vgpvuuids (guestfs_h *g,\n"
16145 " const char *vgname);\n"
16150 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4511
16152 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
16153 "volumes that this volume group resides on."
16157 #: ../src/guestfs-actions.pod:6768
16159 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
16160 "associate physical volumes and volume groups."
16164 #: ../src/guestfs-actions.pod:6771
16165 msgid "See also C<guestfs_vglvuuids>."
16169 #: ../src/guestfs-actions.pod:6779
16170 msgid "guestfs_vgremove"
16174 #: ../src/guestfs-actions.pod:6781
16178 " guestfs_vgremove (guestfs_h *g,\n"
16179 " const char *vgname);\n"
16184 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4523
16185 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
16189 #: ../src/guestfs-actions.pod:6787 ../fish/guestfish-actions.pod:4525
16190 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
16194 #: ../src/guestfs-actions.pod:6794
16195 msgid "guestfs_vgrename"
16199 #: ../src/guestfs-actions.pod:6796
16203 " guestfs_vgrename (guestfs_h *g,\n"
16204 " const char *volgroup,\n"
16205 " const char *newvolgroup);\n"
16210 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4532
16211 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
16215 #: ../src/guestfs-actions.pod:6807
16216 msgid "guestfs_vgs"
16220 #: ../src/guestfs-actions.pod:6809
16224 " guestfs_vgs (guestfs_h *g);\n"
16229 #: ../src/guestfs-actions.pod:6812 ../fish/guestfish-actions.pod:4538
16231 "List all the volumes groups detected. This is the equivalent of the "
16232 "L<vgs(8)> command."
16236 #: ../src/guestfs-actions.pod:6815 ../fish/guestfish-actions.pod:4541
16238 "This returns a list of just the volume group names that were detected "
16239 "(eg. C<VolGroup00>)."
16243 #: ../src/guestfs-actions.pod:6818
16244 msgid "See also C<guestfs_vgs_full>."
16248 #: ../src/guestfs-actions.pod:6826
16249 msgid "guestfs_vgs_full"
16253 #: ../src/guestfs-actions.pod:6828
16256 " struct guestfs_lvm_vg_list *\n"
16257 " guestfs_vgs_full (guestfs_h *g);\n"
16262 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4550
16264 "List all the volumes groups detected. This is the equivalent of the "
16265 "L<vgs(8)> command. The \"full\" version includes all fields."
16269 #: ../src/guestfs-actions.pod:6834
16271 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
16272 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
16277 #: ../src/guestfs-actions.pod:6840
16278 msgid "guestfs_vgscan"
16282 #: ../src/guestfs-actions.pod:6842
16286 " guestfs_vgscan (guestfs_h *g);\n"
16291 #: ../src/guestfs-actions.pod:6845 ../fish/guestfish-actions.pod:4557
16293 "This rescans all block devices and rebuilds the list of LVM physical "
16294 "volumes, volume groups and logical volumes."
16298 #: ../src/guestfs-actions.pod:6852
16299 msgid "guestfs_vguuid"
16303 #: ../src/guestfs-actions.pod:6854
16307 " guestfs_vguuid (guestfs_h *g,\n"
16308 " const char *vgname);\n"
16313 #: ../src/guestfs-actions.pod:6858 ../fish/guestfish-actions.pod:4564
16314 msgid "This command returns the UUID of the LVM VG named C<vgname>."
16318 #: ../src/guestfs-actions.pod:6865
16319 msgid "guestfs_wait_ready"
16323 #: ../src/guestfs-actions.pod:6867
16327 " guestfs_wait_ready (guestfs_h *g);\n"
16332 #: ../src/guestfs-actions.pod:6870
16333 msgid "This function is a no op."
16337 #: ../src/guestfs-actions.pod:6872
16339 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
16340 "calling C<guestfs_launch> to wait for the launch to complete. However this "
16341 "is no longer necessary because C<guestfs_launch> now does the waiting."
16345 #: ../src/guestfs-actions.pod:6877
16347 "If you see any calls to this function in code then you can just remove them, "
16348 "unless you want to retain compatibility with older versions of the API."
16352 #: ../src/guestfs-actions.pod:6885
16353 msgid "guestfs_wc_c"
16357 #: ../src/guestfs-actions.pod:6887
16361 " guestfs_wc_c (guestfs_h *g,\n"
16362 " const char *path);\n"
16367 #: ../src/guestfs-actions.pod:6891 ../fish/guestfish-actions.pod:4570
16369 "This command counts the characters in a file, using the C<wc -c> external "
16374 #: ../src/guestfs-actions.pod:6898
16375 msgid "guestfs_wc_l"
16379 #: ../src/guestfs-actions.pod:6900
16383 " guestfs_wc_l (guestfs_h *g,\n"
16384 " const char *path);\n"
16389 #: ../src/guestfs-actions.pod:6904 ../fish/guestfish-actions.pod:4577
16391 "This command counts the lines in a file, using the C<wc -l> external "
16396 #: ../src/guestfs-actions.pod:6911
16397 msgid "guestfs_wc_w"
16401 #: ../src/guestfs-actions.pod:6913
16405 " guestfs_wc_w (guestfs_h *g,\n"
16406 " const char *path);\n"
16411 #: ../src/guestfs-actions.pod:6917 ../fish/guestfish-actions.pod:4584
16413 "This command counts the words in a file, using the C<wc -w> external "
16418 #: ../src/guestfs-actions.pod:6924
16419 msgid "guestfs_write"
16423 #: ../src/guestfs-actions.pod:6926
16427 " guestfs_write (guestfs_h *g,\n"
16428 " const char *path,\n"
16429 " const char *content,\n"
16430 " size_t content_size);\n"
16435 #: ../src/guestfs-actions.pod:6932 ../fish/guestfish-actions.pod:4591
16437 "This call creates a file called C<path>. The content of the file is the "
16438 "string C<content> (which can contain any 8 bit data)."
16442 #: ../src/guestfs-actions.pod:6942
16443 msgid "guestfs_write_file"
16447 #: ../src/guestfs-actions.pod:6944
16451 " guestfs_write_file (guestfs_h *g,\n"
16452 " const char *path,\n"
16453 " const char *content,\n"
16459 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4601
16461 "This call creates a file called C<path>. The contents of the file is the "
16462 "string C<content> (which can contain any 8 bit data), with length C<size>."
16466 #: ../src/guestfs-actions.pod:6954 ../fish/guestfish-actions.pod:4605
16468 "As a special case, if C<size> is C<0> then the length is calculated using "
16469 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
16473 #: ../src/guestfs-actions.pod:6958 ../fish/guestfish-actions.pod:4609
16475 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
16476 "I<not> work, even if the length is specified."
16480 #: ../src/guestfs-actions.pod:6966 ../fish/guestfish-actions.pod:4615
16481 msgid "This function is deprecated. In new code, use the C<write> call instead."
16485 #: ../src/guestfs-actions.pod:6975
16486 msgid "guestfs_zegrep"
16490 #: ../src/guestfs-actions.pod:6977
16494 " guestfs_zegrep (guestfs_h *g,\n"
16495 " const char *regex,\n"
16496 " const char *path);\n"
16501 #: ../src/guestfs-actions.pod:6982 ../fish/guestfish-actions.pod:4626
16502 msgid "This calls the external C<zegrep> program and returns the matching lines."
16506 #: ../src/guestfs-actions.pod:6994
16507 msgid "guestfs_zegrepi"
16511 #: ../src/guestfs-actions.pod:6996
16515 " guestfs_zegrepi (guestfs_h *g,\n"
16516 " const char *regex,\n"
16517 " const char *path);\n"
16522 #: ../src/guestfs-actions.pod:7001 ../fish/guestfish-actions.pod:4636
16523 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
16527 #: ../src/guestfs-actions.pod:7013
16528 msgid "guestfs_zero"
16532 #: ../src/guestfs-actions.pod:7015
16536 " guestfs_zero (guestfs_h *g,\n"
16537 " const char *device);\n"
16542 #: ../src/guestfs-actions.pod:7019 ../fish/guestfish-actions.pod:4646
16543 msgid "This command writes zeroes over the first few blocks of C<device>."
16547 #: ../src/guestfs-actions.pod:7021 ../fish/guestfish-actions.pod:4648
16549 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16550 "securely wipe the device). It should be sufficient to remove any partition "
16551 "tables, filesystem superblocks and so on."
16555 #: ../src/guestfs-actions.pod:7025
16556 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16560 #: ../src/guestfs-actions.pod:7036
16561 msgid "guestfs_zero_device"
16565 #: ../src/guestfs-actions.pod:7038
16569 " guestfs_zero_device (guestfs_h *g,\n"
16570 " const char *device);\n"
16575 #: ../src/guestfs-actions.pod:7042
16577 "This command writes zeroes over the entire C<device>. Compare with "
16578 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16582 #: ../src/guestfs-actions.pod:7056
16583 msgid "(Added in 1.3.1)"
16587 #: ../src/guestfs-actions.pod:7058
16588 msgid "guestfs_zerofree"
16592 #: ../src/guestfs-actions.pod:7060
16596 " guestfs_zerofree (guestfs_h *g,\n"
16597 " const char *device);\n"
16602 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4669
16604 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16605 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16606 "possible to compress the filesystem more effectively."
16610 #: ../src/guestfs-actions.pod:7069 ../fish/guestfish-actions.pod:4674
16611 msgid "You should B<not> run this program if the filesystem is mounted."
16615 #: ../src/guestfs-actions.pod:7072 ../fish/guestfish-actions.pod:4677
16617 "It is possible that using this program can damage the filesystem or data on "
16622 #: ../src/guestfs-actions.pod:7079
16623 msgid "guestfs_zfgrep"
16627 #: ../src/guestfs-actions.pod:7081
16631 " guestfs_zfgrep (guestfs_h *g,\n"
16632 " const char *pattern,\n"
16633 " const char *path);\n"
16638 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4684
16639 msgid "This calls the external C<zfgrep> program and returns the matching lines."
16643 #: ../src/guestfs-actions.pod:7098
16644 msgid "guestfs_zfgrepi"
16648 #: ../src/guestfs-actions.pod:7100
16652 " guestfs_zfgrepi (guestfs_h *g,\n"
16653 " const char *pattern,\n"
16654 " const char *path);\n"
16659 #: ../src/guestfs-actions.pod:7105 ../fish/guestfish-actions.pod:4694
16660 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
16664 #: ../src/guestfs-actions.pod:7117
16665 msgid "guestfs_zfile"
16669 #: ../src/guestfs-actions.pod:7119
16673 " guestfs_zfile (guestfs_h *g,\n"
16674 " const char *meth,\n"
16675 " const char *path);\n"
16680 #: ../src/guestfs-actions.pod:7124 ../fish/guestfish-actions.pod:4704
16681 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
16685 #: ../src/guestfs-actions.pod:7127 ../fish/guestfish-actions.pod:4707
16686 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16690 #: ../src/guestfs-actions.pod:7129
16692 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16697 #: ../src/guestfs-actions.pod:7135 ../fish/guestfish-actions.pod:4712
16698 msgid "This function is deprecated. In new code, use the C<file> call instead."
16702 #: ../src/guestfs-actions.pod:7144
16703 msgid "guestfs_zgrep"
16707 #: ../src/guestfs-actions.pod:7146
16711 " guestfs_zgrep (guestfs_h *g,\n"
16712 " const char *regex,\n"
16713 " const char *path);\n"
16718 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4723
16719 msgid "This calls the external C<zgrep> program and returns the matching lines."
16723 #: ../src/guestfs-actions.pod:7163
16724 msgid "guestfs_zgrepi"
16728 #: ../src/guestfs-actions.pod:7165
16732 " guestfs_zgrepi (guestfs_h *g,\n"
16733 " const char *regex,\n"
16734 " const char *path);\n"
16739 #: ../src/guestfs-actions.pod:7170 ../fish/guestfish-actions.pod:4733
16740 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
16744 #: ../src/guestfs-availability.pod:3
16749 #: ../src/guestfs-availability.pod:5
16751 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
16752 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
16753 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
16754 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
16755 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
16759 #: ../src/guestfs-availability.pod:21
16764 #: ../src/guestfs-availability.pod:23
16766 "The following functions: L</guestfs_inotify_add_watch> "
16767 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
16768 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16772 #: ../src/guestfs-availability.pod:31
16773 msgid "B<linuxfsuuid>"
16777 #: ../src/guestfs-availability.pod:33
16779 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
16780 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16784 #: ../src/guestfs-availability.pod:40
16785 msgid "B<linuxmodules>"
16789 #: ../src/guestfs-availability.pod:42
16790 msgid "The following functions: L</guestfs_modprobe>"
16794 #: ../src/guestfs-availability.pod:45
16795 msgid "B<linuxxattrs>"
16799 #: ../src/guestfs-availability.pod:47
16801 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
16802 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
16803 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
16804 "L</guestfs_setxattr>"
16808 #: ../src/guestfs-availability.pod:58
16813 #: ../src/guestfs-availability.pod:60
16815 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
16816 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
16817 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16821 #: ../src/guestfs-availability.pod:69
16826 #: ../src/guestfs-availability.pod:71
16828 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
16829 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
16830 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
16831 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
16832 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
16833 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
16834 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
16835 "L</guestfs_vgs_full>"
16839 #: ../src/guestfs-availability.pod:94
16844 #: ../src/guestfs-availability.pod:96
16846 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
16847 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
16851 #: ../src/guestfs-availability.pod:102
16856 #: ../src/guestfs-availability.pod:104
16857 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16861 #: ../src/guestfs-availability.pod:107
16862 msgid "B<ntfsprogs>"
16866 #: ../src/guestfs-availability.pod:109
16867 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16871 #: ../src/guestfs-availability.pod:113
16872 msgid "B<realpath>"
16876 #: ../src/guestfs-availability.pod:115
16877 msgid "The following functions: L</guestfs_realpath>"
16881 #: ../src/guestfs-availability.pod:118
16886 #: ../src/guestfs-availability.pod:120
16888 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
16889 "L</guestfs_scrub_freespace>"
16893 #: ../src/guestfs-availability.pod:125
16898 #: ../src/guestfs-availability.pod:127
16899 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16903 #: ../src/guestfs-availability.pod:131
16908 #: ../src/guestfs-availability.pod:133
16909 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16913 #: ../src/guestfs-availability.pod:137
16914 msgid "B<zerofree>"
16918 #: ../src/guestfs-availability.pod:139
16919 msgid "The following functions: L</guestfs_zerofree>"
16923 #: ../src/guestfs-structs.pod:1
16924 msgid "guestfs_int_bool"
16928 #: ../src/guestfs-structs.pod:3
16931 " struct guestfs_int_bool {\n"
16939 #: ../src/guestfs-structs.pod:8
16942 " struct guestfs_int_bool_list {\n"
16943 " uint32_t len; /* Number of elements in list. */\n"
16944 " struct guestfs_int_bool *val; /* Elements. */\n"
16950 #: ../src/guestfs-structs.pod:13
16953 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16954 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16959 #: ../src/guestfs-structs.pod:16
16960 msgid "guestfs_lvm_pv"
16964 #: ../src/guestfs-structs.pod:18
16967 " struct guestfs_lvm_pv {\n"
16968 " char *pv_name;\n"
16969 " /* The next field is NOT nul-terminated, be careful when printing it: "
16971 " char pv_uuid[32];\n"
16973 " uint64_t pv_size;\n"
16974 " uint64_t dev_size;\n"
16975 " uint64_t pv_free;\n"
16976 " uint64_t pv_used;\n"
16977 " char *pv_attr;\n"
16978 " int64_t pv_pe_count;\n"
16979 " int64_t pv_pe_alloc_count;\n"
16980 " char *pv_tags;\n"
16981 " uint64_t pe_start;\n"
16982 " int64_t pv_mda_count;\n"
16983 " uint64_t pv_mda_free;\n"
16989 #: ../src/guestfs-structs.pod:36
16992 " struct guestfs_lvm_pv_list {\n"
16993 " uint32_t len; /* Number of elements in list. */\n"
16994 " struct guestfs_lvm_pv *val; /* Elements. */\n"
17000 #: ../src/guestfs-structs.pod:41
17003 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
17004 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
17009 #: ../src/guestfs-structs.pod:44
17010 msgid "guestfs_lvm_vg"
17014 #: ../src/guestfs-structs.pod:46
17017 " struct guestfs_lvm_vg {\n"
17018 " char *vg_name;\n"
17019 " /* The next field is NOT nul-terminated, be careful when printing it: "
17021 " char vg_uuid[32];\n"
17023 " char *vg_attr;\n"
17024 " uint64_t vg_size;\n"
17025 " uint64_t vg_free;\n"
17026 " char *vg_sysid;\n"
17027 " uint64_t vg_extent_size;\n"
17028 " int64_t vg_extent_count;\n"
17029 " int64_t vg_free_count;\n"
17030 " int64_t max_lv;\n"
17031 " int64_t max_pv;\n"
17032 " int64_t pv_count;\n"
17033 " int64_t lv_count;\n"
17034 " int64_t snap_count;\n"
17035 " int64_t vg_seqno;\n"
17036 " char *vg_tags;\n"
17037 " int64_t vg_mda_count;\n"
17038 " uint64_t vg_mda_free;\n"
17044 #: ../src/guestfs-structs.pod:69
17047 " struct guestfs_lvm_vg_list {\n"
17048 " uint32_t len; /* Number of elements in list. */\n"
17049 " struct guestfs_lvm_vg *val; /* Elements. */\n"
17055 #: ../src/guestfs-structs.pod:74
17058 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
17059 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
17064 #: ../src/guestfs-structs.pod:77
17065 msgid "guestfs_lvm_lv"
17069 #: ../src/guestfs-structs.pod:79
17072 " struct guestfs_lvm_lv {\n"
17073 " char *lv_name;\n"
17074 " /* The next field is NOT nul-terminated, be careful when printing it: "
17076 " char lv_uuid[32];\n"
17077 " char *lv_attr;\n"
17078 " int64_t lv_major;\n"
17079 " int64_t lv_minor;\n"
17080 " int64_t lv_kernel_major;\n"
17081 " int64_t lv_kernel_minor;\n"
17082 " uint64_t lv_size;\n"
17083 " int64_t seg_count;\n"
17085 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17086 " float snap_percent;\n"
17087 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
17088 " float copy_percent;\n"
17089 " char *move_pv;\n"
17090 " char *lv_tags;\n"
17091 " char *mirror_log;\n"
17092 " char *modules;\n"
17098 #: ../src/guestfs-structs.pod:101
17101 " struct guestfs_lvm_lv_list {\n"
17102 " uint32_t len; /* Number of elements in list. */\n"
17103 " struct guestfs_lvm_lv *val; /* Elements. */\n"
17109 #: ../src/guestfs-structs.pod:106
17112 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
17113 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
17118 #: ../src/guestfs-structs.pod:111
17121 " struct guestfs_stat {\n"
17125 " int64_t nlink;\n"
17130 " int64_t blksize;\n"
17131 " int64_t blocks;\n"
17132 " int64_t atime;\n"
17133 " int64_t mtime;\n"
17134 " int64_t ctime;\n"
17140 #: ../src/guestfs-structs.pod:127
17143 " struct guestfs_stat_list {\n"
17144 " uint32_t len; /* Number of elements in list. */\n"
17145 " struct guestfs_stat *val; /* Elements. */\n"
17151 #: ../src/guestfs-structs.pod:132
17154 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
17155 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
17160 #: ../src/guestfs-structs.pod:137
17163 " struct guestfs_statvfs {\n"
17164 " int64_t bsize;\n"
17165 " int64_t frsize;\n"
17166 " int64_t blocks;\n"
17167 " int64_t bfree;\n"
17168 " int64_t bavail;\n"
17169 " int64_t files;\n"
17170 " int64_t ffree;\n"
17171 " int64_t favail;\n"
17174 " int64_t namemax;\n"
17180 #: ../src/guestfs-structs.pod:151
17183 " struct guestfs_statvfs_list {\n"
17184 " uint32_t len; /* Number of elements in list. */\n"
17185 " struct guestfs_statvfs *val; /* Elements. */\n"
17191 #: ../src/guestfs-structs.pod:156
17194 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
17195 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
17200 #: ../src/guestfs-structs.pod:159
17201 msgid "guestfs_dirent"
17205 #: ../src/guestfs-structs.pod:161
17208 " struct guestfs_dirent {\n"
17217 #: ../src/guestfs-structs.pod:167
17220 " struct guestfs_dirent_list {\n"
17221 " uint32_t len; /* Number of elements in list. */\n"
17222 " struct guestfs_dirent *val; /* Elements. */\n"
17228 #: ../src/guestfs-structs.pod:172
17231 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
17232 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
17237 #: ../src/guestfs-structs.pod:177
17240 " struct guestfs_version {\n"
17241 " int64_t major;\n"
17242 " int64_t minor;\n"
17243 " int64_t release;\n"
17250 #: ../src/guestfs-structs.pod:184
17253 " struct guestfs_version_list {\n"
17254 " uint32_t len; /* Number of elements in list. */\n"
17255 " struct guestfs_version *val; /* Elements. */\n"
17261 #: ../src/guestfs-structs.pod:189
17264 " void guestfs_free_version (struct guestfs_free_version *);\n"
17265 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
17270 #: ../src/guestfs-structs.pod:192
17271 msgid "guestfs_xattr"
17275 #: ../src/guestfs-structs.pod:194
17278 " struct guestfs_xattr {\n"
17279 " char *attrname;\n"
17280 " /* The next two fields describe a byte array. */\n"
17281 " uint32_t attrval_len;\n"
17282 " char *attrval;\n"
17288 #: ../src/guestfs-structs.pod:201
17291 " struct guestfs_xattr_list {\n"
17292 " uint32_t len; /* Number of elements in list. */\n"
17293 " struct guestfs_xattr *val; /* Elements. */\n"
17299 #: ../src/guestfs-structs.pod:206
17302 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
17303 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
17308 #: ../src/guestfs-structs.pod:209
17309 msgid "guestfs_inotify_event"
17313 #: ../src/guestfs-structs.pod:211
17316 " struct guestfs_inotify_event {\n"
17317 " int64_t in_wd;\n"
17318 " uint32_t in_mask;\n"
17319 " uint32_t in_cookie;\n"
17320 " char *in_name;\n"
17326 #: ../src/guestfs-structs.pod:218
17329 " struct guestfs_inotify_event_list {\n"
17330 " uint32_t len; /* Number of elements in list. */\n"
17331 " struct guestfs_inotify_event *val; /* Elements. */\n"
17337 #: ../src/guestfs-structs.pod:223
17340 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
17341 " void guestfs_free_inotify_event_list (struct "
17342 "guestfs_free_inotify_event_list *);\n"
17347 #: ../src/guestfs-structs.pod:226
17348 msgid "guestfs_partition"
17352 #: ../src/guestfs-structs.pod:228
17355 " struct guestfs_partition {\n"
17356 " int32_t part_num;\n"
17357 " uint64_t part_start;\n"
17358 " uint64_t part_end;\n"
17359 " uint64_t part_size;\n"
17365 #: ../src/guestfs-structs.pod:235
17368 " struct guestfs_partition_list {\n"
17369 " uint32_t len; /* Number of elements in list. */\n"
17370 " struct guestfs_partition *val; /* Elements. */\n"
17376 #: ../src/guestfs-structs.pod:240
17379 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
17380 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
17385 #: ../src/guestfs-structs.pod:243
17386 msgid "guestfs_application"
17390 #: ../src/guestfs-structs.pod:245
17393 " struct guestfs_application {\n"
17394 " char *app_name;\n"
17395 " char *app_display_name;\n"
17396 " int32_t app_epoch;\n"
17397 " char *app_version;\n"
17398 " char *app_release;\n"
17399 " char *app_install_path;\n"
17400 " char *app_trans_path;\n"
17401 " char *app_publisher;\n"
17402 " char *app_url;\n"
17403 " char *app_source_package;\n"
17404 " char *app_summary;\n"
17405 " char *app_description;\n"
17411 #: ../src/guestfs-structs.pod:260
17414 " struct guestfs_application_list {\n"
17415 " uint32_t len; /* Number of elements in list. */\n"
17416 " struct guestfs_application *val; /* Elements. */\n"
17422 #: ../src/guestfs-structs.pod:265
17425 " void guestfs_free_application (struct guestfs_free_application *);\n"
17426 " void guestfs_free_application_list (struct guestfs_free_application_list "
17432 #: ../fish/guestfish.pod:5
17433 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
17437 #: ../fish/guestfish.pod:9
17440 " guestfish [--options] [commands]\n"
17445 #: ../fish/guestfish.pod:11
17453 #: ../fish/guestfish.pod:13
17456 " guestfish [--ro|--rw] -a disk.img\n"
17461 #: ../fish/guestfish.pod:15
17464 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
17469 #: ../fish/guestfish.pod:17
17472 " guestfish -d libvirt-domain\n"
17477 #: ../fish/guestfish.pod:19
17480 " guestfish [--ro|--rw] -a disk.img -i\n"
17485 #: ../fish/guestfish.pod:21
17488 " guestfish -d libvirt-domain -i\n"
17493 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
17498 #: ../fish/guestfish.pod:25
17500 "Using guestfish in read/write mode on live virtual machines can be "
17501 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
17502 "option to use guestfish safely if the disk image or virtual machine might be "
17507 #: ../fish/guestfish.pod:32
17509 "Guestfish is a shell and command-line tool for examining and modifying "
17510 "virtual machine filesystems. It uses libguestfs and exposes all of the "
17511 "functionality of the guestfs API, see L<guestfs(3)>."
17515 #: ../fish/guestfish.pod:36
17517 "Guestfish gives you structured access to the libguestfs API, from shell "
17518 "scripts or the command line or interactively. If you want to rescue a "
17519 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
17524 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:897 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
17529 #: ../fish/guestfish.pod:43
17530 msgid "As an interactive shell"
17534 #: ../fish/guestfish.pod:45
17542 #: ../fish/guestfish.pod:47
17545 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17546 " editing virtual machine filesystems.\n"
17551 #: ../fish/guestfish.pod:50
17554 " Type: 'help' for a list of commands\n"
17555 " 'man' to read the manual\n"
17556 " 'quit' to quit the shell\n"
17561 #: ../fish/guestfish.pod:54
17564 " ><fs> add-ro disk.img\n"
17566 " ><fs> list-filesystems\n"
17567 " /dev/sda1: ext4\n"
17568 " /dev/vg_guest/lv_root: ext4\n"
17569 " /dev/vg_guest/lv_swap: swap\n"
17570 " ><fs> mount /dev/vg_guest/lv_root /\n"
17571 " ><fs> cat /etc/fstab\n"
17573 " # Created by anaconda\n"
17580 #: ../fish/guestfish.pod:67
17581 msgid "From shell scripts"
17585 #: ../fish/guestfish.pod:69
17586 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17590 #: ../fish/guestfish.pod:71
17593 " guestfish <<_EOF_\n"
17596 " mount /dev/vg_guest/lv_root /\n"
17597 " write /etc/motd \"Welcome, new users\"\n"
17603 #: ../fish/guestfish.pod:78
17604 msgid "List the LVM logical volumes in a disk image:"
17608 #: ../fish/guestfish.pod:80
17611 " guestfish -a disk.img --ro <<_EOF_\n"
17619 #: ../fish/guestfish.pod:85
17620 msgid "List all the filesystems in a disk image:"
17624 #: ../fish/guestfish.pod:87
17627 " guestfish -a disk.img --ro <<_EOF_\n"
17629 " list-filesystems\n"
17635 #: ../fish/guestfish.pod:92
17636 msgid "On one command line"
17640 #: ../fish/guestfish.pod:94
17641 msgid "Update C</etc/resolv.conf> in a guest:"
17645 #: ../fish/guestfish.pod:96
17649 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17650 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17655 #: ../fish/guestfish.pod:100
17656 msgid "Edit C</boot/grub/grub.conf> interactively:"
17660 #: ../fish/guestfish.pod:102
17663 " guestfish --rw --add disk.img \\\n"
17664 " --mount /dev/vg_guest/lv_root \\\n"
17665 " --mount /dev/sda1:/boot \\\n"
17666 " edit /boot/grub/grub.conf\n"
17671 #: ../fish/guestfish.pod:107
17672 msgid "Mount disks automatically"
17676 #: ../fish/guestfish.pod:109
17678 "Use the I<-i> option to automatically mount the disks from a virtual "
17683 #: ../fish/guestfish.pod:112
17686 " guestfish --ro -a disk.img -i cat /etc/group\n"
17691 #: ../fish/guestfish.pod:114
17694 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17699 #: ../fish/guestfish.pod:116
17700 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17704 #: ../fish/guestfish.pod:118
17707 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17712 #: ../fish/guestfish.pod:120
17713 msgid "As a script interpreter"
17717 #: ../fish/guestfish.pod:122
17718 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17722 #: ../fish/guestfish.pod:124
17725 " #!/usr/bin/guestfish -f\n"
17726 " sparse test1.img 100M\n"
17728 " part-disk /dev/sda mbr\n"
17729 " mkfs ext2 /dev/sda1\n"
17734 #: ../fish/guestfish.pod:130
17735 msgid "Start with a prepared disk"
17739 #: ../fish/guestfish.pod:132
17741 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17742 "single ext2-formatted partition:"
17746 #: ../fish/guestfish.pod:135
17749 " guestfish -N fs\n"
17754 #: ../fish/guestfish.pod:137
17755 msgid "To list what is available do:"
17759 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:888
17762 " guestfish -N help | less\n"
17767 #: ../fish/guestfish.pod:141
17768 msgid "Remote control"
17772 #: ../fish/guestfish.pod:143
17775 " eval \"`guestfish --listen`\"\n"
17776 " guestfish --remote add-ro disk.img\n"
17777 " guestfish --remote run\n"
17778 " guestfish --remote lvs\n"
17783 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72 ../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
17788 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:80 ../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
17793 #: ../fish/guestfish.pod:154
17794 msgid "Displays general help on options."
17798 #: ../fish/guestfish.pod:156
17803 #: ../fish/guestfish.pod:158
17804 msgid "B<--cmd-help>"
17808 #: ../fish/guestfish.pod:160
17809 msgid "Lists all available guestfish commands."
17813 #: ../fish/guestfish.pod:162
17818 #: ../fish/guestfish.pod:164
17819 msgid "B<--cmd-help cmd>"
17823 #: ../fish/guestfish.pod:166
17824 msgid "Displays detailed help on a single command C<cmd>."
17828 #: ../fish/guestfish.pod:168
17829 msgid "B<-a image>"
17833 #: ../fish/guestfish.pod:170
17834 msgid "B<--add image>"
17838 #: ../fish/guestfish.pod:172
17839 msgid "Add a block device or virtual machine image to the shell."
17843 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
17845 "The format of the disk image is auto-detected. To override this and force a "
17846 "particular format use the I<--format=..> option."
17850 #: ../fish/guestfish.pod:177
17852 "Using this flag is mostly equivalent to using the C<add> command, with "
17853 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
17854 "the I<--format:...> flag was given."
17858 #: ../fish/guestfish.pod:181
17863 #: ../fish/guestfish.pod:183
17864 msgid "B<--connect URI>"
17868 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
17870 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17871 "URI to use. The default is to use the default libvirt connection."
17875 #: ../fish/guestfish.pod:189
17880 #: ../fish/guestfish.pod:191
17882 "If using the I<--listen> option and a csh-like shell, use this option. See "
17883 "section L</REMOTE CONTROL AND CSH> below."
17887 #: ../fish/guestfish.pod:194
17888 msgid "B<-d libvirt-domain>"
17892 #: ../fish/guestfish.pod:196
17893 msgid "B<--domain libvirt-domain>"
17897 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
17899 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17900 "used, then any libvirt domain can be used. However in write mode, only "
17901 "libvirt domains which are shut down can be named here."
17905 #: ../fish/guestfish.pod:202
17907 "Using this flag is mostly equivalent to using the C<add-domain> command, "
17908 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
17909 "if the I<--format:...> flag was given."
17913 #: ../fish/guestfish.pod:206
17918 #: ../fish/guestfish.pod:208
17919 msgid "B<--no-dest-paths>"
17923 #: ../fish/guestfish.pod:210
17925 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17926 "to hit the tab key to complete paths on the guest filesystem, but this "
17927 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17928 "allow this feature to be disabled."
17932 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
17933 msgid "B<--echo-keys>"
17937 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
17939 "When prompting for keys and passphrases, guestfish normally turns echoing "
17940 "off so you cannot see what you are typing. If you are not worried about "
17941 "Tempest attacks and there is no one else in the room you can specify this "
17942 "flag to see what you are typing."
17946 #: ../fish/guestfish.pod:222
17951 #: ../fish/guestfish.pod:224
17952 msgid "B<--file file>"
17956 #: ../fish/guestfish.pod:226
17957 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17961 #: ../fish/guestfish.pod:229
17964 " #!/usr/bin/guestfish -f\n"
17969 #: ../fish/guestfish.pod:231
17970 msgid "B<--format=raw|qcow2|..>"
17974 #: ../fish/guestfish.pod:233
17975 msgid "B<--format>"
17979 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
17981 "The default for the I<-a> option is to auto-detect the format of the disk "
17982 "image. Using this forces the disk format for I<-a> options which follow on "
17983 "the command line. Using I<--format> with no argument switches back to "
17984 "auto-detection for subsequent I<-a> options."
17988 #: ../fish/guestfish.pod:242
17991 " guestfish --format=raw -a disk.img\n"
17996 #: ../fish/guestfish.pod:244
17997 msgid "forces raw format (no auto-detection) for C<disk.img>."
18001 #: ../fish/guestfish.pod:246
18004 " guestfish --format=raw -a disk.img --format -a another.img\n"
18009 #: ../fish/guestfish.pod:248
18011 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
18012 "auto-detection for C<another.img>."
18016 #: ../fish/guestfish.pod:251
18018 "If you have untrusted raw-format guest disk images, you should use this "
18019 "option to specify the disk format. This avoids a possible security problem "
18020 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
18024 #: ../fish/guestfish.pod:256
18029 #: ../fish/guestfish.pod:258
18030 msgid "B<--inspector>"
18034 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
18036 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
18037 "system and mount filesystems as they would be mounted on the real virtual "
18042 #: ../fish/guestfish.pod:264
18043 msgid "Typical usage is either:"
18047 #: ../fish/guestfish.pod:266
18050 " guestfish -d myguest -i\n"
18055 #: ../fish/guestfish.pod:268
18056 msgid "(for an inactive libvirt domain called I<myguest>), or:"
18060 #: ../fish/guestfish.pod:270
18063 " guestfish --ro -d myguest -i\n"
18068 #: ../fish/guestfish.pod:272
18069 msgid "(for active domains, readonly), or specify the block device directly:"
18073 #: ../fish/guestfish.pod:274
18076 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
18081 #: ../fish/guestfish.pod:276
18083 "Note that the command line syntax changed slightly over older versions of "
18084 "guestfish. You can still use the old syntax:"
18088 #: ../fish/guestfish.pod:279
18091 " guestfish [--ro] -i disk.img\n"
18096 #: ../fish/guestfish.pod:281
18099 " guestfish [--ro] -i libvirt-domain\n"
18104 #: ../fish/guestfish.pod:283
18106 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
18107 "then using other commands to mount the filesystems that were found."
18111 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
18112 msgid "B<--keys-from-stdin>"
18116 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
18118 "Read key or passphrase parameters from stdin. The default is to try to read "
18119 "passphrases from the user by opening C</dev/tty>."
18123 #: ../fish/guestfish.pod:292
18124 msgid "B<--listen>"
18128 #: ../fish/guestfish.pod:294
18130 "Fork into the background and listen for remote commands. See section "
18131 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
18135 #: ../fish/guestfish.pod:297
18136 msgid "B<-m dev[:mountpoint]>"
18140 #: ../fish/guestfish.pod:299
18141 msgid "B<--mount dev[:mountpoint]>"
18145 #: ../fish/guestfish.pod:301
18146 msgid "Mount the named partition or logical volume on the given mountpoint."
18150 #: ../fish/guestfish.pod:303
18151 msgid "If the mountpoint is omitted, it defaults to C</>."
18155 #: ../fish/guestfish.pod:305
18156 msgid "You have to mount something on C</> before most commands will work."
18160 #: ../fish/guestfish.pod:307
18162 "If any I<-m> or I<--mount> options are given, the guest is automatically "
18167 #: ../fish/guestfish.pod:310
18169 "If you don't know what filesystems a disk image contains, you can either run "
18170 "guestfish without this option, then list the partitions, filesystems and LVs "
18171 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
18172 "commands), or you can use the L<virt-filesystems(1)> program."
18176 #: ../fish/guestfish.pod:316
18178 "Using this flag is mostly equivalent to using the C<mount-options> command "
18179 "or the C<mount-ro> command if the I<--ro> flag was given."
18183 #: ../fish/guestfish.pod:319
18188 #: ../fish/guestfish.pod:321
18189 msgid "B<--no-sync>"
18193 #: ../fish/guestfish.pod:323
18195 "Disable autosync. This is enabled by default. See the discussion of "
18196 "autosync in the L<guestfs(3)> manpage."
18200 #: ../fish/guestfish.pod:326
18205 #: ../fish/guestfish.pod:328
18206 msgid "B<--new type>"
18210 #: ../fish/guestfish.pod:330
18215 #: ../fish/guestfish.pod:332
18217 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
18218 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
18219 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
18224 #: ../fish/guestfish.pod:337
18225 msgid "B<--progress-bars>"
18229 #: ../fish/guestfish.pod:339
18230 msgid "Enable progress bars, even when guestfish is used non-interactively."
18234 #: ../fish/guestfish.pod:341
18236 "Progress bars are enabled by default when guestfish is used as an "
18237 "interactive shell."
18241 #: ../fish/guestfish.pod:344
18242 msgid "B<--no-progress-bars>"
18246 #: ../fish/guestfish.pod:346
18247 msgid "Disable progress bars."
18251 #: ../fish/guestfish.pod:348
18252 msgid "B<--remote[=pid]>"
18256 #: ../fish/guestfish.pod:350
18258 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
18259 "CONTROL GUESTFISH OVER A SOCKET> below."
18263 #: ../fish/guestfish.pod:353
18268 #: ../fish/guestfish.pod:355
18273 #: ../fish/guestfish.pod:357
18275 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
18276 "mounts are done read-only."
18280 #: ../fish/guestfish.pod:360
18282 "The option must always be used if the disk image or virtual machine might be "
18283 "running, and is generally recommended in cases where you don't need write "
18284 "access to the disk."
18288 #: ../fish/guestfish.pod:364
18290 "Note that prepared disk images created with I<-N> are not affected by this "
18291 "option. Also commands like C<add> are not affected - you have to specify "
18292 "the C<readonly:true> option explicitly if you need it."
18296 #: ../fish/guestfish.pod:368
18297 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
18301 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
18302 msgid "B<--selinux>"
18306 #: ../fish/guestfish.pod:372
18307 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
18311 #: ../fish/guestfish.pod:374
18316 #: ../fish/guestfish.pod:376
18317 msgid "B<--verbose>"
18321 #: ../fish/guestfish.pod:378
18323 "Enable very verbose messages. This is particularly useful if you find a "
18328 #: ../fish/guestfish.pod:381
18333 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:88 ../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
18334 msgid "B<--version>"
18338 #: ../fish/guestfish.pod:385
18339 msgid "Display the guestfish / libguestfs version number and exit."
18343 #: ../fish/guestfish.pod:387
18348 #: ../fish/guestfish.pod:389
18353 #: ../fish/guestfish.pod:391
18355 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
18360 #: ../fish/guestfish.pod:394
18365 #: ../fish/guestfish.pod:396
18366 msgid "Echo each command before executing it."
18370 #: ../fish/guestfish.pod:400
18371 msgid "COMMANDS ON COMMAND LINE"
18375 #: ../fish/guestfish.pod:402
18376 msgid "Any additional (non-option) arguments are treated as commands to execute."
18380 #: ../fish/guestfish.pod:405
18382 "Commands to execute should be separated by a colon (C<:>), where the colon "
18383 "is a separate parameter. Thus:"
18387 #: ../fish/guestfish.pod:408
18390 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
18395 #: ../fish/guestfish.pod:410
18397 "If there are no additional arguments, then we enter a shell, either an "
18398 "interactive shell with a prompt (if the input is a terminal) or a "
18399 "non-interactive shell."
18403 #: ../fish/guestfish.pod:414
18405 "In either command line mode or non-interactive shell, the first command that "
18406 "gives an error causes the whole shell to exit. In interactive mode (with a "
18407 "prompt) if a command fails, you can continue to enter commands."
18411 #: ../fish/guestfish.pod:419
18412 msgid "USING launch (OR run)"
18416 #: ../fish/guestfish.pod:421
18418 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
18419 "then launch it, then mount any disks you need, and finally issue "
18420 "actions/commands. So the general order of the day is:"
18424 #: ../fish/guestfish.pod:429
18425 msgid "add or -a/--add"
18429 #: ../fish/guestfish.pod:433
18430 msgid "launch (aka run)"
18434 #: ../fish/guestfish.pod:437
18435 msgid "mount or -m/--mount"
18439 #: ../fish/guestfish.pod:441
18440 msgid "any other commands"
18444 #: ../fish/guestfish.pod:445
18446 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
18447 "guest before mounting or performing any other commands."
18451 #: ../fish/guestfish.pod:448
18453 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
18454 "I<--new> options were given then C<run> is done automatically, simply "
18455 "because guestfish can't perform the action you asked for without doing this."
18459 #: ../fish/guestfish.pod:453
18460 msgid "OPENING DISKS FOR READ AND WRITE"
18464 #: ../fish/guestfish.pod:455
18466 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
18467 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
18468 "open disk images read-only or for writing."
18472 #: ../fish/guestfish.pod:459
18474 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
18475 "disk images supplied on the command line for write. To open a disk image "
18476 "read-only you have to do I<-a image --ro>."
18480 #: ../fish/guestfish.pod:463
18482 "This matters: If you accidentally open a live VM disk image writable then "
18483 "you will cause irreversible disk corruption."
18487 #: ../fish/guestfish.pod:466
18489 "By libguestfs 1.10 we intend to change the default the other way. Disk "
18490 "images will be opened read-only. You will have to either specify "
18491 "I<guestfish --rw> or change a configuration file in order to get write "
18492 "access for disk images specified by those other command line options."
18496 #: ../fish/guestfish.pod:471
18498 "This version of guestfish has a I<--rw> option which does nothing (it is "
18499 "already the default). However it is highly recommended that you use this "
18500 "option to indicate that guestfish needs write access, and to prepare your "
18501 "scripts for the day when this option will be required for write access."
18505 #: ../fish/guestfish.pod:477
18507 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
18508 "other libguestfs program apart from guestfish and guestmount."
18512 #: ../fish/guestfish.pod:480
18517 #: ../fish/guestfish.pod:482
18519 "You can quote ordinary parameters using either single or double quotes. For "
18524 #: ../fish/guestfish.pod:485
18527 " add \"file with a space.img\"\n"
18532 #: ../fish/guestfish.pod:487
18535 " rm '/file name'\n"
18540 #: ../fish/guestfish.pod:489
18548 #: ../fish/guestfish.pod:491
18550 "A few commands require a list of strings to be passed. For these, use a "
18551 "whitespace-separated list, enclosed in quotes. Strings containing "
18552 "whitespace to be passed through must be enclosed in single quotes. A "
18553 "literal single quote must be escaped with a backslash."
18557 #: ../fish/guestfish.pod:496
18560 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
18561 " command \"/bin/echo 'foo bar'\"\n"
18562 " command \"/bin/echo \\'foo\\'\"\n"
18567 #: ../fish/guestfish.pod:500
18568 msgid "OPTIONAL ARGUMENTS"
18572 #: ../fish/guestfish.pod:502
18574 "Some commands take optional arguments. These arguments appear in this "
18575 "documentation as C<[argname:..]>. You can use them as in these examples:"
18579 #: ../fish/guestfish.pod:506
18582 " add-drive-opts filename\n"
18587 #: ../fish/guestfish.pod:508
18590 " add-drive-opts filename readonly:true\n"
18595 #: ../fish/guestfish.pod:510
18598 " add-drive-opts filename format:qcow2 readonly:false\n"
18603 #: ../fish/guestfish.pod:512
18605 "Each optional argument can appear at most once. All optional arguments must "
18606 "appear after the required ones."
18610 #: ../fish/guestfish.pod:515
18615 #: ../fish/guestfish.pod:517
18616 msgid "This section applies to all commands which can take integers as parameters."
18620 #: ../fish/guestfish.pod:520
18621 msgid "SIZE SUFFIX"
18625 #: ../fish/guestfish.pod:522
18627 "When the command takes a parameter measured in bytes, you can use one of the "
18628 "following suffixes to specify kilobytes, megabytes and larger sizes:"
18632 #: ../fish/guestfish.pod:528
18633 msgid "B<k> or B<K> or B<KiB>"
18637 #: ../fish/guestfish.pod:530
18638 msgid "The size in kilobytes (multiplied by 1024)."
18642 #: ../fish/guestfish.pod:532
18647 #: ../fish/guestfish.pod:534
18648 msgid "The size in SI 1000 byte units."
18652 #: ../fish/guestfish.pod:536
18653 msgid "B<M> or B<MiB>"
18657 #: ../fish/guestfish.pod:538
18658 msgid "The size in megabytes (multiplied by 1048576)."
18662 #: ../fish/guestfish.pod:540
18667 #: ../fish/guestfish.pod:542
18668 msgid "The size in SI 1000000 byte units."
18672 #: ../fish/guestfish.pod:544
18673 msgid "B<G> or B<GiB>"
18677 #: ../fish/guestfish.pod:546
18678 msgid "The size in gigabytes (multiplied by 2**30)."
18682 #: ../fish/guestfish.pod:548
18687 #: ../fish/guestfish.pod:550
18688 msgid "The size in SI 10**9 byte units."
18692 #: ../fish/guestfish.pod:552
18693 msgid "B<T> or B<TiB>"
18697 #: ../fish/guestfish.pod:554
18698 msgid "The size in terabytes (multiplied by 2**40)."
18702 #: ../fish/guestfish.pod:556
18707 #: ../fish/guestfish.pod:558
18708 msgid "The size in SI 10**12 byte units."
18712 #: ../fish/guestfish.pod:560
18713 msgid "B<P> or B<PiB>"
18717 #: ../fish/guestfish.pod:562
18718 msgid "The size in petabytes (multiplied by 2**50)."
18722 #: ../fish/guestfish.pod:564
18727 #: ../fish/guestfish.pod:566
18728 msgid "The size in SI 10**15 byte units."
18732 #: ../fish/guestfish.pod:568
18733 msgid "B<E> or B<EiB>"
18737 #: ../fish/guestfish.pod:570
18738 msgid "The size in exabytes (multiplied by 2**60)."
18742 #: ../fish/guestfish.pod:572
18747 #: ../fish/guestfish.pod:574
18748 msgid "The size in SI 10**18 byte units."
18752 #: ../fish/guestfish.pod:576
18753 msgid "B<Z> or B<ZiB>"
18757 #: ../fish/guestfish.pod:578
18758 msgid "The size in zettabytes (multiplied by 2**70)."
18762 #: ../fish/guestfish.pod:580
18767 #: ../fish/guestfish.pod:582
18768 msgid "The size in SI 10**21 byte units."
18772 #: ../fish/guestfish.pod:584
18773 msgid "B<Y> or B<YiB>"
18777 #: ../fish/guestfish.pod:586
18778 msgid "The size in yottabytes (multiplied by 2**80)."
18782 #: ../fish/guestfish.pod:588
18787 #: ../fish/guestfish.pod:590
18788 msgid "The size in SI 10**24 byte units."
18792 #: ../fish/guestfish.pod:596
18795 " truncate-size /file 1G\n"
18800 #: ../fish/guestfish.pod:598
18801 msgid "would truncate the file to 1 gigabyte."
18805 #: ../fish/guestfish.pod:600
18807 "Be careful because a few commands take sizes in kilobytes or megabytes "
18808 "(eg. the parameter to L</memsize> is specified in megabytes already). "
18809 "Adding a suffix will probably not do what you expect."
18813 #: ../fish/guestfish.pod:604
18814 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18818 #: ../fish/guestfish.pod:606
18820 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18821 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18825 #: ../fish/guestfish.pod:609
18828 " 1234 decimal number 1234\n"
18829 " 02322 octal number, equivalent to decimal 1234\n"
18830 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18835 #: ../fish/guestfish.pod:613
18837 "When using the C<chmod> command, you almost always want to specify an octal "
18838 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18839 "L<chmod(1)> program):"
18843 #: ../fish/guestfish.pod:617
18846 " chmod 0777 /public # OK\n"
18847 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18852 #: ../fish/guestfish.pod:620
18854 "Commands that return numbers usually print them in decimal, but some "
18855 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18856 "octal, preceeded by C<0>)."
18860 #: ../fish/guestfish.pod:624
18861 msgid "WILDCARDS AND GLOBBING"
18865 #: ../fish/guestfish.pod:626
18867 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18868 "(globbing) by default. So for example the following will not do what you "
18873 #: ../fish/guestfish.pod:630
18881 #: ../fish/guestfish.pod:632
18883 "Assuming you don't have a directory called literally C</home/*> then the "
18884 "above command will return an error."
18888 #: ../fish/guestfish.pod:635
18889 msgid "To perform wildcard expansion, use the C<glob> command."
18893 #: ../fish/guestfish.pod:637
18896 " glob rm-rf /home/*\n"
18901 #: ../fish/guestfish.pod:639
18903 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18904 "many times), equivalent to:"
18908 #: ../fish/guestfish.pod:642
18911 " rm-rf /home/jim\n"
18912 " rm-rf /home/joe\n"
18913 " rm-rf /home/mary\n"
18918 #: ../fish/guestfish.pod:646
18919 msgid "C<glob> only works on simple guest paths and not on device names."
18923 #: ../fish/guestfish.pod:648
18925 "If you have several parameters, each containing a wildcard, then glob will "
18926 "perform a Cartesian product."
18930 #: ../fish/guestfish.pod:651
18935 #: ../fish/guestfish.pod:653
18937 "Any line which starts with a I<#> character is treated as a comment and "
18938 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18939 "a command. For example:"
18943 #: ../fish/guestfish.pod:657
18946 " # this is a comment\n"
18947 " # this is a comment\n"
18948 " foo # NOT a comment\n"
18953 #: ../fish/guestfish.pod:661
18954 msgid "Blank lines are also ignored."
18958 #: ../fish/guestfish.pod:663
18959 msgid "RUNNING COMMANDS LOCALLY"
18963 #: ../fish/guestfish.pod:665
18965 "Any line which starts with a I<!> character is treated as a command sent to "
18966 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18970 #: ../fish/guestfish.pod:669
18974 " tgz-out /remote local/remote-data.tar.gz\n"
18979 #: ../fish/guestfish.pod:672
18981 "will create a directory C<local> on the host, and then export the contents "
18982 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18983 "(See C<tgz-out>)."
18987 #: ../fish/guestfish.pod:676
18989 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18990 "effect, due to the way that subprocesses work in Unix."
18994 #: ../fish/guestfish.pod:679
18999 #: ../fish/guestfish.pod:681
19001 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
19002 "command (a guestfish command) to the second command (any host command). For "
19007 #: ../fish/guestfish.pod:685
19010 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
19015 #: ../fish/guestfish.pod:687
19017 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
19018 "program). The above command would list all accounts in the guest filesystem "
19019 "which have UID 0, ie. root accounts including backdoors. Other examples:"
19023 #: ../fish/guestfish.pod:692
19026 " hexdump /bin/ls | head\n"
19027 " list-devices | tail -1\n"
19028 " tgz-out / - | tar ztf -\n"
19033 #: ../fish/guestfish.pod:696
19035 "The space before the pipe symbol is required, any space after the pipe "
19036 "symbol is optional. Everything after the pipe symbol is just passed "
19037 "straight to the host shell, so it can contain redirections, globs and "
19038 "anything else that makes sense on the host side."
19042 #: ../fish/guestfish.pod:701
19044 "To use a literal argument which begins with a pipe symbol, you have to quote "
19049 #: ../fish/guestfish.pod:704
19057 #: ../fish/guestfish.pod:706
19058 msgid "HOME DIRECTORIES"
19062 #: ../fish/guestfish.pod:708
19064 "If a parameter starts with the character C<~> then the tilde may be expanded "
19065 "as a home directory path (either C<~> for the current user's home directory, "
19066 "or C<~user> for another user)."
19070 #: ../fish/guestfish.pod:712
19072 "Note that home directory expansion happens for users known I<on the host>, "
19073 "not in the guest filesystem."
19077 #: ../fish/guestfish.pod:715
19079 "To use a literal argument which begins with a tilde, you have to quote it, "
19084 #: ../fish/guestfish.pod:718
19092 #: ../fish/guestfish.pod:722
19094 "Libguestfs has some support for Linux guests encrypted according to the "
19095 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
19096 "disk encryption systems used by modern Linux guests. Currently only "
19097 "LVM-on-LUKS is supported."
19101 #: ../fish/guestfish.pod:727
19102 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
19106 #: ../fish/guestfish.pod:729
19109 " ><fs> vfs-type /dev/sda2\n"
19115 #: ../fish/guestfish.pod:732
19117 "Then open those devices using L</luks-open>. This creates a device-mapper "
19118 "device called C</dev/mapper/luksdev>."
19122 #: ../fish/guestfish.pod:735
19125 " ><fs> luks-open /dev/sda2 luksdev\n"
19126 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
19131 #: ../fish/guestfish.pod:738
19133 "Finally you have to tell LVM to scan for volume groups on the newly created "
19138 #: ../fish/guestfish.pod:741
19142 " vg-activate-all true\n"
19147 #: ../fish/guestfish.pod:744
19148 msgid "The logical volume(s) can now be mounted in the usual way."
19152 #: ../fish/guestfish.pod:746
19154 "Before closing a LUKS device you must unmount any logical volumes on it and "
19155 "deactivate the volume groups by calling C<vg-activate false VG> on each "
19156 "one. Then you can close the mapper device:"
19160 #: ../fish/guestfish.pod:750
19163 " vg-activate false /dev/VG\n"
19164 " luks-close /dev/mapper/luksdev\n"
19169 #: ../fish/guestfish.pod:753
19170 msgid "WINDOWS PATHS"
19174 #: ../fish/guestfish.pod:755
19176 "If a path is prefixed with C<win:> then you can use Windows-style paths "
19177 "(with some limitations). The following commands are equivalent:"
19181 #: ../fish/guestfish.pod:758
19184 " file /WINDOWS/system32/config/system.LOG\n"
19189 #: ../fish/guestfish.pod:760
19192 " file win:/windows/system32/config/system.log\n"
19197 #: ../fish/guestfish.pod:762
19200 " file win:\\windows\\system32\\config\\system.log\n"
19205 #: ../fish/guestfish.pod:764
19208 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
19213 #: ../fish/guestfish.pod:766
19215 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
19216 "handles case insensitivity like Windows would. This only works in argument "
19217 "positions that expect a path."
19221 #: ../fish/guestfish.pod:770
19222 msgid "UPLOADING AND DOWNLOADING FILES"
19226 #: ../fish/guestfish.pod:772
19228 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
19229 "others which upload from or download to a local file, you can use the "
19230 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
19234 #: ../fish/guestfish.pod:776
19242 #: ../fish/guestfish.pod:778
19243 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
19247 #: ../fish/guestfish.pod:781
19250 " tar-out /etc - | tar tf -\n"
19255 #: ../fish/guestfish.pod:783
19257 "writes the tarball to stdout and then pipes that into the external \"tar\" "
19258 "command (see L</PIPES>)."
19262 #: ../fish/guestfish.pod:786
19264 "When using C<-> to read from stdin, the input is read up to the end of "
19265 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
19266 "some arbitrary end marker:"
19270 #: ../fish/guestfish.pod:790
19273 " upload -<<END /foo\n"
19282 #: ../fish/guestfish.pod:796
19284 "Any string of characters can be used instead of C<END>. The end marker must "
19285 "appear on a line of its own, without any preceeding or following characters "
19286 "(not even spaces)."
19290 #: ../fish/guestfish.pod:800
19292 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
19293 "upload local files (so-called \"FileIn\" parameters in the generator)."
19297 #: ../fish/guestfish.pod:803
19298 msgid "EXIT ON ERROR BEHAVIOUR"
19302 #: ../fish/guestfish.pod:805
19304 "By default, guestfish will ignore any errors when in interactive mode "
19305 "(ie. taking commands from a human over a tty), and will exit on the first "
19306 "error in non-interactive mode (scripts, commands given on the command line)."
19310 #: ../fish/guestfish.pod:810
19312 "If you prefix a command with a I<-> character, then that command will not "
19313 "cause guestfish to exit, even if that (one) command returns an error."
19317 #: ../fish/guestfish.pod:814
19318 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
19322 #: ../fish/guestfish.pod:816
19324 "Guestfish can be remote-controlled over a socket. This is useful "
19325 "particularly in shell scripts where you want to make several different "
19326 "changes to a filesystem, but you don't want the overhead of starting up a "
19327 "guestfish process each time."
19331 #: ../fish/guestfish.pod:821
19332 msgid "Start a guestfish server process using:"
19336 #: ../fish/guestfish.pod:823
19339 " eval \"`guestfish --listen`\"\n"
19344 #: ../fish/guestfish.pod:825
19345 msgid "and then send it commands by doing:"
19349 #: ../fish/guestfish.pod:827
19352 " guestfish --remote cmd [...]\n"
19357 #: ../fish/guestfish.pod:829
19358 msgid "To cause the server to exit, send it the exit command:"
19362 #: ../fish/guestfish.pod:831
19365 " guestfish --remote exit\n"
19370 #: ../fish/guestfish.pod:833
19372 "Note that the server will normally exit if there is an error in a command. "
19373 "You can change this in the usual way. See section L</EXIT ON ERROR "
19378 #: ../fish/guestfish.pod:837
19379 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
19383 #: ../fish/guestfish.pod:839
19385 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
19386 "is how the I<--remote> option knows where to send the commands. You can "
19387 "have several guestfish listener processes running using:"
19391 #: ../fish/guestfish.pod:843
19394 " eval \"`guestfish --listen`\"\n"
19395 " pid1=$GUESTFISH_PID\n"
19396 " eval \"`guestfish --listen`\"\n"
19397 " pid2=$GUESTFISH_PID\n"
19399 " guestfish --remote=$pid1 cmd\n"
19400 " guestfish --remote=$pid2 cmd\n"
19405 #: ../fish/guestfish.pod:851
19406 msgid "REMOTE CONTROL AND CSH"
19410 #: ../fish/guestfish.pod:853
19412 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
19417 #: ../fish/guestfish.pod:856
19420 " eval \"`guestfish --listen --csh`\"\n"
19425 #: ../fish/guestfish.pod:858
19426 msgid "REMOTE CONTROL DETAILS"
19430 #: ../fish/guestfish.pod:860
19432 "Remote control happens over a Unix domain socket called "
19433 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
19434 "of the process, and C<$PID> is the process ID of the server."
19438 #: ../fish/guestfish.pod:864
19439 msgid "Guestfish client and server versions must match exactly."
19443 #: ../fish/guestfish.pod:866
19444 msgid "PREPARED DISK IMAGES"
19448 #: ../fish/guestfish.pod:868
19450 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
19451 "preformatted disk images that guestfish can make for you to save typing. "
19452 "This is particularly useful for testing purposes. This option is used "
19453 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
19454 "can be mixed with I<-a>)."
19458 #: ../fish/guestfish.pod:874
19460 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
19461 "the second and so on. Existing files in the current directory are "
19466 #: ../fish/guestfish.pod:878
19468 "The type briefly describes how the disk should be sized, partitioned, how "
19469 "filesystem(s) should be created, and how content should be added. "
19470 "Optionally the type can be followed by extra parameters, separated by C<:> "
19471 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
19472 "sparsely-allocated disk, containing a single partition, with the partition "
19473 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
19474 "on a 1GB disk instead."
19478 #: ../fish/guestfish.pod:886
19479 msgid "To list the available types and any extra parameters they take, run:"
19483 #: ../fish/guestfish.pod:890
19485 "Note that the prepared filesystem is not mounted. You would usually have to "
19486 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
19490 #: ../fish/guestfish.pod:894
19492 "If any I<-N> or I<--new> options are given, the guest is automatically "
19497 #: ../fish/guestfish.pod:899
19498 msgid "Create a 100MB disk with an ext4-formatted partition:"
19502 #: ../fish/guestfish.pod:901
19505 " guestfish -N fs:ext4\n"
19510 #: ../fish/guestfish.pod:903
19511 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
19515 #: ../fish/guestfish.pod:905
19518 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
19523 #: ../fish/guestfish.pod:907
19524 msgid "Create a blank 200MB disk:"
19528 #: ../fish/guestfish.pod:909
19531 " guestfish -N disk:200M\n"
19536 #: ../fish/guestfish.pod:911
19537 msgid "PROGRESS BARS"
19541 #: ../fish/guestfish.pod:913
19543 "Some (not all) long-running commands send progress notification messages as "
19544 "they are running. Guestfish turns these messages into progress bars."
19548 #: ../fish/guestfish.pod:917
19550 "When a command that supports progress bars takes longer than two seconds to "
19551 "run, and if progress bars are enabled, then you will see one appearing below "
19556 #: ../fish/guestfish.pod:921
19559 " ><fs> copy-size /large-file /another-file 2048M\n"
19560 " / 10% [#####-----------------------------------------] 00:30\n"
19565 #: ../fish/guestfish.pod:924
19567 "The spinner on the left hand side moves round once for every progress "
19568 "notification received from the backend. This is a (reasonably) golden "
19569 "assurance that the command is \"doing something\" even if the progress bar "
19570 "is not moving, because the command is able to send the progress "
19571 "notifications. When the bar reaches 100% and the command finishes, the "
19572 "spinner disappears."
19576 #: ../fish/guestfish.pod:931
19578 "Progress bars are enabled by default when guestfish is used interactively. "
19579 "You can enable them even for non-interactive modes using I<--progress-bars>, "
19580 "and you can disable them completely using I<--no-progress-bars>."
19584 #: ../fish/guestfish.pod:936
19585 msgid "GUESTFISH COMMANDS"
19589 #: ../fish/guestfish.pod:938
19591 "The commands in this section are guestfish convenience commands, in other "
19592 "words, they are not part of the L<guestfs(3)> API."
19596 #: ../fish/guestfish.pod:941
19601 #: ../fish/guestfish.pod:943
19610 #: ../fish/guestfish.pod:946
19611 msgid "Without any parameter, this provides general help."
19615 #: ../fish/guestfish.pod:948
19616 msgid "With a C<cmd> parameter, this displays detailed help for that command."
19620 #: ../fish/guestfish.pod:950
19621 msgid "quit | exit"
19625 #: ../fish/guestfish.pod:952
19626 msgid "This exits guestfish. You can also use C<^D> key."
19630 #: ../fish/guestfish.pod:954
19631 msgid "@FISH_COMMANDS@"
19635 #: ../fish/guestfish.pod:956
19640 #: ../fish/guestfish.pod:960 ../test-tool/libguestfs-test-tool.pod:83
19645 #: ../fish/guestfish.pod:962
19647 "guestfish returns 0 if the commands completed without error, or 1 if there "
19652 #: ../fish/guestfish.pod:969
19657 #: ../fish/guestfish.pod:971
19659 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19664 #: ../fish/guestfish.pod:974
19665 msgid "GUESTFISH_PID"
19669 #: ../fish/guestfish.pod:976
19671 "Used with the I<--remote> option to specify the remote guestfish process to "
19672 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19676 #: ../fish/guestfish.pod:980
19681 #: ../fish/guestfish.pod:982
19683 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19684 "not specified, the external L<hexedit(1)> program is used."
19688 #: ../fish/guestfish.pod:986
19693 #: ../fish/guestfish.pod:988
19695 "If compiled with GNU readline support, various files in the home directory "
19696 "can be used. See L</FILES>."
19700 #: ../fish/guestfish.pod:997
19702 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19703 "effect as using the B<-v> option."
19707 #: ../fish/guestfish.pod:1009
19709 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19710 "the discussion of paths in L<guestfs(3)>."
19714 #: ../fish/guestfish.pod:1020
19715 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19719 #: ../fish/guestfish.pod:1022
19724 #: ../fish/guestfish.pod:1024
19726 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19731 #: ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:88
19736 #: ../fish/guestfish.pod:1043
19737 msgid "$HOME/.guestfish"
19741 #: ../fish/guestfish.pod:1045
19743 "If compiled with GNU readline support, then the command history is saved in "
19748 #: ../fish/guestfish.pod:1048
19749 msgid "$HOME/.inputrc"
19753 #: ../fish/guestfish.pod:1050
19754 msgid "/etc/inputrc"
19758 #: ../fish/guestfish.pod:1052
19760 "If compiled with GNU readline support, then these files can be used to "
19761 "configure readline. For further information, please see "
19762 "L<readline(3)/INITIALIZATION FILE>."
19766 #: ../fish/guestfish.pod:1056
19767 msgid "To write rules which only apply to guestfish, use:"
19771 #: ../fish/guestfish.pod:1058
19781 #: ../fish/guestfish.pod:1062
19783 "Variables that you can set in inputrc that change the behaviour of guestfish "
19784 "in useful ways include:"
19788 #: ../fish/guestfish.pod:1067
19789 msgid "completion-ignore-case (default: on)"
19793 #: ../fish/guestfish.pod:1069
19795 "By default, guestfish will ignore case when tab-completing paths on the "
19800 #: ../fish/guestfish.pod:1072
19803 " set completion-ignore-case off\n"
19808 #: ../fish/guestfish.pod:1074
19809 msgid "to make guestfish case sensitive."
19813 #: ../fish/guestfish.pod:1078
19818 #: ../fish/guestfish.pod:1080
19819 msgid "test2.img (etc)"
19823 #: ../fish/guestfish.pod:1082
19825 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19826 "will be created in the file C<test1.img> in the current directory. The "
19827 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19828 "the same name will be overwritten."
19832 #: ../fish/guestfish.pod:1091
19834 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19835 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
19836 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
19837 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
19838 "L<virt-win-reg(1)>, L<hexedit(1)>."
19842 #: ../fish/guestfish.pod:1117 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370 ../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:567 ../tools/virt-list-partitions.pl:277
19844 "This program is free software; you can redistribute it and/or modify it "
19845 "under the terms of the GNU General Public License as published by the Free "
19846 "Software Foundation; either version 2 of the License, or (at your option) "
19847 "any later version."
19851 #: ../fish/guestfish.pod:1122 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375 ../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:572 ../tools/virt-list-partitions.pl:282
19853 "This program is distributed in the hope that it will be useful, but WITHOUT "
19854 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19855 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19860 #: ../fish/guestfish.pod:1127 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380 ../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:577 ../tools/virt-list-partitions.pl:287
19862 "You should have received a copy of the GNU General Public License along with "
19863 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19864 "Ave, Cambridge, MA 02139, USA."
19868 #: ../fish/guestfish-actions.pod:1
19873 #: ../fish/guestfish-actions.pod:3
19876 " add-cdrom filename\n"
19881 #: ../fish/guestfish-actions.pod:15
19883 "This call checks for the existence of C<filename>. This stops you from "
19884 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19885 "and C<http:> URLs. To specify those, use the general L</config> call "
19890 #: ../fish/guestfish-actions.pod:22
19892 "If you just want to add an ISO file (often you use this as an efficient way "
19893 "to transfer large files into the guest), then you should probably use "
19894 "L</add-drive-ro> instead."
19898 #: ../fish/guestfish-actions.pod:35
19903 #: ../fish/guestfish-actions.pod:37
19908 #: ../fish/guestfish-actions.pod:39
19911 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19916 #: ../fish/guestfish-actions.pod:41
19918 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19919 "It works by connecting to libvirt, requesting the domain and domain XML from "
19920 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19924 #: ../fish/guestfish-actions.pod:64
19926 "The other optional parameters are passed directly through to "
19927 "L</add-drive-opts>."
19931 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131 ../fish/guestfish-actions.pod:2842
19933 "This command has one or more optional arguments. See L</OPTIONAL "
19938 #: ../fish/guestfish-actions.pod:69
19943 #: ../fish/guestfish-actions.pod:71
19946 " add-drive filename\n"
19951 #: ../fish/guestfish-actions.pod:73
19953 "This function is the equivalent of calling L</add-drive-opts> with no "
19954 "optional parameters, so the disk is added writable, with the format being "
19955 "detected automatically."
19959 #: ../fish/guestfish-actions.pod:77
19961 "Automatic detection of the format opens you up to a potential security hole "
19962 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19963 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19964 "you should think about replacing calls to this function with calls to "
19965 "L</add-drive-opts>, and specifying the format."
19969 #: ../fish/guestfish-actions.pod:84
19970 msgid "add-drive-opts"
19974 #: ../fish/guestfish-actions.pod:86
19979 #: ../fish/guestfish-actions.pod:88
19982 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19987 #: ../fish/guestfish-actions.pod:115
19989 "This forces the image format. If you omit this (or use L</add-drive> or "
19990 "L</add-drive-ro>) then the format is automatically detected. Possible "
19991 "formats include C<raw> and C<qcow2>."
19995 #: ../fish/guestfish-actions.pod:126
19997 "This rarely-used option lets you emulate the behaviour of the deprecated "
19998 "L</add-drive-with-if> call (q.v.)"
20002 #: ../fish/guestfish-actions.pod:133
20003 msgid "add-drive-ro"
20007 #: ../fish/guestfish-actions.pod:135
20012 #: ../fish/guestfish-actions.pod:137
20015 " add-drive-ro filename\n"
20020 #: ../fish/guestfish-actions.pod:139
20022 "This function is the equivalent of calling L</add-drive-opts> with the "
20023 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
20024 "is added read-only, with the format being detected automatically."
20028 #: ../fish/guestfish-actions.pod:144
20029 msgid "add-drive-ro-with-if"
20033 #: ../fish/guestfish-actions.pod:146
20036 " add-drive-ro-with-if filename iface\n"
20041 #: ../fish/guestfish-actions.pod:148
20043 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
20044 "interface emulation to use at run time."
20048 #: ../fish/guestfish-actions.pod:158
20049 msgid "add-drive-with-if"
20053 #: ../fish/guestfish-actions.pod:160
20056 " add-drive-with-if filename iface\n"
20061 #: ../fish/guestfish-actions.pod:162
20063 "This is the same as L</add-drive> but it allows you to specify the QEMU "
20064 "interface emulation to use at run time."
20068 #: ../fish/guestfish-actions.pod:172
20073 #: ../fish/guestfish-actions.pod:174
20076 " aug-clear augpath\n"
20081 #: ../fish/guestfish-actions.pod:179
20086 #: ../fish/guestfish-actions.pod:181
20094 #: ../fish/guestfish-actions.pod:183
20096 "Close the current Augeas handle and free up any resources used by it. After "
20097 "calling this, you have to call L</aug-init> again before you can use any "
20098 "other Augeas functions."
20102 #: ../fish/guestfish-actions.pod:188
20103 msgid "aug-defnode"
20107 #: ../fish/guestfish-actions.pod:190
20110 " aug-defnode name expr val\n"
20115 #: ../fish/guestfish-actions.pod:195
20117 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
20118 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
20119 "containing that single node."
20123 #: ../fish/guestfish-actions.pod:203
20128 #: ../fish/guestfish-actions.pod:205
20131 " aug-defvar name expr\n"
20136 #: ../fish/guestfish-actions.pod:214
20141 #: ../fish/guestfish-actions.pod:216
20144 " aug-get augpath\n"
20149 #: ../fish/guestfish-actions.pod:221
20154 #: ../fish/guestfish-actions.pod:223
20157 " aug-init root flags\n"
20162 #: ../fish/guestfish-actions.pod:229
20163 msgid "You must call this before using any other L</aug-*> commands."
20167 #: ../fish/guestfish-actions.pod:264
20168 msgid "Do not load the tree in L</aug-init>."
20172 #: ../fish/guestfish-actions.pod:268
20173 msgid "To close the handle, you can call L</aug-close>."
20177 #: ../fish/guestfish-actions.pod:272
20182 #: ../fish/guestfish-actions.pod:274
20185 " aug-insert augpath label true|false\n"
20190 #: ../fish/guestfish-actions.pod:284
20195 #: ../fish/guestfish-actions.pod:286
20203 #: ../fish/guestfish-actions.pod:293
20208 #: ../fish/guestfish-actions.pod:295
20211 " aug-ls augpath\n"
20216 #: ../fish/guestfish-actions.pod:297
20218 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
20219 "resulting nodes into alphabetical order."
20223 #: ../fish/guestfish-actions.pod:300
20228 #: ../fish/guestfish-actions.pod:302
20231 " aug-match augpath\n"
20236 #: ../fish/guestfish-actions.pod:308
20241 #: ../fish/guestfish-actions.pod:310
20244 " aug-mv src dest\n"
20249 #: ../fish/guestfish-actions.pod:315
20254 #: ../fish/guestfish-actions.pod:317
20257 " aug-rm augpath\n"
20262 #: ../fish/guestfish-actions.pod:323
20267 #: ../fish/guestfish-actions.pod:325
20275 #: ../fish/guestfish-actions.pod:329
20277 "The flags which were passed to L</aug-init> affect exactly how files are "
20282 #: ../fish/guestfish-actions.pod:332
20287 #: ../fish/guestfish-actions.pod:334
20290 " aug-set augpath val\n"
20295 #: ../fish/guestfish-actions.pod:338
20297 "In the Augeas API, it is possible to clear a node by setting the value to "
20298 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
20299 "this call. Instead you must use the L</aug-clear> call."
20303 #: ../fish/guestfish-actions.pod:343
20308 #: ../fish/guestfish-actions.pod:345
20311 " available 'groups ...'\n"
20316 #: ../fish/guestfish-actions.pod:351
20318 "The libguestfs groups, and the functions that those groups correspond to, "
20319 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
20320 "runtime by calling L</available-all-groups>."
20324 #: ../fish/guestfish-actions.pod:375
20325 msgid "You must call L</launch> before calling this function."
20329 #: ../fish/guestfish-actions.pod:397
20331 "This call was added in version C<1.0.80>. In previous versions of "
20332 "libguestfs all you could do would be to speculatively execute a command to "
20333 "find out if the daemon implemented it. See also L</version>."
20337 #: ../fish/guestfish-actions.pod:404
20338 msgid "available-all-groups"
20342 #: ../fish/guestfish-actions.pod:406
20345 " available-all-groups\n"
20350 #: ../fish/guestfish-actions.pod:408
20352 "This command returns a list of all optional groups that this daemon knows "
20353 "about. Note this returns both supported and unsupported groups. To find "
20354 "out which ones the daemon can actually support you have to call "
20355 "L</available> on each member of the returned list."
20359 #: ../fish/guestfish-actions.pod:414
20360 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
20364 #: ../fish/guestfish-actions.pod:416
20369 #: ../fish/guestfish-actions.pod:418
20372 " base64-in (base64file|-) filename\n"
20377 #: ../fish/guestfish-actions.pod:423 ../fish/guestfish-actions.pod:432 ../fish/guestfish-actions.pod:656 ../fish/guestfish-actions.pod:825 ../fish/guestfish-actions.pod:844 ../fish/guestfish-actions.pod:1221 ../fish/guestfish-actions.pod:4197 ../fish/guestfish-actions.pod:4209 ../fish/guestfish-actions.pod:4220 ../fish/guestfish-actions.pod:4231 ../fish/guestfish-actions.pod:4283 ../fish/guestfish-actions.pod:4292 ../fish/guestfish-actions.pod:4346 ../fish/guestfish-actions.pod:4369
20378 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
20382 #: ../fish/guestfish-actions.pod:425
20387 #: ../fish/guestfish-actions.pod:427
20390 " base64-out filename (base64file|-)\n"
20395 #: ../fish/guestfish-actions.pod:434
20396 msgid "blockdev-flushbufs"
20400 #: ../fish/guestfish-actions.pod:436
20403 " blockdev-flushbufs device\n"
20408 #: ../fish/guestfish-actions.pod:443
20409 msgid "blockdev-getbsz"
20413 #: ../fish/guestfish-actions.pod:445
20416 " blockdev-getbsz device\n"
20421 #: ../fish/guestfish-actions.pod:454
20422 msgid "blockdev-getro"
20426 #: ../fish/guestfish-actions.pod:456
20429 " blockdev-getro device\n"
20434 #: ../fish/guestfish-actions.pod:463
20435 msgid "blockdev-getsize64"
20439 #: ../fish/guestfish-actions.pod:465
20442 " blockdev-getsize64 device\n"
20447 #: ../fish/guestfish-actions.pod:469
20448 msgid "See also L</blockdev-getsz>."
20452 #: ../fish/guestfish-actions.pod:473
20453 msgid "blockdev-getss"
20457 #: ../fish/guestfish-actions.pod:475
20460 " blockdev-getss device\n"
20465 #: ../fish/guestfish-actions.pod:480
20466 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
20470 #: ../fish/guestfish-actions.pod:485
20471 msgid "blockdev-getsz"
20475 #: ../fish/guestfish-actions.pod:487
20478 " blockdev-getsz device\n"
20483 #: ../fish/guestfish-actions.pod:492
20485 "See also L</blockdev-getss> for the real sector size of the device, and "
20486 "L</blockdev-getsize64> for the more useful I<size in bytes>."
20490 #: ../fish/guestfish-actions.pod:498
20491 msgid "blockdev-rereadpt"
20495 #: ../fish/guestfish-actions.pod:500
20498 " blockdev-rereadpt device\n"
20503 #: ../fish/guestfish-actions.pod:506
20504 msgid "blockdev-setbsz"
20508 #: ../fish/guestfish-actions.pod:508
20511 " blockdev-setbsz device blocksize\n"
20516 #: ../fish/guestfish-actions.pod:517
20517 msgid "blockdev-setro"
20521 #: ../fish/guestfish-actions.pod:519
20524 " blockdev-setro device\n"
20529 #: ../fish/guestfish-actions.pod:525
20530 msgid "blockdev-setrw"
20534 #: ../fish/guestfish-actions.pod:527
20537 " blockdev-setrw device\n"
20542 #: ../fish/guestfish-actions.pod:533
20543 msgid "case-sensitive-path"
20547 #: ../fish/guestfish-actions.pod:535
20550 " case-sensitive-path path\n"
20555 #: ../fish/guestfish-actions.pod:559
20557 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
20558 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
20559 "how the directories were originally created under Windows)."
20563 #: ../fish/guestfish-actions.pod:567
20564 msgid "See also L</realpath>."
20568 #: ../fish/guestfish-actions.pod:569
20573 #: ../fish/guestfish-actions.pod:571
20581 #: ../fish/guestfish-actions.pod:575
20583 "Note that this function cannot correctly handle binary files (specifically, "
20584 "files containing C<\\0> character which is treated as end of string). For "
20585 "those you need to use the L</read-file> or L</download> functions which have "
20586 "a more complex interface."
20590 #: ../fish/guestfish-actions.pod:583
20595 #: ../fish/guestfish-actions.pod:585
20598 " checksum csumtype path\n"
20603 #: ../fish/guestfish-actions.pod:628
20604 msgid "To get the checksum for a device, use L</checksum-device>."
20608 #: ../fish/guestfish-actions.pod:630
20609 msgid "To get the checksums for many files, use L</checksums-out>."
20613 #: ../fish/guestfish-actions.pod:632
20614 msgid "checksum-device"
20618 #: ../fish/guestfish-actions.pod:634
20621 " checksum-device csumtype device\n"
20626 #: ../fish/guestfish-actions.pod:636
20628 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20629 "device named C<device>. For the types of checksums supported see the "
20630 "L</checksum> command."
20634 #: ../fish/guestfish-actions.pod:640
20635 msgid "checksums-out"
20639 #: ../fish/guestfish-actions.pod:642
20642 " checksums-out csumtype directory (sumsfile|-)\n"
20647 #: ../fish/guestfish-actions.pod:658
20652 #: ../fish/guestfish-actions.pod:660
20655 " chmod mode path\n"
20660 #: ../fish/guestfish-actions.pod:671
20665 #: ../fish/guestfish-actions.pod:673
20668 " chown owner group path\n"
20673 #: ../fish/guestfish-actions.pod:681
20678 #: ../fish/guestfish-actions.pod:683
20681 " command 'arguments ...'\n"
20686 #: ../fish/guestfish-actions.pod:690
20688 "The single parameter is an argv-style list of arguments. The first element "
20689 "is the name of the program to run. Subsequent elements are parameters. The "
20690 "list must be non-empty (ie. must contain a program name). Note that the "
20691 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20695 #: ../fish/guestfish-actions.pod:718
20696 msgid "command-lines"
20700 #: ../fish/guestfish-actions.pod:720
20703 " command-lines 'arguments ...'\n"
20708 #: ../fish/guestfish-actions.pod:722
20709 msgid "This is the same as L</command>, but splits the result into a list of lines."
20713 #: ../fish/guestfish-actions.pod:725
20714 msgid "See also: L</sh-lines>"
20718 #: ../fish/guestfish-actions.pod:730
20723 #: ../fish/guestfish-actions.pod:732
20726 " config qemuparam qemuvalue\n"
20731 #: ../fish/guestfish-actions.pod:743
20736 #: ../fish/guestfish-actions.pod:745
20739 " copy-size src dest size\n"
20744 #: ../fish/guestfish-actions.pod:753
20749 #: ../fish/guestfish-actions.pod:755
20757 #: ../fish/guestfish-actions.pod:760
20762 #: ../fish/guestfish-actions.pod:762
20770 #: ../fish/guestfish-actions.pod:767
20775 #: ../fish/guestfish-actions.pod:769
20783 #: ../fish/guestfish-actions.pod:776
20785 "If the destination is a device, it must be as large or larger than the "
20786 "source file or device, otherwise the copy will fail. This command cannot do "
20787 "partial copies (see L</copy-size>)."
20791 #: ../fish/guestfish-actions.pod:780
20796 #: ../fish/guestfish-actions.pod:782
20804 #: ../fish/guestfish-actions.pod:786 ../fish/guestfish-actions.pod:797
20806 "This command is mostly useful for interactive sessions. It is I<not> "
20807 "intended that you try to parse the output string. Use L</statvfs> from "
20812 #: ../fish/guestfish-actions.pod:790
20817 #: ../fish/guestfish-actions.pod:792
20825 #: ../fish/guestfish-actions.pod:801
20830 #: ../fish/guestfish-actions.pod:803
20838 #: ../fish/guestfish-actions.pod:809
20840 "Another way to get the same information is to enable verbose messages with "
20841 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20842 "before running the program."
20846 #: ../fish/guestfish-actions.pod:814
20851 #: ../fish/guestfish-actions.pod:816
20854 " download remotefilename (filename|-)\n"
20859 #: ../fish/guestfish-actions.pod:823
20860 msgid "See also L</upload>, L</cat>."
20864 #: ../fish/guestfish-actions.pod:827
20865 msgid "download-offset"
20869 #: ../fish/guestfish-actions.pod:829
20872 " download-offset remotefilename (filename|-) offset size\n"
20877 #: ../fish/guestfish-actions.pod:837
20879 "Note that there is no limit on the amount of data that can be downloaded "
20880 "with this call, unlike with L</pread>, and this call always reads the full "
20881 "amount unless an error occurs."
20885 #: ../fish/guestfish-actions.pod:842
20886 msgid "See also L</download>, L</pread>."
20890 #: ../fish/guestfish-actions.pod:846
20891 msgid "drop-caches"
20895 #: ../fish/guestfish-actions.pod:848
20898 " drop-caches whattodrop\n"
20903 #: ../fish/guestfish-actions.pod:860
20908 #: ../fish/guestfish-actions.pod:862
20916 #: ../fish/guestfish-actions.pod:874
20921 #: ../fish/guestfish-actions.pod:876
20924 " e2fsck-f device\n"
20929 #: ../fish/guestfish-actions.pod:882
20931 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20932 "should use L</fsck>."
20936 #: ../fish/guestfish-actions.pod:885
20937 msgid "echo-daemon"
20941 #: ../fish/guestfish-actions.pod:887
20944 " echo-daemon 'words ...'\n"
20949 #: ../fish/guestfish-actions.pod:894
20950 msgid "See also L</ping-daemon>."
20954 #: ../fish/guestfish-actions.pod:896
20959 #: ../fish/guestfish-actions.pod:898
20962 " egrep regex path\n"
20967 #: ../fish/guestfish-actions.pod:906
20972 #: ../fish/guestfish-actions.pod:908
20975 " egrepi regex path\n"
20980 #: ../fish/guestfish-actions.pod:916
20985 #: ../fish/guestfish-actions.pod:918
20988 " equal file1 file2\n"
20993 #: ../fish/guestfish-actions.pod:925
20998 #: ../fish/guestfish-actions.pod:927
21006 #: ../fish/guestfish-actions.pod:932
21007 msgid "See also L</is-file>, L</is-dir>, L</stat>."
21011 #: ../fish/guestfish-actions.pod:934
21016 #: ../fish/guestfish-actions.pod:936
21019 " fallocate path len\n"
21024 #: ../fish/guestfish-actions.pod:953
21025 msgid "fallocate64"
21029 #: ../fish/guestfish-actions.pod:955
21032 " fallocate64 path len\n"
21037 #: ../fish/guestfish-actions.pod:961
21039 "Note that this call allocates disk blocks for the file. To create a sparse "
21040 "file use L</truncate-size> instead."
21044 #: ../fish/guestfish-actions.pod:964
21046 "The deprecated call L</fallocate> does the same, but owing to an oversight "
21047 "it only allowed 30 bit lengths to be specified, effectively limiting the "
21048 "maximum size of files created through that call to 1GB."
21052 #: ../fish/guestfish-actions.pod:973
21057 #: ../fish/guestfish-actions.pod:975
21060 " fgrep pattern path\n"
21065 #: ../fish/guestfish-actions.pod:983
21070 #: ../fish/guestfish-actions.pod:985
21073 " fgrepi pattern path\n"
21078 #: ../fish/guestfish-actions.pod:993
21083 #: ../fish/guestfish-actions.pod:995
21091 #: ../fish/guestfish-actions.pod:1007
21093 "This command can also be used on C</dev/> devices (and partitions, LV "
21094 "names). You can for example use this to determine if a device contains a "
21095 "filesystem, although it's usually better to use L</vfs-type>."
21099 #: ../fish/guestfish-actions.pod:1017
21100 msgid "file-architecture"
21104 #: ../fish/guestfish-actions.pod:1019
21107 " file-architecture filename\n"
21112 #: ../fish/guestfish-actions.pod:1122
21117 #: ../fish/guestfish-actions.pod:1124
21125 #: ../fish/guestfish-actions.pod:1128
21127 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
21128 "L</is-file> etc. To get the size of block devices, use "
21129 "L</blockdev-getsize64>."
21133 #: ../fish/guestfish-actions.pod:1132
21138 #: ../fish/guestfish-actions.pod:1134
21141 " fill c len path\n"
21146 #: ../fish/guestfish-actions.pod:1140
21148 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
21149 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
21150 "L</fill-pattern>."
21154 #: ../fish/guestfish-actions.pod:1145
21155 msgid "fill-pattern"
21159 #: ../fish/guestfish-actions.pod:1147
21162 " fill-pattern pattern len path\n"
21167 #: ../fish/guestfish-actions.pod:1149
21169 "This function is like L</fill> except that it creates a new file of length "
21170 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
21171 "is truncated if necessary to ensure the length of the file is exactly C<len> "
21176 #: ../fish/guestfish-actions.pod:1154
21181 #: ../fish/guestfish-actions.pod:1156
21184 " find directory\n"
21189 #: ../fish/guestfish-actions.pod:1170
21190 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
21194 #: ../fish/guestfish-actions.pod:1183
21195 msgid "See also L</find0>."
21199 #: ../fish/guestfish-actions.pod:1188
21204 #: ../fish/guestfish-actions.pod:1190
21207 " find0 directory (files|-)\n"
21212 #: ../fish/guestfish-actions.pod:1196
21213 msgid "This command works the same way as L</find> with the following exceptions:"
21217 #: ../fish/guestfish-actions.pod:1223
21218 msgid "findfs-label"
21222 #: ../fish/guestfish-actions.pod:1225
21225 " findfs-label label\n"
21230 #: ../fish/guestfish-actions.pod:1231
21231 msgid "To find the label of a filesystem, use L</vfs-label>."
21235 #: ../fish/guestfish-actions.pod:1233
21236 msgid "findfs-uuid"
21240 #: ../fish/guestfish-actions.pod:1235
21243 " findfs-uuid uuid\n"
21248 #: ../fish/guestfish-actions.pod:1241
21249 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
21253 #: ../fish/guestfish-actions.pod:1243
21258 #: ../fish/guestfish-actions.pod:1245
21261 " fsck fstype device\n"
21266 #: ../fish/guestfish-actions.pod:1275
21271 #: ../fish/guestfish-actions.pod:1277
21279 #: ../fish/guestfish-actions.pod:1284
21280 msgid "get-autosync"
21284 #: ../fish/guestfish-actions.pod:1286
21292 #: ../fish/guestfish-actions.pod:1290
21297 #: ../fish/guestfish-actions.pod:1292
21305 #: ../fish/guestfish-actions.pod:1296
21306 msgid "get-e2label"
21310 #: ../fish/guestfish-actions.pod:1298
21313 " get-e2label device\n"
21318 #: ../fish/guestfish-actions.pod:1310
21323 #: ../fish/guestfish-actions.pod:1312
21326 " get-e2uuid device\n"
21331 #: ../fish/guestfish-actions.pod:1324
21332 msgid "get-memsize"
21336 #: ../fish/guestfish-actions.pod:1326
21344 #: ../fish/guestfish-actions.pod:1331
21346 "If L</set-memsize> was not called on this handle, and if "
21347 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
21348 "value for memsize."
21352 #: ../fish/guestfish-actions.pod:1338
21353 msgid "get-network"
21357 #: ../fish/guestfish-actions.pod:1340
21365 #: ../fish/guestfish-actions.pod:1344
21370 #: ../fish/guestfish-actions.pod:1346
21378 #: ../fish/guestfish-actions.pod:1353
21383 #: ../fish/guestfish-actions.pod:1355
21388 #: ../fish/guestfish-actions.pod:1357
21396 #: ../fish/guestfish-actions.pod:1364
21401 #: ../fish/guestfish-actions.pod:1366
21409 #: ../fish/guestfish-actions.pod:1373
21410 msgid "get-recovery-proc"
21414 #: ../fish/guestfish-actions.pod:1375
21417 " get-recovery-proc\n"
21422 #: ../fish/guestfish-actions.pod:1379
21423 msgid "get-selinux"
21427 #: ../fish/guestfish-actions.pod:1381
21435 #: ../fish/guestfish-actions.pod:1383
21437 "This returns the current setting of the selinux flag which is passed to the "
21438 "appliance at boot time. See L</set-selinux>."
21442 #: ../fish/guestfish-actions.pod:1389
21447 #: ../fish/guestfish-actions.pod:1391
21455 #: ../fish/guestfish-actions.pod:1398
21460 #: ../fish/guestfish-actions.pod:1400
21468 #: ../fish/guestfish-actions.pod:1404
21473 #: ../fish/guestfish-actions.pod:1406
21481 #: ../fish/guestfish-actions.pod:1408
21483 "Return the current umask. By default the umask is C<022> unless it has been "
21484 "set by calling L</umask>."
21488 #: ../fish/guestfish-actions.pod:1411
21489 msgid "get-verbose"
21493 #: ../fish/guestfish-actions.pod:1413
21501 #: ../fish/guestfish-actions.pod:1417
21506 #: ../fish/guestfish-actions.pod:1419
21514 #: ../fish/guestfish-actions.pod:1423
21515 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
21519 #: ../fish/guestfish-actions.pod:1426
21524 #: ../fish/guestfish-actions.pod:1428
21527 " getxattr path name\n"
21532 #: ../fish/guestfish-actions.pod:1430
21534 "Get a single extended attribute from file C<path> named C<name>. This call "
21535 "follows symlinks. If you want to lookup an extended attribute for the "
21536 "symlink itself, use L</lgetxattr>."
21540 #: ../fish/guestfish-actions.pod:1434 ../fish/guestfish-actions.pod:2261
21542 "Normally it is better to get all extended attributes from a file in one go "
21543 "by calling L</getxattrs>. However some Linux filesystem implementations are "
21544 "buggy and do not provide a way to list out attributes. For these "
21545 "filesystems (notably ntfs-3g) you have to know the names of the extended "
21546 "attributes you want in advance and call this function."
21550 #: ../fish/guestfish-actions.pod:1444
21551 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
21555 #: ../fish/guestfish-actions.pod:1446
21560 #: ../fish/guestfish-actions.pod:1448
21563 " getxattrs path\n"
21568 #: ../fish/guestfish-actions.pod:1456
21569 msgid "See also: L</lgetxattrs>, L<attr(5)>."
21573 #: ../fish/guestfish-actions.pod:1458
21574 msgid "glob-expand"
21578 #: ../fish/guestfish-actions.pod:1460
21581 " glob-expand pattern\n"
21586 #: ../fish/guestfish-actions.pod:1473
21591 #: ../fish/guestfish-actions.pod:1475
21594 " grep regex path\n"
21599 #: ../fish/guestfish-actions.pod:1483
21604 #: ../fish/guestfish-actions.pod:1485
21607 " grepi regex path\n"
21612 #: ../fish/guestfish-actions.pod:1493
21613 msgid "grub-install"
21617 #: ../fish/guestfish-actions.pod:1495
21620 " grub-install root device\n"
21625 #: ../fish/guestfish-actions.pod:1511
21630 #: ../fish/guestfish-actions.pod:1513
21638 #: ../fish/guestfish-actions.pod:1521
21643 #: ../fish/guestfish-actions.pod:1523
21646 " head-n nrlines path\n"
21651 #: ../fish/guestfish-actions.pod:1536
21656 #: ../fish/guestfish-actions.pod:1538
21664 #: ../fish/guestfish-actions.pod:1546
21669 #: ../fish/guestfish-actions.pod:1548
21672 " initrd-cat initrdpath filename\n"
21677 #: ../fish/guestfish-actions.pod:1560
21678 msgid "See also L</initrd-list>."
21682 #: ../fish/guestfish-actions.pod:1565
21683 msgid "initrd-list"
21687 #: ../fish/guestfish-actions.pod:1567
21690 " initrd-list path\n"
21695 #: ../fish/guestfish-actions.pod:1579
21696 msgid "inotify-add-watch"
21700 #: ../fish/guestfish-actions.pod:1581
21703 " inotify-add-watch path mask\n"
21708 #: ../fish/guestfish-actions.pod:1593
21709 msgid "inotify-close"
21713 #: ../fish/guestfish-actions.pod:1595
21721 #: ../fish/guestfish-actions.pod:1601
21722 msgid "inotify-files"
21726 #: ../fish/guestfish-actions.pod:1603
21734 #: ../fish/guestfish-actions.pod:1605
21736 "This function is a helpful wrapper around L</inotify-read> which just "
21737 "returns a list of pathnames of objects that were touched. The returned "
21738 "pathnames are sorted and deduplicated."
21742 #: ../fish/guestfish-actions.pod:1609
21743 msgid "inotify-init"
21747 #: ../fish/guestfish-actions.pod:1611
21750 " inotify-init maxevents\n"
21755 #: ../fish/guestfish-actions.pod:1617
21757 "C<maxevents> is the maximum number of events which will be queued up between "
21758 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21759 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21760 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21761 "but records the fact that it threw them away by setting a flag "
21762 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21766 #: ../fish/guestfish-actions.pod:1627
21768 "Before any events are generated, you have to add some watches to the "
21769 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21770 "L</inotify-watch-all>."
21774 #: ../fish/guestfish-actions.pod:1633
21776 "Queued up events should be read periodically by calling L</inotify-read> (or "
21777 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21778 "If you don't read the events out often enough then you risk the internal "
21779 "queue overflowing."
21783 #: ../fish/guestfish-actions.pod:1640
21785 "The handle should be closed after use by calling L</inotify-close>. This "
21786 "also removes any watches automatically."
21790 #: ../fish/guestfish-actions.pod:1649
21791 msgid "inotify-read"
21795 #: ../fish/guestfish-actions.pod:1651
21803 #: ../fish/guestfish-actions.pod:1664
21804 msgid "inotify-rm-watch"
21808 #: ../fish/guestfish-actions.pod:1666
21811 " inotify-rm-watch wd\n"
21816 #: ../fish/guestfish-actions.pod:1668
21817 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21821 #: ../fish/guestfish-actions.pod:1671
21822 msgid "inspect-get-arch"
21826 #: ../fish/guestfish-actions.pod:1673
21829 " inspect-get-arch root\n"
21834 #: ../fish/guestfish-actions.pod:1675 ../fish/guestfish-actions.pod:1691 ../fish/guestfish-actions.pod:1765 ../fish/guestfish-actions.pod:1783 ../fish/guestfish-actions.pod:1798 ../fish/guestfish-actions.pod:1819 ../fish/guestfish-actions.pod:1834 ../fish/guestfish-actions.pod:1857 ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1903 ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1968 ../fish/guestfish-actions.pod:1984
21836 "This function should only be called with a root device string as returned by "
21841 #: ../fish/guestfish-actions.pod:1678
21843 "This returns the architecture of the inspected operating system. The "
21844 "possible return values are listed under L</file-architecture>."
21848 #: ../fish/guestfish-actions.pod:1687
21849 msgid "inspect-get-distro"
21853 #: ../fish/guestfish-actions.pod:1689
21856 " inspect-get-distro root\n"
21861 #: ../fish/guestfish-actions.pod:1761
21862 msgid "inspect-get-filesystems"
21866 #: ../fish/guestfish-actions.pod:1763
21869 " inspect-get-filesystems root\n"
21874 #: ../fish/guestfish-actions.pod:1776
21876 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21877 "L</inspect-get-mountpoints>."
21881 #: ../fish/guestfish-actions.pod:1779
21882 msgid "inspect-get-hostname"
21886 #: ../fish/guestfish-actions.pod:1781
21889 " inspect-get-hostname root\n"
21894 #: ../fish/guestfish-actions.pod:1794
21895 msgid "inspect-get-major-version"
21899 #: ../fish/guestfish-actions.pod:1796
21902 " inspect-get-major-version root\n"
21907 #: ../fish/guestfish-actions.pod:1815
21908 msgid "inspect-get-minor-version"
21912 #: ../fish/guestfish-actions.pod:1817
21915 " inspect-get-minor-version root\n"
21920 #: ../fish/guestfish-actions.pod:1827
21922 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21923 "L</inspect-get-major-version>."
21927 #: ../fish/guestfish-actions.pod:1830
21928 msgid "inspect-get-mountpoints"
21932 #: ../fish/guestfish-actions.pod:1832
21935 " inspect-get-mountpoints root\n"
21940 #: ../fish/guestfish-actions.pod:1850
21942 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
21943 "L</inspect-get-filesystems>."
21947 #: ../fish/guestfish-actions.pod:1853
21948 msgid "inspect-get-package-format"
21952 #: ../fish/guestfish-actions.pod:1855
21955 " inspect-get-package-format root\n"
21960 #: ../fish/guestfish-actions.pod:1860
21962 "This function and L</inspect-get-package-management> return the package "
21963 "format and package management tool used by the inspected operating system. "
21964 "For example for Fedora these functions would return C<rpm> (package format) "
21965 "and C<yum> (package management)."
21969 #: ../fish/guestfish-actions.pod:1875
21970 msgid "inspect-get-package-management"
21974 #: ../fish/guestfish-actions.pod:1877
21977 " inspect-get-package-management root\n"
21982 #: ../fish/guestfish-actions.pod:1882
21984 "L</inspect-get-package-format> and this function return the package format "
21985 "and package management tool used by the inspected operating system. For "
21986 "example for Fedora these functions would return C<rpm> (package format) and "
21987 "C<yum> (package management)."
21991 #: ../fish/guestfish-actions.pod:1899
21992 msgid "inspect-get-product-name"
21996 #: ../fish/guestfish-actions.pod:1901
21999 " inspect-get-product-name root\n"
22004 #: ../fish/guestfish-actions.pod:1916
22005 msgid "inspect-get-roots"
22009 #: ../fish/guestfish-actions.pod:1918
22012 " inspect-get-roots\n"
22017 #: ../fish/guestfish-actions.pod:1920
22019 "This function is a convenient way to get the list of root devices, as "
22020 "returned from a previous call to L</inspect-os>, but without redoing the "
22021 "whole inspection process."
22025 #: ../fish/guestfish-actions.pod:1924
22027 "This returns an empty list if either no root devices were found or the "
22028 "caller has not called L</inspect-os>."
22032 #: ../fish/guestfish-actions.pod:1929
22033 msgid "inspect-get-type"
22037 #: ../fish/guestfish-actions.pod:1931
22040 " inspect-get-type root\n"
22045 #: ../fish/guestfish-actions.pod:1964
22046 msgid "inspect-get-windows-systemroot"
22050 #: ../fish/guestfish-actions.pod:1966
22053 " inspect-get-windows-systemroot root\n"
22058 #: ../fish/guestfish-actions.pod:1980
22059 msgid "inspect-list-applications"
22063 #: ../fish/guestfish-actions.pod:1982
22066 " inspect-list-applications root\n"
22071 #: ../fish/guestfish-actions.pod:1989
22073 "I<Note:> This call works differently from other parts of the inspection "
22074 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
22075 "then mount up the disks, before calling this. Listing applications is a "
22076 "significantly more difficult operation which requires access to the full "
22077 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
22078 "are just returning data cached in the libguestfs handle, this call actually "
22079 "reads parts of the mounted filesystems during the call."
22083 #: ../fish/guestfish-actions.pod:2079
22088 #: ../fish/guestfish-actions.pod:2081
22096 #: ../fish/guestfish-actions.pod:2096
22098 "You can pass the root string(s) returned to other L</inspect-get-*> "
22099 "functions in order to query further information about each operating system, "
22100 "such as the name and version."
22104 #: ../fish/guestfish-actions.pod:2101
22106 "This function uses other libguestfs features such as L</mount-ro> and "
22107 "L</umount-all> in order to mount and unmount filesystems and look at the "
22108 "contents. This should be called with no disks currently mounted. The "
22109 "function may also use Augeas, so any existing Augeas handle will be closed."
22113 #: ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2289 ../fish/guestfish-actions.pod:2335
22114 msgid "See also L</list-filesystems>."
22118 #: ../fish/guestfish-actions.pod:2115
22119 msgid "is-blockdev"
22123 #: ../fish/guestfish-actions.pod:2117
22126 " is-blockdev path\n"
22131 #: ../fish/guestfish-actions.pod:2122 ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2159 ../fish/guestfish-actions.pod:2168 ../fish/guestfish-actions.pod:2178 ../fish/guestfish-actions.pod:2212 ../fish/guestfish-actions.pod:2221
22132 msgid "See also L</stat>."
22136 #: ../fish/guestfish-actions.pod:2124
22141 #: ../fish/guestfish-actions.pod:2126
22149 #: ../fish/guestfish-actions.pod:2133
22154 #: ../fish/guestfish-actions.pod:2135
22157 " is-chardev path\n"
22162 #: ../fish/guestfish-actions.pod:2142
22167 #: ../fish/guestfish-actions.pod:2144
22175 #: ../fish/guestfish-actions.pod:2151
22180 #: ../fish/guestfish-actions.pod:2153
22188 #: ../fish/guestfish-actions.pod:2161
22193 #: ../fish/guestfish-actions.pod:2163
22201 #: ../fish/guestfish-actions.pod:2170
22206 #: ../fish/guestfish-actions.pod:2172
22214 #: ../fish/guestfish-actions.pod:2180
22215 msgid "is-launching"
22219 #: ../fish/guestfish-actions.pod:2182
22227 #: ../fish/guestfish-actions.pod:2189
22232 #: ../fish/guestfish-actions.pod:2191
22240 #: ../fish/guestfish-actions.pod:2196
22245 #: ../fish/guestfish-actions.pod:2198
22253 #: ../fish/guestfish-actions.pod:2205
22258 #: ../fish/guestfish-actions.pod:2207
22261 " is-socket path\n"
22266 #: ../fish/guestfish-actions.pod:2214
22271 #: ../fish/guestfish-actions.pod:2216
22274 " is-symlink path\n"
22279 #: ../fish/guestfish-actions.pod:2223
22280 msgid "kill-subprocess"
22284 #: ../fish/guestfish-actions.pod:2225
22287 " kill-subprocess\n"
22292 #: ../fish/guestfish-actions.pod:2229
22297 #: ../fish/guestfish-actions.pod:2231
22302 #: ../fish/guestfish-actions.pod:2233
22310 #: ../fish/guestfish-actions.pod:2241
22315 #: ../fish/guestfish-actions.pod:2243
22318 " lchown owner group path\n"
22323 #: ../fish/guestfish-actions.pod:2245
22325 "Change the file owner to C<owner> and group to C<group>. This is like "
22326 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
22331 #: ../fish/guestfish-actions.pod:2253
22336 #: ../fish/guestfish-actions.pod:2255
22339 " lgetxattr path name\n"
22344 #: ../fish/guestfish-actions.pod:2271
22345 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
22349 #: ../fish/guestfish-actions.pod:2273
22354 #: ../fish/guestfish-actions.pod:2275
22357 " lgetxattrs path\n"
22362 #: ../fish/guestfish-actions.pod:2277
22364 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
22365 "it returns the extended attributes of the link itself."
22369 #: ../fish/guestfish-actions.pod:2281
22370 msgid "list-devices"
22374 #: ../fish/guestfish-actions.pod:2283
22382 #: ../fish/guestfish-actions.pod:2291
22383 msgid "list-filesystems"
22387 #: ../fish/guestfish-actions.pod:2293
22390 " list-filesystems\n"
22395 #: ../fish/guestfish-actions.pod:2312
22397 "This command runs other libguestfs commands, which might include L</mount> "
22398 "and L</umount>, and therefore you should use this soon after launch and only "
22399 "when nothing is mounted."
22403 #: ../fish/guestfish-actions.pod:2316
22405 "Not all of the filesystems returned will be mountable. In particular, swap "
22406 "partitions are returned in the list. Also this command does not check that "
22407 "each filesystem found is valid and mountable, and some filesystems might be "
22408 "mountable but require special options. Filesystems may not all belong to a "
22409 "single logical operating system (use L</inspect-os> to look for OSes)."
22413 #: ../fish/guestfish-actions.pod:2324
22414 msgid "list-partitions"
22418 #: ../fish/guestfish-actions.pod:2326
22421 " list-partitions\n"
22426 #: ../fish/guestfish-actions.pod:2332
22428 "This does not return logical volumes. For that you will need to call "
22433 #: ../fish/guestfish-actions.pod:2337
22438 #: ../fish/guestfish-actions.pod:2339
22446 #: ../fish/guestfish-actions.pod:2347
22451 #: ../fish/guestfish-actions.pod:2349
22454 " ln target linkname\n"
22459 #: ../fish/guestfish-actions.pod:2353
22464 #: ../fish/guestfish-actions.pod:2355
22467 " ln-f target linkname\n"
22472 #: ../fish/guestfish-actions.pod:2360
22477 #: ../fish/guestfish-actions.pod:2362
22480 " ln-s target linkname\n"
22485 #: ../fish/guestfish-actions.pod:2366
22490 #: ../fish/guestfish-actions.pod:2368
22493 " ln-sf target linkname\n"
22498 #: ../fish/guestfish-actions.pod:2373
22499 msgid "lremovexattr"
22503 #: ../fish/guestfish-actions.pod:2375
22506 " lremovexattr xattr path\n"
22511 #: ../fish/guestfish-actions.pod:2377
22513 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
22514 "it removes an extended attribute of the link itself."
22518 #: ../fish/guestfish-actions.pod:2381
22523 #: ../fish/guestfish-actions.pod:2383
22531 #: ../fish/guestfish-actions.pod:2389
22533 "This command is mostly useful for interactive sessions. Programs should "
22534 "probably use L</readdir> instead."
22538 #: ../fish/guestfish-actions.pod:2392
22543 #: ../fish/guestfish-actions.pod:2394
22546 " lsetxattr xattr val vallen path\n"
22551 #: ../fish/guestfish-actions.pod:2396
22553 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
22554 "sets an extended attribute of the link itself."
22558 #: ../fish/guestfish-actions.pod:2400
22563 #: ../fish/guestfish-actions.pod:2402
22571 #: ../fish/guestfish-actions.pod:2406
22573 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
22574 "the link is stat-ed, not the file it refers to."
22578 #: ../fish/guestfish-actions.pod:2412
22583 #: ../fish/guestfish-actions.pod:2414
22586 " lstatlist path 'names ...'\n"
22591 #: ../fish/guestfish-actions.pod:2416
22593 "This call allows you to perform the L</lstat> operation on multiple files, "
22594 "where all files are in the directory C<path>. C<names> is the list of files "
22595 "from this directory."
22599 #: ../fish/guestfish-actions.pod:2425
22601 "This call is intended for programs that want to efficiently list a directory "
22602 "contents without making many round-trips. See also L</lxattrlist> for a "
22603 "similarly efficient call for getting extended attributes. Very long "
22604 "directory listings might cause the protocol message size to be exceeded, "
22605 "causing this call to fail. The caller must split up such requests into "
22606 "smaller groups of names."
22610 #: ../fish/guestfish-actions.pod:2433
22611 msgid "luks-add-key"
22615 #: ../fish/guestfish-actions.pod:2435
22618 " luks-add-key device keyslot\n"
22623 #: ../fish/guestfish-actions.pod:2442
22625 "Note that if C<keyslot> already contains a key, then this command will "
22626 "fail. You have to use L</luks-kill-slot> first to remove that key."
22630 #: ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2468 ../fish/guestfish-actions.pod:2481 ../fish/guestfish-actions.pod:2495 ../fish/guestfish-actions.pod:2518 ../fish/guestfish-actions.pod:2528
22632 "This command has one or more key or passphrase parameters. Guestfish will "
22633 "prompt for these separately."
22637 #: ../fish/guestfish-actions.pod:2449
22642 #: ../fish/guestfish-actions.pod:2451
22645 " luks-close device\n"
22650 #: ../fish/guestfish-actions.pod:2453
22652 "This closes a LUKS device that was created earlier by L</luks-open> or "
22653 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
22654 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
22655 "underlying block device."
22659 #: ../fish/guestfish-actions.pod:2459
22660 msgid "luks-format"
22664 #: ../fish/guestfish-actions.pod:2461
22667 " luks-format device keyslot\n"
22672 #: ../fish/guestfish-actions.pod:2474
22673 msgid "luks-format-cipher"
22677 #: ../fish/guestfish-actions.pod:2476
22680 " luks-format-cipher device keyslot cipher\n"
22685 #: ../fish/guestfish-actions.pod:2478
22687 "This command is the same as L</luks-format> but it also allows you to set "
22688 "the C<cipher> used."
22692 #: ../fish/guestfish-actions.pod:2487
22693 msgid "luks-kill-slot"
22697 #: ../fish/guestfish-actions.pod:2489
22700 " luks-kill-slot device keyslot\n"
22705 #: ../fish/guestfish-actions.pod:2498
22710 #: ../fish/guestfish-actions.pod:2500
22713 " luks-open device mapname\n"
22718 #: ../fish/guestfish-actions.pod:2514
22720 "If this block device contains LVM volume groups, then calling L</vgscan> "
22721 "followed by L</vg-activate-all> will make them visible."
22725 #: ../fish/guestfish-actions.pod:2521
22726 msgid "luks-open-ro"
22730 #: ../fish/guestfish-actions.pod:2523
22733 " luks-open-ro device mapname\n"
22738 #: ../fish/guestfish-actions.pod:2525
22740 "This is the same as L</luks-open> except that a read-only mapping is "
22745 #: ../fish/guestfish-actions.pod:2531
22750 #: ../fish/guestfish-actions.pod:2533
22753 " lvcreate logvol volgroup mbytes\n"
22758 #: ../fish/guestfish-actions.pod:2538
22759 msgid "lvm-canonical-lv-name"
22763 #: ../fish/guestfish-actions.pod:2540
22766 " lvm-canonical-lv-name lvname\n"
22771 #: ../fish/guestfish-actions.pod:2549
22772 msgid "See also L</is-lv>."
22776 #: ../fish/guestfish-actions.pod:2551
22777 msgid "lvm-clear-filter"
22781 #: ../fish/guestfish-actions.pod:2553
22784 " lvm-clear-filter\n"
22789 #: ../fish/guestfish-actions.pod:2555
22791 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22796 #: ../fish/guestfish-actions.pod:2561
22797 msgid "lvm-remove-all"
22801 #: ../fish/guestfish-actions.pod:2563
22804 " lvm-remove-all\n"
22809 #: ../fish/guestfish-actions.pod:2571
22810 msgid "lvm-set-filter"
22814 #: ../fish/guestfish-actions.pod:2573
22817 " lvm-set-filter 'devices ...'\n"
22822 #: ../fish/guestfish-actions.pod:2598
22827 #: ../fish/guestfish-actions.pod:2600
22830 " lvremove device\n"
22835 #: ../fish/guestfish-actions.pod:2608
22840 #: ../fish/guestfish-actions.pod:2610
22843 " lvrename logvol newlogvol\n"
22848 #: ../fish/guestfish-actions.pod:2614
22853 #: ../fish/guestfish-actions.pod:2616
22856 " lvresize device mbytes\n"
22861 #: ../fish/guestfish-actions.pod:2622
22862 msgid "lvresize-free"
22866 #: ../fish/guestfish-actions.pod:2624
22869 " lvresize-free lv percent\n"
22874 #: ../fish/guestfish-actions.pod:2632
22879 #: ../fish/guestfish-actions.pod:2634
22887 #: ../fish/guestfish-actions.pod:2642
22888 msgid "See also L</lvs-full>, L</list-filesystems>."
22892 #: ../fish/guestfish-actions.pod:2644
22897 #: ../fish/guestfish-actions.pod:2646
22905 #: ../fish/guestfish-actions.pod:2651
22910 #: ../fish/guestfish-actions.pod:2653
22918 #: ../fish/guestfish-actions.pod:2657
22923 #: ../fish/guestfish-actions.pod:2659
22926 " lxattrlist path 'names ...'\n"
22931 #: ../fish/guestfish-actions.pod:2675
22933 "This call is intended for programs that want to efficiently list a directory "
22934 "contents without making many round-trips. See also L</lstatlist> for a "
22935 "similarly efficient call for getting standard stats. Very long directory "
22936 "listings might cause the protocol message size to be exceeded, causing this "
22937 "call to fail. The caller must split up such requests into smaller groups of "
22942 #: ../fish/guestfish-actions.pod:2683
22947 #: ../fish/guestfish-actions.pod:2685
22955 #: ../fish/guestfish-actions.pod:2689
22960 #: ../fish/guestfish-actions.pod:2691
22963 " mkdir-mode path mode\n"
22968 #: ../fish/guestfish-actions.pod:2700
22969 msgid "See also L</mkdir>, L</umask>"
22973 #: ../fish/guestfish-actions.pod:2702
22978 #: ../fish/guestfish-actions.pod:2704
22986 #: ../fish/guestfish-actions.pod:2709
22991 #: ../fish/guestfish-actions.pod:2711
22994 " mkdtemp template\n"
22999 #: ../fish/guestfish-actions.pod:2732
23004 #: ../fish/guestfish-actions.pod:2734
23007 " mke2fs-J fstype blocksize device journal\n"
23012 #: ../fish/guestfish-actions.pod:2742
23013 msgid "See also L</mke2journal>."
23017 #: ../fish/guestfish-actions.pod:2744
23022 #: ../fish/guestfish-actions.pod:2746
23025 " mke2fs-JL fstype blocksize device label\n"
23030 #: ../fish/guestfish-actions.pod:2751
23031 msgid "See also L</mke2journal-L>."
23035 #: ../fish/guestfish-actions.pod:2753
23040 #: ../fish/guestfish-actions.pod:2755
23043 " mke2fs-JU fstype blocksize device uuid\n"
23048 #: ../fish/guestfish-actions.pod:2760
23049 msgid "See also L</mke2journal-U>."
23053 #: ../fish/guestfish-actions.pod:2762
23054 msgid "mke2journal"
23058 #: ../fish/guestfish-actions.pod:2764
23061 " mke2journal blocksize device\n"
23066 #: ../fish/guestfish-actions.pod:2771
23067 msgid "mke2journal-L"
23071 #: ../fish/guestfish-actions.pod:2773
23074 " mke2journal-L blocksize label device\n"
23079 #: ../fish/guestfish-actions.pod:2777
23080 msgid "mke2journal-U"
23084 #: ../fish/guestfish-actions.pod:2779
23087 " mke2journal-U blocksize uuid device\n"
23092 #: ../fish/guestfish-actions.pod:2783
23097 #: ../fish/guestfish-actions.pod:2785
23100 " mkfifo mode path\n"
23105 #: ../fish/guestfish-actions.pod:2787
23107 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
23108 "is just a convenient wrapper around L</mknod>."
23112 #: ../fish/guestfish-actions.pod:2793
23117 #: ../fish/guestfish-actions.pod:2795
23120 " mkfs fstype device\n"
23125 #: ../fish/guestfish-actions.pod:2801
23130 #: ../fish/guestfish-actions.pod:2803
23133 " mkfs-b fstype blocksize device\n"
23138 #: ../fish/guestfish-actions.pod:2805
23140 "This call is similar to L</mkfs>, but it allows you to control the block "
23141 "size of the resulting filesystem. Supported block sizes depend on the "
23142 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
23146 #: ../fish/guestfish-actions.pod:2820
23151 #: ../fish/guestfish-actions.pod:2822
23154 " mkfs-opts fstype device [blocksize:..]\n"
23159 #: ../fish/guestfish-actions.pod:2844
23160 msgid "mkmountpoint"
23164 #: ../fish/guestfish-actions.pod:2846
23167 " mkmountpoint exemptpath\n"
23172 #: ../fish/guestfish-actions.pod:2848
23174 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
23175 "to create extra mountpoints before mounting the first filesystem."
23179 #: ../fish/guestfish-actions.pod:2872
23181 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
23182 "unexpected errors if you try to mix these calls. It is safest to manually "
23183 "unmount filesystems and remove mountpoints after use."
23187 #: ../fish/guestfish-actions.pod:2876
23189 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
23190 "for this to work for manual mountpoints, you must ensure that the innermost "
23191 "mountpoints have the longest pathnames, as in the example code above."
23195 #: ../fish/guestfish-actions.pod:2883
23197 "Autosync [see L</set-autosync>, this is set by default on handles] means "
23198 "that L</umount-all> is called when the handle is closed which can also "
23199 "trigger these issues."
23203 #: ../fish/guestfish-actions.pod:2887
23208 #: ../fish/guestfish-actions.pod:2889
23211 " mknod mode devmajor devminor path\n"
23216 #: ../fish/guestfish-actions.pod:2899
23218 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
23219 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
23220 "regular file). These constants are available in the standard Linux header "
23221 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
23222 "wrappers around this command which bitwise OR in the appropriate constant "
23227 #: ../fish/guestfish-actions.pod:2909
23232 #: ../fish/guestfish-actions.pod:2911
23235 " mknod-b mode devmajor devminor path\n"
23240 #: ../fish/guestfish-actions.pod:2913
23242 "This call creates a block device node called C<path> with mode C<mode> and "
23243 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23244 "wrapper around L</mknod>."
23248 #: ../fish/guestfish-actions.pod:2919
23253 #: ../fish/guestfish-actions.pod:2921
23256 " mknod-c mode devmajor devminor path\n"
23261 #: ../fish/guestfish-actions.pod:2923
23263 "This call creates a char device node called C<path> with mode C<mode> and "
23264 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
23265 "wrapper around L</mknod>."
23269 #: ../fish/guestfish-actions.pod:2929
23274 #: ../fish/guestfish-actions.pod:2931
23282 #: ../fish/guestfish-actions.pod:2935
23287 #: ../fish/guestfish-actions.pod:2937
23290 " mkswap-L label device\n"
23295 #: ../fish/guestfish-actions.pod:2945
23300 #: ../fish/guestfish-actions.pod:2947
23303 " mkswap-U uuid device\n"
23308 #: ../fish/guestfish-actions.pod:2951
23309 msgid "mkswap-file"
23313 #: ../fish/guestfish-actions.pod:2953
23316 " mkswap-file path\n"
23321 #: ../fish/guestfish-actions.pod:2957
23323 "This command just writes a swap file signature to an existing file. To "
23324 "create the file itself, use something like L</fallocate>."
23328 #: ../fish/guestfish-actions.pod:2960
23333 #: ../fish/guestfish-actions.pod:2962
23336 " modprobe modulename\n"
23341 #: ../fish/guestfish-actions.pod:2969
23346 #: ../fish/guestfish-actions.pod:2971
23349 " mount device mountpoint\n"
23354 #: ../fish/guestfish-actions.pod:2987
23356 "B<Important note:> When you use this call, the filesystem options C<sync> "
23357 "and C<noatime> are set implicitly. This was originally done because we "
23358 "thought it would improve reliability, but it turns out that I<-o sync> has a "
23359 "very large negative performance impact and negligible effect on "
23360 "reliability. Therefore we recommend that you avoid using L</mount> in any "
23361 "code that needs performance, and instead use L</mount-options> (use an empty "
23362 "string for the first parameter if you don't want any options)."
23366 #: ../fish/guestfish-actions.pod:2997
23371 #: ../fish/guestfish-actions.pod:2999
23374 " mount-loop file mountpoint\n"
23379 #: ../fish/guestfish-actions.pod:3005
23380 msgid "mount-options"
23384 #: ../fish/guestfish-actions.pod:3007
23387 " mount-options options device mountpoint\n"
23392 #: ../fish/guestfish-actions.pod:3009
23394 "This is the same as the L</mount> command, but it allows you to set the "
23395 "mount options as for the L<mount(8)> I<-o> flag."
23399 #: ../fish/guestfish-actions.pod:3017
23404 #: ../fish/guestfish-actions.pod:3019
23407 " mount-ro device mountpoint\n"
23412 #: ../fish/guestfish-actions.pod:3021
23414 "This is the same as the L</mount> command, but it mounts the filesystem with "
23415 "the read-only (I<-o ro>) flag."
23419 #: ../fish/guestfish-actions.pod:3024
23424 #: ../fish/guestfish-actions.pod:3026
23427 " mount-vfs options vfstype device mountpoint\n"
23432 #: ../fish/guestfish-actions.pod:3028
23434 "This is the same as the L</mount> command, but it allows you to set both the "
23435 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
23439 #: ../fish/guestfish-actions.pod:3032
23440 msgid "mountpoints"
23444 #: ../fish/guestfish-actions.pod:3034
23452 #: ../fish/guestfish-actions.pod:3036
23454 "This call is similar to L</mounts>. That call returns a list of devices. "
23455 "This one returns a hash table (map) of device name to directory where the "
23456 "device is mounted."
23460 #: ../fish/guestfish-actions.pod:3040
23465 #: ../fish/guestfish-actions.pod:3042
23473 #: ../fish/guestfish-actions.pod:3049
23474 msgid "See also: L</mountpoints>"
23478 #: ../fish/guestfish-actions.pod:3051
23483 #: ../fish/guestfish-actions.pod:3053
23491 #: ../fish/guestfish-actions.pod:3058
23492 msgid "ntfs-3g-probe"
23496 #: ../fish/guestfish-actions.pod:3060
23499 " ntfs-3g-probe true|false device\n"
23504 #: ../fish/guestfish-actions.pod:3074
23509 #: ../fish/guestfish-actions.pod:3076
23512 " ntfsresize device\n"
23517 #: ../fish/guestfish-actions.pod:3082
23518 msgid "ntfsresize-size"
23522 #: ../fish/guestfish-actions.pod:3084
23525 " ntfsresize-size device size\n"
23530 #: ../fish/guestfish-actions.pod:3086
23532 "This command is the same as L</ntfsresize> except that it allows you to "
23533 "specify the new size (in bytes) explicitly."
23537 #: ../fish/guestfish-actions.pod:3089
23542 #: ../fish/guestfish-actions.pod:3091
23545 " part-add device prlogex startsect endsect\n"
23550 #: ../fish/guestfish-actions.pod:3093
23552 "This command adds a partition to C<device>. If there is no partition table "
23553 "on the device, call L</part-init> first."
23557 #: ../fish/guestfish-actions.pod:3105
23559 "Creating a partition which covers the whole disk is not so easy. Use "
23560 "L</part-disk> to do that."
23564 #: ../fish/guestfish-actions.pod:3108
23569 #: ../fish/guestfish-actions.pod:3110
23572 " part-del device partnum\n"
23577 #: ../fish/guestfish-actions.pod:3118
23582 #: ../fish/guestfish-actions.pod:3120
23585 " part-disk device parttype\n"
23590 #: ../fish/guestfish-actions.pod:3122
23592 "This command is simply a combination of L</part-init> followed by "
23593 "L</part-add> to create a single primary partition covering the whole disk."
23597 #: ../fish/guestfish-actions.pod:3126
23599 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
23600 "possible values are described in L</part-init>."
23604 #: ../fish/guestfish-actions.pod:3132
23605 msgid "part-get-bootable"
23609 #: ../fish/guestfish-actions.pod:3134
23612 " part-get-bootable device partnum\n"
23617 #: ../fish/guestfish-actions.pod:3139
23618 msgid "See also L</part-set-bootable>."
23622 #: ../fish/guestfish-actions.pod:3141
23623 msgid "part-get-mbr-id"
23627 #: ../fish/guestfish-actions.pod:3143
23630 " part-get-mbr-id device partnum\n"
23635 #: ../fish/guestfish-actions.pod:3148 ../fish/guestfish-actions.pod:3286
23637 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
23638 "undefined results for other partition table types (see "
23639 "L</part-get-parttype>)."
23643 #: ../fish/guestfish-actions.pod:3152
23644 msgid "part-get-parttype"
23648 #: ../fish/guestfish-actions.pod:3154
23651 " part-get-parttype device\n"
23656 #: ../fish/guestfish-actions.pod:3159
23658 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
23659 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
23660 "possible, although unusual. See L</part-init> for a full list."
23664 #: ../fish/guestfish-actions.pod:3164
23669 #: ../fish/guestfish-actions.pod:3166
23672 " part-init device parttype\n"
23677 #: ../fish/guestfish-actions.pod:3172
23679 "Initially there are no partitions. Following this, you should call "
23680 "L</part-add> for each partition required."
23684 #: ../fish/guestfish-actions.pod:3235
23689 #: ../fish/guestfish-actions.pod:3237
23692 " part-list device\n"
23697 #: ../fish/guestfish-actions.pod:3252
23699 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23700 "the device's sector size, see L</blockdev-getss>."
23704 #: ../fish/guestfish-actions.pod:3265
23705 msgid "part-set-bootable"
23709 #: ../fish/guestfish-actions.pod:3267
23712 " part-set-bootable device partnum true|false\n"
23717 #: ../fish/guestfish-actions.pod:3276
23718 msgid "part-set-mbr-id"
23722 #: ../fish/guestfish-actions.pod:3278
23725 " part-set-mbr-id device partnum idbyte\n"
23730 #: ../fish/guestfish-actions.pod:3290
23731 msgid "part-set-name"
23735 #: ../fish/guestfish-actions.pod:3292
23738 " part-set-name device partnum name\n"
23743 #: ../fish/guestfish-actions.pod:3300
23744 msgid "part-to-dev"
23748 #: ../fish/guestfish-actions.pod:3302
23751 " part-to-dev partition\n"
23756 #: ../fish/guestfish-actions.pod:3308
23758 "The named partition must exist, for example as a string returned from "
23759 "L</list-partitions>."
23763 #: ../fish/guestfish-actions.pod:3311
23764 msgid "ping-daemon"
23768 #: ../fish/guestfish-actions.pod:3313
23776 #: ../fish/guestfish-actions.pod:3320
23781 #: ../fish/guestfish-actions.pod:3322
23784 " pread path count offset\n"
23789 #: ../fish/guestfish-actions.pod:3330
23790 msgid "See also L</pwrite>, L</pread-device>."
23794 #: ../fish/guestfish-actions.pod:3335
23795 msgid "pread-device"
23799 #: ../fish/guestfish-actions.pod:3337
23802 " pread-device device count offset\n"
23807 #: ../fish/guestfish-actions.pod:3345
23808 msgid "See also L</pread>."
23812 #: ../fish/guestfish-actions.pod:3350
23817 #: ../fish/guestfish-actions.pod:3352
23820 " pvcreate device\n"
23825 #: ../fish/guestfish-actions.pod:3358
23830 #: ../fish/guestfish-actions.pod:3360
23833 " pvremove device\n"
23838 #: ../fish/guestfish-actions.pod:3369
23843 #: ../fish/guestfish-actions.pod:3371
23846 " pvresize device\n"
23851 #: ../fish/guestfish-actions.pod:3376
23852 msgid "pvresize-size"
23856 #: ../fish/guestfish-actions.pod:3378
23859 " pvresize-size device size\n"
23864 #: ../fish/guestfish-actions.pod:3380
23866 "This command is the same as L</pvresize> except that it allows you to "
23867 "specify the new size (in bytes) explicitly."
23871 #: ../fish/guestfish-actions.pod:3383
23876 #: ../fish/guestfish-actions.pod:3385
23884 #: ../fish/guestfish-actions.pod:3393
23885 msgid "See also L</pvs-full>."
23889 #: ../fish/guestfish-actions.pod:3395
23894 #: ../fish/guestfish-actions.pod:3397
23902 #: ../fish/guestfish-actions.pod:3402
23907 #: ../fish/guestfish-actions.pod:3404
23915 #: ../fish/guestfish-actions.pod:3408
23920 #: ../fish/guestfish-actions.pod:3410
23923 " pwrite path content offset\n"
23928 #: ../fish/guestfish-actions.pod:3421
23929 msgid "See also L</pread>, L</pwrite-device>."
23933 #: ../fish/guestfish-actions.pod:3426
23934 msgid "pwrite-device"
23938 #: ../fish/guestfish-actions.pod:3428
23941 " pwrite-device device content offset\n"
23946 #: ../fish/guestfish-actions.pod:3438
23947 msgid "See also L</pwrite>."
23951 #: ../fish/guestfish-actions.pod:3443
23956 #: ../fish/guestfish-actions.pod:3445
23959 " read-file path\n"
23964 #: ../fish/guestfish-actions.pod:3450
23966 "Unlike L</cat>, this function can correctly handle files that contain "
23967 "embedded ASCII NUL characters. However unlike L</download>, this function "
23968 "is limited in the total size of file that can be handled."
23972 #: ../fish/guestfish-actions.pod:3458
23977 #: ../fish/guestfish-actions.pod:3460
23980 " read-lines path\n"
23985 #: ../fish/guestfish-actions.pod:3467
23987 "Note that this function cannot correctly handle binary files (specifically, "
23988 "files containing C<\\0> character which is treated as end of line). For "
23989 "those you need to use the L</read-file> function which has a more complex "
23994 #: ../fish/guestfish-actions.pod:3472
23999 #: ../fish/guestfish-actions.pod:3474
24007 #: ../fish/guestfish-actions.pod:3526
24009 "This function is primarily intended for use by programs. To get a simple "
24010 "list of names, use L</ls>. To get a printable directory for human "
24011 "consumption, use L</ll>."
24015 #: ../fish/guestfish-actions.pod:3530
24020 #: ../fish/guestfish-actions.pod:3532
24028 #: ../fish/guestfish-actions.pod:3536
24029 msgid "readlinklist"
24033 #: ../fish/guestfish-actions.pod:3538
24036 " readlinklist path 'names ...'\n"
24041 #: ../fish/guestfish-actions.pod:3562
24046 #: ../fish/guestfish-actions.pod:3564
24054 #: ../fish/guestfish-actions.pod:3569
24055 msgid "removexattr"
24059 #: ../fish/guestfish-actions.pod:3571
24062 " removexattr xattr path\n"
24067 #: ../fish/guestfish-actions.pod:3576
24068 msgid "See also: L</lremovexattr>, L<attr(5)>."
24072 #: ../fish/guestfish-actions.pod:3578
24077 #: ../fish/guestfish-actions.pod:3580
24080 " resize2fs device\n"
24085 #: ../fish/guestfish-actions.pod:3585
24087 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
24088 "before calling this command. For unknown reasons C<resize2fs> sometimes "
24089 "gives an error about this and sometimes not. In any case, it is always safe "
24090 "to call L</e2fsck-f> before calling this function."
24094 #: ../fish/guestfish-actions.pod:3591
24095 msgid "resize2fs-size"
24099 #: ../fish/guestfish-actions.pod:3593
24102 " resize2fs-size device size\n"
24107 #: ../fish/guestfish-actions.pod:3595
24109 "This command is the same as L</resize2fs> except that it allows you to "
24110 "specify the new size (in bytes) explicitly."
24114 #: ../fish/guestfish-actions.pod:3598
24119 #: ../fish/guestfish-actions.pod:3600
24127 #: ../fish/guestfish-actions.pod:3604
24132 #: ../fish/guestfish-actions.pod:3606
24140 #: ../fish/guestfish-actions.pod:3612
24145 #: ../fish/guestfish-actions.pod:3614
24153 #: ../fish/guestfish-actions.pod:3618
24154 msgid "rmmountpoint"
24158 #: ../fish/guestfish-actions.pod:3620
24161 " rmmountpoint exemptpath\n"
24166 #: ../fish/guestfish-actions.pod:3622
24168 "This calls removes a mountpoint that was previously created with "
24169 "L</mkmountpoint>. See L</mkmountpoint> for full details."
24173 #: ../fish/guestfish-actions.pod:3626
24174 msgid "scrub-device"
24178 #: ../fish/guestfish-actions.pod:3628
24181 " scrub-device device\n"
24186 #: ../fish/guestfish-actions.pod:3639
24191 #: ../fish/guestfish-actions.pod:3641
24194 " scrub-file file\n"
24199 #: ../fish/guestfish-actions.pod:3651
24200 msgid "scrub-freespace"
24204 #: ../fish/guestfish-actions.pod:3653
24207 " scrub-freespace dir\n"
24212 #: ../fish/guestfish-actions.pod:3655
24214 "This command creates the directory C<dir> and then fills it with files until "
24215 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
24216 "deletes them. The intention is to scrub any free space on the partition "
24217 "containing C<dir>."
24221 #: ../fish/guestfish-actions.pod:3664
24226 #: ../fish/guestfish-actions.pod:3666
24231 #: ../fish/guestfish-actions.pod:3668
24234 " set-append append\n"
24239 #: ../fish/guestfish-actions.pod:3679
24240 msgid "set-autosync"
24244 #: ../fish/guestfish-actions.pod:3681
24249 #: ../fish/guestfish-actions.pod:3683
24252 " set-autosync true|false\n"
24257 #: ../fish/guestfish-actions.pod:3685
24259 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
24260 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
24261 "closed (also if the program exits without closing handles)."
24265 #: ../fish/guestfish-actions.pod:3693
24270 #: ../fish/guestfish-actions.pod:3695
24275 #: ../fish/guestfish-actions.pod:3697
24278 " set-direct true|false\n"
24283 #: ../fish/guestfish-actions.pod:3703
24285 "One consequence of this is that log messages aren't caught by the library "
24286 "and handled by L</set-log-message-callback>, but go straight to stdout."
24290 #: ../fish/guestfish-actions.pod:3712
24291 msgid "set-e2label"
24295 #: ../fish/guestfish-actions.pod:3714
24298 " set-e2label device label\n"
24303 #: ../fish/guestfish-actions.pod:3720
24305 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
24306 "label on a filesystem."
24310 #: ../fish/guestfish-actions.pod:3723
24315 #: ../fish/guestfish-actions.pod:3725
24318 " set-e2uuid device uuid\n"
24323 #: ../fish/guestfish-actions.pod:3732
24325 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
24326 "UUID of a filesystem."
24330 #: ../fish/guestfish-actions.pod:3735
24331 msgid "set-memsize"
24335 #: ../fish/guestfish-actions.pod:3737
24340 #: ../fish/guestfish-actions.pod:3739
24343 " set-memsize memsize\n"
24348 #: ../fish/guestfish-actions.pod:3741
24350 "This sets the memory size in megabytes allocated to the qemu subprocess. "
24351 "This only has any effect if called before L</launch>."
24355 #: ../fish/guestfish-actions.pod:3752
24356 msgid "set-network"
24360 #: ../fish/guestfish-actions.pod:3754
24365 #: ../fish/guestfish-actions.pod:3756
24368 " set-network true|false\n"
24373 #: ../fish/guestfish-actions.pod:3764
24374 msgid "You must call this before calling L</launch>, otherwise it has no effect."
24378 #: ../fish/guestfish-actions.pod:3767
24383 #: ../fish/guestfish-actions.pod:3769
24388 #: ../fish/guestfish-actions.pod:3771
24391 " set-path searchpath\n"
24396 #: ../fish/guestfish-actions.pod:3780
24401 #: ../fish/guestfish-actions.pod:3782
24406 #: ../fish/guestfish-actions.pod:3784
24414 #: ../fish/guestfish-actions.pod:3804
24415 msgid "set-recovery-proc"
24419 #: ../fish/guestfish-actions.pod:3806
24420 msgid "recovery-proc"
24424 #: ../fish/guestfish-actions.pod:3808
24427 " set-recovery-proc true|false\n"
24432 #: ../fish/guestfish-actions.pod:3810
24434 "If this is called with the parameter C<false> then L</launch> does not "
24435 "create a recovery process. The purpose of the recovery process is to stop "
24436 "runaway qemu processes in the case where the main program aborts abruptly."
24440 #: ../fish/guestfish-actions.pod:3815
24442 "This only has any effect if called before L</launch>, and the default is "
24447 #: ../fish/guestfish-actions.pod:3824
24448 msgid "set-selinux"
24452 #: ../fish/guestfish-actions.pod:3826
24457 #: ../fish/guestfish-actions.pod:3828
24460 " set-selinux true|false\n"
24465 #: ../fish/guestfish-actions.pod:3839
24470 #: ../fish/guestfish-actions.pod:3841
24475 #: ../fish/guestfish-actions.pod:3843
24478 " set-trace true|false\n"
24483 #: ../fish/guestfish-actions.pod:3859
24484 msgid "set-verbose"
24488 #: ../fish/guestfish-actions.pod:3861
24493 #: ../fish/guestfish-actions.pod:3863
24496 " set-verbose true|false\n"
24501 #: ../fish/guestfish-actions.pod:3870
24506 #: ../fish/guestfish-actions.pod:3872
24509 " setcon context\n"
24514 #: ../fish/guestfish-actions.pod:3879
24519 #: ../fish/guestfish-actions.pod:3881
24522 " setxattr xattr val vallen path\n"
24527 #: ../fish/guestfish-actions.pod:3887
24528 msgid "See also: L</lsetxattr>, L<attr(5)>."
24532 #: ../fish/guestfish-actions.pod:3889
24537 #: ../fish/guestfish-actions.pod:3891
24540 " sfdisk device cyls heads sectors 'lines ...'\n"
24545 #: ../fish/guestfish-actions.pod:3913
24546 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
24550 #: ../fish/guestfish-actions.pod:3919
24555 #: ../fish/guestfish-actions.pod:3921
24558 " sfdiskM device 'lines ...'\n"
24563 #: ../fish/guestfish-actions.pod:3923
24565 "This is a simplified interface to the L</sfdisk> command, where partition "
24566 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
24567 "you don't need to specify the cyls, heads and sectors parameters which were "
24568 "rarely if ever used anyway."
24572 #: ../fish/guestfish-actions.pod:3929
24573 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
24577 #: ../fish/guestfish-actions.pod:3935
24582 #: ../fish/guestfish-actions.pod:3937
24585 " sfdisk-N device partnum cyls heads sectors line\n"
24590 #: ../fish/guestfish-actions.pod:3942
24592 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
24593 "cyls/heads/sectors parameters."
24597 #: ../fish/guestfish-actions.pod:3945
24598 msgid "See also: L</part-add>"
24602 #: ../fish/guestfish-actions.pod:3950
24603 msgid "sfdisk-disk-geometry"
24607 #: ../fish/guestfish-actions.pod:3952
24610 " sfdisk-disk-geometry device\n"
24615 #: ../fish/guestfish-actions.pod:3954
24617 "This displays the disk geometry of C<device> read from the partition table. "
24618 "Especially in the case where the underlying block device has been resized, "
24619 "this can be different from the kernel's idea of the geometry (see "
24620 "L</sfdisk-kernel-geometry>)."
24624 #: ../fish/guestfish-actions.pod:3962
24625 msgid "sfdisk-kernel-geometry"
24629 #: ../fish/guestfish-actions.pod:3964
24632 " sfdisk-kernel-geometry device\n"
24637 #: ../fish/guestfish-actions.pod:3971
24642 #: ../fish/guestfish-actions.pod:3973
24645 " sfdisk-l device\n"
24650 #: ../fish/guestfish-actions.pod:3979
24651 msgid "See also: L</part-list>"
24655 #: ../fish/guestfish-actions.pod:3981
24660 #: ../fish/guestfish-actions.pod:3983
24668 #: ../fish/guestfish-actions.pod:3988
24669 msgid "This is like L</command>, but passes the command to:"
24673 #: ../fish/guestfish-actions.pod:3996
24674 msgid "All the provisos about L</command> apply to this call."
24678 #: ../fish/guestfish-actions.pod:3998
24683 #: ../fish/guestfish-actions.pod:4000
24686 " sh-lines command\n"
24691 #: ../fish/guestfish-actions.pod:4002
24692 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24696 #: ../fish/guestfish-actions.pod:4005
24697 msgid "See also: L</command-lines>"
24701 #: ../fish/guestfish-actions.pod:4007
24706 #: ../fish/guestfish-actions.pod:4009
24714 #: ../fish/guestfish-actions.pod:4013
24719 #: ../fish/guestfish-actions.pod:4015
24727 #: ../fish/guestfish-actions.pod:4021
24732 #: ../fish/guestfish-actions.pod:4023
24740 #: ../fish/guestfish-actions.pod:4031
24745 #: ../fish/guestfish-actions.pod:4033
24753 #: ../fish/guestfish-actions.pod:4041
24758 #: ../fish/guestfish-actions.pod:4043
24761 " strings-e encoding path\n"
24766 #: ../fish/guestfish-actions.pod:4045
24768 "This is like the L</strings> command, but allows you to specify the encoding "
24769 "of strings that are looked for in the source file C<path>."
24773 #: ../fish/guestfish-actions.pod:4055
24775 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24776 "ISO-8859-X (this is what L</strings> uses)."
24780 #: ../fish/guestfish-actions.pod:4087
24781 msgid "swapoff-device"
24785 #: ../fish/guestfish-actions.pod:4089
24788 " swapoff-device device\n"
24793 #: ../fish/guestfish-actions.pod:4091
24795 "This command disables the libguestfs appliance swap device or partition "
24796 "named C<device>. See L</swapon-device>."
24800 #: ../fish/guestfish-actions.pod:4095
24801 msgid "swapoff-file"
24805 #: ../fish/guestfish-actions.pod:4097
24808 " swapoff-file file\n"
24813 #: ../fish/guestfish-actions.pod:4101
24814 msgid "swapoff-label"
24818 #: ../fish/guestfish-actions.pod:4103
24821 " swapoff-label label\n"
24826 #: ../fish/guestfish-actions.pod:4108
24827 msgid "swapoff-uuid"
24831 #: ../fish/guestfish-actions.pod:4110
24834 " swapoff-uuid uuid\n"
24839 #: ../fish/guestfish-actions.pod:4115
24840 msgid "swapon-device"
24844 #: ../fish/guestfish-actions.pod:4117
24847 " swapon-device device\n"
24852 #: ../fish/guestfish-actions.pod:4119
24854 "This command enables the libguestfs appliance to use the swap device or "
24855 "partition named C<device>. The increased memory is made available for all "
24856 "commands, for example those run using L</command> or L</sh>."
24860 #: ../fish/guestfish-actions.pod:4131
24861 msgid "swapon-file"
24865 #: ../fish/guestfish-actions.pod:4133
24868 " swapon-file file\n"
24873 #: ../fish/guestfish-actions.pod:4135
24874 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
24878 #: ../fish/guestfish-actions.pod:4138
24879 msgid "swapon-label"
24883 #: ../fish/guestfish-actions.pod:4140
24886 " swapon-label label\n"
24891 #: ../fish/guestfish-actions.pod:4142
24893 "This command enables swap to a labeled swap partition. See "
24894 "L</swapon-device> for other notes."
24898 #: ../fish/guestfish-actions.pod:4145
24899 msgid "swapon-uuid"
24903 #: ../fish/guestfish-actions.pod:4147
24906 " swapon-uuid uuid\n"
24911 #: ../fish/guestfish-actions.pod:4149
24913 "This command enables swap to a swap partition with the given UUID. See "
24914 "L</swapon-device> for other notes."
24918 #: ../fish/guestfish-actions.pod:4152
24923 #: ../fish/guestfish-actions.pod:4154
24931 #: ../fish/guestfish-actions.pod:4162
24936 #: ../fish/guestfish-actions.pod:4164
24944 #: ../fish/guestfish-actions.pod:4172
24949 #: ../fish/guestfish-actions.pod:4174
24952 " tail-n nrlines path\n"
24957 #: ../fish/guestfish-actions.pod:4187
24962 #: ../fish/guestfish-actions.pod:4189
24965 " tar-in (tarfile|-) directory\n"
24970 #: ../fish/guestfish-actions.pod:4194
24971 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24975 #: ../fish/guestfish-actions.pod:4199
24980 #: ../fish/guestfish-actions.pod:4201
24983 " tar-out directory (tarfile|-)\n"
24988 #: ../fish/guestfish-actions.pod:4206
24989 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24993 #: ../fish/guestfish-actions.pod:4211
24998 #: ../fish/guestfish-actions.pod:4213
25001 " tgz-in (tarball|-) directory\n"
25006 #: ../fish/guestfish-actions.pod:4218
25007 msgid "To upload an uncompressed tarball, use L</tar-in>."
25011 #: ../fish/guestfish-actions.pod:4222
25016 #: ../fish/guestfish-actions.pod:4224
25019 " tgz-out directory (tarball|-)\n"
25024 #: ../fish/guestfish-actions.pod:4229
25025 msgid "To download an uncompressed tarball, use L</tar-out>."
25029 #: ../fish/guestfish-actions.pod:4233
25034 #: ../fish/guestfish-actions.pod:4235
25042 #: ../fish/guestfish-actions.pod:4244
25047 #: ../fish/guestfish-actions.pod:4246
25055 #: ../fish/guestfish-actions.pod:4251
25056 msgid "truncate-size"
25060 #: ../fish/guestfish-actions.pod:4253
25063 " truncate-size path size\n"
25068 #: ../fish/guestfish-actions.pod:4258
25070 "If the current file size is less than C<size> then the file is extended to "
25071 "the required size with zero bytes. This creates a sparse file (ie. disk "
25072 "blocks are not allocated for the file until you write to it). To create a "
25073 "non-sparse file of zeroes, use L</fallocate64> instead."
25077 #: ../fish/guestfish-actions.pod:4264
25082 #: ../fish/guestfish-actions.pod:4266
25085 " tune2fs-l device\n"
25090 #: ../fish/guestfish-actions.pod:4276
25095 #: ../fish/guestfish-actions.pod:4278
25098 " txz-in (tarball|-) directory\n"
25103 #: ../fish/guestfish-actions.pod:4285
25108 #: ../fish/guestfish-actions.pod:4287
25111 " txz-out directory (tarball|-)\n"
25116 #: ../fish/guestfish-actions.pod:4294
25121 #: ../fish/guestfish-actions.pod:4296
25129 #: ../fish/guestfish-actions.pod:4310
25130 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
25134 #: ../fish/guestfish-actions.pod:4315
25139 #: ../fish/guestfish-actions.pod:4317
25144 #: ../fish/guestfish-actions.pod:4319
25147 " umount pathordevice\n"
25152 #: ../fish/guestfish-actions.pod:4325
25157 #: ../fish/guestfish-actions.pod:4327
25158 msgid "unmount-all"
25162 #: ../fish/guestfish-actions.pod:4329
25170 #: ../fish/guestfish-actions.pod:4335
25175 #: ../fish/guestfish-actions.pod:4337
25178 " upload (filename|-) remotefilename\n"
25183 #: ../fish/guestfish-actions.pod:4344
25184 msgid "See also L</download>."
25188 #: ../fish/guestfish-actions.pod:4348
25189 msgid "upload-offset"
25193 #: ../fish/guestfish-actions.pod:4350
25196 " upload-offset (filename|-) remotefilename offset\n"
25201 #: ../fish/guestfish-actions.pod:4362
25203 "Note that there is no limit on the amount of data that can be uploaded with "
25204 "this call, unlike with L</pwrite>, and this call always writes the full "
25205 "amount unless an error occurs."
25209 #: ../fish/guestfish-actions.pod:4367
25210 msgid "See also L</upload>, L</pwrite>."
25214 #: ../fish/guestfish-actions.pod:4371
25219 #: ../fish/guestfish-actions.pod:4373
25222 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
25227 #: ../fish/guestfish-actions.pod:4392
25232 #: ../fish/guestfish-actions.pod:4394
25240 #: ../fish/guestfish-actions.pod:4421
25242 "I<Note:> Don't use this call to test for availability of features. In "
25243 "enterprise distributions we backport features from later versions into "
25244 "earlier versions, making this an unreliable way to test for features. Use "
25245 "L</available> instead."
25249 #: ../fish/guestfish-actions.pod:4427
25254 #: ../fish/guestfish-actions.pod:4429
25257 " vfs-label device\n"
25262 #: ../fish/guestfish-actions.pod:4436
25263 msgid "To find a filesystem from the label, use L</findfs-label>."
25267 #: ../fish/guestfish-actions.pod:4438
25272 #: ../fish/guestfish-actions.pod:4440
25275 " vfs-type device\n"
25280 #: ../fish/guestfish-actions.pod:4450
25285 #: ../fish/guestfish-actions.pod:4452
25288 " vfs-uuid device\n"
25293 #: ../fish/guestfish-actions.pod:4459
25294 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
25298 #: ../fish/guestfish-actions.pod:4461
25299 msgid "vg-activate"
25303 #: ../fish/guestfish-actions.pod:4463
25306 " vg-activate true|false 'volgroups ...'\n"
25311 #: ../fish/guestfish-actions.pod:4476
25312 msgid "vg-activate-all"
25316 #: ../fish/guestfish-actions.pod:4478
25319 " vg-activate-all true|false\n"
25324 #: ../fish/guestfish-actions.pod:4488
25329 #: ../fish/guestfish-actions.pod:4490
25332 " vgcreate volgroup 'physvols ...'\n"
25337 #: ../fish/guestfish-actions.pod:4495
25342 #: ../fish/guestfish-actions.pod:4497
25345 " vglvuuids vgname\n"
25350 #: ../fish/guestfish-actions.pod:4502
25352 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
25353 "logical volumes and volume groups."
25357 #: ../fish/guestfish-actions.pod:4505
25358 msgid "See also L</vgpvuuids>."
25362 #: ../fish/guestfish-actions.pod:4507
25367 #: ../fish/guestfish-actions.pod:4509
25370 " vgpvuuids vgname\n"
25375 #: ../fish/guestfish-actions.pod:4514
25377 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
25378 "physical volumes and volume groups."
25382 #: ../fish/guestfish-actions.pod:4517
25383 msgid "See also L</vglvuuids>."
25387 #: ../fish/guestfish-actions.pod:4519
25392 #: ../fish/guestfish-actions.pod:4521
25395 " vgremove vgname\n"
25400 #: ../fish/guestfish-actions.pod:4528
25405 #: ../fish/guestfish-actions.pod:4530
25408 " vgrename volgroup newvolgroup\n"
25413 #: ../fish/guestfish-actions.pod:4534
25418 #: ../fish/guestfish-actions.pod:4536
25426 #: ../fish/guestfish-actions.pod:4544
25427 msgid "See also L</vgs-full>."
25431 #: ../fish/guestfish-actions.pod:4546
25436 #: ../fish/guestfish-actions.pod:4548
25444 #: ../fish/guestfish-actions.pod:4553
25449 #: ../fish/guestfish-actions.pod:4555
25457 #: ../fish/guestfish-actions.pod:4560
25462 #: ../fish/guestfish-actions.pod:4562
25470 #: ../fish/guestfish-actions.pod:4566
25475 #: ../fish/guestfish-actions.pod:4568
25483 #: ../fish/guestfish-actions.pod:4573
25488 #: ../fish/guestfish-actions.pod:4575
25496 #: ../fish/guestfish-actions.pod:4580
25501 #: ../fish/guestfish-actions.pod:4582
25509 #: ../fish/guestfish-actions.pod:4587
25514 #: ../fish/guestfish-actions.pod:4589
25517 " write path content\n"
25522 #: ../fish/guestfish-actions.pod:4597
25527 #: ../fish/guestfish-actions.pod:4599
25530 " write-file path content size\n"
25535 #: ../fish/guestfish-actions.pod:4622
25540 #: ../fish/guestfish-actions.pod:4624
25543 " zegrep regex path\n"
25548 #: ../fish/guestfish-actions.pod:4632
25553 #: ../fish/guestfish-actions.pod:4634
25556 " zegrepi regex path\n"
25561 #: ../fish/guestfish-actions.pod:4642
25566 #: ../fish/guestfish-actions.pod:4644
25574 #: ../fish/guestfish-actions.pod:4652
25575 msgid "See also: L</zero-device>, L</scrub-device>."
25579 #: ../fish/guestfish-actions.pod:4654
25580 msgid "zero-device"
25584 #: ../fish/guestfish-actions.pod:4656
25587 " zero-device device\n"
25592 #: ../fish/guestfish-actions.pod:4658
25594 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
25595 "which just zeroes the first few blocks of a device."
25599 #: ../fish/guestfish-actions.pod:4665
25604 #: ../fish/guestfish-actions.pod:4667
25607 " zerofree device\n"
25612 #: ../fish/guestfish-actions.pod:4680
25617 #: ../fish/guestfish-actions.pod:4682
25620 " zfgrep pattern path\n"
25625 #: ../fish/guestfish-actions.pod:4690
25630 #: ../fish/guestfish-actions.pod:4692
25633 " zfgrepi pattern path\n"
25638 #: ../fish/guestfish-actions.pod:4700
25643 #: ../fish/guestfish-actions.pod:4702
25646 " zfile meth path\n"
25651 #: ../fish/guestfish-actions.pod:4709
25652 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
25656 #: ../fish/guestfish-actions.pod:4719
25661 #: ../fish/guestfish-actions.pod:4721
25664 " zgrep regex path\n"
25669 #: ../fish/guestfish-actions.pod:4729
25674 #: ../fish/guestfish-actions.pod:4731
25677 " zgrepi regex path\n"
25682 #: ../fish/guestfish-commands.pod:1
25687 #: ../fish/guestfish-commands.pod:3
25692 #: ../fish/guestfish-commands.pod:5
25695 " alloc filename size\n"
25700 #: ../fish/guestfish-commands.pod:7
25702 "This creates an empty (zeroed) file of the given size, and then adds so it "
25703 "can be further examined."
25707 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25708 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25712 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25713 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25717 #: ../fish/guestfish-commands.pod:14
25719 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25720 "image, see L</PREPARED DISK IMAGES>."
25724 #: ../fish/guestfish-commands.pod:17
25729 #: ../fish/guestfish-commands.pod:19
25732 " copy-in local [local ...] /remotedir\n"
25737 #: ../fish/guestfish-commands.pod:21
25739 "C<copy-in> copies local files or directories recursively into the disk "
25740 "image, placing them in the directory called C</remotedir> (which must "
25741 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25742 "other commands as necessary."
25746 #: ../fish/guestfish-commands.pod:26
25748 "Multiple local files and directories can be specified, but the last "
25749 "parameter must always be a remote directory. Wildcards cannot be used."
25753 #: ../fish/guestfish-commands.pod:30
25758 #: ../fish/guestfish-commands.pod:32
25761 " copy-out remote [remote ...] localdir\n"
25766 #: ../fish/guestfish-commands.pod:34
25768 "C<copy-out> copies remote files or directories recursively out of the disk "
25769 "image, placing them on the host disk in a local directory called C<localdir> "
25770 "(which must exist). This guestfish meta-command turns into a sequence of "
25771 "L</download>, L</tar-out> and other commands as necessary."
25775 #: ../fish/guestfish-commands.pod:40
25777 "Multiple remote files and directories can be specified, but the last "
25778 "parameter must always be a local directory. To download to the current "
25779 "directory, use C<.> as in:"
25783 #: ../fish/guestfish-commands.pod:44
25786 " copy-out /home .\n"
25791 #: ../fish/guestfish-commands.pod:46
25793 "Wildcards cannot be used in the ordinary command, but you can use them with "
25794 "the help of L</glob> like this:"
25798 #: ../fish/guestfish-commands.pod:49
25801 " glob copy-out /home/* .\n"
25806 #: ../fish/guestfish-commands.pod:51
25811 #: ../fish/guestfish-commands.pod:53
25814 " echo [params ...]\n"
25819 #: ../fish/guestfish-commands.pod:55
25820 msgid "This echos the parameters to the terminal."
25824 #: ../fish/guestfish-commands.pod:57
25829 #: ../fish/guestfish-commands.pod:59
25834 #: ../fish/guestfish-commands.pod:61
25839 #: ../fish/guestfish-commands.pod:63
25847 #: ../fish/guestfish-commands.pod:65
25849 "This is used to edit a file. It downloads the file, edits it locally using "
25850 "your editor, then uploads the result."
25854 #: ../fish/guestfish-commands.pod:68
25856 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25857 "or C<emacs> you will get those corresponding editors."
25861 #: ../fish/guestfish-commands.pod:72
25866 #: ../fish/guestfish-commands.pod:74
25869 " glob command args...\n"
25874 #: ../fish/guestfish-commands.pod:76
25876 "Expand wildcards in any paths in the args list, and run C<command> "
25877 "repeatedly on each matching path."
25881 #: ../fish/guestfish-commands.pod:79
25882 msgid "See L</WILDCARDS AND GLOBBING>."
25886 #: ../fish/guestfish-commands.pod:81
25891 #: ../fish/guestfish-commands.pod:83
25894 " hexedit <filename|device>\n"
25895 " hexedit <filename|device> <max>\n"
25896 " hexedit <filename|device> <start> <max>\n"
25901 #: ../fish/guestfish-commands.pod:87
25903 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25908 #: ../fish/guestfish-commands.pod:90
25910 "This command works by downloading potentially the whole file or device, "
25911 "editing it locally, then uploading it. If the file or device is large, you "
25912 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25913 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25914 "usual modifiers allowed such as C<1M> (1 megabyte)."
25918 #: ../fish/guestfish-commands.pod:97
25919 msgid "For example to edit the first few sectors of a disk you might do:"
25923 #: ../fish/guestfish-commands.pod:100
25926 " hexedit /dev/sda 1M\n"
25931 #: ../fish/guestfish-commands.pod:102
25933 "which would allow you to edit anywhere within the first megabyte of the "
25938 #: ../fish/guestfish-commands.pod:105
25939 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25943 #: ../fish/guestfish-commands.pod:107
25946 " hexedit /dev/sda1 0x400 0x400\n"
25951 #: ../fish/guestfish-commands.pod:109
25952 msgid "(assuming the superblock is in the standard location)."
25956 #: ../fish/guestfish-commands.pod:111
25958 "This command requires the external L<hexedit(1)> program. You can specify "
25959 "another program to use by setting the C<HEXEDITOR> environment variable."
25963 #: ../fish/guestfish-commands.pod:115
25964 msgid "See also L</hexdump>."
25968 #: ../fish/guestfish-commands.pod:117
25973 #: ../fish/guestfish-commands.pod:119
25981 #: ../fish/guestfish-commands.pod:121
25982 msgid "Change the local directory, ie. the current directory of guestfish itself."
25986 #: ../fish/guestfish-commands.pod:124
25987 msgid "Note that C<!cd> won't do what you might expect."
25991 #: ../fish/guestfish-commands.pod:126
25996 #: ../fish/guestfish-commands.pod:128
26001 #: ../fish/guestfish-commands.pod:130
26009 #: ../fish/guestfish-commands.pod:132
26010 msgid "Opens the manual page for guestfish."
26014 #: ../fish/guestfish-commands.pod:134
26019 #: ../fish/guestfish-commands.pod:136
26024 #: ../fish/guestfish-commands.pod:138
26032 #: ../fish/guestfish-commands.pod:140
26040 #: ../fish/guestfish-commands.pod:142
26041 msgid "This is used to view a file."
26045 #: ../fish/guestfish-commands.pod:144
26047 "The default viewer is C<$PAGER>. However if you use the alternate command "
26048 "C<less> you will get the C<less> command specifically."
26052 #: ../fish/guestfish-commands.pod:147
26057 #: ../fish/guestfish-commands.pod:149
26065 #: ../fish/guestfish-commands.pod:151
26067 "Close and reopen the libguestfs handle. It is not necessary to use this "
26068 "normally, because the handle is closed properly when guestfish exits. "
26069 "However this is occasionally useful for testing."
26073 #: ../fish/guestfish-commands.pod:155
26078 #: ../fish/guestfish-commands.pod:157
26081 " sparse filename size\n"
26086 #: ../fish/guestfish-commands.pod:159
26088 "This creates an empty sparse file of the given size, and then adds so it can "
26089 "be further examined."
26093 #: ../fish/guestfish-commands.pod:162
26095 "In all respects it works the same as the L</alloc> command, except that the "
26096 "image file is allocated sparsely, which means that disk blocks are not "
26097 "assigned to the file until they are needed. Sparse disk files only use "
26098 "space when written to, but they are slower and there is a danger you could "
26099 "run out of real disk space during a write operation."
26103 #: ../fish/guestfish-commands.pod:172
26108 #: ../fish/guestfish-commands.pod:174
26116 #: ../fish/guestfish-commands.pod:176
26118 "This command returns a list of the optional groups known to the daemon, and "
26119 "indicates which ones are supported by this build of the libguestfs "
26124 #: ../fish/guestfish-commands.pod:180
26125 msgid "See also L<guestfs(3)/AVAILABILITY>."
26129 #: ../fish/guestfish-commands.pod:182
26134 #: ../fish/guestfish-commands.pod:184
26137 " time command args...\n"
26142 #: ../fish/guestfish-commands.pod:186
26144 "Run the command as usual, but print the elapsed time afterwards. This can "
26145 "be useful for benchmarking operations."
26149 #: ../test-tool/libguestfs-test-tool.pod:5
26150 msgid "libguestfs-test-tool - End user tests for libguestfs"
26154 #: ../test-tool/libguestfs-test-tool.pod:9
26157 " libguestfs-test-tool [--options]\n"
26162 #: ../test-tool/libguestfs-test-tool.pod:13
26164 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
26165 "and developers, to allow them to check basic libguestfs functionality is "
26166 "working. This is needed because libguestfs occasionally breaks for reasons "
26167 "beyond our control: usually because of changes in the underlying qemu or "
26168 "kernel packages, or the host environment."
26172 #: ../test-tool/libguestfs-test-tool.pod:20
26173 msgid "If you suspect a problem in libguestfs, then just run:"
26177 #: ../test-tool/libguestfs-test-tool.pod:22
26180 " libguestfs-test-tool\n"
26185 #: ../test-tool/libguestfs-test-tool.pod:24
26186 msgid "It will print lots of diagnostic messages."
26190 #: ../test-tool/libguestfs-test-tool.pod:26
26191 msgid "If it runs to completion successfully, you will see this near the end:"
26195 #: ../test-tool/libguestfs-test-tool.pod:28
26198 " ===== TEST FINISHED OK =====\n"
26203 #: ../test-tool/libguestfs-test-tool.pod:30
26204 msgid "and the test tool will exit with code 0."
26208 #: ../test-tool/libguestfs-test-tool.pod:32
26210 "If it fails (and/or exits with non-zero error code), please paste the "
26211 "B<complete, unedited> output of the test tool into a bug report. More "
26212 "information about reporting bugs can be found on the "
26213 "L<http://libguestfs.org/> website."
26217 #: ../test-tool/libguestfs-test-tool.pod:41
26222 #: ../test-tool/libguestfs-test-tool.pod:43
26223 msgid "Display short usage information and exit."
26227 #: ../test-tool/libguestfs-test-tool.pod:45
26228 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
26232 #: ../test-tool/libguestfs-test-tool.pod:47
26234 "Pass an alternate name for the helper program. libguestfs-test-tool will "
26235 "normally look in the C<$libexec> directory that was configured when the tool "
26240 #: ../test-tool/libguestfs-test-tool.pod:51
26241 msgid "I<--qemu qemu_binary>"
26245 #: ../test-tool/libguestfs-test-tool.pod:53
26247 "If you have downloaded another qemu binary, point this option at the full "
26248 "path of the binary to try it."
26252 #: ../test-tool/libguestfs-test-tool.pod:56
26253 msgid "I<--qemudir qemu_source_dir>"
26257 #: ../test-tool/libguestfs-test-tool.pod:58
26259 "If you have compiled qemu from source, point this option at the source "
26260 "directory to try it."
26264 #: ../test-tool/libguestfs-test-tool.pod:61
26265 msgid "I<--timeout N>"
26269 #: ../test-tool/libguestfs-test-tool.pod:63
26271 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
26272 "does not usually need to be adjusted unless your machine is very slow."
26276 #: ../test-tool/libguestfs-test-tool.pod:69
26277 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
26281 #: ../test-tool/libguestfs-test-tool.pod:71
26283 "If you have compiled another version of qemu from source and would like to "
26284 "try that, then you can use the I<--qemudir> option to point to the qemu "
26285 "source directory."
26289 #: ../test-tool/libguestfs-test-tool.pod:75
26291 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
26292 "option to point to the binary."
26296 #: ../test-tool/libguestfs-test-tool.pod:78
26298 "When using an alternate qemu with libguestfs, usually you would need to "
26299 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
26300 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
26301 "when you use either of the I<--qemudir> or I<--qemu> options."
26305 #: ../test-tool/libguestfs-test-tool.pod:85
26307 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
26308 "I<1> if there was an error."
26312 #: ../test-tool/libguestfs-test-tool.pod:92
26313 msgid "/usr/libexec/libguestfs-test-tool-helper"
26317 #: ../test-tool/libguestfs-test-tool.pod:94
26319 "This helper program is run inside the appliance and provides additional "
26324 #: ../test-tool/libguestfs-test-tool.pod:97
26325 msgid "/usr/bin/mkisofs"
26329 #: ../test-tool/libguestfs-test-tool.pod:99
26331 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
26332 "which is used as part of the tests."
26336 #: ../test-tool/libguestfs-test-tool.pod:106
26338 "For the full list of environment variables which may affect libguestfs, "
26339 "please see the L<guestfs(3)> manual page."
26343 #: ../test-tool/libguestfs-test-tool.pod:111
26344 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
26348 #: ../test-tool/libguestfs-test-tool.pod:121
26349 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
26353 #: ../fuse/guestmount.pod:5
26354 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
26358 #: ../fuse/guestmount.pod:9
26361 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
26366 #: ../fuse/guestmount.pod:11
26369 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
26374 #: ../fuse/guestmount.pod:13
26377 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
26382 #: ../fuse/guestmount.pod:17
26384 "You must I<not> use C<guestmount> in read-write mode on live virtual "
26385 "machines. If you do this, you risk disk corruption in the VM."
26389 #: ../fuse/guestmount.pod:22
26391 "The guestmount program can be used to mount virtual machine filesystems and "
26392 "other disk images on the host. It uses libguestfs for access to the guest "
26393 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
26394 "a mountable device."
26398 #: ../fuse/guestmount.pod:27
26400 "Along with other options, you have to give at least one device (I<-a> "
26401 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
26402 "option) or use the I<-i> inspection option. How this works is better "
26403 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
26408 #: ../fuse/guestmount.pod:33
26410 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
26411 "by you, and the filesystem will not be visible to any other users unless you "
26412 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
26413 "the filesystem, use the C<fusermount -u> command."
26417 #: ../fuse/guestmount.pod:41
26419 "For a typical Windows guest which has its main filesystem on the first "
26424 #: ../fuse/guestmount.pod:44
26427 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
26432 #: ../fuse/guestmount.pod:46
26434 "For a typical Linux guest which has a /boot filesystem on the first "
26435 "partition, and the root filesystem on a logical volume:"
26439 #: ../fuse/guestmount.pod:49
26442 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
26447 #: ../fuse/guestmount.pod:51
26448 msgid "To get libguestfs to detect guest mountpoints for you:"
26452 #: ../fuse/guestmount.pod:53
26455 " guestmount -a guest.img -i --ro /mnt\n"
26460 #: ../fuse/guestmount.pod:55
26461 msgid "For a libvirt guest called \"Guest\" you could do:"
26465 #: ../fuse/guestmount.pod:57
26468 " guestmount -d Guest -i --ro /mnt\n"
26473 #: ../fuse/guestmount.pod:59
26475 "If you don't know what filesystems are contained in a guest or disk image, "
26476 "use L<virt-filesystems(1)> first:"
26480 #: ../fuse/guestmount.pod:62
26483 " virt-filesystems MyGuest\n"
26488 #: ../fuse/guestmount.pod:64
26490 "If you want to trace the libguestfs calls but without excessive debugging "
26491 "information, we recommend:"
26495 #: ../fuse/guestmount.pod:67
26498 " guestmount [...] --trace /mnt\n"
26503 #: ../fuse/guestmount.pod:69
26504 msgid "If you want to debug the program, we recommend:"
26508 #: ../fuse/guestmount.pod:71
26511 " guestmount [...] --trace --verbose /mnt\n"
26516 #: ../fuse/guestmount.pod:77
26517 msgid "B<-a image> | B<--add image>"
26521 #: ../fuse/guestmount.pod:79
26522 msgid "Add a block device or virtual machine image."
26526 #: ../fuse/guestmount.pod:84
26527 msgid "B<-c URI> | B<--connect URI>"
26531 #: ../fuse/guestmount.pod:90
26532 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
26536 #: ../fuse/guestmount.pod:96
26537 msgid "B<--dir-cache-timeout N>"
26541 #: ../fuse/guestmount.pod:98
26543 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
26544 "seconds. The readdir cache [actually, there are several semi-independent "
26545 "caches] is populated after a readdir(2) call with the stat and extended "
26546 "attributes of the files in the directory, in anticipation that they will be "
26547 "requested soon after."
26551 #: ../fuse/guestmount.pod:104
26553 "There is also a different attribute cache implemented by FUSE (see the FUSE "
26554 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
26555 "requests, only cache existing ones."
26559 #: ../fuse/guestmount.pod:115
26560 msgid "B<--format=raw|qcow2|..> | B<--format>"
26564 #: ../fuse/guestmount.pod:122
26566 "If you have untrusted raw-format guest disk images, you should use this "
26567 "option to specify the disk format. This avoids a possible security problem "
26568 "with malicious guests (CVE-2010-3851). See also "
26569 "L<guestfs(3)/guestfs_add_drive_opts>."
26573 #: ../fuse/guestmount.pod:127
26574 msgid "B<--fuse-help>"
26578 #: ../fuse/guestmount.pod:129
26579 msgid "Display help on special FUSE options (see I<-o> below)."
26583 #: ../fuse/guestmount.pod:133
26584 msgid "Display brief help and exit."
26588 #: ../fuse/guestmount.pod:135
26589 msgid "B<-i> | B<--inspector>"
26593 #: ../fuse/guestmount.pod:146
26594 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
26598 #: ../fuse/guestmount.pod:148
26600 "Mount the named partition or logical volume on the given mountpoint B<in the "
26601 "guest> (this has nothing to do with mountpoints in the host)."
26605 #: ../fuse/guestmount.pod:151
26607 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
26608 "something on C</>."
26612 #: ../fuse/guestmount.pod:154
26613 msgid "B<-n> | B<--no-sync>"
26617 #: ../fuse/guestmount.pod:156
26619 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
26620 "unmounted. If you specify this option, then we don't attempt to sync the "
26621 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
26625 #: ../fuse/guestmount.pod:161
26626 msgid "B<-o option> | B<--option option>"
26630 #: ../fuse/guestmount.pod:163
26631 msgid "Pass extra options to FUSE."
26635 #: ../fuse/guestmount.pod:165
26637 "To get a list of all the extra options supported by FUSE, use the command "
26638 "below. Note that only the FUSE I<-o> options can be passed, and only some "
26639 "of them are a good idea."
26643 #: ../fuse/guestmount.pod:169
26646 " guestmount --fuse-help\n"
26651 #: ../fuse/guestmount.pod:171
26652 msgid "Some potentially useful FUSE options:"
26656 #: ../fuse/guestmount.pod:175
26657 msgid "B<-o allow_other>"
26661 #: ../fuse/guestmount.pod:177
26662 msgid "Allow other users to see the filesystem."
26666 #: ../fuse/guestmount.pod:179
26667 msgid "B<-o attr_timeout=N>"
26671 #: ../fuse/guestmount.pod:181
26672 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
26676 #: ../fuse/guestmount.pod:183
26677 msgid "B<-o kernel_cache>"
26681 #: ../fuse/guestmount.pod:185
26683 "Allow the kernel to cache files (reduces the number of reads that have to go "
26684 "through the L<guestfs(3)> API). This is generally a good idea if you can "
26685 "afford the extra memory usage."
26689 #: ../fuse/guestmount.pod:189
26690 msgid "B<-o uid=N> B<-o gid=N>"
26694 #: ../fuse/guestmount.pod:191
26696 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
26697 "the chosen values."
26701 #: ../fuse/guestmount.pod:196
26702 msgid "B<-r> | B<--ro>"
26706 #: ../fuse/guestmount.pod:198
26708 "Add devices and mount everything read-only. Also disallow writes and make "
26709 "the disk appear read-only to FUSE."
26713 #: ../fuse/guestmount.pod:201
26715 "This is highly recommended if you are not going to edit the guest disk. If "
26716 "the guest is running and this option is I<not> supplied, then there is a "
26717 "strong risk of disk corruption in the guest. We try to prevent this from "
26718 "happening, but it is not always possible."
26722 #: ../fuse/guestmount.pod:206
26723 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26727 #: ../fuse/guestmount.pod:210
26728 msgid "Enable SELinux support for the guest."
26732 #: ../fuse/guestmount.pod:212
26733 msgid "B<-v> | B<--verbose>"
26737 #: ../fuse/guestmount.pod:214
26738 msgid "Enable verbose messages from underlying libguestfs."
26742 #: ../fuse/guestmount.pod:216
26743 msgid "B<-V> | B<--version>"
26747 #: ../fuse/guestmount.pod:218
26748 msgid "Display the program version and exit."
26752 #: ../fuse/guestmount.pod:220
26753 msgid "B<-w> | B<--rw>"
26757 #: ../fuse/guestmount.pod:222
26759 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26760 "FOR READ AND WRITE>."
26764 #: ../fuse/guestmount.pod:225
26765 msgid "B<-x> | B<--trace>"
26769 #: ../fuse/guestmount.pod:227
26770 msgid "Trace libguestfs calls and entry into each FUSE function."
26774 #: ../fuse/guestmount.pod:229
26775 msgid "This also stops the daemon from forking into the background."
26779 #: ../fuse/guestmount.pod:235
26781 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26782 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
26783 "L<http://fuse.sf.net/>."
26787 #: ../tools/virt-edit.pl:34
26788 msgid "virt-edit - Edit a file in a virtual machine"
26792 #: ../tools/virt-edit.pl:38
26795 " virt-edit [--options] domname file\n"
26800 #: ../tools/virt-edit.pl:40
26803 " virt-edit [--options] disk.img [disk.img ...] file\n"
26808 #: ../tools/virt-edit.pl:42
26811 " virt-edit [domname|disk.img] file -e 'expr'\n"
26816 #: ../tools/virt-edit.pl:46
26818 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26819 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26820 "doing this, but doesn't catch all cases."
26824 #: ../tools/virt-edit.pl:52
26826 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26827 "the named virtual machine (or disk image)."
26831 #: ../tools/virt-edit.pl:55
26833 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
26834 "you should look at the L<guestfish(1)> tool."
26838 #: ../tools/virt-edit.pl:60
26839 msgid "Edit the named files interactively:"
26843 #: ../tools/virt-edit.pl:62
26846 " virt-edit mydomain /boot/grub/grub.conf\n"
26851 #: ../tools/virt-edit.pl:64
26854 " virt-edit mydomain /etc/passwd\n"
26859 #: ../tools/virt-edit.pl:66
26861 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26862 "below). To change the init default level to 5:"
26866 #: ../tools/virt-edit.pl:70
26869 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26874 #: ../tools/virt-edit.pl:82 ../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
26875 msgid "Display brief help."
26879 #: ../tools/virt-edit.pl:90 ../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
26880 msgid "Display version number and exit."
26884 #: ../tools/virt-edit.pl:96
26885 msgid "B<--backup extension> | B<-b extension>"
26889 #: ../tools/virt-edit.pl:98
26891 "Create a backup of the original file I<in the guest disk image>. The backup "
26892 "has the original filename with C<extension> added."
26896 #: ../tools/virt-edit.pl:101
26898 "Usually the first character of C<extension> would be a dot C<.> so you would "
26903 #: ../tools/virt-edit.pl:104
26906 " virt-edit -b .orig [etc]\n"
26911 #: ../tools/virt-edit.pl:106
26912 msgid "By default, no backup file is made."
26916 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122 ../tools/virt-list-partitions.pl:78
26917 msgid "B<--connect URI> | B<-c URI>"
26921 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124 ../tools/virt-list-partitions.pl:80
26923 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26924 "to the default libvirt hypervisor."
26928 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:83
26930 "If you specify guest block devices directly, then libvirt is not used at "
26935 #: ../tools/virt-edit.pl:124 ../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
26936 msgid "B<--format> raw"
26940 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136 ../tools/virt-list-partitions.pl:92
26942 "Specify the format of disk images given on the command line. If this is "
26943 "omitted then the format is autodetected from the content of the disk image."
26947 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140 ../tools/virt-list-partitions.pl:96
26949 "If disk images are requested from libvirt, then this program asks libvirt "
26950 "for this information. In this case, the value of the format parameter is "
26955 #: ../tools/virt-edit.pl:134 ../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
26957 "If working with untrusted raw-format guest disk images, you should ensure "
26958 "the format is always specified."
26962 #: ../tools/virt-edit.pl:141
26963 msgid "B<--expr EXPR> | B<-e EXPR>"
26967 #: ../tools/virt-edit.pl:143
26969 "Instead of launching the external editor, non-interactively apply the Perl "
26970 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26975 #: ../tools/virt-edit.pl:147
26977 "Be careful to properly quote the expression to prevent it from being altered "
26982 #: ../tools/virt-edit.pl:268
26983 msgid "NON-INTERACTIVE EDITING"
26987 #: ../tools/virt-edit.pl:270
26989 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26990 "administrator can interactively edit the file."
26994 #: ../tools/virt-edit.pl:273
26996 "There are two ways also to use C<virt-edit> from scripts in order to make "
26997 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26998 "like this, it's less error-prone to write scripts directly using the "
26999 "libguestfs API and Augeas for configuration file editing.)"
27003 #: ../tools/virt-edit.pl:279
27005 "The first method is to temporarily set C<$EDITOR> to any script or program "
27006 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
27007 "update C<tmpfile> in place however it likes."
27011 #: ../tools/virt-edit.pl:283
27013 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
27014 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
27015 "instances of C<foo> with C<bar> in a file:"
27019 #: ../tools/virt-edit.pl:287
27022 " virt-edit domname filename -e 's/foo/bar/'\n"
27027 #: ../tools/virt-edit.pl:289
27029 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
27030 "For example to delete root's password you could do:"
27034 #: ../tools/virt-edit.pl:292
27037 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
27042 #: ../tools/virt-edit.pl:294
27044 "What really happens is that the snippet is evaluated as a Perl expression "
27045 "for each line of the file. The line, including the final C<\\n>, is passed "
27046 "in C<$_> and the expression should update C<$_> or leave it unchanged."
27050 #: ../tools/virt-edit.pl:299
27052 "To delete a line, set C<$_> to the empty string. For example, to delete the "
27053 "C<apache> user account from the password file you can do:"
27057 #: ../tools/virt-edit.pl:302
27060 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
27065 #: ../tools/virt-edit.pl:304
27067 "To insert a line, prepend or append it to C<$_>. However appending lines to "
27068 "the end of the file is rather difficult this way since there is no concept "
27069 "of \"last line of the file\" - your expression just doesn't get called "
27070 "again. You might want to use the first method (setting C<$EDITOR>) if you "
27075 #: ../tools/virt-edit.pl:310
27077 "The variable C<$lineno> contains the current line number. As is "
27078 "traditional, the first line in the file is number C<1>."
27082 #: ../tools/virt-edit.pl:313
27084 "The return value from the expression is ignored, but the expression may call "
27085 "C<die> in order to abort the whole program, leaving the original file "
27090 #: ../tools/virt-edit.pl:317
27092 "Remember when matching the end of a line that C<$_> may contain the final "
27093 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
27094 "newline then neither of these. Thus to match or substitute some text at the "
27095 "end of a line, use this regular expression:"
27099 #: ../tools/virt-edit.pl:322
27102 " /some text(\\r?\\n)?$/\n"
27107 #: ../tools/virt-edit.pl:324
27109 "Alternately, use the perl C<chomp> function, being careful not to chomp "
27110 "C<$_> itself (since that would remove all newlines from the file):"
27114 #: ../tools/virt-edit.pl:328
27117 " my $m = $_; chomp $m; $m =~ /some text$/\n"
27122 #: ../tools/virt-edit.pl:334
27127 #: ../tools/virt-edit.pl:336
27129 "If set, this string is used as the editor. It may contain arguments, "
27130 "eg. C<\"emacs -nw\">"
27134 #: ../tools/virt-edit.pl:339
27135 msgid "If not set, C<vi> is used."
27139 #: ../tools/virt-edit.pl:343 ../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:527 ../tools/virt-list-partitions.pl:250
27140 msgid "SHELL QUOTING"
27144 #: ../tools/virt-edit.pl:345 ../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:529 ../tools/virt-list-partitions.pl:252
27146 "Libvirt guest names can contain arbitrary characters, some of which have "
27147 "meaning to the shell such as C<#> and space. You may need to quote or "
27148 "escape these characters on the command line. See the shell manual page "
27149 "L<sh(1)> for details."
27153 #: ../tools/virt-edit.pl:352
27155 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27156 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
27157 "L<perl(1)>, L<perlre(1)>."
27161 #: ../tools/virt-edit.pl:362 ../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:559 ../tools/virt-list-partitions.pl:269
27166 #: ../tools/virt-edit.pl:364 ../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:561 ../tools/virt-list-partitions.pl:271
27167 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
27171 #: ../tools/virt-edit.pl:368 ../tools/virt-list-partitions.pl:275
27172 msgid "Copyright (C) 2009-2010 Red Hat Inc."
27176 #: ../tools/virt-win-reg.pl:37
27178 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
27183 #: ../tools/virt-win-reg.pl:41
27186 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
27191 #: ../tools/virt-win-reg.pl:43
27194 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
27199 #: ../tools/virt-win-reg.pl:45
27202 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
27207 #: ../tools/virt-win-reg.pl:47
27210 " virt-win-reg --merge domname [input.reg ...]\n"
27215 #: ../tools/virt-win-reg.pl:49
27218 " virt-win-reg [--options] disk.img ... # instead of domname\n"
27223 #: ../tools/virt-win-reg.pl:53
27225 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
27226 "virtual machines. If you do this, you I<will> get irreversible disk "
27227 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
27228 "but doesn't catch all cases."
27232 #: ../tools/virt-win-reg.pl:58
27234 "Modifying the Windows Registry is an inherently risky operation. The format "
27235 "is deliberately obscure and undocumented, and Registry changes can leave the "
27236 "system unbootable. Therefore when using the C<--merge> option, make sure "
27237 "you have a reliable backup first."
27241 #: ../tools/virt-win-reg.pl:65
27243 "This program can export and merge Windows Registry entries from a Windows "
27248 #: ../tools/virt-win-reg.pl:68
27250 "The first parameter is the libvirt guest name or the raw disk image of a "
27255 #: ../tools/virt-win-reg.pl:71
27257 "If C<--merge> is I<not> specified, then the chosen registry key is "
27258 "displayed/exported (recursively). For example:"
27262 #: ../tools/virt-win-reg.pl:74
27265 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
27270 #: ../tools/virt-win-reg.pl:76
27271 msgid "You can also display single values from within registry keys, for example:"
27275 #: ../tools/virt-win-reg.pl:79
27278 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
27279 " $ virt-win-reg Windows7 $cvkey ProductName\n"
27280 " Windows 7 Enterprise\n"
27285 #: ../tools/virt-win-reg.pl:83
27287 "With C<--merge>, you can merge a textual regedit file into the Windows "
27292 #: ../tools/virt-win-reg.pl:86
27295 " $ virt-win-reg --merge Windows7 changes.reg\n"
27300 #: ../tools/virt-win-reg.pl:88
27305 #: ../tools/virt-win-reg.pl:90
27307 "This program is only meant for simple access to the registry. If you want "
27308 "to do complicated things with the registry, we suggest you download the "
27309 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
27310 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
27311 "L<hivexregedit(1)>."
27315 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
27320 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
27321 msgid "Enable debugging messages."
27325 #: ../tools/virt-win-reg.pl:157
27330 #: ../tools/virt-win-reg.pl:159
27332 "In merge mode, this merges a textual regedit file into the Windows Registry "
27333 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
27334 "displays or exports Registry entries instead."
27338 #: ../tools/virt-win-reg.pl:163
27340 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
27341 "result in disk corruption. However exporting (without this flag) is always "
27346 #: ../tools/virt-win-reg.pl:171
27347 msgid "B<--encoding> UTF-16LE|ASCII"
27351 #: ../tools/virt-win-reg.pl:173
27353 "When merging (only), you may need to specify the encoding for strings to be "
27354 "used in the hive file. This is explained in detail in "
27355 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
27359 #: ../tools/virt-win-reg.pl:177
27361 "The default is to use UTF-16LE, which should work with recent versions of "
27366 #: ../tools/virt-win-reg.pl:402
27367 msgid "SUPPORTED SYSTEMS"
27371 #: ../tools/virt-win-reg.pl:404
27373 "The program currently supports Windows NT-derived guests starting with "
27374 "Windows XP through to at least Windows 7."
27378 #: ../tools/virt-win-reg.pl:407
27380 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
27381 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
27382 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
27386 #: ../tools/virt-win-reg.pl:411
27388 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
27393 #: ../tools/virt-win-reg.pl:414
27395 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
27400 #: ../tools/virt-win-reg.pl:417
27405 #: ../tools/virt-win-reg.pl:419
27407 "C<virt-win-reg> expects that regedit files have already been reencoded in "
27408 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
27409 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
27410 "with Windows-style line endings, you may need to reencode the whole file "
27411 "before or after processing."
27415 #: ../tools/virt-win-reg.pl:425
27417 "To reencode a file from Windows format to Linux (before processing it with "
27418 "the C<--merge> option), you would do something like this:"
27422 #: ../tools/virt-win-reg.pl:428
27425 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
27430 #: ../tools/virt-win-reg.pl:430
27432 "To go in the opposite direction, after exporting and before sending the file "
27433 "to a Windows user, do something like this:"
27437 #: ../tools/virt-win-reg.pl:433
27440 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
27445 #: ../tools/virt-win-reg.pl:435
27446 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
27450 #: ../tools/virt-win-reg.pl:437
27452 "If you are unsure about the current encoding, use the L<file(1)> command. "
27453 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
27454 "Windows-style (CRLF) line endings, like this:"
27458 #: ../tools/virt-win-reg.pl:441
27461 " $ file software.reg\n"
27462 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
27463 " with CRLF line terminators\n"
27468 #: ../tools/virt-win-reg.pl:445
27469 msgid "This file would need conversion before you could C<--merge> it."
27473 #: ../tools/virt-win-reg.pl:447
27474 msgid "CurrentControlSet etc."
27478 #: ../tools/virt-win-reg.pl:449
27480 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
27481 "Registry at the level of the hive file, and therefore you cannot modify "
27486 #: ../tools/virt-win-reg.pl:453
27488 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
27489 "circumstances it might refer to another control set. The way to find out is "
27490 "to look at the C<HKLM\\SYSTEM\\Select> key:"
27494 #: ../tools/virt-win-reg.pl:457
27497 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
27498 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
27499 " \"Current\"=dword:00000001\n"
27500 " \"Default\"=dword:00000001\n"
27501 " \"Failed\"=dword:00000000\n"
27502 " \"LastKnownGood\"=dword:00000002\n"
27507 #: ../tools/virt-win-reg.pl:464
27508 msgid "\"Current\" is the one which Windows will choose when it boots."
27512 #: ../tools/virt-win-reg.pl:466
27513 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
27517 #: ../tools/virt-win-reg.pl:469
27518 msgid "WINDOWS TIPS"
27522 #: ../tools/virt-win-reg.pl:471
27524 "Note that some of these tips modify the guest disk image. The guest I<must> "
27525 "be shut off, else you will get disk corruption."
27529 #: ../tools/virt-win-reg.pl:474
27530 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
27534 #: ../tools/virt-win-reg.pl:476
27536 "Prepare a DOS batch script, VBScript or executable. Upload this using "
27537 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
27538 "is uploaded into C<C:\\>:"
27542 #: ../tools/virt-win-reg.pl:480
27545 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
27550 #: ../tools/virt-win-reg.pl:482
27551 msgid "Prepare a regedit file containing the registry change:"
27555 #: ../tools/virt-win-reg.pl:484
27558 " cat > test.reg <<'EOF'\n"
27559 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
27560 " \"Test\"=\"c:\\\\test.bat\"\n"
27566 #: ../tools/virt-win-reg.pl:489
27568 "In this example we use the key C<RunOnce> which means that the script will "
27569 "run precisely once when the first user logs in. If you want it to run every "
27570 "time a user logs in, replace C<RunOnce> with C<Run>."
27574 #: ../tools/virt-win-reg.pl:493
27575 msgid "Now update the registry:"
27579 #: ../tools/virt-win-reg.pl:495
27582 " virt-win-reg --merge WindowsGuest test.reg\n"
27587 #: ../tools/virt-win-reg.pl:497
27588 msgid "INSTALLING A SERVICE"
27592 #: ../tools/virt-win-reg.pl:499
27594 "This section assumes you are familiar with Windows services, and you either "
27595 "have a program which handles the Windows Service Control Protocol directly "
27596 "or you want to run any program using a service wrapper like SrvAny or the "
27601 #: ../tools/virt-win-reg.pl:504
27603 "First upload the program and optionally the service wrapper. In this case "
27604 "the test program is called C<test.exe> and we are using the RHSrvAny "
27609 #: ../tools/virt-win-reg.pl:508
27612 " guestfish -i -d WindowsGuest <<EOF\n"
27613 " upload rhsrvany.exe /rhsrvany.exe\n"
27614 " upload test.exe /test.exe\n"
27620 #: ../tools/virt-win-reg.pl:513
27622 "Prepare a regedit file containing the registry changes. In this example, "
27623 "the first registry change is needed for the service itself or the service "
27624 "wrapper (if used). The second registry change is only needed because I am "
27625 "using the RHSrvAny service wrapper."
27629 #: ../tools/virt-win-reg.pl:518
27632 " cat > service.reg <<'EOF'\n"
27633 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
27634 " \"Type\"=dword:00000010\n"
27635 " \"Start\"=dword:00000002\n"
27636 " \"ErrorControl\"=dword:00000001\n"
27637 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
27638 " \"DisplayName\"=\"RHSrvAny\"\n"
27639 " \"ObjectName\"=\"NetworkService\"\n"
27644 #: ../tools/virt-win-reg.pl:527
27647 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
27648 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
27649 " \"PWD\"=\"c:\\\\Temp\"\n"
27655 #: ../tools/virt-win-reg.pl:538
27657 "For use of C<ControlSet001> see the section above in this manual page. You "
27658 "may need to adjust this according to the control set that is in use by the "
27663 #: ../tools/virt-win-reg.pl:544
27665 "C<\"ObjectName\"> controls the privileges that the service will have. An "
27666 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
27667 "privileged account."
27671 #: ../tools/virt-win-reg.pl:550
27673 "For the meaning of the magic numbers, see this Microsoft KB article: "
27674 "L<http://support.microsoft.com/kb/103000>."
27678 #: ../tools/virt-win-reg.pl:555
27679 msgid "Update the registry:"
27683 #: ../tools/virt-win-reg.pl:557
27686 " virt-win-reg --merge WindowsGuest service.reg\n"
27691 #: ../tools/virt-win-reg.pl:561
27693 "Be careful when passing parameters containing C<\\> (backslash) in the "
27694 "shell. Usually you will have to use 'single quotes' or double backslashes "
27695 "(but not both) to protect them from the shell."
27699 #: ../tools/virt-win-reg.pl:565
27700 msgid "Paths and value names are case-insensitive."
27704 #: ../tools/virt-win-reg.pl:574
27706 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
27707 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27708 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
27709 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27713 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:550
27715 "When reporting bugs, please enable debugging and capture the I<complete> "
27720 #: ../tools/virt-win-reg.pl:592
27723 " export LIBGUESTFS_DEBUG=1\n"
27724 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
27729 #: ../tools/virt-win-reg.pl:595
27731 "Attach /tmp/virt-win-reg.log to a new bug report at "
27732 "L<https://bugzilla.redhat.com/>"
27736 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:565
27737 msgid "Copyright (C) 2010 Red Hat Inc."
27741 #: ../tools/virt-resize.pl:42
27742 msgid "virt-resize - Resize a virtual machine disk"
27746 #: ../tools/virt-resize.pl:46
27749 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27750 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27751 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27756 #: ../tools/virt-resize.pl:52
27758 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27759 "larger or smaller overall, and resizing or deleting any partitions contained "
27764 #: ../tools/virt-resize.pl:56
27766 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27767 "not> be used on live virtual machines - for consistent results, shut the "
27768 "virtual machine down before resizing it."
27772 #: ../tools/virt-resize.pl:60
27774 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
27775 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
27779 #: ../tools/virt-resize.pl:66
27781 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27782 "fill the extra 5GB of space."
27786 #: ../tools/virt-resize.pl:69
27789 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27790 " virt-filesystems --long -h --all -a olddisk\n"
27791 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27792 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27797 #: ../tools/virt-resize.pl:74
27799 "As above, but make the /boot partition 200MB bigger, while giving the "
27800 "remaining space to /dev/sda2:"
27804 #: ../tools/virt-resize.pl:77
27807 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
27812 #: ../tools/virt-resize.pl:79
27813 msgid "As above, but the output format will be uncompressed qcow2:"
27817 #: ../tools/virt-resize.pl:81
27820 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
27821 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
27826 #: ../tools/virt-resize.pl:84
27827 msgid "DETAILED USAGE"
27831 #: ../tools/virt-resize.pl:86
27832 msgid "EXPANDING A VIRTUAL MACHINE DISK"
27836 #: ../tools/virt-resize.pl:90
27837 msgid "1. Shut down the virtual machine"
27841 #: ../tools/virt-resize.pl:92
27842 msgid "2. Locate input disk image"
27846 #: ../tools/virt-resize.pl:94
27848 "Locate the input disk image (ie. the file or device on the host containing "
27849 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27850 "dumpxml> like this to find the disk image name:"
27854 #: ../tools/virt-resize.pl:98
27857 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27858 " Found 1 nodes:\n"
27860 " <source dev=\"/dev/vg/lv_guest\" />\n"
27865 #: ../tools/virt-resize.pl:103
27866 msgid "3. Look at current sizing"
27870 #: ../tools/virt-resize.pl:105
27871 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
27875 #: ../tools/virt-resize.pl:108
27878 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
27879 " Name Type Size Parent\n"
27880 " /dev/sda1 partition 101M /dev/sda\n"
27881 " /dev/sda2 partition 7.9G /dev/sda\n"
27882 " /dev/sda device 8.0G -\n"
27887 #: ../tools/virt-resize.pl:114
27889 "(This example is a virtual machine with an 8 GB disk which we would like to "
27890 "expand up to 10 GB)."
27894 #: ../tools/virt-resize.pl:117
27895 msgid "4. Create output disk"
27899 #: ../tools/virt-resize.pl:119
27901 "Virt-resize cannot do in-place disk modifications. You have to have space "
27902 "to store the resized output disk."
27906 #: ../tools/virt-resize.pl:122
27907 msgid "To store the resized disk image in a file, create a file of a suitable size:"
27911 #: ../tools/virt-resize.pl:125
27914 " # rm -f outdisk\n"
27915 " # truncate -s 10G outdisk\n"
27920 #: ../tools/virt-resize.pl:128
27921 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27925 #: ../tools/virt-resize.pl:130
27928 " # lvcreate -L 10G -n lv_name vg_name\n"
27933 #: ../tools/virt-resize.pl:132
27934 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27938 #: ../tools/virt-resize.pl:134
27941 " # virsh pool-list\n"
27942 " # virsh vol-create-as poolname newvol 10G\n"
27947 #: ../tools/virt-resize.pl:137
27952 #: ../tools/virt-resize.pl:139
27954 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27955 "file) and the output disk. The output disk is the one created in the "
27960 #: ../tools/virt-resize.pl:143
27963 " # virt-resize indisk outdisk\n"
27968 #: ../tools/virt-resize.pl:145
27970 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27971 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27972 "larger, then an extra, empty partition is created at the end of the disk "
27973 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27978 #: ../tools/virt-resize.pl:151
27980 "More realistically you'd want to expand existing partitions in the disk "
27981 "image by passing extra options (for the full list see the L</OPTIONS> "
27986 #: ../tools/virt-resize.pl:155
27988 "L</--expand> is the most useful option. It expands the named partition "
27989 "within the disk to fill any extra space:"
27993 #: ../tools/virt-resize.pl:158
27996 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
28001 #: ../tools/virt-resize.pl:160
28003 "(In this case, an extra partition is I<not> created at the end of the disk, "
28004 "because there will be no unused space)."
28008 #: ../tools/virt-resize.pl:163
28010 "L</--resize> is the other commonly used option. The following would "
28011 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
28012 "rest of the available space:"
28016 #: ../tools/virt-resize.pl:167
28019 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
28020 " indisk outdisk\n"
28025 #: ../tools/virt-resize.pl:170
28027 "If the expanded partition in the image contains a filesystem or LVM PV, then "
28028 "if virt-resize knows how, it will resize the contents, the equivalent of "
28029 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
28030 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
28031 "filesystems, so you would have to online resize them after booting the "
28036 #: ../tools/virt-resize.pl:177
28037 msgid "Other options are covered below."
28041 #: ../tools/virt-resize.pl:179
28046 #: ../tools/virt-resize.pl:181
28047 msgid "Thoroughly test the new disk image I<before> discarding the old one."
28051 #: ../tools/virt-resize.pl:183
28052 msgid "If you are using libvirt, edit the XML to point at the new disk:"
28056 #: ../tools/virt-resize.pl:185
28059 " # virsh edit guestname\n"
28064 #: ../tools/virt-resize.pl:187
28066 "Change E<lt>source ...E<gt>, see "
28067 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
28071 #: ../tools/virt-resize.pl:190
28072 msgid "Then start up the domain with the new, resized disk:"
28076 #: ../tools/virt-resize.pl:192
28079 " # virsh start guestname\n"
28084 #: ../tools/virt-resize.pl:194
28086 "and check that it still works. See also the L</NOTES> section below for "
28087 "additional information."
28091 #: ../tools/virt-resize.pl:197
28092 msgid "7. Resize LVs etc inside the guest"
28096 #: ../tools/virt-resize.pl:199
28097 msgid "(This can also be done offline using L<guestfish(1)>)"
28101 #: ../tools/virt-resize.pl:201
28103 "Once the guest has booted you should see the new space available, at least "
28104 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
28105 "may need to resize LVs inside PVs, and also resize filesystem types that "
28106 "virt-resize does not know how to expand."
28110 #: ../tools/virt-resize.pl:208
28111 msgid "SHRINKING A VIRTUAL MACHINE DISK"
28115 #: ../tools/virt-resize.pl:210
28117 "Shrinking is somewhat more complex than expanding, and only an overview is "
28122 #: ../tools/virt-resize.pl:213
28124 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
28125 "filesystems). The user has to shrink content before passing the disk image "
28126 "to virt-resize, and virt-resize will check that the content has been shrunk "
28131 #: ../tools/virt-resize.pl:218
28132 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
28136 #: ../tools/virt-resize.pl:220
28138 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
28139 "steps 3 and 4 above to allocate a new disk image."
28143 #: ../tools/virt-resize.pl:223
28144 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
28148 #: ../tools/virt-resize.pl:226
28149 msgid "IGNORING OR DELETING PARTITIONS"
28153 #: ../tools/virt-resize.pl:228
28155 "virt-resize also gives a convenient way to ignore or delete partitions when "
28156 "copying from the input disk to the output disk. Ignoring a partition speeds "
28157 "up the copy where you don't care about the existing contents of a "
28158 "partition. Deleting a partition removes it completely, but note that it "
28159 "also renumbers any partitions after the one which is deleted, which can "
28160 "leave some guests unbootable."
28164 #: ../tools/virt-resize.pl:235
28165 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
28169 #: ../tools/virt-resize.pl:237
28171 "If the input disk is in qcow2 format, then you may prefer that the output is "
28172 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
28173 "the fly. The output format is simply determined by the format of the empty "
28174 "output container that you provide. Thus to create qcow2 output, use:"
28178 #: ../tools/virt-resize.pl:243
28181 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
28186 #: ../tools/virt-resize.pl:245
28187 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
28191 #: ../tools/virt-resize.pl:247
28192 msgid "Similarly, to get non-sparse raw output use:"
28196 #: ../tools/virt-resize.pl:249
28199 " fallocate -l size outdisk\n"
28204 #: ../tools/virt-resize.pl:251
28206 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
28207 "if=/dev/zero of=outdisk bs=1M count=..>)"
28211 #: ../tools/virt-resize.pl:264
28212 msgid "Display help."
28216 #: ../tools/virt-resize.pl:278
28217 msgid "B<--resize part=size>"
28221 #: ../tools/virt-resize.pl:280
28223 "Resize the named partition (expanding or shrinking it) so that it has the "
28228 #: ../tools/virt-resize.pl:283
28230 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
28231 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
28232 "Exabytes; or as a percentage of the current size; or as a relative number or "
28233 "percentage. For example:"
28237 #: ../tools/virt-resize.pl:288
28240 " --resize /dev/sda2=10G\n"
28245 #: ../tools/virt-resize.pl:290
28248 " --resize /dev/sda4=90%\n"
28253 #: ../tools/virt-resize.pl:292
28256 " --resize /dev/sda2=+1G\n"
28261 #: ../tools/virt-resize.pl:294
28264 " --resize /dev/sda2=-200M\n"
28269 #: ../tools/virt-resize.pl:296
28272 " --resize /dev/sda1=+128K\n"
28277 #: ../tools/virt-resize.pl:298
28280 " --resize /dev/sda1=+10%\n"
28285 #: ../tools/virt-resize.pl:300
28288 " --resize /dev/sda1=-10%\n"
28293 #: ../tools/virt-resize.pl:302
28295 "You can increase the size of any partition. Virt-resize will expand the "
28296 "direct content of the partition if it knows how (see C<--expand> below)."
28300 #: ../tools/virt-resize.pl:306
28302 "You can only I<decrease> the size of partitions that contain filesystems or "
28303 "PVs which have already been shrunk. Virt-resize will check this has been "
28304 "done before proceeding, or else will print an error (see also "
28305 "C<--resize-force>)."
28309 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
28310 msgid "You can give this option multiple times."
28314 #: ../tools/virt-resize.pl:317
28315 msgid "B<--resize-force part=size>"
28319 #: ../tools/virt-resize.pl:319
28321 "This is the same as C<--resize> except that it will let you decrease the "
28322 "size of any partition. Generally this means you will lose any data which "
28323 "was at the end of the partition you shrink, but you may not care about that "
28324 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
28325 "as a swap partition)."
28329 #: ../tools/virt-resize.pl:325
28330 msgid "See also the C<--ignore> option."
28334 #: ../tools/virt-resize.pl:331
28335 msgid "B<--expand part>"
28339 #: ../tools/virt-resize.pl:333
28341 "Expand the named partition so it uses up all extra space (space left over "
28342 "after any other resize changes that you request have been done)."
28346 #: ../tools/virt-resize.pl:336
28348 "If virt-resize knows how, it will expand the direct content of the "
28349 "partition. For example, if the partition is an LVM PV, it will expand the "
28350 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
28351 "content it doesn't know about alone."
28355 #: ../tools/virt-resize.pl:341
28356 msgid "Currently virt-resize can resize:"
28360 #: ../tools/virt-resize.pl:347
28362 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
28367 #: ../tools/virt-resize.pl:352
28369 "NTFS filesystems contained directly in a partition, if libguestfs was "
28370 "compiled with support for NTFS."
28374 #: ../tools/virt-resize.pl:355
28376 "The filesystem must have been shut down consistently last time it was used. "
28377 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
28378 "consistency check, so at the first boot after resizing Windows will check "
28383 #: ../tools/virt-resize.pl:362
28385 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
28386 "inside the PV, but see the C<--LV-expand> option. The user could also "
28387 "resize LVs as desired after boot."
28391 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
28392 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
28396 #: ../tools/virt-resize.pl:374
28397 msgid "B<--shrink part>"
28401 #: ../tools/virt-resize.pl:376
28403 "Shrink the named partition until the overall disk image fits in the "
28404 "destination. The named partition B<must> contain a filesystem or PV which "
28405 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
28406 "online tools). Virt-resize will check this and give an error if it has not "
28411 #: ../tools/virt-resize.pl:382
28413 "The amount by which the overall disk must be shrunk (after carrying out all "
28414 "other operations requested by the user) is called the \"deficit\". For "
28415 "example, a straight copy (assume no other operations) from a 5GB disk image "
28416 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
28417 "would give an error unless the user specified a partition to shrink and that "
28418 "partition had more than a gigabyte of free space."
28422 #: ../tools/virt-resize.pl:396
28423 msgid "B<--ignore part>"
28427 #: ../tools/virt-resize.pl:398
28429 "Ignore the named partition. Effectively this means the partition is "
28430 "allocated on the destination disk, but the content is not copied across from "
28431 "the source disk. The content of the partition will be blank (all zero "
28436 #: ../tools/virt-resize.pl:409
28437 msgid "B<--delete part>"
28441 #: ../tools/virt-resize.pl:411
28443 "Delete the named partition. It would be more accurate to describe this as "
28444 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
28445 "the original disk image is left intact."
28449 #: ../tools/virt-resize.pl:415
28451 "Note that when you delete a partition, then anything contained in the "
28452 "partition is also deleted. Furthermore, this causes any partitions that "
28453 "come after to be I<renumbered>, which can easily make your guest unbootable."
28457 #: ../tools/virt-resize.pl:426
28458 msgid "B<--LV-expand logvol>"
28462 #: ../tools/virt-resize.pl:428
28464 "This takes the logical volume and, as a final step, expands it to fill all "
28465 "the space available in its volume group. A typical usage, assuming a Linux "
28466 "guest with a single PV C</dev/sda2> and a root device called "
28467 "C</dev/vg_guest/lv_root> would be:"
28471 #: ../tools/virt-resize.pl:433
28474 " virt-resize indisk outdisk \\\n"
28475 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
28480 #: ../tools/virt-resize.pl:436
28482 "This would first expand the partition (and PV), and then expand the root "
28483 "device to fill the extra space in the PV."
28487 #: ../tools/virt-resize.pl:439
28489 "The contents of the LV are also resized if virt-resize knows how to do "
28490 "that. You can stop virt-resize from trying to expand the content by using "
28491 "the option C<--no-expand-content>."
28495 #: ../tools/virt-resize.pl:443
28496 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
28500 #: ../tools/virt-resize.pl:446
28502 "You can give this option multiple times, I<but> it doesn't make sense to do "
28503 "this unless the logical volumes you specify are all in different volume "
28508 #: ../tools/virt-resize.pl:454
28509 msgid "B<--no-copy-boot-loader>"
28513 #: ../tools/virt-resize.pl:456
28515 "By default, virt-resize copies over some sectors at the start of the disk "
28516 "(up to the beginning of the first partition). Commonly these sectors "
28517 "contain the Master Boot Record (MBR) and the boot loader, and are required "
28518 "in order for the guest to boot correctly."
28522 #: ../tools/virt-resize.pl:461
28524 "If you specify this flag, then this initial copy is not done. You may need "
28525 "to reinstall the boot loader in this case."
28529 #: ../tools/virt-resize.pl:469
28530 msgid "B<--no-extra-partition>"
28534 #: ../tools/virt-resize.pl:471
28536 "By default, virt-resize creates an extra partition if there is any extra, "
28537 "unused space after all resizing has happened. Use this option to prevent "
28538 "the extra partition from being created. If you do this then the extra space "
28539 "will be inaccessible until you run fdisk, parted, or some other partitioning "
28540 "tool in the guest."
28544 #: ../tools/virt-resize.pl:477
28546 "Note that if the surplus space is smaller than 10 MB, no extra partition "
28551 #: ../tools/virt-resize.pl:484
28552 msgid "B<--no-expand-content>"
28556 #: ../tools/virt-resize.pl:486
28558 "By default, virt-resize will try to expand the direct contents of "
28559 "partitions, if it knows how (see C<--expand> option above)."
28563 #: ../tools/virt-resize.pl:489
28565 "If you give the C<--no-expand-content> option then virt-resize will not "
28570 #: ../tools/virt-resize.pl:496
28571 msgid "B<-d> | B<--debug>"
28575 #: ../tools/virt-resize.pl:504
28576 msgid "B<-n> | B<--dryrun>"
28580 #: ../tools/virt-resize.pl:506
28581 msgid "Print a summary of what would be done, but don't do anything."
28585 #: ../tools/virt-resize.pl:512
28586 msgid "B<-q> | B<--quiet>"
28590 #: ../tools/virt-resize.pl:514
28591 msgid "Don't print the summary."
28595 #: ../tools/virt-resize.pl:522
28597 "Specify the format of the input disk image. If this flag is not given then "
28598 "it is auto-detected from the image itself."
28602 #: ../tools/virt-resize.pl:528
28604 "Note that this option I<does not> affect the output format. See L</QCOW2 "
28605 "AND NON-SPARSE RAW FORMATS>."
28609 #: ../tools/virt-resize.pl:535
28610 msgid "B<--output-format> raw"
28614 #: ../tools/virt-resize.pl:537
28616 "Specify the format of the output disk image. If this flag is not given then "
28617 "it is auto-detected from the image itself."
28621 #: ../tools/virt-resize.pl:543
28623 "Note that you still need to create the output disk with the right format. "
28624 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28628 #: ../tools/virt-resize.pl:1419
28633 #: ../tools/virt-resize.pl:1421
28634 msgid "\"Partition 1 does not end on cylinder boundary.\""
28638 #: ../tools/virt-resize.pl:1423
28640 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28641 "means the partitions will not be aligned to the ancient CHS geometry. "
28642 "However CHS geometry is meaningless for disks manufactured since the early "
28643 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28644 "cylinders is not required by any modern operating system."
28648 #: ../tools/virt-resize.pl:1430
28649 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28653 #: ../tools/virt-resize.pl:1432
28655 "In Windows Vista and later versions, Microsoft switched to using a separate "
28656 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28657 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28658 "the boot partition. Doing so seems to break the guest completely. However "
28659 "expanding the second partition (ie. C: drive) should work."
28663 #: ../tools/virt-resize.pl:1439
28665 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28666 "NTFS partitions have been expanded. This is just a safety check and (unless "
28667 "it find errors) is nothing to worry about."
28671 #: ../tools/virt-resize.pl:1443
28672 msgid "GUEST BOOT STUCK AT \"GRUB\""
28676 #: ../tools/virt-resize.pl:1445
28678 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28679 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28680 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28681 "although we think is to do with partition alignment."
28685 #: ../tools/virt-resize.pl:1450
28688 " guestfish -i -a newdisk\n"
28689 " ><fs> cat /boot/grub/device.map\n"
28690 " # check the contents of this file are sensible or\n"
28691 " # edit the file if necessary\n"
28692 " ><fs> grub-install / /dev/vda\n"
28698 #: ../tools/virt-resize.pl:1457
28700 "For more flexible guest reconfiguration, including if you need to specify "
28701 "other parameters to grub-install, use L<virt-rescue(1)>."
28705 #: ../tools/virt-resize.pl:1460
28706 msgid "ALTERNATIVE TOOLS"
28710 #: ../tools/virt-resize.pl:1462
28712 "There are several proprietary tools for resizing partitions. We won't "
28713 "mention any here."
28717 #: ../tools/virt-resize.pl:1465
28719 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28720 "operations on disk images. They can resize and move partitions, but I don't "
28721 "think they can do anything with the contents, and they certainly don't "
28726 #: ../tools/virt-resize.pl:1470
28728 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28729 "but at a much lower level. You will probably end up hand-calculating sector "
28730 "offsets, which is something that virt-resize was designed to avoid. If you "
28731 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
28736 #: ../tools/virt-resize.pl:1485
28738 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
28739 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
28740 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
28741 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
28742 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28746 #: ../tools/virt-list-filesystems.pl:32
28747 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28751 #: ../tools/virt-list-filesystems.pl:36
28754 " virt-list-filesystems [--options] domname\n"
28759 #: ../tools/virt-list-filesystems.pl:38
28762 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28767 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
28769 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
28774 #: ../tools/virt-list-filesystems.pl:45
28776 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28777 "are contained in a virtual machine or disk image."
28781 #: ../tools/virt-list-filesystems.pl:49
28783 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28784 "functionality. For more complex cases you should look at the "
28785 "L<guestfish(1)> tool."
28789 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
28790 msgid "B<-l> | B<--long>"
28794 #: ../tools/virt-list-filesystems.pl:108
28796 "With this option, C<virt-list-filesystems> displays the type of each "
28797 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28801 #: ../tools/virt-list-filesystems.pl:115
28802 msgid "B<-a> | B<--all>"
28806 #: ../tools/virt-list-filesystems.pl:117
28808 "Normally we only show mountable filesystems. If this option is given then "
28809 "swap devices are shown too."
28813 #: ../tools/virt-list-filesystems.pl:191
28815 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
28816 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
28817 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28821 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
28822 msgid "Copyright (C) 2009 Red Hat Inc."
28826 #: ../tools/virt-tar.pl:33
28827 msgid "virt-tar - Extract or upload files to a virtual machine"
28831 #: ../tools/virt-tar.pl:37
28834 " virt-tar [--options] -x domname directory tarball\n"
28839 #: ../tools/virt-tar.pl:39
28842 " virt-tar [--options] -u domname tarball directory\n"
28847 #: ../tools/virt-tar.pl:41
28850 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28855 #: ../tools/virt-tar.pl:43
28858 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28863 #: ../tools/virt-tar.pl:47
28864 msgid "Download C</home> from the VM into a local tarball:"
28868 #: ../tools/virt-tar.pl:49
28871 " virt-tar -x domname /home home.tar\n"
28876 #: ../tools/virt-tar.pl:51
28879 " virt-tar -zx domname /home home.tar.gz\n"
28884 #: ../tools/virt-tar.pl:53
28885 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28889 #: ../tools/virt-tar.pl:55
28892 " virt-tar -u domname uploadstuff.tar /tmp\n"
28897 #: ../tools/virt-tar.pl:57
28900 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28905 #: ../tools/virt-tar.pl:61
28907 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28908 "virtual machines. If you do this, you risk disk corruption in the VM. "
28909 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28913 #: ../tools/virt-tar.pl:66
28915 "You can use C<-x> (extract) on live virtual machines, but you might get "
28916 "inconsistent results or errors if there is filesystem activity inside the "
28917 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28918 "work, but the only way to guarantee consistent results is if the virtual "
28919 "machine is shut down."
28923 #: ../tools/virt-tar.pl:74
28925 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28926 "parts of a guest filesystem. There are many possibilities: making backups, "
28927 "uploading data files, snooping on guest activity, fixing or customizing "
28932 #: ../tools/virt-tar.pl:79
28934 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28935 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28936 "should look at the L<guestfish(1)> tool."
28940 #: ../tools/virt-tar.pl:83
28942 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28943 "its contents (recursively) from the virtual machine into a local tarball. "
28944 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28945 "virtual machine. You cannot use these two options together."
28949 #: ../tools/virt-tar.pl:89
28951 "In addition, you may need to use the C<-z> (gZip) option to enable "
28952 "compression. When uploading, you have to specify C<-z> if the upload file "
28953 "is compressed because virt-tar won't detect this on its own."
28957 #: ../tools/virt-tar.pl:93
28959 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28960 "example it cannot do PKZip files or bzip2 compression. If you want that "
28961 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28962 "the L<libguestfs(3)> API)."
28966 #: ../tools/virt-tar.pl:151
28967 msgid "B<-x> | B<--extract> | B<--download>"
28971 #: ../tools/virt-tar.pl:153
28972 msgid "B<-u> | B<--upload>"
28976 #: ../tools/virt-tar.pl:155
28978 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28983 #: ../tools/virt-tar.pl:158
28985 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28986 "Please read the L</WARNING> section above before using this option."
28990 #: ../tools/virt-tar.pl:162
28991 msgid "You must specify exactly one of these options."
28995 #: ../tools/virt-tar.pl:168
28996 msgid "B<-z> | B<--gzip>"
29000 #: ../tools/virt-tar.pl:170
29001 msgid "Specify that the input or output tarball is gzip-compressed."
29005 #: ../tools/virt-tar.pl:283
29007 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29008 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
29009 "L<http://libguestfs.org/>."
29013 #: ../tools/virt-make-fs.pl:37
29014 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29018 #: ../tools/virt-make-fs.pl:41
29021 " virt-make-fs [--options] input.tar output.img\n"
29026 #: ../tools/virt-make-fs.pl:43
29029 " virt-make-fs [--options] input.tar.gz output.img\n"
29034 #: ../tools/virt-make-fs.pl:45
29037 " virt-make-fs [--options] directory output.img\n"
29042 #: ../tools/virt-make-fs.pl:49
29044 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29045 "archive or some files in a directory. It is similar to tools like "
29046 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29047 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29048 "useful if you want to attach these filesystems to existing virtual machines "
29049 "(eg. to import large amounts of read-only data to a VM)."
29053 #: ../tools/virt-make-fs.pl:57
29054 msgid "Basic usage is:"
29058 #: ../tools/virt-make-fs.pl:59
29061 " virt-make-fs input output\n"
29066 #: ../tools/virt-make-fs.pl:61
29068 "where C<input> is either a directory containing files that you want to add, "
29069 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29070 "C<output> is a disk image. The input type is detected automatically. The "
29071 "output disk image defaults to a raw ext2 image unless you specify extra "
29072 "flags (see L</OPTIONS> below)."
29076 #: ../tools/virt-make-fs.pl:67
29077 msgid "EXTRA SPACE"
29081 #: ../tools/virt-make-fs.pl:69
29083 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29084 "the files that it contains, but might have extra space. Depending on how "
29085 "you are going to use the output, you might think this extra space is wasted "
29086 "and want to minimize it, or you might want to leave space so that more files "
29087 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29088 "but you can use the C<--size> flag to leave space in the filesystem if you "
29093 #: ../tools/virt-make-fs.pl:77
29095 "An alternative way to leave extra space but not make the output image any "
29096 "bigger is to use an alternative disk image format (instead of the default "
29097 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
29098 "image format (check your hypervisor supports this before using it). This "
29099 "allows you to choose a large C<--size> but the extra space won't actually be "
29100 "allocated in the image until you try to store something in it."
29104 #: ../tools/virt-make-fs.pl:85
29106 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29107 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
29108 "virt-make-resize to build another image from scratch."
29112 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29117 #: ../tools/virt-make-fs.pl:91
29120 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29125 #: ../tools/virt-make-fs.pl:93
29126 msgid "FILESYSTEM TYPE"
29130 #: ../tools/virt-make-fs.pl:95
29132 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29133 "libguestfs supports can be used (but I<not> read-only formats like "
29134 "ISO9660). Here are some of the more common choices:"
29138 #: ../tools/virt-make-fs.pl:101
29143 #: ../tools/virt-make-fs.pl:103
29145 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29146 "you are not going to use the filesystem in a way that requires the journal, "
29147 "then this is just wasted overhead."
29151 #: ../tools/virt-make-fs.pl:107
29152 msgid "I<ntfs> or I<vfat>"
29156 #: ../tools/virt-make-fs.pl:109
29157 msgid "Useful if exporting data to a Windows guest."
29161 #: ../tools/virt-make-fs.pl:111
29163 "I<Note for vfat>: The tar archive or local directory must only contain files "
29164 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29165 "program running within libguestfs is unable to change the ownership of "
29166 "non-root files, since vfat itself does not support this."
29170 #: ../tools/virt-make-fs.pl:116
29175 #: ../tools/virt-make-fs.pl:118
29177 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29178 "total filesystem size."
29182 #: ../tools/virt-make-fs.pl:125
29185 " virt-make-fs --type=minix input minixfs.img\n"
29190 #: ../tools/virt-make-fs.pl:127
29191 msgid "TO PARTITION OR NOT TO PARTITION"
29195 #: ../tools/virt-make-fs.pl:129
29196 msgid "Optionally virt-make-fs can add a partition table to the output disk."
29200 #: ../tools/virt-make-fs.pl:131
29202 "Adding a partition can make the disk image more compatible with certain "
29203 "virtualized operating systems which don't expect to see a filesystem "
29204 "directly located on a block device (Linux doesn't care and will happily "
29205 "handle both types)."
29209 #: ../tools/virt-make-fs.pl:136
29211 "On the other hand, if you have a partition table then the output image is no "
29212 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
29213 "directly on a partitioned disk image. (However libguestfs tools such as "
29214 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
29218 #: ../tools/virt-make-fs.pl:144
29219 msgid "Add an MBR partition:"
29223 #: ../tools/virt-make-fs.pl:146
29226 " virt-make-fs --partition -- input disk.img\n"
29231 #: ../tools/virt-make-fs.pl:148
29233 "If the output disk image could be terabyte-sized or larger, it's better to "
29234 "use an EFI/GPT-compatible partition table:"
29238 #: ../tools/virt-make-fs.pl:151
29241 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
29246 #: ../tools/virt-make-fs.pl:179
29247 msgid "Enable debugging information."
29251 #: ../tools/virt-make-fs.pl:185
29252 msgid "B<--size=E<lt>NE<gt>>"
29256 #: ../tools/virt-make-fs.pl:187
29257 msgid "B<--size=+E<lt>NE<gt>>"
29261 #: ../tools/virt-make-fs.pl:189
29262 msgid "B<-s E<lt>NE<gt>>"
29266 #: ../tools/virt-make-fs.pl:191
29267 msgid "B<-s +E<lt>NE<gt>>"
29271 #: ../tools/virt-make-fs.pl:193
29272 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
29276 #: ../tools/virt-make-fs.pl:196
29278 "If this option is I<not> given, then the output image will be just large "
29279 "enough to contain all the files, with not much wasted space."
29283 #: ../tools/virt-make-fs.pl:199
29285 "To choose a fixed size output disk, specify an absolute number followed by "
29286 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29287 "Petabytes or Exabytes. This must be large enough to contain all the input "
29288 "files, else you will get an error."
29292 #: ../tools/virt-make-fs.pl:204
29294 "To leave extra space, specify C<+> (plus sign) and a number followed by "
29295 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
29296 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
29297 "the input files, and (approximately) an extra 200 MB free space."
29301 #: ../tools/virt-make-fs.pl:210
29303 "Note that virt-make-fs estimates free space, and therefore will not produce "
29304 "filesystems containing precisely the free space requested. (It is much more "
29305 "expensive and time-consuming to produce a filesystem which has precisely the "
29306 "desired free space)."
29310 #: ../tools/virt-make-fs.pl:219
29311 msgid "B<--format=E<lt>fmtE<gt>>"
29315 #: ../tools/virt-make-fs.pl:221
29316 msgid "B<-F E<lt>fmtE<gt>>"
29320 #: ../tools/virt-make-fs.pl:223
29321 msgid "Choose the output disk image format."
29325 #: ../tools/virt-make-fs.pl:225
29326 msgid "The default is C<raw> (raw disk image)."
29330 #: ../tools/virt-make-fs.pl:227
29332 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
29333 "that would really make sense here is C<qcow2>."
29337 #: ../tools/virt-make-fs.pl:234
29338 msgid "B<--type=E<lt>fsE<gt>>"
29342 #: ../tools/virt-make-fs.pl:236
29343 msgid "B<-t E<lt>fsE<gt>>"
29347 #: ../tools/virt-make-fs.pl:238
29348 msgid "Choose the output filesystem type."
29352 #: ../tools/virt-make-fs.pl:240
29353 msgid "The default is C<ext2>."
29357 #: ../tools/virt-make-fs.pl:242
29358 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
29362 #: ../tools/virt-make-fs.pl:249
29363 msgid "B<--partition>"
29367 #: ../tools/virt-make-fs.pl:251
29368 msgid "B<--partition=E<lt>parttypeE<gt>>"
29372 #: ../tools/virt-make-fs.pl:253
29374 "If specified, this flag adds an MBR partition table to the output disk "
29379 #: ../tools/virt-make-fs.pl:256
29381 "You can change the partition table type, eg. C<--partition=gpt> for large "
29386 #: ../tools/virt-make-fs.pl:259
29388 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
29389 "might consider the next parameter to be the partition type. For example:"
29393 #: ../tools/virt-make-fs.pl:263
29396 " virt-make-fs --partition input.tar ...\n"
29401 #: ../tools/virt-make-fs.pl:265
29403 "would cause virt-make-fs to think you wanted to use a partition type of "
29404 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
29405 "dash) between options and the input file argument:"
29409 #: ../tools/virt-make-fs.pl:269
29412 " virt-make-fs --partition -- input.tar ...\n"
29417 #: ../tools/virt-make-fs.pl:536
29419 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
29420 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
29421 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29425 #: ../tools/virt-make-fs.pl:553
29428 " export LIBGUESTFS_DEBUG=1\n"
29429 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29434 #: ../tools/virt-make-fs.pl:556
29436 "Attach /tmp/virt-make-fs.log to a new bug report at "
29437 "L<https://bugzilla.redhat.com/>"
29441 #: ../tools/virt-list-partitions.pl:32
29442 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
29446 #: ../tools/virt-list-partitions.pl:36
29449 " virt-list-partitions [--options] domname\n"
29454 #: ../tools/virt-list-partitions.pl:38
29457 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29462 #: ../tools/virt-list-partitions.pl:45
29464 "C<virt-list-partitions> is a command line tool to list the partitions that "
29465 "are contained in a virtual machine or disk image. It is mainly useful as a "
29466 "first step to using L<virt-resize(1)>."
29470 #: ../tools/virt-list-partitions.pl:50
29472 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29473 "functionality. For more complex cases you should look at the "
29474 "L<guestfish(1)> tool."
29478 #: ../tools/virt-list-partitions.pl:107
29479 msgid "B<-h> | B<--human-readable>"
29483 #: ../tools/virt-list-partitions.pl:109
29484 msgid "Show sizes in human-readable form (eg. \"1G\")."
29488 #: ../tools/virt-list-partitions.pl:117
29490 "With this option, C<virt-list-partitions> displays the type and size of each "
29491 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29495 #: ../tools/virt-list-partitions.pl:124
29496 msgid "B<-t> | B<--total>"
29500 #: ../tools/virt-list-partitions.pl:126
29501 msgid "Display the total size of each block device (as a separate row or rows)."
29505 #: ../tools/virt-list-partitions.pl:259
29507 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
29508 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
29509 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."