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.11.18\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-07-15 17:18+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
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-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
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-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
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 file descriptor 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:1064 ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763 ../src/guestfs.pod:1773 ../src/guestfs.pod:2047 ../src/guestfs.pod:2052 ../src/guestfs.pod:2058 ../src/guestfs.pod:2066 ../src/guestfs.pod:2420 ../src/guestfs.pod:2426 ../src/guestfs.pod:2431 ../src/guestfs.pod:2437 ../src/guestfs.pod:3011 ../src/guestfs.pod:3015 ../src/guestfs.pod:3019 ../src/guestfs.pod:3023 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598 ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1662 ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1670 ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1690 ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:2857 ../src/guestfs-actions.pod:2863 ../src/guestfs-actions.pod:2871 ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:2885 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1099 ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1127 ../fish/guestfish-actions.pod:1137 ../fish/guestfish-actions.pod:1141 ../fish/guestfish-actions.pod:1145 ../fish/guestfish-actions.pod:1235 ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1244 ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1291 ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1939 ../fish/guestfish-actions.pod:1947 ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1961 ../tools/virt-win-reg.pl:195 ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206 ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714 ../tools/virt-win-reg.pl:720
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:1257 ../src/guestfs.pod:1395 ../src/guestfs.pod:2465
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:1261 ../src/guestfs.pod:1399 ../src/guestfs.pod:2490
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:1405
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:825
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, an install CD or a live CD. (These APIs used to "
1112 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
1113 "version 1.5.3 the most frequently used part of this library has been "
1114 "rewritten in C and moved into the core code)."
1118 #: ../src/guestfs.pod:559
1120 "Add all disks belonging to the unknown virtual machine and call "
1121 "L</guestfs_launch> in the usual way."
1125 #: ../src/guestfs.pod:562
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:571
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:577
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:584
1161 " /boot => /dev/sda1\n"
1162 " / => /dev/vg_guest/lv_root\n"
1163 " /usr => /dev/vg_guest/lv_usr\n"
1168 #: ../src/guestfs.pod:588
1170 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1171 "filesystems as suggested."
1175 #: ../src/guestfs.pod:591
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:595
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:599
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:603
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:612
1213 msgid "INSPECTING INSTALL DISKS"
1217 #: ../src/guestfs.pod:614
1219 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1224 #: ../src/guestfs.pod:617
1226 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1227 "system, which currently can be C<installed> (a regular operating system) or "
1228 "C<installer> (some sort of install disk)."
1232 #: ../src/guestfs.pod:621
1234 "Further information is available about the operating system that can be "
1235 "installed using the regular inspection APIs like "
1236 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1241 #: ../src/guestfs.pod:626
1243 "Some additional information specific to installer disks is also available "
1244 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1245 "L</guestfs_inspect_is_multipart> calls."
1249 #: ../src/guestfs.pod:631
1250 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1254 #: ../src/guestfs.pod:633
1256 "Libguestfs can mount NTFS partitions. It does this using the "
1257 "L<http://www.ntfs-3g.org/> driver."
1261 #: ../src/guestfs.pod:636
1262 msgid "DRIVE LETTERS AND PATHS"
1266 #: ../src/guestfs.pod:638
1268 "DOS and Windows still use drive letters, and the filesystems are always "
1269 "treated as case insensitive by Windows itself, and therefore you might find "
1270 "a Windows configuration file referring to a path like "
1271 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1272 "that directory might be referred to as C</WINDOWS/System32>."
1276 #: ../src/guestfs.pod:644
1278 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1279 "L</guestfs_inspect_get_drive_mappings>)"
1283 #: ../src/guestfs.pod:647
1285 "Dealing with separator characters (backslash vs forward slash) is outside "
1286 "the scope of libguestfs, but usually a simple character replacement will "
1291 #: ../src/guestfs.pod:651
1293 "To resolve the case insensitivity of paths, call "
1294 "L</guestfs_case_sensitive_path>."
1298 #: ../src/guestfs.pod:654
1299 msgid "ACCESSING THE WINDOWS REGISTRY"
1303 #: ../src/guestfs.pod:656
1305 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1306 "files, through the library C<hivex> which is part of the libguestfs project "
1307 "although ships as a separate tarball. You have to locate and download the "
1308 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1309 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1310 "L<virt-win-reg(1)> for more help on this issue."
1314 #: ../src/guestfs.pod:664
1315 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1319 #: ../src/guestfs.pod:666
1321 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1322 "provide something which looks like a Linux symlink. The way it tries to do "
1323 "the rewriting is described here:"
1327 #: ../src/guestfs.pod:670
1328 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
1332 #: ../src/guestfs.pod:672
1334 "The essential problem is that ntfs-3g simply does not have enough "
1335 "information to do a correct job. NTFS links can contain drive letters and "
1336 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1337 "It is almost certainly the case that libguestfs callers should ignore what "
1338 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1342 #: ../src/guestfs.pod:679
1344 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1345 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1346 "attribute, and read the raw reparse data from that (you can find the format "
1347 "documented in various places around the web)."
1351 #: ../src/guestfs.pod:684
1352 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1356 #: ../src/guestfs.pod:686
1358 "There are other useful extended attributes that can be read from ntfs-3g "
1359 "filesystems (using L</guestfs_getxattr>). See:"
1363 #: ../src/guestfs.pod:689
1364 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1368 #: ../src/guestfs.pod:691
1369 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1373 #: ../src/guestfs.pod:693
1375 "Although we don't want to discourage you from using the C API, we will "
1376 "mention here that the same API is also available in other languages."
1380 #: ../src/guestfs.pod:696
1382 "The API is broadly identical in all supported languages. This means that "
1383 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
1384 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1385 "OCaml. In other words, a straightforward, predictable isomorphism between "
1390 #: ../src/guestfs.pod:702
1392 "Error messages are automatically transformed into exceptions if the language "
1397 #: ../src/guestfs.pod:705
1399 "We don't try to \"object orientify\" parts of the API in OO languages, "
1400 "although contributors are welcome to write higher level APIs above what we "
1401 "provide in their favourite languages if they wish."
1405 #: ../src/guestfs.pod:711
1410 #: ../src/guestfs.pod:713
1412 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1413 "identical to the C API. C++ classes and exceptions are not used."
1417 #: ../src/guestfs.pod:717
1422 #: ../src/guestfs.pod:719
1424 "The C# bindings are highly experimental. Please read the warnings at the "
1425 "top of C<csharp/Libguestfs.cs>."
1429 #: ../src/guestfs.pod:722
1434 #: ../src/guestfs.pod:724
1436 "This is the only language binding that is working but incomplete. Only "
1437 "calls which return simple integers have been bound in Haskell, and we are "
1438 "looking for help to complete this binding."
1442 #: ../src/guestfs.pod:728
1447 #: ../src/guestfs.pod:730
1449 "Full documentation is contained in the Javadoc which is distributed with "
1454 #: ../src/guestfs.pod:733
1459 #: ../src/guestfs.pod:735
1460 msgid "See L<guestfs-ocaml(3)>."
1464 #: ../src/guestfs.pod:737
1469 #: ../src/guestfs.pod:739
1470 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1474 #: ../src/guestfs.pod:741
1479 #: ../src/guestfs.pod:743
1481 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1482 "the php-libguestfs package for your distribution."
1486 #: ../src/guestfs.pod:746
1487 msgid "The PHP binding only works correctly on 64 bit machines."
1491 #: ../src/guestfs.pod:748
1496 #: ../src/guestfs.pod:750
1497 msgid "See L<guestfs-python(3)>."
1501 #: ../src/guestfs.pod:752
1506 #: ../src/guestfs.pod:754
1507 msgid "See L<guestfs-ruby(3)>."
1511 #: ../src/guestfs.pod:756
1512 msgid "B<shell scripts>"
1516 #: ../src/guestfs.pod:758
1517 msgid "See L<guestfish(1)>."
1521 #: ../src/guestfs.pod:762
1522 msgid "LIBGUESTFS GOTCHAS"
1526 #: ../src/guestfs.pod:764
1528 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1529 "system [...] that works in the way it is documented but is counterintuitive "
1530 "and almost invites mistakes.\""
1534 #: ../src/guestfs.pod:768
1536 "Since we developed libguestfs and the associated tools, there are several "
1537 "things we would have designed differently, but are now stuck with for "
1538 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1539 "release, you can expect these to change. Beware of them."
1543 #: ../src/guestfs.pod:776
1544 msgid "Autosync / forgetting to sync."
1548 #: ../src/guestfs.pod:778
1550 "I<Update:> Autosync is enabled by default for all API users starting from "
1551 "libguestfs 1.5.24. This section only applies to older versions."
1555 #: ../src/guestfs.pod:781
1557 "When modifying a filesystem from C or another language, you B<must> unmount "
1558 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1559 "libguestfs handle. You can also call:"
1563 #: ../src/guestfs.pod:785
1566 " guestfs_set_autosync (g, 1);\n"
1571 #: ../src/guestfs.pod:787
1573 "to have the unmount/sync done automatically for you when the handle 'g' is "
1574 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1579 #: ../src/guestfs.pod:791
1581 "If you forget to do this, then it is entirely possible that your changes "
1582 "won't be written out, or will be partially written, or (very rarely) that "
1583 "you'll get disk corruption."
1587 #: ../src/guestfs.pod:795
1589 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1590 "guestfish scripts that forget to sync will work just fine, which can make "
1591 "this very puzzling if you are trying to debug a problem."
1595 #: ../src/guestfs.pod:799
1596 msgid "Mount option C<-o sync> should not be the default."
1600 #: ../src/guestfs.pod:801
1602 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1603 "However C<-o sync> does not add any reliability benefit, but does have a "
1604 "very large performance impact."
1608 #: ../src/guestfs.pod:805
1610 "The work around is to use L</guestfs_mount_options> and set the mount "
1611 "options that you actually want to use."
1615 #: ../src/guestfs.pod:808
1616 msgid "Read-only should be the default."
1620 #: ../src/guestfs.pod:810
1622 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1623 "specify I<--rw> if you want to make changes to the image."
1627 #: ../src/guestfs.pod:813
1628 msgid "This would reduce the potential to corrupt live VM images."
1632 #: ../src/guestfs.pod:815
1634 "Note that many filesystems change the disk when you just mount and unmount, "
1635 "even if you didn't perform any writes. You need to use "
1636 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1640 #: ../src/guestfs.pod:819
1641 msgid "guestfish command line is hard to use."
1645 #: ../src/guestfs.pod:821
1647 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1648 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1649 "exist, so it fails. In earlier versions of guestfish the error message was "
1650 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1651 "we should have used C<guestfish -c command> to run commands."
1655 #: ../src/guestfs.pod:828
1656 msgid "guestfish megabyte modifiers don't work right on all commands"
1660 #: ../src/guestfs.pod:830
1662 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1663 "other modifiers). What guestfish actually does is to multiply the number "
1664 "part by the modifier part and pass the result to the C API. However this "
1665 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1666 "expecting some other unit (eg. megabytes)."
1670 #: ../src/guestfs.pod:837
1671 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1675 #: ../src/guestfs.pod:839
1678 " lvcreate LV VG 100M\n"
1683 #: ../src/guestfs.pod:841
1685 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1686 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1687 "megabytes * megabytes) logical volume. The error message you get from this "
1688 "is also a little obscure."
1692 #: ../src/guestfs.pod:846
1694 "This could be fixed in the generator by specially marking parameters and "
1695 "return values which take bytes or other units."
1699 #: ../src/guestfs.pod:849
1700 msgid "Ambiguity between devices and paths"
1704 #: ../src/guestfs.pod:851
1706 "There is a subtle ambiguity in the API between a device name "
1707 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1708 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1712 #: ../src/guestfs.pod:856
1714 "In the current API we usually resolve this ambiguity by having two separate "
1715 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1716 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1717 "detecting if the path supplied begins with C</dev/>."
1721 #: ../src/guestfs.pod:862
1723 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1724 "make paths/devices into structured names. One way to do this would be to "
1725 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1726 "aspect of grub. Another way would be to use a structured type, equivalent "
1727 "to this OCaml type:"
1731 #: ../src/guestfs.pod:868
1734 " type path = Path of string | Device of int | Partition of int * int\n"
1739 #: ../src/guestfs.pod:870
1740 msgid "which would allow you to pass arguments like:"
1744 #: ../src/guestfs.pod:872
1747 " Path \"/foo/bar\"\n"
1748 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1749 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1750 " Path \"/dev/sdb2\" (* not a device *)\n"
1755 #: ../src/guestfs.pod:877
1757 "As you can see there are still problems to resolve even with this "
1758 "representation. Also consider how it might work in guestfish."
1762 #: ../src/guestfs.pod:882
1763 msgid "KEYS AND PASSPHRASES"
1767 #: ../src/guestfs.pod:884
1769 "Certain libguestfs calls take a parameter that contains sensitive key "
1770 "material, passed in as a C string."
1774 #: ../src/guestfs.pod:887
1776 "In the future we would hope to change the libguestfs implementation so that "
1777 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1778 "swap. However this is I<not> done at the moment, because of the complexity "
1779 "of such an implementation."
1783 #: ../src/guestfs.pod:892
1785 "Therefore you should be aware that any key parameter you pass to libguestfs "
1786 "might end up being written out to the swap partition. If this is a concern, "
1787 "scrub the swap partition or don't use libguestfs on encrypted devices."
1791 #: ../src/guestfs.pod:897
1792 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1796 #: ../src/guestfs.pod:899
1798 "All high-level libguestfs actions are synchronous. If you want to use "
1799 "libguestfs asynchronously then you must create a thread."
1803 #: ../src/guestfs.pod:902
1805 "Only use the handle from a single thread. Either use the handle exclusively "
1806 "from one thread, or provide your own mutex so that two threads cannot issue "
1807 "calls on the same handle at the same time."
1811 #: ../src/guestfs.pod:906
1813 "See the graphical program guestfs-browser for one possible architecture for "
1814 "multithreaded programs using libvirt and libguestfs."
1818 #: ../src/guestfs.pod:909
1823 #: ../src/guestfs.pod:911
1825 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1830 #: ../src/guestfs.pod:914
1832 "By default it looks for these in the directory C<$libdir/guestfs> "
1833 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1837 #: ../src/guestfs.pod:917
1839 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1840 "to change the directories that libguestfs will search in. The value is a "
1841 "colon-separated list of paths. The current directory is I<not> searched "
1842 "unless the path contains an empty element or C<.>. For example "
1843 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1844 "then C</usr/lib/guestfs>."
1848 #: ../src/guestfs.pod:924
1849 msgid "QEMU WRAPPERS"
1853 #: ../src/guestfs.pod:926
1855 "If you want to compile your own qemu, run qemu from a non-standard location, "
1856 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1861 #: ../src/guestfs.pod:930
1863 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1864 "last command in the shell script (so that qemu replaces the shell and "
1865 "becomes the direct child of the libguestfs-using program). If you don't do "
1866 "this, then the qemu process won't be cleaned up correctly."
1870 #: ../src/guestfs.pod:935
1872 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1877 #: ../src/guestfs.pod:938
1881 " qemudir=/home/rjones/d/qemu\n"
1882 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1888 #: ../src/guestfs.pod:942
1890 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1891 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1896 #: ../src/guestfs.pod:946
1899 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1904 #: ../src/guestfs.pod:948
1906 "Note that libguestfs also calls qemu with the -help and -version options in "
1907 "order to determine features."
1911 #: ../src/guestfs.pod:951
1912 msgid "ATTACHING TO RUNNING DAEMONS"
1916 #: ../src/guestfs.pod:953
1918 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
1919 "babies. Use with caution."
1923 #: ../src/guestfs.pod:956
1925 "I<Note (2):> This section explains how to attach to a running daemon from a "
1926 "low level perspective. For most users, simply using virt tools such as "
1927 "L<guestfish(1)> with the I<--live> option will \"just work\"."
1931 #: ../src/guestfs.pod:960
1932 msgid "Using guestfs_set_attach_method"
1936 #: ../src/guestfs.pod:962
1938 "By calling L</guestfs_set_attach_method> you can change how the library "
1939 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
1940 "L</ARCHITECTURE> for some background)."
1944 #: ../src/guestfs.pod:966
1946 "The normal attach method is C<appliance>, where a small appliance is created "
1947 "containing the daemon, and then the library connects to this."
1951 #: ../src/guestfs.pod:969
1953 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
1954 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
1955 "daemon over the Unix domain socket."
1959 #: ../src/guestfs.pod:973
1961 "The normal use for this is to connect to a running virtual machine that "
1962 "contains a C<guestfsd> daemon, and send commands so you can read and write "
1963 "files inside the live virtual machine."
1967 #: ../src/guestfs.pod:977
1968 msgid "Using guestfs_add_domain with live flag"
1972 #: ../src/guestfs.pod:979
1974 "L</guestfs_add_domain> provides some help for getting the correct attach "
1975 "method. If you pass the C<live> option to this function, then (if the "
1976 "virtual machine is running) it will examine the libvirt XML looking for a "
1977 "virtio-serial channel to connect to:"
1981 #: ../src/guestfs.pod:985
1988 " <channel type='unix'>\n"
1989 " <source mode='bind' path='/path/to/socket'/>\n"
1990 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
1999 #: ../src/guestfs.pod:997
2001 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2002 "method to C<unix:/path/to/socket>."
2006 #: ../src/guestfs.pod:1000
2008 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2009 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2010 "to attach to and modify live virtual machines."
2014 #: ../src/guestfs.pod:1004
2016 "The virtual machine needs to have been set up beforehand so that it has the "
2017 "virtio-serial channel and so that guestfsd is running inside it."
2021 #: ../src/guestfs.pod:1008
2022 msgid "ABI GUARANTEE"
2026 #: ../src/guestfs.pod:1010
2028 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2029 "actions as outlined in this section. Although we will deprecate some "
2030 "actions, for example if they get replaced by newer calls, we will keep the "
2031 "old actions forever. This allows you the developer to program in confidence "
2032 "against the libguestfs API."
2036 #: ../src/guestfs.pod:1016
2037 msgid "BLOCK DEVICE NAMING"
2041 #: ../src/guestfs.pod:1018
2043 "In the kernel there is now quite a profusion of schemata for naming block "
2044 "devices (in this context, by I<block device> I mean a physical or virtual "
2045 "hard drive). The original Linux IDE driver used names starting with "
2046 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
2047 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2048 "replacement for the old IDE driver (particularly for SATA devices) those "
2049 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2050 "machines with paravirtualized drivers. This has created several different "
2051 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2056 #: ../src/guestfs.pod:1030
2058 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2059 "Linux kernel to access block devices. We can run a variety of appliances "
2060 "based on a variety of Linux kernels."
2064 #: ../src/guestfs.pod:1034
2066 "This causes a problem for libguestfs because many API calls use device or "
2067 "partition names. Working scripts and the recipe (example) scripts that we "
2068 "make available over the internet could fail if the naming scheme changes."
2072 #: ../src/guestfs.pod:1039
2074 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2075 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
2076 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
2077 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2081 #: ../src/guestfs.pod:1045
2083 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
2084 "L</guestfs_list_partitions> and similar calls return the true names of the "
2085 "devices and partitions as known to the appliance."
2089 #: ../src/guestfs.pod:1050
2090 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2094 #: ../src/guestfs.pod:1052
2096 "Usually this translation is transparent. However in some (very rare) cases "
2097 "you may need to know the exact algorithm. Such cases include where you use "
2098 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
2099 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
2104 #: ../src/guestfs.pod:1058
2106 "The algorithm is applied only to I<parameters> which are known to be either "
2107 "device or partition names. Return values from functions such as "
2108 "L</guestfs_list_devices> are never changed."
2112 #: ../src/guestfs.pod:1066
2113 msgid "Is the string a parameter which is a device or partition name?"
2117 #: ../src/guestfs.pod:1070
2118 msgid "Does the string begin with C</dev/sd>?"
2122 #: ../src/guestfs.pod:1074
2124 "Does the named device exist? If so, we use that device. However if I<not> "
2125 "then we continue with this algorithm."
2129 #: ../src/guestfs.pod:1079
2130 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2134 #: ../src/guestfs.pod:1081
2135 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2139 #: ../src/guestfs.pod:1083
2140 msgid "If that named device exists, use it. If not, continue."
2144 #: ../src/guestfs.pod:1087
2145 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2149 #: ../src/guestfs.pod:1089
2150 msgid "If that named device exists, use it. If not, return an error."
2154 #: ../src/guestfs.pod:1093
2155 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2159 #: ../src/guestfs.pod:1095
2161 "Although the standard naming scheme and automatic translation is useful for "
2162 "simple programs and guestfish scripts, for larger programs it is best not to "
2163 "rely on this mechanism."
2167 #: ../src/guestfs.pod:1099
2169 "Where possible for maximum future portability programs using libguestfs "
2170 "should use these future-proof techniques:"
2174 #: ../src/guestfs.pod:1106
2176 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2177 "device names, and then use those names directly."
2181 #: ../src/guestfs.pod:1109
2182 msgid "Since those device names exist by definition, they will never be translated."
2186 #: ../src/guestfs.pod:1114
2188 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2189 "filesystem labels."
2193 #: ../src/guestfs.pod:1119
2198 #: ../src/guestfs.pod:1121
2200 "This section discusses security implications of using libguestfs, "
2201 "particularly with untrusted or malicious guests or disk images."
2205 #: ../src/guestfs.pod:1124
2206 msgid "GENERAL SECURITY CONSIDERATIONS"
2210 #: ../src/guestfs.pod:1126
2212 "Be careful with any files or data that you download from a guest (by "
2213 "\"download\" we mean not just the L</guestfs_download> command but any "
2214 "command that reads files, filenames, directories or anything else from a "
2215 "disk image). An attacker could manipulate the data to fool your program "
2216 "into doing the wrong thing. Consider cases such as:"
2220 #: ../src/guestfs.pod:1136
2221 msgid "the data (file etc) not being present"
2225 #: ../src/guestfs.pod:1140
2226 msgid "being present but empty"
2230 #: ../src/guestfs.pod:1144
2231 msgid "being much larger than normal"
2235 #: ../src/guestfs.pod:1148
2236 msgid "containing arbitrary 8 bit data"
2240 #: ../src/guestfs.pod:1152
2241 msgid "being in an unexpected character encoding"
2245 #: ../src/guestfs.pod:1156
2246 msgid "containing homoglyphs."
2250 #: ../src/guestfs.pod:1160
2251 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2255 #: ../src/guestfs.pod:1162
2257 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2258 "(VFS) module can sometimes be escalated into exploits by deliberately "
2259 "creating a malicious, malformed filesystem. These exploits are very severe "
2260 "for two reasons. Firstly there are very many filesystem drivers in the "
2261 "kernel, and many of them are infrequently used and not much developer "
2262 "attention has been paid to the code. Linux userspace helps potential "
2263 "crackers by detecting the filesystem type and automatically choosing the "
2264 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2265 "the administrator. Secondly, a kernel-level exploit is like a local root "
2266 "exploit (worse in some ways), giving immediate and total access to the "
2267 "system right down to the hardware level."
2271 #: ../src/guestfs.pod:1175
2273 "That explains why you should never mount a filesystem from an untrusted "
2274 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2275 "inside a qemu virtual machine, usually running as a non-root user. The "
2276 "attacker would need to write a filesystem which first exploited the kernel, "
2277 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2278 "the libguestfs protocol, and finally to be as serious as the host kernel "
2279 "exploit it would need to escalate its privileges to root. This multi-step "
2280 "escalation, performed by a static piece of data, is thought to be extremely "
2281 "hard to do, although we never say 'never' about security issues."
2285 #: ../src/guestfs.pod:1186
2287 "In any case callers can reduce the attack surface by forcing the filesystem "
2288 "type when mounting (use L</guestfs_mount_vfs>)."
2292 #: ../src/guestfs.pod:1189
2293 msgid "PROTOCOL SECURITY"
2297 #: ../src/guestfs.pod:1191
2299 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2300 "defined upper message size. However a program that uses libguestfs must "
2301 "also take care - for example you can write a program that downloads a binary "
2302 "from a disk image and executes it locally, and no amount of protocol "
2303 "security will save you from the consequences."
2307 #: ../src/guestfs.pod:1197
2308 msgid "INSPECTION SECURITY"
2312 #: ../src/guestfs.pod:1199
2314 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2315 "directly from the guest, and these could contain any 8 bit data. Callers "
2316 "should be careful to escape these before printing them to a structured file "
2317 "(for example, use HTML escaping if creating a web page)."
2321 #: ../src/guestfs.pod:1205
2323 "Guest configuration may be altered in unusual ways by the administrator of "
2324 "the virtual machine, and may not reflect reality (particularly for untrusted "
2325 "or actively malicious guests). For example we parse the hostname from "
2326 "configuration files like C</etc/sysconfig/network> that we find in the "
2327 "guest, but the guest administrator can easily manipulate these files to "
2328 "provide the wrong hostname."
2332 #: ../src/guestfs.pod:1213
2334 "The inspection API parses guest configuration using two external libraries: "
2335 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2336 "designed to be robust in the face of malicious data, although denial of "
2337 "service attacks are still possible, for example with oversized configuration "
2342 #: ../src/guestfs.pod:1219
2343 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2347 #: ../src/guestfs.pod:1221
2349 "Be very cautious about running commands from the guest. By running a "
2350 "command in the guest, you are giving CPU time to a binary that you do not "
2351 "control, under the same user account as the library, albeit wrapped in qemu "
2352 "virtualization. More information and alternatives can be found in the "
2353 "section L</RUNNING COMMANDS>."
2357 #: ../src/guestfs.pod:1227
2358 msgid "CVE-2010-3851"
2362 #: ../src/guestfs.pod:1229
2363 msgid "https://bugzilla.redhat.com/642934"
2367 #: ../src/guestfs.pod:1231
2369 "This security bug concerns the automatic disk format detection that qemu "
2370 "does on disk images."
2374 #: ../src/guestfs.pod:1234
2376 "A raw disk image is just the raw bytes, there is no header. Other disk "
2377 "images like qcow2 contain a special header. Qemu deals with this by looking "
2378 "for one of the known headers, and if none is found then assuming the disk "
2379 "image must be raw."
2383 #: ../src/guestfs.pod:1239
2385 "This allows a guest which has been given a raw disk image to write some "
2386 "other header. At next boot (or when the disk image is accessed by "
2387 "libguestfs) qemu would do autodetection and think the disk image format was, "
2388 "say, qcow2 based on the header written by the guest."
2392 #: ../src/guestfs.pod:1244
2394 "This in itself would not be a problem, but qcow2 offers many features, one "
2395 "of which is to allow a disk image to refer to another image (called the "
2396 "\"backing disk\"). It does this by placing the path to the backing disk "
2397 "into the qcow2 header. This path is not validated and could point to any "
2398 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2399 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2400 "control of the attacker."
2404 #: ../src/guestfs.pod:1252
2405 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2409 #: ../src/guestfs.pod:1259
2410 msgid "You have enabled the network or have opened the disk in write mode."
2414 #: ../src/guestfs.pod:1263
2416 "You are also running untrusted code from the guest (see L</RUNNING "
2421 #: ../src/guestfs.pod:1268
2423 "The way to avoid this is to specify the expected disk format when adding "
2424 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2425 "should always do this if the disk is raw format, and it's a good idea for "
2430 #: ../src/guestfs.pod:1273
2432 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2433 "format is fetched from libvirt and passed through."
2437 #: ../src/guestfs.pod:1276
2439 "For libguestfs tools, use the I<--format> command line parameter as "
2444 #: ../src/guestfs.pod:1279
2445 msgid "CONNECTION MANAGEMENT"
2449 #: ../src/guestfs.pod:1281
2454 #: ../src/guestfs.pod:1283
2456 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2457 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2458 "handle and release all resources used."
2462 #: ../src/guestfs.pod:1287
2464 "For information on using multiple handles and threads, see the section "
2465 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2469 #: ../src/guestfs.pod:1290
2470 msgid "guestfs_create"
2474 #: ../src/guestfs.pod:1292
2477 " guestfs_h *guestfs_create (void);\n"
2482 #: ../src/guestfs.pod:1294
2483 msgid "Create a connection handle."
2487 #: ../src/guestfs.pod:1296
2489 "On success this returns a non-NULL pointer to a handle. On error it returns "
2494 #: ../src/guestfs.pod:1299
2496 "You have to \"configure\" the handle after creating it. This includes "
2497 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2498 "handle at least once."
2502 #: ../src/guestfs.pod:1303
2503 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2507 #: ../src/guestfs.pod:1305
2509 "You may also want to configure error handling for the handle. See the "
2510 "L</ERROR HANDLING> section below."
2514 #: ../src/guestfs.pod:1308
2515 msgid "guestfs_close"
2519 #: ../src/guestfs.pod:1310
2522 " void guestfs_close (guestfs_h *g);\n"
2527 #: ../src/guestfs.pod:1312
2528 msgid "This closes the connection handle and frees up all resources used."
2532 #: ../src/guestfs.pod:1314
2534 "If autosync was set on the handle and the handle was launched, then this "
2535 "implicitly calls various functions to unmount filesystems and sync the "
2536 "disk. See L</guestfs_set_autosync> for more details."
2540 #: ../src/guestfs.pod:1318
2541 msgid "If a close callback was set on the handle, then it is called."
2545 #: ../src/guestfs.pod:1320
2546 msgid "ERROR HANDLING"
2550 #: ../src/guestfs.pod:1322
2552 "API functions can return errors. For example, almost all functions that "
2553 "return C<int> will return C<-1> to indicate an error."
2557 #: ../src/guestfs.pod:1325
2559 "Additional information is available for errors: an error message string and "
2560 "optionally an error number (errno) if the thing that failed was a system "
2565 #: ../src/guestfs.pod:1329
2567 "You can get at the additional information about the last error on the handle "
2568 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2569 "up an error handler with L</guestfs_set_error_handler>."
2573 #: ../src/guestfs.pod:1334
2575 "When the handle is created, a default error handler is installed which "
2576 "prints the error message string to C<stderr>. For small short-running "
2577 "command line programs it is sufficient to do:"
2581 #: ../src/guestfs.pod:1338
2584 " if (guestfs_launch (g) == -1)\n"
2585 " exit (EXIT_FAILURE);\n"
2590 #: ../src/guestfs.pod:1341
2592 "since the default error handler will ensure that an error message has been "
2593 "printed to C<stderr> before the program exits."
2597 #: ../src/guestfs.pod:1344
2599 "For other programs the caller will almost certainly want to install an "
2600 "alternate error handler or do error handling in-line like this:"
2604 #: ../src/guestfs.pod:1347
2607 " g = guestfs_create ();\n"
2612 #: ../src/guestfs.pod:1349
2615 " /* This disables the default behaviour of printing errors\n"
2617 " guestfs_set_error_handler (g, NULL, NULL);\n"
2622 #: ../src/guestfs.pod:1353
2625 " if (guestfs_launch (g) == -1) {\n"
2626 " /* Examine the error message and print it etc. */\n"
2627 " char *msg = guestfs_last_error (g);\n"
2628 " int errnum = guestfs_last_errno (g);\n"
2629 " fprintf (stderr, \"%s\\n\", msg);\n"
2636 #: ../src/guestfs.pod:1361
2638 "Out of memory errors are handled differently. The default action is to call "
2639 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2640 "L</guestfs_set_out_of_memory_handler>."
2644 #: ../src/guestfs.pod:1365
2646 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2647 "because there is no handle if this happens there is no way to get additional "
2648 "error information. However L</guestfs_create> is supposed to be a "
2649 "lightweight operation which can only fail because of insufficient memory (it "
2650 "returns NULL in this case)."
2654 #: ../src/guestfs.pod:1371
2655 msgid "guestfs_last_error"
2659 #: ../src/guestfs.pod:1373
2662 " const char *guestfs_last_error (guestfs_h *g);\n"
2667 #: ../src/guestfs.pod:1375
2669 "This returns the last error message that happened on C<g>. If there has not "
2670 "been an error since the handle was created, then this returns C<NULL>."
2674 #: ../src/guestfs.pod:1379
2676 "The lifetime of the returned string is until the next error occurs, or "
2677 "L</guestfs_close> is called."
2681 #: ../src/guestfs.pod:1382
2682 msgid "guestfs_last_errno"
2686 #: ../src/guestfs.pod:1384
2689 " int guestfs_last_errno (guestfs_h *g);\n"
2694 #: ../src/guestfs.pod:1386
2695 msgid "This returns the last error number (errno) that happened on C<g>."
2699 #: ../src/guestfs.pod:1388
2700 msgid "If successful, an errno integer not equal to zero is returned."
2704 #: ../src/guestfs.pod:1390
2705 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2709 #: ../src/guestfs.pod:1397
2710 msgid "There has not been any error on the handle."
2714 #: ../src/guestfs.pod:1401
2716 "There has been an error but the errno was meaningless. This corresponds to "
2717 "the case where the error did not come from a failed system call, but for "
2718 "some other reason."
2722 #: ../src/guestfs.pod:1407
2724 "There was an error from a failed system call, but for some reason the errno "
2725 "was not captured and returned. This usually indicates a bug in libguestfs."
2729 #: ../src/guestfs.pod:1413
2731 "Libguestfs tries to convert the errno from inside the applicance into a "
2732 "corresponding errno for the caller (not entirely trivial: the appliance "
2733 "might be running a completely different operating system from the library "
2734 "and error numbers are not standardized across Un*xen). If this could not be "
2735 "done, then the error is translated to C<EINVAL>. In practice this should "
2736 "only happen in very rare circumstances."
2740 #: ../src/guestfs.pod:1421
2741 msgid "guestfs_set_error_handler"
2745 #: ../src/guestfs.pod:1423
2748 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2750 " const char *msg);\n"
2751 " void guestfs_set_error_handler (guestfs_h *g,\n"
2752 " guestfs_error_handler_cb cb,\n"
2758 #: ../src/guestfs.pod:1430
2760 "The callback C<cb> will be called if there is an error. The parameters "
2761 "passed to the callback are an opaque data pointer and the error message "
2766 #: ../src/guestfs.pod:1434
2768 "C<errno> is not passed to the callback. To get that the callback must call "
2769 "L</guestfs_last_errno>."
2773 #: ../src/guestfs.pod:1437
2775 "Note that the message string C<msg> is freed as soon as the callback "
2776 "function returns, so if you want to stash it somewhere you must make your "
2781 #: ../src/guestfs.pod:1441
2782 msgid "The default handler prints messages on C<stderr>."
2786 #: ../src/guestfs.pod:1443
2787 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2791 #: ../src/guestfs.pod:1445
2792 msgid "guestfs_get_error_handler"
2796 #: ../src/guestfs.pod:1447
2799 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2800 " void **opaque_rtn);\n"
2805 #: ../src/guestfs.pod:1450
2806 msgid "Returns the current error handler callback."
2810 #: ../src/guestfs.pod:1452
2811 msgid "guestfs_set_out_of_memory_handler"
2815 #: ../src/guestfs.pod:1454
2818 " typedef void (*guestfs_abort_cb) (void);\n"
2819 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2820 " guestfs_abort_cb);\n"
2825 #: ../src/guestfs.pod:1458
2827 "The callback C<cb> will be called if there is an out of memory situation. "
2828 "I<Note this callback must not return>."
2832 #: ../src/guestfs.pod:1461
2833 msgid "The default is to call L<abort(3)>."
2837 #: ../src/guestfs.pod:1463
2838 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2842 #: ../src/guestfs.pod:1466
2843 msgid "guestfs_get_out_of_memory_handler"
2847 #: ../src/guestfs.pod:1468
2850 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2855 #: ../src/guestfs.pod:1470
2856 msgid "This returns the current out of memory handler."
2860 #: ../src/guestfs.pod:1472
2865 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1068
2870 #: ../src/guestfs.pod:1476
2875 #: ../src/guestfs.pod:1478
2880 #: ../src/guestfs.pod:1480
2881 msgid "AVAILABILITY"
2885 #: ../src/guestfs.pod:1482
2886 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2890 #: ../src/guestfs.pod:1484
2892 "Using L</guestfs_available> you can test availability of the following "
2893 "groups of functions. This test queries the appliance to see if the "
2894 "appliance you are currently using supports the functionality."
2898 #: ../src/guestfs.pod:1489
2899 msgid "@AVAILABILITY@"
2903 #: ../src/guestfs.pod:1491
2904 msgid "GUESTFISH supported COMMAND"
2908 #: ../src/guestfs.pod:1493
2910 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2911 "prints out the available groups and whether they are supported by this build "
2912 "of libguestfs. Note however that you have to do C<run> first."
2916 #: ../src/guestfs.pod:1498
2917 msgid "SINGLE CALLS AT COMPILE TIME"
2921 #: ../src/guestfs.pod:1500
2923 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2924 "function, such as:"
2928 #: ../src/guestfs.pod:1503
2931 " #define LIBGUESTFS_HAVE_DD 1\n"
2936 #: ../src/guestfs.pod:1505
2937 msgid "if L</guestfs_dd> is available."
2941 #: ../src/guestfs.pod:1507
2943 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2944 "function is available at compile time, we recommended using build tools such "
2945 "as autoconf or cmake. For example in autotools you could use:"
2949 #: ../src/guestfs.pod:1512
2952 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2953 " AC_CHECK_FUNCS([guestfs_dd])\n"
2958 #: ../src/guestfs.pod:1515
2960 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2965 #: ../src/guestfs.pod:1518
2966 msgid "SINGLE CALLS AT RUN TIME"
2970 #: ../src/guestfs.pod:1520
2972 "Testing at compile time doesn't guarantee that a function really exists in "
2973 "the library. The reason is that you might be dynamically linked against a "
2974 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2975 "This situation unfortunately results in a segmentation fault, which is a "
2976 "shortcoming of the C dynamic linking system itself."
2980 #: ../src/guestfs.pod:1527
2982 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2983 "in this example program (note that you still need the compile time check as "
2988 #: ../src/guestfs.pod:1531
2991 " #include <stdio.h>\n"
2992 " #include <stdlib.h>\n"
2993 " #include <unistd.h>\n"
2994 " #include <dlfcn.h>\n"
2995 " #include <guestfs.h>\n"
3000 #: ../src/guestfs.pod:1537
3005 " #ifdef LIBGUESTFS_HAVE_DD\n"
3007 " int has_function;\n"
3012 #: ../src/guestfs.pod:1543
3015 " /* Test if the function guestfs_dd is really available. */\n"
3016 " dl = dlopen (NULL, RTLD_LAZY);\n"
3018 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3019 " exit (EXIT_FAILURE);\n"
3021 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3027 #: ../src/guestfs.pod:1552
3030 " if (!has_function)\n"
3031 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3033 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3034 " /* Now it's safe to call\n"
3035 " guestfs_dd (g, \"foo\", \"bar\");\n"
3039 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3046 #: ../src/guestfs.pod:1565
3048 "You may think the above is an awful lot of hassle, and it is. There are "
3049 "other ways outside of the C linking system to ensure that this kind of "
3050 "incompatibility never arises, such as using package versioning:"
3054 #: ../src/guestfs.pod:1570
3057 " Requires: libguestfs >= 1.0.80\n"
3062 #: ../src/guestfs.pod:1572
3063 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3067 #: ../src/guestfs.pod:1574
3069 "A recent feature of the API is the introduction of calls which take optional "
3070 "arguments. In C these are declared 3 ways. The main way is as a call which "
3071 "takes variable arguments (ie. C<...>), as in this example:"
3075 #: ../src/guestfs.pod:1579
3078 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3083 #: ../src/guestfs.pod:1581
3085 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3086 "call with no optional arguments specified:"
3090 #: ../src/guestfs.pod:1584
3093 " guestfs_add_drive_opts (g, filename, -1);\n"
3098 #: ../src/guestfs.pod:1586
3099 msgid "With a single optional argument:"
3103 #: ../src/guestfs.pod:1588
3106 " guestfs_add_drive_opts (g, filename,\n"
3107 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3113 #: ../src/guestfs.pod:1592
3118 #: ../src/guestfs.pod:1594
3121 " guestfs_add_drive_opts (g, filename,\n"
3122 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3123 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3129 #: ../src/guestfs.pod:1599
3131 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3136 #: ../src/guestfs.pod:1602
3137 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3141 #: ../src/guestfs.pod:1604
3143 "The second variant has the same name with the suffix C<_va>, which works the "
3144 "same way but takes a C<va_list>. See the C manual for details. For the "
3145 "example function, this is declared:"
3149 #: ../src/guestfs.pod:1608
3152 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3158 #: ../src/guestfs.pod:1611
3159 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3163 #: ../src/guestfs.pod:1613
3165 "The third variant is useful where you need to construct these calls. You "
3166 "pass in a structure where you fill in the optional fields. The structure "
3167 "has a bitmask as the first element which you must set to indicate which "
3168 "fields you have filled in. For our example function the structure and call "
3173 #: ../src/guestfs.pod:1619
3176 " struct guestfs_add_drive_opts_argv {\n"
3177 " uint64_t bitmask;\n"
3179 " const char *format;\n"
3182 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3183 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3188 #: ../src/guestfs.pod:1628
3189 msgid "You could call it like this:"
3193 #: ../src/guestfs.pod:1630
3196 " struct guestfs_add_drive_opts_argv optargs = {\n"
3197 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3198 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3200 " .format = \"qcow2\"\n"
3206 #: ../src/guestfs.pod:1637
3209 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3214 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:2853 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287 ../fish/guestfish-actions.pod:1929 ../tools/virt-win-reg.pl:704
3219 #: ../src/guestfs.pod:1645
3220 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3224 #: ../src/guestfs.pod:1650
3225 msgid "You do not need to fill in all fields of the structure."
3229 #: ../src/guestfs.pod:1654
3231 "There must be a one-to-one correspondence between fields of the structure "
3232 "that are filled in, and bits set in the bitmask."
3236 #: ../src/guestfs.pod:1659
3237 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3241 #: ../src/guestfs.pod:1661
3243 "In other languages, optional arguments are expressed in the way that is "
3244 "natural for that language. We refer you to the language-specific "
3245 "documentation for more details on that."
3249 #: ../src/guestfs.pod:1665
3250 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3254 #: ../src/guestfs.pod:1667
3255 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3259 #: ../src/guestfs.pod:1669
3261 "B<Note:> This section documents the generic event mechanism introduced in "
3262 "libguestfs 1.10, which you should use in new code if possible. The old "
3263 "functions C<guestfs_set_log_message_callback>, "
3264 "C<guestfs_set_subprocess_quit_callback>, "
3265 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3266 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3267 "page. Because of the ABI guarantee, the old functions continue to work."
3271 #: ../src/guestfs.pod:1678
3273 "Handles generate events when certain things happen, such as log messages "
3274 "being generated, progress messages during long-running operations, or the "
3275 "handle being closed. The API calls described below let you register a "
3276 "callback to be called when events happen. You can register multiple "
3277 "callbacks (for the same, different or overlapping sets of events), and "
3278 "individually remove callbacks. If callbacks are not removed, then they "
3279 "remain in force until the handle is closed."
3283 #: ../src/guestfs.pod:1686
3285 "In the current implementation, events are only generated synchronously: that "
3286 "means that events (and hence callbacks) can only happen while you are in the "
3287 "middle of making another libguestfs call. The callback is called in the "
3292 #: ../src/guestfs.pod:1691
3294 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3295 "unsigned integers, or a message buffer. Payloads are discussed later on."
3299 #: ../src/guestfs.pod:1695
3300 msgid "CLASSES OF EVENTS"
3304 #: ../src/guestfs.pod:1699
3305 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3309 #: ../src/guestfs.pod:1702
3311 "The callback function will be called while the handle is being closed "
3312 "(synchronously from L</guestfs_close>)."
3316 #: ../src/guestfs.pod:1705
3318 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3319 "handles that are open when the program exits. This means that this callback "
3320 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3321 "problems in higher-level languages (eg. if your HLL interpreter has already "
3322 "been cleaned up by the time this is called, and if your callback then jumps "
3323 "into some HLL function)."
3327 #: ../src/guestfs.pod:1712
3329 "If no callback is registered: the handle is closed without any callback "
3334 #: ../src/guestfs.pod:1715
3335 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3339 #: ../src/guestfs.pod:1718
3341 "The callback function will be called when the child process quits, either "
3342 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3343 "corresponds to a transition from any state to the CONFIG state)."
3347 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3348 msgid "If no callback is registered: the event is ignored."
3352 #: ../src/guestfs.pod:1724
3353 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3357 #: ../src/guestfs.pod:1727
3359 "The callback function will be called when the child process becomes ready "
3360 "first time after it has been launched. (This corresponds to a transition "
3361 "from LAUNCHING to the READY state)."
3365 #: ../src/guestfs.pod:1733
3366 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3370 #: ../src/guestfs.pod:1736
3372 "Some long-running operations can generate progress messages. If this "
3373 "callback is registered, then it will be called each time a progress message "
3374 "is generated (usually two seconds after the operation started, and three "
3375 "times per second thereafter until it completes, although the frequency may "
3376 "change in future versions)."
3380 #: ../src/guestfs.pod:1742
3382 "The callback receives in the payload four unsigned 64 bit numbers which are "
3383 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3387 #: ../src/guestfs.pod:1745
3389 "The units of C<total> are not defined, although for some operations C<total> "
3390 "may relate in some way to the amount of data to be transferred (eg. in bytes "
3391 "or megabytes), and C<position> may be the portion which has been "
3396 #: ../src/guestfs.pod:1750
3397 msgid "The only defined and stable parts of the API are:"
3401 #: ../src/guestfs.pod:1756
3403 "The callback can display to the user some type of progress bar or indicator "
3404 "which shows the ratio of C<position>:C<total>."
3408 #: ../src/guestfs.pod:1761
3409 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3413 #: ../src/guestfs.pod:1765
3415 "If any progress notification is sent during a call, then a final progress "
3416 "notification is always sent when C<position> = C<total> (I<unless> the call "
3417 "fails with an error)."
3421 #: ../src/guestfs.pod:1769
3423 "This is to simplify caller code, so callers can easily set the progress "
3424 "indicator to \"100%\" at the end of the operation, without requiring special "
3425 "code to detect this case."
3429 #: ../src/guestfs.pod:1775
3431 "For some calls we are unable to estimate the progress of the call, but we "
3432 "can still generate progress messages to indicate activity. This is known as "
3433 "\"pulse mode\", and is directly supported by certain progress bar "
3434 "implementations (eg. GtkProgressBar)."
3438 #: ../src/guestfs.pod:1780
3440 "For these calls, zero or more progress messages are generated with "
3441 "C<position = 0> and C<total = 1>, followed by a final message with "
3442 "C<position = total = 1>."
3446 #: ../src/guestfs.pod:1784
3448 "As noted above, if the call fails with an error then the final message may "
3453 #: ../src/guestfs.pod:1789
3455 "The callback also receives the procedure number (C<proc_nr>) and serial "
3456 "number (C<serial>) of the call. These are only useful for debugging "
3457 "protocol issues, and the callback can normally ignore them. The callback "
3458 "may want to print these numbers in error messages or debugging messages."
3462 #: ../src/guestfs.pod:1795
3463 msgid "If no callback is registered: progress messages are discarded."
3467 #: ../src/guestfs.pod:1797
3468 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3472 #: ../src/guestfs.pod:1800
3474 "The callback function is called whenever a log message is generated by qemu, "
3475 "the appliance kernel, guestfsd (daemon), or utility programs."
3479 #: ../src/guestfs.pod:1803
3481 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
3482 "(L</guestfs_launch>) then additional debug messages are generated."
3486 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3488 "If no callback is registered: the messages are discarded unless the verbose "
3489 "flag is set in which case they are sent to stderr. You can override the "
3490 "printing of verbose messages to stderr by setting up a callback."
3494 #: ../src/guestfs.pod:1811
3495 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3499 #: ../src/guestfs.pod:1814
3501 "The callback function is called whenever a log message is generated by the "
3502 "library part of libguestfs."
3506 #: ../src/guestfs.pod:1817
3508 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3509 "messages are generated."
3513 #: ../src/guestfs.pod:1825
3514 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3518 #: ../src/guestfs.pod:1828
3520 "The callback function is called whenever a trace message is generated. This "
3521 "only applies if the trace flag (L</guestfs_set_trace>) is set."
3525 #: ../src/guestfs.pod:1831
3527 "If no callback is registered: the messages are sent to stderr. You can "
3528 "override the printing of trace messages to stderr by setting up a callback."
3532 #: ../src/guestfs.pod:1837
3533 msgid "guestfs_set_event_callback"
3537 #: ../src/guestfs.pod:1839
3540 " int guestfs_set_event_callback (guestfs_h *g,\n"
3541 " guestfs_event_callback cb,\n"
3542 " uint64_t event_bitmask,\n"
3549 #: ../src/guestfs.pod:1845
3551 "This function registers a callback (C<cb>) for all event classes in the "
3556 #: ../src/guestfs.pod:1848
3558 "For example, to register for all log message events, you could call this "
3559 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
3560 "To register a single callback for all possible classes of events, use "
3561 "C<GUESTFS_EVENT_ALL>."
3565 #: ../src/guestfs.pod:1854
3566 msgid "C<flags> should always be passed as 0."
3570 #: ../src/guestfs.pod:1856
3572 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
3573 "it for any purpose."
3577 #: ../src/guestfs.pod:1859
3579 "The return value is the event handle (an integer) which you can use to "
3580 "delete the callback (see below)."
3584 #: ../src/guestfs.pod:1862
3586 "If there is an error, this function returns C<-1>, and sets the error in the "
3587 "handle in the usual way (see L</guestfs_last_error> etc.)"
3591 #: ../src/guestfs.pod:1865
3593 "Callbacks remain in effect until they are deleted, or until the handle is "
3598 #: ../src/guestfs.pod:1868
3600 "In the case where multiple callbacks are registered for a particular event "
3601 "class, all of the callbacks are called. The order in which multiple "
3602 "callbacks are called is not defined."
3606 #: ../src/guestfs.pod:1872
3607 msgid "guestfs_delete_event_callback"
3611 #: ../src/guestfs.pod:1874
3614 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3619 #: ../src/guestfs.pod:1876
3621 "Delete a callback that was previously registered. C<event_handle> should be "
3622 "the integer that was returned by a previous call to "
3623 "C<guestfs_set_event_callback> on the same handle."
3627 #: ../src/guestfs.pod:1880
3628 msgid "guestfs_event_callback"
3632 #: ../src/guestfs.pod:1882
3635 " typedef void (*guestfs_event_callback) (\n"
3638 " uint64_t event,\n"
3639 " int event_handle,\n"
3641 " const char *buf, size_t buf_len,\n"
3642 " const uint64_t *array, size_t array_len);\n"
3647 #: ../src/guestfs.pod:1891
3648 msgid "This is the type of the event callback function that you have to provide."
3652 #: ../src/guestfs.pod:1894
3654 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3655 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3656 "handle, and C<flags> which in the current API you should ignore."
3660 #: ../src/guestfs.pod:1898
3662 "The remaining parameters contain the event payload (if any). Each event may "
3663 "contain a payload, which usually relates to the event class, but for future "
3664 "proofing your code should be written to handle any payload for any event "
3669 #: ../src/guestfs.pod:1903
3671 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3672 "there is no message buffer). Note that this message buffer can contain "
3673 "arbitrary 8 bit data, including NUL bytes."
3677 #: ../src/guestfs.pod:1907
3679 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3680 "moment this is only used for progress messages."
3684 #: ../src/guestfs.pod:1910
3685 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3689 #: ../src/guestfs.pod:1912
3691 "One motivation for the generic event API was to allow GUI programs to "
3692 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3693 "unconditionally to C<stderr>."
3697 #: ../src/guestfs.pod:1916
3699 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3700 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3701 "messages are not events; you must capture error messages separately)."
3705 #: ../src/guestfs.pod:1921
3707 "Programs have to set up a callback to capture the classes of events of "
3712 #: ../src/guestfs.pod:1924
3716 " guestfs_set_event_callback\n"
3717 " (g, message_callback,\n"
3718 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3719 " GUESTFS_EVENT_TRACE,\n"
3720 " 0, NULL) == -1)\n"
3721 " if (eh == -1) {\n"
3722 " // handle error in the usual way\n"
3728 #: ../src/guestfs.pod:1934
3730 "The callback can then direct messages to the appropriate place. In this "
3731 "example, messages are directed to syslog:"
3735 #: ../src/guestfs.pod:1937
3739 " message_callback (\n"
3742 " uint64_t event,\n"
3743 " int event_handle,\n"
3745 " const char *buf, size_t buf_len,\n"
3746 " const uint64_t *array, size_t array_len)\n"
3748 " const int priority = LOG_USER|LOG_INFO;\n"
3749 " if (buf_len > 0)\n"
3750 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3756 #: ../src/guestfs.pod:1952
3757 msgid "CANCELLING LONG TRANSFERS"
3761 #: ../src/guestfs.pod:1954
3763 "Some operations can be cancelled by the caller while they are in progress. "
3764 "Currently only operations that involve uploading or downloading data can be "
3765 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
3766 "parameters in the generator)."
3770 #: ../src/guestfs.pod:1959
3771 msgid "guestfs_user_cancel"
3775 #: ../src/guestfs.pod:1961
3778 " void guestfs_user_cancel (guestfs_h *g);\n"
3783 #: ../src/guestfs.pod:1963
3784 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
3788 #: ../src/guestfs.pod:1966
3790 "Unlike most other libguestfs calls, this function is signal safe and thread "
3791 "safe. You can call it from a signal handler or from another thread, without "
3792 "needing to do any locking."
3796 #: ../src/guestfs.pod:1970
3798 "The transfer that was in progress (if there is one) will stop shortly "
3799 "afterwards, and will return an error. The errno (see "
3800 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
3801 "out if the operation was cancelled or failed because of another error."
3805 #: ../src/guestfs.pod:1976
3807 "No cleanup is performed: for example, if a file was being uploaded then "
3808 "after cancellation there may be a partially uploaded file. It is the "
3809 "caller's responsibility to clean up if necessary."
3813 #: ../src/guestfs.pod:1980
3814 msgid "There are two common places that you might call C<guestfs_user_cancel>."
3818 #: ../src/guestfs.pod:1982
3820 "In an interactive text-based program, you might call it from a C<SIGINT> "
3821 "signal handler so that pressing C<^C> cancels the current operation. (You "
3822 "also need to call L</guestfs_set_pgroup> so that child processes don't "
3823 "receive the C<^C> signal)."
3827 #: ../src/guestfs.pod:1987
3829 "In a graphical program, when the main thread is displaying a progress bar "
3830 "with a cancel button, wire up the cancel button to call this function."
3834 #: ../src/guestfs.pod:1991
3835 msgid "PRIVATE DATA AREA"
3839 #: ../src/guestfs.pod:1993
3841 "You can attach named pieces of private data to the libguestfs handle, fetch "
3842 "them by name, and walk over them, for the lifetime of the handle. This is "
3843 "called the private data area and is only available from the C API."
3847 #: ../src/guestfs.pod:1998
3848 msgid "To attach a named piece of data, use the following call:"
3852 #: ../src/guestfs.pod:2000
3855 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3860 #: ../src/guestfs.pod:2002
3862 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3863 "pointer (which can be C<NULL>). Any previous item with the same key is "
3868 #: ../src/guestfs.pod:2006
3870 "You can use any C<key> you want, but your key should I<not> start with an "
3871 "underscore character. Keys beginning with an underscore character are "
3872 "reserved for internal libguestfs purposes (eg. for implementing language "
3873 "bindings). It is recommended that you prefix the key with some unique "
3874 "string to avoid collisions with other users."
3878 #: ../src/guestfs.pod:2012
3879 msgid "To retrieve the pointer, use:"
3883 #: ../src/guestfs.pod:2014
3886 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3891 #: ../src/guestfs.pod:2016
3893 "This function returns C<NULL> if either no data is found associated with "
3894 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3899 #: ../src/guestfs.pod:2020
3901 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3902 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3903 "all. In particular, libguestfs does I<not> try to free the data when the "
3904 "handle is closed. If the data must be freed, then the caller must either "
3905 "free it before calling L</guestfs_close> or must set up a close callback to "
3906 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3910 #: ../src/guestfs.pod:2027
3911 msgid "To walk over all entries, use these two functions:"
3915 #: ../src/guestfs.pod:2029
3918 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3923 #: ../src/guestfs.pod:2031
3926 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3931 #: ../src/guestfs.pod:2033
3933 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3934 "not have any particular meaning -- keys are not returned in any defined "
3935 "order). A pointer to the key is returned in C<*key_rtn> and the "
3936 "corresponding data pointer is returned from the function. C<NULL> is "
3937 "returned if there are no keys stored in the handle."
3941 #: ../src/guestfs.pod:2039
3943 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3944 "value of this function is also C<NULL> is there are no further entries to "
3949 #: ../src/guestfs.pod:2043
3950 msgid "Notes about walking over entries:"
3954 #: ../src/guestfs.pod:2049
3955 msgid "You must not call C<guestfs_set_private> while walking over the entries."
3959 #: ../src/guestfs.pod:2054
3961 "The handle maintains an internal iterator which is reset when you call "
3962 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3963 "call C<guestfs_set_private>."
3967 #: ../src/guestfs.pod:2060
3968 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3972 #: ../src/guestfs.pod:2062
3975 " guestfs_set_private (g, key, NULL);\n"
3980 #: ../src/guestfs.pod:2064
3981 msgid "then that C<key> is not returned when walking."
3985 #: ../src/guestfs.pod:2068
3987 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
3988 "C<guestfs_next_private> or C<guestfs_set_private>."
3992 #: ../src/guestfs.pod:2074
3994 "The following example code shows how to print all keys and data pointers "
3995 "that are associated with the handle C<g>:"
3999 #: ../src/guestfs.pod:2077
4002 " const char *key;\n"
4003 " void *data = guestfs_first_private (g, &key);\n"
4004 " while (data != NULL)\n"
4006 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4007 " data = guestfs_next_private (g, &key);\n"
4013 #: ../src/guestfs.pod:2085
4015 "More commonly you are only interested in keys that begin with an "
4016 "application-specific prefix C<foo_>. Modify the loop like so:"
4020 #: ../src/guestfs.pod:2088
4023 " const char *key;\n"
4024 " void *data = guestfs_first_private (g, &key);\n"
4025 " while (data != NULL)\n"
4027 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4028 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4029 " data = guestfs_next_private (g, &key);\n"
4035 #: ../src/guestfs.pod:2097
4037 "If you need to modify keys while walking, then you have to jump back to the "
4038 "beginning of the loop. For example, to delete all keys prefixed with "
4043 #: ../src/guestfs.pod:2101
4046 " const char *key;\n"
4049 " data = guestfs_first_private (g, &key);\n"
4050 " while (data != NULL)\n"
4052 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4054 " guestfs_set_private (g, key, NULL);\n"
4055 " /* note that 'key' pointer is now invalid, and so is\n"
4056 " the internal iterator */\n"
4059 " data = guestfs_next_private (g, &key);\n"
4065 #: ../src/guestfs.pod:2117
4067 "Note that the above loop is guaranteed to terminate because the keys are "
4068 "being deleted, but other manipulations of keys within the loop might not "
4069 "terminate unless you also maintain an indication of which keys have been "
4074 #: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
4079 #: ../src/guestfs.pod:2124
4081 "<!-- old anchor for the next section --> <a "
4082 "name=\"state_machine_and_low_level_event_api\"/>"
4086 #: ../src/guestfs.pod:2129
4087 msgid "ARCHITECTURE"
4091 #: ../src/guestfs.pod:2131
4093 "Internally, libguestfs is implemented by running an appliance (a special "
4094 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4095 "process of the main program."
4099 #: ../src/guestfs.pod:2135
4102 " ___________________\n"
4104 " | main program |\n"
4106 " | | child process / appliance\n"
4107 " | | __________________________\n"
4109 " +-------------------+ RPC | +-----------------+ |\n"
4110 " | libguestfs <--------------------> guestfsd | |\n"
4111 " | | | +-----------------+ |\n"
4112 " \\___________________/ | | Linux kernel | |\n"
4113 " | +--^--------------+ |\n"
4114 " \\_________|________________/\n"
4120 " \\______________/\n"
4125 #: ../src/guestfs.pod:2155
4127 "The library, linked to the main program, creates the child process and hence "
4128 "the appliance in the L</guestfs_launch> function."
4132 #: ../src/guestfs.pod:2158
4134 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4135 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4136 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4137 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4138 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4139 "attached to the qemu process which translates device access by the "
4140 "appliance's Linux kernel into accesses to the image."
4144 #: ../src/guestfs.pod:2167
4146 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4147 "Although the disk image you are attached to might also be used by some "
4148 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4149 "care if both libguestfs's qemu process and your virtual machine are trying "
4150 "to update the disk image at the same time, since these usually results in "
4151 "massive disk corruption)."
4155 #: ../src/guestfs.pod:2174
4156 msgid "STATE MACHINE"
4160 #: ../src/guestfs.pod:2176
4161 msgid "libguestfs uses a state machine to model the child process:"
4165 #: ../src/guestfs.pod:2178
4177 " / | \\ \\ guestfs_launch\n"
4178 " / | _\\__V______\n"
4180 " / | | LAUNCHING |\n"
4181 " / | \\___________/\n"
4183 " / | guestfs_launch\n"
4185 " ______ / __|____V\n"
4186 " / \\ ------> / \\\n"
4187 " | BUSY | | READY |\n"
4188 " \\______/ <------ \\________/\n"
4193 #: ../src/guestfs.pod:2200
4195 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4196 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4197 "(3) alternating between READY and BUSY as commands are issued to, and "
4198 "carried out by, the child process."
4202 #: ../src/guestfs.pod:2205
4204 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4205 "asynchronously at any time (eg. due to some internal error), and that causes "
4206 "the state to transition back to CONFIG."
4210 #: ../src/guestfs.pod:2209
4212 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4213 "issued when in the CONFIG state."
4217 #: ../src/guestfs.pod:2212
4219 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4220 "L</guestfs_launch> blocks until the child process is READY to accept "
4221 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4222 "moves the state from CONFIG to LAUNCHING while it is running."
4226 #: ../src/guestfs.pod:2218
4228 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4229 "state. These API calls block waiting for the command to be carried out "
4230 "(ie. the state to transition to BUSY and then back to READY). There are no "
4231 "non-blocking versions, and no way to issue more than one command per handle "
4236 #: ../src/guestfs.pod:2224
4238 "Finally, the child process sends asynchronous messages back to the main "
4239 "program, such as kernel log messages. You can register a callback to "
4240 "receive these messages."
4244 #: ../src/guestfs.pod:2228
4249 #: ../src/guestfs.pod:2230
4250 msgid "COMMUNICATION PROTOCOL"
4254 #: ../src/guestfs.pod:2232
4256 "Don't rely on using this protocol directly. This section documents how it "
4257 "currently works, but it may change at any time."
4261 #: ../src/guestfs.pod:2235
4263 "The protocol used to talk between the library and the daemon running inside "
4264 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4265 "1014, RFC 1832, RFC 4506)."
4269 #: ../src/guestfs.pod:2239
4271 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4272 "this file is automatically generated)."
4276 #: ../src/guestfs.pod:2242
4278 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4279 "and C<FileOut> parameters, which are handled with very simple request/reply "
4280 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4281 "parameters, which use the same request and reply messages, but they may also "
4282 "be followed by files sent using a chunked encoding."
4286 #: ../src/guestfs.pod:2249
4287 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4291 #: ../src/guestfs.pod:2251
4292 msgid "For ordinary functions, the request message is:"
4296 #: ../src/guestfs.pod:2253
4299 " total length (header + arguments,\n"
4300 " but not including the length word itself)\n"
4301 " struct guestfs_message_header (encoded as XDR)\n"
4302 " struct guestfs_<foo>_args (encoded as XDR)\n"
4307 #: ../src/guestfs.pod:2258
4309 "The total length field allows the daemon to allocate a fixed size buffer "
4310 "into which it slurps the rest of the message. As a result, the total length "
4311 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4312 "effective size of any request is limited to somewhere under this size."
4316 #: ../src/guestfs.pod:2264
4318 "Note also that many functions don't take any arguments, in which case the "
4319 "C<guestfs_I<foo>_args> is completely omitted."
4323 #: ../src/guestfs.pod:2267
4325 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4326 "receiver knows what type of args structure to expect, or none at all."
4330 #: ../src/guestfs.pod:2271
4332 "For functions that take optional arguments, the optional arguments are "
4333 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4334 "arguments. A bitmask in the header indicates which optional arguments are "
4335 "meaningful. The bitmask is also checked to see if it contains bits set "
4336 "which the daemon does not know about (eg. if more optional arguments were "
4337 "added in a later version of the library), and this causes the call to be "
4342 #: ../src/guestfs.pod:2279
4343 msgid "The reply message for ordinary functions is:"
4347 #: ../src/guestfs.pod:2281
4350 " total length (header + ret,\n"
4351 " but not including the length word itself)\n"
4352 " struct guestfs_message_header (encoded as XDR)\n"
4353 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4358 #: ../src/guestfs.pod:2286
4360 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4361 "functions that return no formal return values."
4365 #: ../src/guestfs.pod:2289
4366 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4370 #: ../src/guestfs.pod:2292
4372 "In the case of an error, a flag is set in the header, and the reply message "
4373 "is slightly changed:"
4377 #: ../src/guestfs.pod:2295
4380 " total length (header + error,\n"
4381 " but not including the length word itself)\n"
4382 " struct guestfs_message_header (encoded as XDR)\n"
4383 " struct guestfs_message_error (encoded as XDR)\n"
4388 #: ../src/guestfs.pod:2300
4390 "The C<guestfs_message_error> structure contains the error message as a "
4395 #: ../src/guestfs.pod:2303
4396 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4400 #: ../src/guestfs.pod:2305
4402 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4403 "The normal request message is sent (see above). However this is followed by "
4404 "a sequence of file chunks."
4408 #: ../src/guestfs.pod:2309
4411 " total length (header + arguments,\n"
4412 " but not including the length word itself,\n"
4413 " and not including the chunks)\n"
4414 " struct guestfs_message_header (encoded as XDR)\n"
4415 " struct guestfs_<foo>_args (encoded as XDR)\n"
4416 " sequence of chunks for FileIn param #0\n"
4417 " sequence of chunks for FileIn param #1 etc.\n"
4422 #: ../src/guestfs.pod:2317
4423 msgid "The \"sequence of chunks\" is:"
4427 #: ../src/guestfs.pod:2319
4430 " length of chunk (not including length word itself)\n"
4431 " struct guestfs_chunk (encoded as XDR)\n"
4432 " length of chunk\n"
4433 " struct guestfs_chunk (encoded as XDR)\n"
4435 " length of chunk\n"
4436 " struct guestfs_chunk (with data.data_len == 0)\n"
4441 #: ../src/guestfs.pod:2327
4443 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4444 "is set in the final chunk to indicate either successful completion or early "
4449 #: ../src/guestfs.pod:2331
4451 "At time of writing there are no functions that have more than one FileIn "
4452 "parameter. However this is (theoretically) supported, by sending the "
4453 "sequence of chunks for each FileIn parameter one after another (from left to "
4458 #: ../src/guestfs.pod:2336
4460 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4461 "transfer. The library does this by sending a chunk with a special flag set "
4462 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4463 "RPC, does I<not> send any reply, and goes back to reading the next request."
4467 #: ../src/guestfs.pod:2342
4469 "The daemon may also cancel. It does this by writing a special word "
4470 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4471 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4472 "cancel chunk). The special word is chosen so that even if cancellation "
4473 "happens right at the end of the transfer (after the library has finished "
4474 "writing and has started listening for the reply), the \"spurious\" cancel "
4475 "flag will not be confused with the reply message."
4479 #: ../src/guestfs.pod:2351
4481 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4482 "limit), and also files where the size is not known in advance (eg. from "
4483 "pipes or sockets). However the chunks are rather small "
4484 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4485 "to keep much in memory."
4489 #: ../src/guestfs.pod:2357
4490 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4494 #: ../src/guestfs.pod:2359
4496 "The protocol for FileOut parameters is exactly the same as for FileIn "
4497 "parameters, but with the roles of daemon and library reversed."
4501 #: ../src/guestfs.pod:2362
4504 " total length (header + ret,\n"
4505 " but not including the length word itself,\n"
4506 " and not including the chunks)\n"
4507 " struct guestfs_message_header (encoded as XDR)\n"
4508 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4509 " sequence of chunks for FileOut param #0\n"
4510 " sequence of chunks for FileOut param #1 etc.\n"
4515 #: ../src/guestfs.pod:2370
4516 msgid "INITIAL MESSAGE"
4520 #: ../src/guestfs.pod:2372
4522 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4523 "which indicates that the guest and daemon is alive. This is what "
4524 "L</guestfs_launch> waits for."
4528 #: ../src/guestfs.pod:2376
4529 msgid "PROGRESS NOTIFICATION MESSAGES"
4533 #: ../src/guestfs.pod:2378
4535 "The daemon may send progress notification messages at any time. These are "
4536 "distinguished by the normal length word being replaced by "
4537 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4541 #: ../src/guestfs.pod:2382
4543 "The library turns them into progress callbacks (see "
4544 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4549 #: ../src/guestfs.pod:2386
4551 "The daemon self-limits the frequency of progress messages it sends (see "
4552 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4557 #: ../src/guestfs.pod:2390
4558 msgid "LIBGUESTFS VERSION NUMBERS"
4562 #: ../src/guestfs.pod:2392
4564 "Since April 2010, libguestfs has started to make separate development and "
4565 "stable releases, along with corresponding branches in our git repository. "
4566 "These separate releases can be identified by version number:"
4570 #: ../src/guestfs.pod:2397
4573 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4574 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4580 " | `-------- sub-version\n"
4582 " `------ always '1' because we don't change the ABI\n"
4587 #: ../src/guestfs.pod:2408
4588 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4592 #: ../src/guestfs.pod:2410
4594 "As time passes we cherry pick fixes from the development branch and backport "
4595 "those into the stable branch, the effect being that the stable branch should "
4596 "get more stable and less buggy over time. So the stable releases are ideal "
4597 "for people who don't need new features but would just like the software to "
4602 #: ../src/guestfs.pod:2416
4603 msgid "Our criteria for backporting changes are:"
4607 #: ../src/guestfs.pod:2422
4609 "Documentation changes which don't affect any code are backported unless the "
4610 "documentation refers to a future feature which is not in stable."
4614 #: ../src/guestfs.pod:2428
4616 "Bug fixes which are not controversial, fix obvious problems, and have been "
4617 "well tested are backported."
4621 #: ../src/guestfs.pod:2433
4623 "Simple rearrangements of code which shouldn't affect how it works get "
4624 "backported. This is so that the code in the two branches doesn't get too "
4625 "far out of step, allowing us to backport future fixes more easily."
4629 #: ../src/guestfs.pod:2439
4631 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4632 "exceptional case: the new feature is required in order to implement an "
4633 "important bug fix."
4637 #: ../src/guestfs.pod:2445
4639 "A new stable branch starts when we think the new features in development are "
4640 "substantial and compelling enough over the current stable branch to warrant "
4641 "it. When that happens we create new stable and development versions 1.N.0 "
4642 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4643 "stable at this point, but by backporting fixes from development, that branch "
4644 "will stabilize over time."
4648 #: ../src/guestfs.pod:2453
4649 msgid "EXTENDING LIBGUESTFS"
4653 #: ../src/guestfs.pod:2455
4654 msgid "ADDING A NEW API ACTION"
4658 #: ../src/guestfs.pod:2457
4660 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4661 "documentation) are generated, and this makes it easy to extend the "
4666 #: ../src/guestfs.pod:2461
4667 msgid "To add a new API action there are two changes:"
4671 #: ../src/guestfs.pod:2467
4673 "You need to add a description of the call (name, parameters, return type, "
4674 "tests, documentation) to C<generator/generator_actions.ml>."
4678 #: ../src/guestfs.pod:2470
4680 "There are two sorts of API action, depending on whether the call goes "
4681 "through to the daemon in the appliance, or is serviced entirely by the "
4682 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4683 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4684 "an example of the latter, since a trace flag is maintained in the handle and "
4685 "all tracing is done on the library side."
4689 #: ../src/guestfs.pod:2478
4691 "Most new actions are of the first type, and get added to the "
4692 "C<daemon_functions> list. Each function has a unique procedure number used "
4693 "in the RPC protocol which is assigned to that action when we publish "
4694 "libguestfs and cannot be reused. Take the latest procedure number and "
4699 #: ../src/guestfs.pod:2484
4701 "For library-only actions of the second type, add to the "
4702 "C<non_daemon_functions> list. Since these functions are serviced by the "
4703 "library and do not travel over the RPC mechanism to the daemon, these "
4704 "functions do not need a procedure number, and so the procedure number is set "
4709 #: ../src/guestfs.pod:2492
4710 msgid "Implement the action (in C):"
4714 #: ../src/guestfs.pod:2494
4716 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4717 "C<daemon/> directory."
4721 #: ../src/guestfs.pod:2497
4723 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4724 "(note: double underscore) in the C<src/> directory."
4728 #: ../src/guestfs.pod:2500
4729 msgid "In either case, use another function as an example of what to do."
4733 #: ../src/guestfs.pod:2504
4734 msgid "After making these changes, use C<make> to compile."
4738 #: ../src/guestfs.pod:2506
4740 "Note that you don't need to implement the RPC, language bindings, manual "
4741 "pages or anything else. It's all automatically generated from the OCaml "
4746 #: ../src/guestfs.pod:2510
4747 msgid "ADDING TESTS FOR AN API ACTION"
4751 #: ../src/guestfs.pod:2512
4753 "You can supply zero or as many tests as you want per API call. The tests "
4754 "can either be added as part of the API description "
4755 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4756 "drop a script into C<regressions/>. Note that adding a script to "
4757 "C<regressions/> is slower, so if possible use the first method."
4761 #: ../src/guestfs.pod:2518
4763 "The following describes the test environment used when you add an API test "
4764 "in C<generator_actions.ml>."
4768 #: ../src/guestfs.pod:2521
4769 msgid "The test environment has 4 block devices:"
4773 #: ../src/guestfs.pod:2525
4774 msgid "C</dev/sda> 500MB"
4778 #: ../src/guestfs.pod:2527
4779 msgid "General block device for testing."
4783 #: ../src/guestfs.pod:2529
4784 msgid "C</dev/sdb> 50MB"
4788 #: ../src/guestfs.pod:2531
4790 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4795 #: ../src/guestfs.pod:2534
4796 msgid "C</dev/sdc> 10MB"
4800 #: ../src/guestfs.pod:2536
4801 msgid "Used in a few tests where two block devices are needed."
4805 #: ../src/guestfs.pod:2538
4810 #: ../src/guestfs.pod:2540
4811 msgid "ISO with fixed content (see C<images/test.iso>)."
4815 #: ../src/guestfs.pod:2544
4817 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4818 "appliance and block devices are reused between tests. So don't try testing "
4819 "L</guestfs_kill_subprocess> :-x"
4823 #: ../src/guestfs.pod:2548
4825 "Each test starts with an initial scenario, selected using one of the "
4826 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4827 "initialize the disks mentioned above in a particular way as documented in "
4828 "C<generator_types.ml>. You should not assume anything about the previous "
4829 "contents of other disks that are not initialized."
4833 #: ../src/guestfs.pod:2554
4835 "You can add a prerequisite clause to any individual test. This is a "
4836 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4837 "if testing a command which might not work on all variations of libguestfs "
4838 "builds. A test that has prerequisite of C<Always> means to run "
4843 #: ../src/guestfs.pod:2560
4845 "In addition, packagers can skip individual tests by setting environment "
4846 "variables before running C<make check>."
4850 #: ../src/guestfs.pod:2563
4853 " SKIP_TEST_<CMD>_<NUM>=1\n"
4858 #: ../src/guestfs.pod:2565
4859 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4863 #: ../src/guestfs.pod:2567
4868 #: ../src/guestfs.pod:2569
4871 " SKIP_TEST_<CMD>=1\n"
4876 #: ../src/guestfs.pod:2571
4877 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4881 #: ../src/guestfs.pod:2573
4882 msgid "Packagers can run only certain tests by setting for example:"
4886 #: ../src/guestfs.pod:2575
4889 " TEST_ONLY=\"vfs_type zerofree\"\n"
4894 #: ../src/guestfs.pod:2577
4896 "See C<capitests/tests.c> for more details of how these environment variables "
4901 #: ../src/guestfs.pod:2580
4902 msgid "DEBUGGING NEW API ACTIONS"
4906 #: ../src/guestfs.pod:2582
4907 msgid "Test new actions work before submitting them."
4911 #: ../src/guestfs.pod:2584
4912 msgid "You can use guestfish to try out new commands."
4916 #: ../src/guestfs.pod:2586
4918 "Debugging the daemon is a problem because it runs inside a minimal "
4919 "environment. However you can fprintf messages in the daemon to stderr, and "
4920 "they will show up if you use C<guestfish -v>."
4924 #: ../src/guestfs.pod:2590
4925 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4929 #: ../src/guestfs.pod:2592
4931 "Our C source code generally adheres to some basic code-formatting "
4932 "conventions. The existing code base is not totally consistent on this "
4933 "front, but we do prefer that contributed code be formatted similarly. In "
4934 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4935 "indentation level, and other than that, follow the K&R style."
4939 #: ../src/guestfs.pod:2598
4941 "If you use Emacs, add the following to one of one of your start-up files "
4942 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4946 #: ../src/guestfs.pod:2601
4949 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4950 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4951 " (add-hook 'find-file-hook\n"
4952 " '(lambda () (if (and buffer-file-name\n"
4953 " (string-match \"/libguestfs\\\\>\"\n"
4954 " (buffer-file-name))\n"
4955 " (not (string-equal mode-name \"Change Log\"))\n"
4956 " (not (string-equal mode-name \"Makefile\")))\n"
4957 " (setq indent-tabs-mode nil))))\n"
4962 #: ../src/guestfs.pod:2611
4965 " ;;; When editing C sources in libguestfs, use this style.\n"
4966 " (defun libguestfs-c-mode ()\n"
4967 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4969 " (c-set-style \"K&R\")\n"
4970 " (setq c-indent-level 2)\n"
4971 " (setq c-basic-offset 2))\n"
4972 " (add-hook 'c-mode-hook\n"
4973 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4974 " (buffer-file-name))\n"
4975 " (libguestfs-c-mode))))\n"
4980 #: ../src/guestfs.pod:2623
4981 msgid "Enable warnings when compiling (and fix any problems this finds):"
4985 #: ../src/guestfs.pod:2626
4988 " ./configure --enable-gcc-warnings\n"
4993 #: ../src/guestfs.pod:2628
4994 msgid "Useful targets are:"
4998 #: ../src/guestfs.pod:2630
5001 " make syntax-check # checks the syntax of the C code\n"
5002 " make check # runs the test suite\n"
5007 #: ../src/guestfs.pod:2633
5008 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5012 #: ../src/guestfs.pod:2635
5014 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
5015 "which are used to do shell quoting."
5019 #: ../src/guestfs.pod:2640
5024 #: ../src/guestfs.pod:2642
5026 "Simple shell quoted string. Any spaces or other shell characters are "
5031 #: ../src/guestfs.pod:2645
5036 #: ../src/guestfs.pod:2647
5038 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5043 #: ../src/guestfs.pod:2652 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
5044 msgid "For example:"
5048 #: ../src/guestfs.pod:2654
5051 " asprintf (&cmd, \"cat %R\", path);\n"
5056 #: ../src/guestfs.pod:2656
5057 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5061 #: ../src/guestfs.pod:2658
5063 "I<Note:> Do I<not> use these when you are passing parameters to the "
5064 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
5065 "because they are not passed via the shell (instead, straight to exec). You "
5066 "probably want to use the C<sysroot_path()> function however."
5070 #: ../src/guestfs.pod:2664
5071 msgid "SUBMITTING YOUR NEW API ACTIONS"
5075 #: ../src/guestfs.pod:2666
5077 "Submit patches to the mailing list: "
5078 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5079 "L<rjones@redhat.com>."
5083 #: ../src/guestfs.pod:2670
5084 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5088 #: ../src/guestfs.pod:2672
5089 msgid "We support i18n (gettext anyhow) in the library."
5093 #: ../src/guestfs.pod:2674
5095 "However many messages come from the daemon, and we don't translate those at "
5096 "the moment. One reason is that the appliance generally has all locale files "
5097 "removed from it, because they take up a lot of space. So we'd have to readd "
5098 "some of those, as well as copying our PO files into the appliance."
5102 #: ../src/guestfs.pod:2680
5104 "Debugging messages are never translated, since they are intended for the "
5109 #: ../src/guestfs.pod:2683
5110 msgid "SOURCE CODE SUBDIRECTORIES"
5114 #: ../src/guestfs.pod:2687 ../src/guestfs-actions.pod:6174 ../fish/guestfish-actions.pod:4072
5115 msgid "C<appliance>"
5119 #: ../src/guestfs.pod:2689
5120 msgid "The libguestfs appliance, build scripts and so on."
5124 #: ../src/guestfs.pod:2691
5125 msgid "C<capitests>"
5129 #: ../src/guestfs.pod:2693
5130 msgid "Automated tests of the C API."
5134 #: ../src/guestfs.pod:2695
5139 #: ../src/guestfs.pod:2697
5141 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5146 #: ../src/guestfs.pod:2700
5151 #: ../src/guestfs.pod:2702
5153 "Safety and liveness tests of components that libguestfs depends upon (not of "
5154 "libguestfs itself). Mainly this is for qemu and the kernel."
5158 #: ../src/guestfs.pod:2705
5163 #: ../src/guestfs.pod:2707
5164 msgid "Outside contributions, experimental parts."
5168 #: ../src/guestfs.pod:2709
5173 #: ../src/guestfs.pod:2711
5175 "The daemon that runs inside the libguestfs appliance and carries out "
5180 #: ../src/guestfs.pod:2714
5185 #: ../src/guestfs.pod:2716
5186 msgid "L<virt-df(1)> command and documentation."
5190 #: ../src/guestfs.pod:2718
5195 #: ../src/guestfs.pod:2720
5196 msgid "L<virt-edit(1)> command and documentation."
5200 #: ../src/guestfs.pod:2722
5205 #: ../src/guestfs.pod:2724
5206 msgid "C API example code."
5210 #: ../src/guestfs.pod:2726
5215 #: ../src/guestfs.pod:2728
5217 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5218 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5219 "L<virt-tar-out(1)>."
5223 #: ../src/guestfs.pod:2732
5228 #: ../src/guestfs.pod:2734
5229 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5233 #: ../src/guestfs.pod:2736
5234 msgid "C<generator>"
5238 #: ../src/guestfs.pod:2738
5240 "The crucially important generator, used to automatically generate large "
5241 "amounts of boilerplate C code for things like RPC and bindings."
5245 #: ../src/guestfs.pod:2741
5250 #: ../src/guestfs.pod:2743
5251 msgid "Files used by the test suite."
5255 #: ../src/guestfs.pod:2745
5256 msgid "Some \"phony\" guest images which we test against."
5260 #: ../src/guestfs.pod:2747
5261 msgid "C<inspector>"
5265 #: ../src/guestfs.pod:2749
5266 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5270 #: ../src/guestfs.pod:2751
5275 #: ../src/guestfs.pod:2753
5276 msgid "Logo used on the website. The fish is called Arthur by the way."
5280 #: ../src/guestfs.pod:2755
5285 #: ../src/guestfs.pod:2757
5286 msgid "M4 macros used by autoconf."
5290 #: ../src/guestfs.pod:2759
5295 #: ../src/guestfs.pod:2761
5296 msgid "Translations of simple gettext strings."
5300 #: ../src/guestfs.pod:2763
5305 #: ../src/guestfs.pod:2765
5307 "The build infrastructure and PO files for translations of manpages and POD "
5308 "files. Eventually this will be combined with the C<po> directory, but that "
5309 "is rather complicated."
5313 #: ../src/guestfs.pod:2769
5314 msgid "C<regressions>"
5318 #: ../src/guestfs.pod:2771
5319 msgid "Regression tests."
5323 #: ../src/guestfs.pod:2773
5328 #: ../src/guestfs.pod:2775
5329 msgid "L<virt-rescue(1)> command and documentation."
5333 #: ../src/guestfs.pod:2777
5338 #: ../src/guestfs.pod:2779
5339 msgid "Source code to the C library."
5343 #: ../src/guestfs.pod:2781
5348 #: ../src/guestfs.pod:2783
5349 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5353 #: ../src/guestfs.pod:2785
5354 msgid "C<test-tool>"
5358 #: ../src/guestfs.pod:2787
5360 "Test tool for end users to test if their qemu/kernel combination will work "
5365 #: ../src/guestfs.pod:2790
5370 #: ../src/guestfs.pod:2792
5375 #: ../src/guestfs.pod:2794
5380 #: ../src/guestfs.pod:2796
5385 #: ../src/guestfs.pod:2798
5390 #: ../src/guestfs.pod:2800
5395 #: ../src/guestfs.pod:2802
5400 #: ../src/guestfs.pod:2804
5405 #: ../src/guestfs.pod:2806
5406 msgid "Language bindings."
5410 #: ../src/guestfs.pod:2810
5415 #: ../src/guestfs.pod:2812
5416 msgid "PROTOCOL LIMITS"
5420 #: ../src/guestfs.pod:2814
5422 "Internally libguestfs uses a message-based protocol to pass API calls and "
5423 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5424 "plenty more detail about this). The maximum message size used by the "
5425 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5426 "aware of this limit. The API calls which may be affected are individually "
5427 "documented, with a link back to this section of the documentation."
5431 #: ../src/guestfs.pod:2822
5433 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5434 "a simple string. Because this string is at some point internally encoded as "
5435 "a message, the maximum size that it can return is slightly under 4 MB. If "
5436 "the requested file is larger than this then you will get an error."
5440 #: ../src/guestfs.pod:2828
5442 "In order to transfer large files into and out of the guest filesystem, you "
5443 "need to use particular calls that support this. The sections L</UPLOADING> "
5444 "and L</DOWNLOADING> document how to do this."
5448 #: ../src/guestfs.pod:2832
5450 "You might also consider mounting the disk image using our FUSE filesystem "
5451 "support (L<guestmount(1)>)."
5455 #: ../src/guestfs.pod:2835
5456 msgid "MAXIMUM NUMBER OF DISKS"
5460 #: ../src/guestfs.pod:2837
5461 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5465 #: ../src/guestfs.pod:2840
5467 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5468 "slots. However febootstrap only understands disks with names C</dev/vda> "
5469 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5474 #: ../src/guestfs.pod:2845
5476 "We are working to substantially raise this limit in future versions but it "
5477 "requires complex changes to qemu."
5481 #: ../src/guestfs.pod:2848
5483 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5484 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5485 "requires changes to qemu."
5489 #: ../src/guestfs.pod:2852
5490 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5494 #: ../src/guestfs.pod:2854
5495 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5499 #: ../src/guestfs.pod:2856
5501 "This is because it reserves 4 bits for the minor device number (thus "
5502 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5506 #: ../src/guestfs.pod:2859
5508 "If you attach a disk with more than 15 partitions, the extra partitions are "
5509 "ignored by libguestfs."
5513 #: ../src/guestfs.pod:2862
5514 msgid "MAXIMUM SIZE OF A DISK"
5518 #: ../src/guestfs.pod:2864
5519 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5523 #: ../src/guestfs.pod:2866
5525 "We have tested block devices up to 1 exabyte (2**60 or "
5526 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5531 #: ../src/guestfs.pod:2870
5533 "Although libguestfs probably does not impose any limit, the underlying host "
5534 "storage will. If you store disk images on a host ext4 filesystem, then the "
5535 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5536 "TB). If you store disk images as host logical volumes then you are limited "
5537 "by the maximum size of an LV."
5541 #: ../src/guestfs.pod:2876
5543 "For the hugest disk image files, we recommend using XFS on the host for "
5548 #: ../src/guestfs.pod:2879
5549 msgid "MAXIMUM SIZE OF A PARTITION"
5553 #: ../src/guestfs.pod:2881
5555 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5556 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5557 "address a partition located beyond 2 TB on the disk."
5561 #: ../src/guestfs.pod:2885
5563 "It is recommended that you use GPT partitions on disks which are larger than "
5564 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5565 "which are theoretically larger than the largest disk we could support."
5569 #: ../src/guestfs.pod:2890
5570 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5574 #: ../src/guestfs.pod:2892
5576 "This depends on the filesystem type. libguestfs itself does not impose any "
5577 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5578 "what these limits are."
5582 #: ../src/guestfs.pod:2896
5583 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5587 #: ../src/guestfs.pod:2898
5589 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5590 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5591 "uploads and downloads."
5595 #: ../src/guestfs.pod:2902
5596 msgid "INSPECTION LIMITS"
5600 #: ../src/guestfs.pod:2904
5602 "The inspection code has several arbitrary limits on things like the size of "
5603 "Windows Registry hive it will read, and the length of product name. These "
5604 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5605 "memory and disk space on the host, and should not be reached in practice. "
5606 "See the source code for more information."
5610 #: ../src/guestfs.pod:2910 ../fish/guestfish.pod:1075 ../test-tool/libguestfs-test-tool.pod:82
5611 msgid "ENVIRONMENT VARIABLES"
5615 #: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1106
5616 msgid "LIBGUESTFS_APPEND"
5620 #: ../src/guestfs.pod:2916 ../fish/guestfish.pod:1108
5621 msgid "Pass additional options to the guest kernel."
5625 #: ../src/guestfs.pod:2918 ../fish/guestfish.pod:1110
5626 msgid "LIBGUESTFS_DEBUG"
5630 #: ../src/guestfs.pod:2920
5632 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5633 "effect as calling C<guestfs_set_verbose (g, 1)>."
5637 #: ../src/guestfs.pod:2923 ../fish/guestfish.pod:1115
5638 msgid "LIBGUESTFS_MEMSIZE"
5642 #: ../src/guestfs.pod:2925 ../fish/guestfish.pod:1117
5643 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5647 #: ../src/guestfs.pod:2928 ../fish/guestfish.pod:1120
5650 " LIBGUESTFS_MEMSIZE=700\n"
5655 #: ../src/guestfs.pod:2930 ../fish/guestfish.pod:1122
5656 msgid "LIBGUESTFS_PATH"
5660 #: ../src/guestfs.pod:2932
5662 "Set the path that libguestfs uses to search for a supermin appliance. See "
5663 "the discussion of paths in section L</PATH> above."
5667 #: ../src/guestfs.pod:2935 ../fish/guestfish.pod:1127
5668 msgid "LIBGUESTFS_QEMU"
5672 #: ../src/guestfs.pod:2937 ../fish/guestfish.pod:1129
5674 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5675 "which was found at compile time by the configure script is used."
5679 #: ../src/guestfs.pod:2941
5680 msgid "See also L</QEMU WRAPPERS> above."
5684 #: ../src/guestfs.pod:2943 ../fish/guestfish.pod:1133
5685 msgid "LIBGUESTFS_TRACE"
5689 #: ../src/guestfs.pod:2945
5691 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5692 "effect as calling C<guestfs_set_trace (g, 1)>."
5696 #: ../src/guestfs.pod:2948 ../fish/guestfish.pod:1142
5701 #: ../src/guestfs.pod:2950 ../fish/guestfish.pod:1144
5703 "Location of temporary directory, defaults to C</tmp> except for the cached "
5704 "supermin appliance which defaults to C</var/tmp>."
5708 #: ../src/guestfs.pod:2953 ../fish/guestfish.pod:1147
5710 "If libguestfs was compiled to use the supermin appliance then the real "
5711 "appliance is cached in this directory, shared between all handles belonging "
5712 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5713 "use in case C</var/tmp> is not large enough."
5717 #: ../src/guestfs.pod:2961 ../fish/guestfish.pod:1214 ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279 ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539 ../tools/virt-list-partitions.pl:257
5722 #: ../src/guestfs.pod:2963
5724 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5725 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5726 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5727 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5728 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5729 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5730 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5731 "L<http://libguestfs.org/>."
5735 #: ../src/guestfs.pod:2990
5737 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5738 "L<lvm(8)>, L<disktype(1)>."
5742 #: ../src/guestfs.pod:2997 ../tools/virt-win-reg.pl:759 ../tools/virt-make-fs.pl:553
5747 #: ../src/guestfs.pod:2999
5748 msgid "To get a list of bugs against libguestfs use this link:"
5752 #: ../src/guestfs.pod:3001
5753 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5757 #: ../src/guestfs.pod:3003
5758 msgid "To report a new bug against libguestfs use this link:"
5762 #: ../src/guestfs.pod:3005
5763 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5767 #: ../src/guestfs.pod:3007
5768 msgid "When reporting a bug, please check:"
5772 #: ../src/guestfs.pod:3013
5773 msgid "That the bug hasn't been reported already."
5777 #: ../src/guestfs.pod:3017
5778 msgid "That you are testing a recent version."
5782 #: ../src/guestfs.pod:3021
5783 msgid "Describe the bug accurately, and give a way to reproduce it."
5787 #: ../src/guestfs.pod:3025
5789 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5794 #: ../src/guestfs.pod:3030 ../fish/guestfish.pod:1238 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5799 #: ../src/guestfs.pod:3032 ../fish/guestfish.pod:1240 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5800 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5804 #: ../src/guestfs.pod:3034 ../fish/guestfish.pod:1242 ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294 ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568 ../tools/virt-list-partitions.pl:273
5809 #: ../src/guestfs.pod:3036 ../fish/guestfish.pod:1244 ../test-tool/libguestfs-test-tool.pod:99
5810 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5814 #: ../src/guestfs.pod:3039
5816 "This library is free software; you can redistribute it and/or modify it "
5817 "under the terms of the GNU Lesser General Public License as published by the "
5818 "Free Software Foundation; either version 2 of the License, or (at your "
5819 "option) any later version."
5823 #: ../src/guestfs.pod:3044
5825 "This library is distributed in the hope that it will be useful, but WITHOUT "
5826 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5827 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5832 #: ../src/guestfs.pod:3049
5834 "You should have received a copy of the GNU Lesser General Public License "
5835 "along with this library; if not, write to the Free Software Foundation, "
5836 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5840 #: ../src/guestfs-actions.pod:1
5841 msgid "guestfs_add_cdrom"
5845 #: ../src/guestfs-actions.pod:3
5849 " guestfs_add_cdrom (guestfs_h *g,\n"
5850 " const char *filename);\n"
5855 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5856 msgid "This function adds a virtual CD-ROM disk image to the guest."
5860 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5861 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5865 #: ../src/guestfs-actions.pod:17
5867 "This call checks for the existence of C<filename>. This stops you from "
5868 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5869 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5874 #: ../src/guestfs-actions.pod:24
5876 "If you just want to add an ISO file (often you use this as an efficient way "
5877 "to transfer large files into the guest), then you should probably use "
5878 "C<guestfs_add_drive_ro> instead."
5882 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307 ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547 ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821 ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1041 ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1234 ../src/guestfs-actions.pod:1304 ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1402 ../src/guestfs-actions.pod:1508 ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1757 ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:2339 ../src/guestfs-actions.pod:2483 ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2579 ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3634 ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3848 ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:3875 ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3904 ../src/guestfs-actions.pod:3940 ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4049 ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4095 ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4149 ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:4251 ../src/guestfs-actions.pod:4267 ../src/guestfs-actions.pod:4280 ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4312 ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4425 ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4507 ../src/guestfs-actions.pod:4525 ../src/guestfs-actions.pod:4541 ../src/guestfs-actions.pod:4555 ../src/guestfs-actions.pod:4569 ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4601 ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4691 ../src/guestfs-actions.pod:4764 ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4833 ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4862 ../src/guestfs-actions.pod:4875 ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4905 ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5032 ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:5158 ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5248 ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5300 ../src/guestfs-actions.pod:5318 ../src/guestfs-actions.pod:5452 ../src/guestfs-actions.pod:5509 ../src/guestfs-actions.pod:5531 ../src/guestfs-actions.pod:5549 ../src/guestfs-actions.pod:5581 ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5677 ../src/guestfs-actions.pod:5691 ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:5999 ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6032 ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6058 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6084 ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6159 ../src/guestfs-actions.pod:6189 ../src/guestfs-actions.pod:6207 ../src/guestfs-actions.pod:6230 ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6288 ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6324 ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6369 ../src/guestfs-actions.pod:6393 ../src/guestfs-actions.pod:6412 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6489 ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6556 ../src/guestfs-actions.pod:6589 ../src/guestfs-actions.pod:6711 ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6857 ../src/guestfs-actions.pod:6870 ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6905 ../src/guestfs-actions.pod:6918 ../src/guestfs-actions.pod:6931 ../src/guestfs-actions.pod:6946 ../src/guestfs-actions.pod:7005 ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7038 ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7071 ../src/guestfs-actions.pod:7084 ../src/guestfs-actions.pod:7104 ../src/guestfs-actions.pod:7140 ../src/guestfs-actions.pod:7154 ../src/guestfs-actions.pod:7195 ../src/guestfs-actions.pod:7208 ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7296 ../src/guestfs-actions.pod:7412 ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7441 ../src/guestfs-actions.pod:7496 ../src/guestfs-actions.pod:7509 ../src/guestfs-actions.pod:7554 ../src/guestfs-actions.pod:7587 ../src/guestfs-actions.pod:7650 ../src/guestfs-actions.pod:7670 ../src/guestfs-actions.pod:7694 ../src/guestfs-actions.pod:7761 ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7809
5883 msgid "This function returns 0 on success or -1 on error."
5887 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
5889 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5894 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513 ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4945 ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:6534 ../src/guestfs-actions.pod:6564 ../src/guestfs-actions.pod:6597 ../src/guestfs-actions.pod:6656 ../src/guestfs-actions.pod:7592 ../src/guestfs-actions.pod:7702 ../src/guestfs-actions.pod:7872 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:1346 ../fish/guestfish-actions.pod:1360 ../fish/guestfish-actions.pod:3085 ../fish/guestfish-actions.pod:3292 ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3454 ../fish/guestfish-actions.pod:4349 ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4394 ../fish/guestfish-actions.pod:4432 ../fish/guestfish-actions.pod:5081 ../fish/guestfish-actions.pod:5179
5896 "Deprecated functions will not be removed from the API, but the fact that "
5897 "they are deprecated indicates that there are problems with correct use of "
5902 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1165 ../src/guestfs-actions.pod:1980 ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3641 ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:6209 ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6457 ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:7073 ../src/guestfs-actions.pod:7596
5903 msgid "(Added in 0.3)"
5907 #: ../src/guestfs-actions.pod:41
5908 msgid "guestfs_add_domain"
5912 #: ../src/guestfs-actions.pod:43
5916 " guestfs_add_domain (guestfs_h *g,\n"
5917 " const char *dom,\n"
5923 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2824 ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4959 ../src/guestfs-actions.pod:5176
5925 "You may supply a list of optional arguments to this call. Use zero or more "
5926 "of the following pairs of parameters, and terminate the list with C<-1> on "
5927 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5931 #: ../src/guestfs-actions.pod:53
5934 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5935 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5936 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5937 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5938 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
5943 #: ../src/guestfs-actions.pod:59
5945 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5946 "It works by connecting to libvirt, requesting the domain and domain XML from "
5947 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5952 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
5954 "The number of disks added is returned. This operation is atomic: if an "
5955 "error is returned, then no disks are added."
5959 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
5961 "This function does some minimal checks to make sure the libvirt domain is "
5962 "not running (unless C<readonly> is true). In a future version we will try "
5963 "to acquire the libvirt lock on each disk."
5967 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
5969 "Disks must be accessible locally. This often means that adding disks from a "
5970 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5971 "unless those disks are accessible via the same device path locally too."
5975 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
5977 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5978 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5979 "default libvirt URI (or one set through an environment variable, see the "
5980 "libvirt documentation for full details)."
5984 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
5986 "The optional C<live> flag controls whether this call will try to connect to "
5987 "a running virtual machine C<guestfsd> process if it sees a suitable "
5988 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5989 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5990 "DAEMONS> for more information."
5994 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
5996 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5997 "passed instead of the domain name. The C<dom> string is treated as a UUID "
5998 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
6003 #: ../src/guestfs-actions.pod:94
6005 "The other optional parameters are passed directly through to "
6006 "C<guestfs_add_drive_opts>."
6010 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1380 ../src/guestfs-actions.pod:1736 ../src/guestfs-actions.pod:1939 ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:2099 ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2177 ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2942 ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:5135 ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:7181 ../src/guestfs-actions.pod:7607 ../src/guestfs-actions.pod:7620 ../src/guestfs-actions.pod:7633
6011 msgid "On error this function returns -1."
6015 #: ../src/guestfs-actions.pod:99
6016 msgid "(Added in 1.7.4)"
6020 #: ../src/guestfs-actions.pod:101
6021 msgid "guestfs_add_domain_va"
6025 #: ../src/guestfs-actions.pod:103
6029 " guestfs_add_domain_va (guestfs_h *g,\n"
6030 " const char *dom,\n"
6036 #: ../src/guestfs-actions.pod:108
6037 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6041 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:871 ../src/guestfs-actions.pod:882 ../src/guestfs-actions.pod:2908 ../src/guestfs-actions.pod:2920 ../src/guestfs-actions.pod:4705 ../src/guestfs-actions.pod:4717 ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:5225 ../src/guestfs-actions.pod:5236
6042 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6046 #: ../src/guestfs-actions.pod:112
6047 msgid "guestfs_add_domain_argv"
6051 #: ../src/guestfs-actions.pod:114
6055 " guestfs_add_domain_argv (guestfs_h *g,\n"
6056 " const char *dom,\n"
6057 " const struct guestfs_add_domain_argv *optargs);\n"
6062 #: ../src/guestfs-actions.pod:119
6063 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6067 #: ../src/guestfs-actions.pod:123
6068 msgid "guestfs_add_drive"
6072 #: ../src/guestfs-actions.pod:125
6076 " guestfs_add_drive (guestfs_h *g,\n"
6077 " const char *filename);\n"
6082 #: ../src/guestfs-actions.pod:129
6084 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
6085 "optional parameters, so the disk is added writable, with the format being "
6086 "detected automatically."
6090 #: ../src/guestfs-actions.pod:133
6092 "Automatic detection of the format opens you up to a potential security hole "
6093 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6094 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6095 "you should think about replacing calls to this function with calls to "
6096 "C<guestfs_add_drive_opts>, and specifying the format."
6100 #: ../src/guestfs-actions.pod:144
6101 msgid "guestfs_add_drive_opts"
6105 #: ../src/guestfs-actions.pod:146
6109 " guestfs_add_drive_opts (guestfs_h *g,\n"
6110 " const char *filename,\n"
6116 #: ../src/guestfs-actions.pod:156
6119 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6120 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6121 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6126 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6128 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6129 "The first time you call this function, the disk appears as C</dev/sda>, the "
6130 "second time as C</dev/sdb>, and so on."
6134 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6136 "You don't necessarily need to be root when using libguestfs. However you "
6137 "obviously do need sufficient permissions to access the filename for whatever "
6138 "operations you want to perform (ie. read access if you just want to read the "
6139 "image or write access if you want to modify the image)."
6143 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6144 msgid "This call checks that C<filename> exists."
6148 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096
6149 msgid "The optional arguments are:"
6153 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6158 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6160 "If true then the image is treated as read-only. Writes are still allowed, "
6161 "but they are stored in a temporary snapshot overlay which is discarded at "
6162 "the end. The disk that you add is not modified."
6166 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6171 #: ../src/guestfs-actions.pod:185
6173 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6174 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6175 "Possible formats include C<raw> and C<qcow2>."
6179 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6181 "Automatic detection of the format opens you up to a potential security hole "
6182 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6183 "RHBZ#642934. Specifying the format closes this security hole."
6187 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6192 #: ../src/guestfs-actions.pod:196
6194 "This rarely-used option lets you emulate the behaviour of the deprecated "
6195 "C<guestfs_add_drive_with_if> call (q.v.)"
6199 #: ../src/guestfs-actions.pod:203
6200 msgid "(Added in 1.5.23)"
6204 #: ../src/guestfs-actions.pod:205
6205 msgid "guestfs_add_drive_opts_va"
6209 #: ../src/guestfs-actions.pod:207
6213 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6214 " const char *filename,\n"
6220 #: ../src/guestfs-actions.pod:212
6221 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6225 #: ../src/guestfs-actions.pod:216
6226 msgid "guestfs_add_drive_opts_argv"
6230 #: ../src/guestfs-actions.pod:218
6234 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6235 " const char *filename,\n"
6236 " const struct guestfs_add_drive_opts_argv "
6242 #: ../src/guestfs-actions.pod:223
6243 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6247 #: ../src/guestfs-actions.pod:227
6248 msgid "guestfs_add_drive_ro"
6252 #: ../src/guestfs-actions.pod:229
6256 " guestfs_add_drive_ro (guestfs_h *g,\n"
6257 " const char *filename);\n"
6262 #: ../src/guestfs-actions.pod:233
6264 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6265 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6266 "disk is added read-only, with the format being detected automatically."
6270 #: ../src/guestfs-actions.pod:240
6271 msgid "(Added in 1.0.38)"
6275 #: ../src/guestfs-actions.pod:242
6276 msgid "guestfs_add_drive_ro_with_if"
6280 #: ../src/guestfs-actions.pod:244
6284 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6285 " const char *filename,\n"
6286 " const char *iface);\n"
6291 #: ../src/guestfs-actions.pod:249
6293 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6294 "QEMU interface emulation to use at run time."
6298 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2429
6299 msgid "(Added in 1.0.84)"
6303 #: ../src/guestfs-actions.pod:263
6304 msgid "guestfs_add_drive_with_if"
6308 #: ../src/guestfs-actions.pod:265
6312 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6313 " const char *filename,\n"
6314 " const char *iface);\n"
6319 #: ../src/guestfs-actions.pod:270
6321 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6322 "QEMU interface emulation to use at run time."
6326 #: ../src/guestfs-actions.pod:284
6327 msgid "guestfs_aug_clear"
6331 #: ../src/guestfs-actions.pod:286
6335 " guestfs_aug_clear (guestfs_h *g,\n"
6336 " const char *augpath);\n"
6341 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6343 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6344 "L<augtool(1)> C<clear> command."
6348 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2179
6349 msgid "(Added in 1.3.4)"
6353 #: ../src/guestfs-actions.pod:297
6354 msgid "guestfs_aug_close"
6358 #: ../src/guestfs-actions.pod:299
6362 " guestfs_aug_close (guestfs_h *g);\n"
6367 #: ../src/guestfs-actions.pod:302
6369 "Close the current Augeas handle and free up any resources used by it. After "
6370 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6371 "any other Augeas functions."
6375 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366 ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549 ../src/guestfs-actions.pod:5838
6376 msgid "(Added in 0.7)"
6380 #: ../src/guestfs-actions.pod:311
6381 msgid "guestfs_aug_defnode"
6385 #: ../src/guestfs-actions.pod:313
6388 " struct guestfs_int_bool *\n"
6389 " guestfs_aug_defnode (guestfs_h *g,\n"
6390 " const char *name,\n"
6391 " const char *expr,\n"
6392 " const char *val);\n"
6397 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6398 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6402 #: ../src/guestfs-actions.pod:322
6404 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6405 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6406 "containing that single node."
6410 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6412 "On success this returns a pair containing the number of nodes in the "
6413 "nodeset, and a boolean flag if a node was created."
6417 #: ../src/guestfs-actions.pod:330
6419 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6420 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6424 #: ../src/guestfs-actions.pod:336
6425 msgid "guestfs_aug_defvar"
6429 #: ../src/guestfs-actions.pod:338
6433 " guestfs_aug_defvar (guestfs_h *g,\n"
6434 " const char *name,\n"
6435 " const char *expr);\n"
6440 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6442 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6443 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6447 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6449 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6450 "evaluates to something which is not a nodeset."
6454 #: ../src/guestfs-actions.pod:354
6455 msgid "guestfs_aug_get"
6459 #: ../src/guestfs-actions.pod:356
6463 " guestfs_aug_get (guestfs_h *g,\n"
6464 " const char *augpath);\n"
6469 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6471 "Look up the value associated with C<path>. If C<path> matches exactly one "
6472 "node, the C<value> is returned."
6476 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:922 ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1119 ../src/guestfs-actions.pod:1249 ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1419 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1719 ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:1899 ../src/guestfs-actions.pod:1966 ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:2023 ../src/guestfs-actions.pod:2202 ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:3025 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074 ../src/guestfs-actions.pod:3108 ../src/guestfs-actions.pod:3167 ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:3207 ../src/guestfs-actions.pod:3834 ../src/guestfs-actions.pod:4187 ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4467 ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:5736 ../src/guestfs-actions.pod:5914 ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:6633 ../src/guestfs-actions.pod:6650 ../src/guestfs-actions.pod:6681 ../src/guestfs-actions.pod:7355 ../src/guestfs-actions.pod:7374 ../src/guestfs-actions.pod:7392 ../src/guestfs-actions.pod:7566 ../src/guestfs-actions.pod:7866
6478 "This function returns a string, or NULL on error. I<The caller must free "
6479 "the returned string after use>."
6483 #: ../src/guestfs-actions.pod:368
6484 msgid "guestfs_aug_init"
6488 #: ../src/guestfs-actions.pod:370
6492 " guestfs_aug_init (guestfs_h *g,\n"
6493 " const char *root,\n"
6499 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6501 "Create a new Augeas handle for editing configuration files. If there was "
6502 "any previous Augeas handle associated with this guestfs session, then it is "
6507 #: ../src/guestfs-actions.pod:379
6508 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6512 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6513 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6517 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6519 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6520 "logical I<or> of the following integers:"
6524 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6525 msgid "C<AUG_SAVE_BACKUP> = 1"
6529 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6530 msgid "Keep the original file with a C<.augsave> extension."
6534 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6535 msgid "C<AUG_SAVE_NEWFILE> = 2"
6539 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6541 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6542 "original. Overrides C<AUG_SAVE_BACKUP>."
6546 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6547 msgid "C<AUG_TYPE_CHECK> = 4"
6551 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6552 msgid "Typecheck lenses (can be expensive)."
6556 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6557 msgid "C<AUG_NO_STDINC> = 8"
6561 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6562 msgid "Do not use standard load path for modules."
6566 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6567 msgid "C<AUG_SAVE_NOOP> = 16"
6571 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6572 msgid "Make save a no-op, just record what would have been changed."
6576 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6577 msgid "C<AUG_NO_LOAD> = 32"
6581 #: ../src/guestfs-actions.pod:414
6582 msgid "Do not load the tree in C<guestfs_aug_init>."
6586 #: ../src/guestfs-actions.pod:418
6587 msgid "To close the handle, you can call C<guestfs_aug_close>."
6591 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6592 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6596 #: ../src/guestfs-actions.pod:426
6597 msgid "guestfs_aug_insert"
6601 #: ../src/guestfs-actions.pod:428
6605 " guestfs_aug_insert (guestfs_h *g,\n"
6606 " const char *augpath,\n"
6607 " const char *label,\n"
6613 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6615 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6616 "or after C<path> (depending on the boolean flag C<before>)."
6620 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6622 "C<path> must match exactly one existing node in the tree, and C<label> must "
6623 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6627 #: ../src/guestfs-actions.pod:446
6628 msgid "guestfs_aug_load"
6632 #: ../src/guestfs-actions.pod:448
6636 " guestfs_aug_load (guestfs_h *g);\n"
6641 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6642 msgid "Load files into the tree."
6646 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6647 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6651 #: ../src/guestfs-actions.pod:460
6652 msgid "guestfs_aug_ls"
6656 #: ../src/guestfs-actions.pod:462
6660 " guestfs_aug_ls (guestfs_h *g,\n"
6661 " const char *augpath);\n"
6666 #: ../src/guestfs-actions.pod:466
6668 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6669 "sorting the resulting nodes into alphabetical order."
6673 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485 ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1138 ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1453 ../src/guestfs-actions.pod:1556 ../src/guestfs-actions.pod:1575 ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:2290 ../src/guestfs-actions.pod:2309 ../src/guestfs-actions.pod:2352 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2496 ../src/guestfs-actions.pod:2753 ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3717 ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3754 ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3921 ../src/guestfs-actions.pod:4329 ../src/guestfs-actions.pod:5096 ../src/guestfs-actions.pod:5708 ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:6697 ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6983 ../src/guestfs-actions.pod:7459 ../src/guestfs-actions.pod:7479 ../src/guestfs-actions.pod:7526 ../src/guestfs-actions.pod:7718 ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7823 ../src/guestfs-actions.pod:7842 ../src/guestfs-actions.pod:7888 ../src/guestfs-actions.pod:7907
6675 "This function returns a NULL-terminated array of strings (like "
6676 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6677 "strings and the array after use>."
6681 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1063 ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1491 ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4220 ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5100 ../src/guestfs-actions.pod:5649 ../src/guestfs-actions.pod:6046 ../src/guestfs-actions.pod:6060 ../src/guestfs-actions.pod:6072 ../src/guestfs-actions.pod:6538 ../src/guestfs-actions.pod:7197 ../src/guestfs-actions.pod:7210 ../src/guestfs-actions.pod:7443 ../src/guestfs-actions.pod:7706
6682 msgid "(Added in 0.8)"
6686 #: ../src/guestfs-actions.pod:475
6687 msgid "guestfs_aug_match"
6691 #: ../src/guestfs-actions.pod:477
6695 " guestfs_aug_match (guestfs_h *g,\n"
6696 " const char *augpath);\n"
6701 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6703 "Returns a list of paths which match the path expression C<path>. The "
6704 "returned paths are sufficiently qualified so that they match exactly one "
6705 "node in the current tree."
6709 #: ../src/guestfs-actions.pod:491
6710 msgid "guestfs_aug_mv"
6714 #: ../src/guestfs-actions.pod:493
6718 " guestfs_aug_mv (guestfs_h *g,\n"
6719 " const char *src,\n"
6720 " const char *dest);\n"
6725 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6727 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6728 "C<dest> is overwritten if it exists."
6732 #: ../src/guestfs-actions.pod:505
6733 msgid "guestfs_aug_rm"
6737 #: ../src/guestfs-actions.pod:507
6741 " guestfs_aug_rm (guestfs_h *g,\n"
6742 " const char *augpath);\n"
6747 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6748 msgid "Remove C<path> and all of its children."
6752 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
6753 msgid "On success this returns the number of entries which were removed."
6757 #: ../src/guestfs-actions.pod:519
6758 msgid "guestfs_aug_save"
6762 #: ../src/guestfs-actions.pod:521
6766 " guestfs_aug_save (guestfs_h *g);\n"
6771 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
6772 msgid "This writes all pending changes to disk."
6776 #: ../src/guestfs-actions.pod:526
6778 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6783 #: ../src/guestfs-actions.pod:533
6784 msgid "guestfs_aug_set"
6788 #: ../src/guestfs-actions.pod:535
6792 " guestfs_aug_set (guestfs_h *g,\n"
6793 " const char *augpath,\n"
6794 " const char *val);\n"
6799 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
6800 msgid "Set the value associated with C<path> to C<val>."
6804 #: ../src/guestfs-actions.pod:542
6806 "In the Augeas API, it is possible to clear a node by setting the value to "
6807 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6808 "this call. Instead you must use the C<guestfs_aug_clear> call."
6812 #: ../src/guestfs-actions.pod:551
6813 msgid "guestfs_available"
6817 #: ../src/guestfs-actions.pod:553
6821 " guestfs_available (guestfs_h *g,\n"
6822 " char *const *groups);\n"
6827 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
6829 "This command is used to check the availability of some groups of "
6830 "functionality in the appliance, which not all builds of the libguestfs "
6831 "appliance will be able to provide."
6835 #: ../src/guestfs-actions.pod:561
6837 "The libguestfs groups, and the functions that those groups correspond to, "
6838 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6839 "runtime by calling C<guestfs_available_all_groups>."
6843 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
6845 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6846 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6847 "and Augeas (configuration file editing) functions."
6851 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
6852 msgid "The command returns no error if I<all> requested groups are available."
6856 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
6858 "It fails with an error if one or more of the requested groups is unavailable "
6863 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
6865 "If an unknown group name is included in the list of groups then an error is "
6870 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
6875 #: ../src/guestfs-actions.pod:585
6876 msgid "You must call C<guestfs_launch> before calling this function."
6880 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
6882 "The reason is because we don't know what groups are supported by the "
6883 "appliance/daemon until it is running and can be queried."
6887 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
6889 "If a group of functions is available, this does not necessarily mean that "
6890 "they will work. You still have to check for errors when calling individual "
6891 "API functions even if they are available."
6895 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
6897 "It is usually the job of distro packagers to build complete functionality "
6898 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6899 "with all requirements satisfied, will support everything."
6903 #: ../src/guestfs-actions.pod:607
6905 "This call was added in version C<1.0.80>. In previous versions of "
6906 "libguestfs all you could do would be to speculatively execute a command to "
6907 "find out if the daemon implemented it. See also C<guestfs_version>."
6911 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1236
6912 msgid "(Added in 1.0.80)"
6916 #: ../src/guestfs-actions.pod:618
6917 msgid "guestfs_available_all_groups"
6921 #: ../src/guestfs-actions.pod:620
6925 " guestfs_available_all_groups (guestfs_h *g);\n"
6930 #: ../src/guestfs-actions.pod:623
6932 "This command returns a list of all optional groups that this daemon knows "
6933 "about. Note this returns both supported and unsupported groups. To find "
6934 "out which ones the daemon can actually support you have to call "
6935 "C<guestfs_available> on each member of the returned list."
6939 #: ../src/guestfs-actions.pod:629
6940 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6944 #: ../src/guestfs-actions.pod:635
6945 msgid "(Added in 1.3.15)"
6949 #: ../src/guestfs-actions.pod:637
6950 msgid "guestfs_base64_in"
6954 #: ../src/guestfs-actions.pod:639
6958 " guestfs_base64_in (guestfs_h *g,\n"
6959 " const char *base64file,\n"
6960 " const char *filename);\n"
6965 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
6966 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6970 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
6971 msgid "(Added in 1.3.5)"
6975 #: ../src/guestfs-actions.pod:651
6976 msgid "guestfs_base64_out"
6980 #: ../src/guestfs-actions.pod:653
6984 " guestfs_base64_out (guestfs_h *g,\n"
6985 " const char *filename,\n"
6986 " const char *base64file);\n"
6991 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
6993 "This command downloads the contents of C<filename>, writing it out to local "
6994 "file C<base64file> encoded as base64."
6998 #: ../src/guestfs-actions.pod:665
6999 msgid "guestfs_blockdev_flushbufs"
7003 #: ../src/guestfs-actions.pod:667
7007 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7008 " const char *device);\n"
7013 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7014 msgid "This tells the kernel to flush internal buffers associated with C<device>."
7018 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691 ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722 ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819 ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464 ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483 ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508 ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527 ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7019 msgid "This uses the L<blockdev(8)> command."
7023 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7024 msgid "(Added in 0.9.3)"
7028 #: ../src/guestfs-actions.pod:680
7029 msgid "guestfs_blockdev_getbsz"
7033 #: ../src/guestfs-actions.pod:682
7037 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7038 " const char *device);\n"
7043 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7044 msgid "This returns the block size of a device."
7048 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788 ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7050 "(Note this is different from both I<size in blocks> and I<filesystem block "
7055 #: ../src/guestfs-actions.pod:697
7056 msgid "guestfs_blockdev_getro"
7060 #: ../src/guestfs-actions.pod:699
7064 " guestfs_blockdev_getro (guestfs_h *g,\n"
7065 " const char *device);\n"
7070 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7072 "Returns a boolean indicating if the block device is read-only (true if "
7073 "read-only, false if not)."
7077 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:1489 ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2061 ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:2140 ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3449 ../src/guestfs-actions.pod:3463 ../src/guestfs-actions.pod:3479 ../src/guestfs-actions.pod:3494 ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3551 ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3581 ../src/guestfs-actions.pod:3594 ../src/guestfs-actions.pod:3608 ../src/guestfs-actions.pod:5337
7078 msgid "This function returns a C truth value on success or -1 on error."
7082 #: ../src/guestfs-actions.pod:712
7083 msgid "guestfs_blockdev_getsize64"
7087 #: ../src/guestfs-actions.pod:714
7091 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7092 " const char *device);\n"
7097 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7098 msgid "This returns the size of the device in bytes."
7102 #: ../src/guestfs-actions.pod:720
7103 msgid "See also C<guestfs_blockdev_getsz>."
7107 #: ../src/guestfs-actions.pod:728
7108 msgid "guestfs_blockdev_getss"
7112 #: ../src/guestfs-actions.pod:730
7116 " guestfs_blockdev_getss (guestfs_h *g,\n"
7117 " const char *device);\n"
7122 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7124 "This returns the size of sectors on a block device. Usually 512, but can be "
7125 "larger for modern devices."
7129 #: ../src/guestfs-actions.pod:737
7131 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7136 #: ../src/guestfs-actions.pod:746
7137 msgid "guestfs_blockdev_getsz"
7141 #: ../src/guestfs-actions.pod:748
7145 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7146 " const char *device);\n"
7151 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7153 "This returns the size of the device in units of 512-byte sectors (even if "
7154 "the sectorsize isn't 512 bytes ... weird)."
7158 #: ../src/guestfs-actions.pod:755
7160 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7161 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7165 #: ../src/guestfs-actions.pod:765
7166 msgid "guestfs_blockdev_rereadpt"
7170 #: ../src/guestfs-actions.pod:767
7174 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7175 " const char *device);\n"
7180 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7181 msgid "Reread the partition table on C<device>."
7185 #: ../src/guestfs-actions.pod:779
7186 msgid "guestfs_blockdev_setbsz"
7190 #: ../src/guestfs-actions.pod:781
7194 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7195 " const char *device,\n"
7196 " int blocksize);\n"
7201 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7202 msgid "This sets the block size of a device."
7206 #: ../src/guestfs-actions.pod:797
7207 msgid "guestfs_blockdev_setro"
7211 #: ../src/guestfs-actions.pod:799
7215 " guestfs_blockdev_setro (guestfs_h *g,\n"
7216 " const char *device);\n"
7221 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7222 msgid "Sets the block device named C<device> to read-only."
7226 #: ../src/guestfs-actions.pod:811
7227 msgid "guestfs_blockdev_setrw"
7231 #: ../src/guestfs-actions.pod:813
7235 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7236 " const char *device);\n"
7241 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7242 msgid "Sets the block device named C<device> to read-write."
7246 #: ../src/guestfs-actions.pod:825
7247 msgid "guestfs_btrfs_filesystem_resize"
7251 #: ../src/guestfs-actions.pod:827
7255 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
7256 " const char *mountpoint,\n"
7262 #: ../src/guestfs-actions.pod:837
7265 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
7270 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:549
7271 msgid "This command resizes a btrfs filesystem."
7275 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:551
7277 "Note that unlike other resize calls, the filesystem has to be mounted and "
7278 "the parameter is the mountpoint not the device (this is a requirement of "
7283 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5187 ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3417
7284 msgid "The optional parameters are:"
7288 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5191 ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3421
7293 #: ../src/guestfs-actions.pod:851 ../fish/guestfish-actions.pod:561
7295 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
7296 "resized to the maximum size."
7300 #: ../src/guestfs-actions.pod:856 ../fish/guestfish-actions.pod:566
7301 msgid "See also L<btrfs(8)>."
7305 #: ../src/guestfs-actions.pod:860
7306 msgid "(Added in 1.11.17)"
7310 #: ../src/guestfs-actions.pod:862
7311 msgid "guestfs_btrfs_filesystem_resize_va"
7315 #: ../src/guestfs-actions.pod:864
7319 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
7320 " const char *mountpoint,\n"
7326 #: ../src/guestfs-actions.pod:869
7327 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
7331 #: ../src/guestfs-actions.pod:873
7332 msgid "guestfs_btrfs_filesystem_resize_argv"
7336 #: ../src/guestfs-actions.pod:875
7340 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
7341 " const char *mountpoint,\n"
7343 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
7348 #: ../src/guestfs-actions.pod:880
7349 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
7353 #: ../src/guestfs-actions.pod:884
7354 msgid "guestfs_case_sensitive_path"
7358 #: ../src/guestfs-actions.pod:886
7362 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7363 " const char *path);\n"
7368 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:574
7370 "This can be used to resolve case insensitive paths on a filesystem which is "
7371 "case sensitive. The use case is to resolve paths which you have read from "
7372 "Windows configuration files or the Windows Registry, to the true path."
7376 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:579
7378 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7379 "(and probably others), which is that although the underlying filesystem is "
7380 "case-insensitive, the driver exports the filesystem to Linux as "
7385 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:584
7387 "One consequence of this is that special directories such as C<c:\\windows> "
7388 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7389 "precise details of how they were created. In Windows itself this would not "
7394 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:590
7396 "Bug or feature? You decide: "
7397 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7401 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:593
7403 "This function resolves the true case of each element in the path and returns "
7404 "the case-sensitive path."
7408 #: ../src/guestfs-actions.pod:912
7410 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7411 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7412 "how the directories were originally created under Windows)."
7416 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:601
7417 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7421 #: ../src/guestfs-actions.pod:920
7422 msgid "See also C<guestfs_realpath>."
7426 #: ../src/guestfs-actions.pod:925 ../src/guestfs-actions.pod:7377
7427 msgid "(Added in 1.0.75)"
7431 #: ../src/guestfs-actions.pod:927
7436 #: ../src/guestfs-actions.pod:929
7440 " guestfs_cat (guestfs_h *g,\n"
7441 " const char *path);\n"
7446 #: ../src/guestfs-actions.pod:933 ../src/guestfs-actions.pod:5824 ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3831
7447 msgid "Return the contents of the file named C<path>."
7451 #: ../src/guestfs-actions.pod:935
7453 "Note that this function cannot correctly handle binary files (specifically, "
7454 "files containing C<\\0> character which is treated as end of string). For "
7455 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7456 "functions which have a more complex interface."
7460 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1438 ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1560 ../src/guestfs-actions.pod:1579 ../src/guestfs-actions.pod:1825 ../src/guestfs-actions.pod:2294 ../src/guestfs-actions.pod:2313 ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:2380 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:5606 ../src/guestfs-actions.pod:5632 ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5789 ../src/guestfs-actions.pod:5813 ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:6817 ../src/guestfs-actions.pod:6963 ../src/guestfs-actions.pod:6987 ../src/guestfs-actions.pod:7652 ../src/guestfs-actions.pod:7672 ../src/guestfs-actions.pod:7696 ../src/guestfs-actions.pod:7722 ../src/guestfs-actions.pod:7741 ../src/guestfs-actions.pod:7827 ../src/guestfs-actions.pod:7846 ../src/guestfs-actions.pod:7892 ../src/guestfs-actions.pod:7911 ../fish/guestfish-actions.pod:617 ../fish/guestfish-actions.pod:752 ../fish/guestfish-actions.pod:764 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:1017 ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:1536 ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:1579 ../fish/guestfish-actions.pod:1589 ../fish/guestfish-actions.pod:1608 ../fish/guestfish-actions.pod:3701 ../fish/guestfish-actions.pod:3716 ../fish/guestfish-actions.pod:3792 ../fish/guestfish-actions.pod:3809 ../fish/guestfish-actions.pod:3824 ../fish/guestfish-actions.pod:4493 ../fish/guestfish-actions.pod:4539 ../fish/guestfish-actions.pod:4624 ../fish/guestfish-actions.pod:4639 ../fish/guestfish-actions.pod:5045 ../fish/guestfish-actions.pod:5057 ../fish/guestfish-actions.pod:5075 ../fish/guestfish-actions.pod:5092 ../fish/guestfish-actions.pod:5102 ../fish/guestfish-actions.pod:5151 ../fish/guestfish-actions.pod:5161 ../fish/guestfish-actions.pod:5190 ../fish/guestfish-actions.pod:5200
7462 "Because of the message protocol, there is a transfer limit of somewhere "
7463 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7467 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:3738 ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3837 ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:4333 ../src/guestfs-actions.pod:4347 ../src/guestfs-actions.pod:5712 ../src/guestfs-actions.pod:5726 ../src/guestfs-actions.pod:7530 ../src/guestfs-actions.pod:7544
7468 msgid "(Added in 0.4)"
7472 #: ../src/guestfs-actions.pod:948
7473 msgid "guestfs_checksum"
7477 #: ../src/guestfs-actions.pod:950
7481 " guestfs_checksum (guestfs_h *g,\n"
7482 " const char *csumtype,\n"
7483 " const char *path);\n"
7488 #: ../src/guestfs-actions.pod:955 ../fish/guestfish-actions.pod:624
7489 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7493 #: ../src/guestfs-actions.pod:958 ../fish/guestfish-actions.pod:627
7495 "The type of checksum to compute is given by the C<csumtype> parameter which "
7496 "must have one of the following values:"
7500 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:632
7505 #: ../src/guestfs-actions.pod:965 ../fish/guestfish-actions.pod:634
7507 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7512 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:637
7517 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:639
7518 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7522 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:641
7527 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:643
7528 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7532 #: ../src/guestfs-actions.pod:976 ../fish/guestfish-actions.pod:645
7537 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:647
7538 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7542 #: ../src/guestfs-actions.pod:980 ../fish/guestfish-actions.pod:649
7547 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:651
7548 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7552 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:653
7557 #: ../src/guestfs-actions.pod:986 ../fish/guestfish-actions.pod:655
7558 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7562 #: ../src/guestfs-actions.pod:988 ../fish/guestfish-actions.pod:657
7567 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:659
7568 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7572 #: ../src/guestfs-actions.pod:994 ../fish/guestfish-actions.pod:663
7573 msgid "The checksum is returned as a printable string."
7577 #: ../src/guestfs-actions.pod:996
7578 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7582 #: ../src/guestfs-actions.pod:998
7583 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7587 #: ../src/guestfs-actions.pod:1003 ../src/guestfs-actions.pod:1311 ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:7233
7588 msgid "(Added in 1.0.2)"
7592 #: ../src/guestfs-actions.pod:1005
7593 msgid "guestfs_checksum_device"
7597 #: ../src/guestfs-actions.pod:1007
7601 " guestfs_checksum_device (guestfs_h *g,\n"
7602 " const char *csumtype,\n"
7603 " const char *device);\n"
7608 #: ../src/guestfs-actions.pod:1012
7610 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7611 "device named C<device>. For the types of checksums supported see the "
7612 "C<guestfs_checksum> command."
7616 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:5167 ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5357 ../src/guestfs-actions.pod:5533 ../src/guestfs-actions.pod:7142 ../src/guestfs-actions.pod:7156 ../src/guestfs-actions.pod:7556
7617 msgid "(Added in 1.3.2)"
7621 #: ../src/guestfs-actions.pod:1021
7622 msgid "guestfs_checksums_out"
7626 #: ../src/guestfs-actions.pod:1023
7630 " guestfs_checksums_out (guestfs_h *g,\n"
7631 " const char *csumtype,\n"
7632 " const char *directory,\n"
7633 " const char *sumsfile);\n"
7638 #: ../src/guestfs-actions.pod:1029 ../fish/guestfish-actions.pod:681
7640 "This command computes the checksums of all regular files in C<directory> and "
7641 "then emits a list of those checksums to the local output file C<sumsfile>."
7645 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:685
7647 "This can be used for verifying the integrity of a virtual machine. However "
7648 "to be properly secure you should pay attention to the output of the checksum "
7649 "command (it uses the ones from GNU coreutils). In particular when the "
7650 "filename is not printable, coreutils uses a special backslash syntax. For "
7651 "more information, see the GNU coreutils info file."
7655 #: ../src/guestfs-actions.pod:1043
7656 msgid "(Added in 1.3.7)"
7660 #: ../src/guestfs-actions.pod:1045
7661 msgid "guestfs_chmod"
7665 #: ../src/guestfs-actions.pod:1047
7669 " guestfs_chmod (guestfs_h *g,\n"
7671 " const char *path);\n"
7676 #: ../src/guestfs-actions.pod:1052 ../fish/guestfish-actions.pod:699
7678 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7683 #: ../src/guestfs-actions.pod:1055 ../fish/guestfish-actions.pod:702
7685 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7686 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7691 #: ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4812 ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:706 ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3199 ../fish/guestfish-actions.pod:3209 ../fish/guestfish-actions.pod:3219
7692 msgid "The mode actually set is affected by the umask."
7696 #: ../src/guestfs-actions.pod:1065
7697 msgid "guestfs_chown"
7701 #: ../src/guestfs-actions.pod:1067
7705 " guestfs_chown (guestfs_h *g,\n"
7708 " const char *path);\n"
7713 #: ../src/guestfs-actions.pod:1073 ../fish/guestfish-actions.pod:712
7714 msgid "Change the file owner to C<owner> and group to C<group>."
7718 #: ../src/guestfs-actions.pod:1075 ../src/guestfs-actions.pod:3655 ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2495
7720 "Only numeric uid and gid are supported. If you want to use names, you will "
7721 "need to locate and parse the password file yourself (Augeas support makes "
7722 "this relatively easy)."
7726 #: ../src/guestfs-actions.pod:1083
7727 msgid "guestfs_command"
7731 #: ../src/guestfs-actions.pod:1085
7735 " guestfs_command (guestfs_h *g,\n"
7736 " char *const *arguments);\n"
7741 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:722
7743 "This call runs a command from the guest filesystem. The filesystem must be "
7744 "mounted, and must contain a compatible operating system (ie. something "
7745 "Linux, with the same or compatible processor architecture)."
7749 #: ../src/guestfs-actions.pod:1094
7751 "The single parameter is an argv-style list of arguments. The first element "
7752 "is the name of the program to run. Subsequent elements are parameters. The "
7753 "list must be non-empty (ie. must contain a program name). Note that the "
7754 "command runs directly, and is I<not> invoked via the shell (see "
7759 #: ../src/guestfs-actions.pod:1101 ../fish/guestfish-actions.pod:734
7760 msgid "The return value is anything printed to I<stdout> by the command."
7764 #: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:737
7766 "If the command returns a non-zero exit status, then this function returns an "
7767 "error message. The error message string is the content of I<stderr> from "
7772 #: ../src/guestfs-actions.pod:1108 ../fish/guestfish-actions.pod:741
7774 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7775 "C</bin>. If you require a program from another location, you should provide "
7776 "the full path in the first parameter."
7780 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:746
7782 "Shared libraries and data files required by the program must be available on "
7783 "filesystems which are mounted in the correct places. It is the caller's "
7784 "responsibility to ensure all filesystems that are needed are mounted at the "
7789 #: ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1145 ../src/guestfs-actions.pod:1610
7790 msgid "(Added in 0.9.1)"
7794 #: ../src/guestfs-actions.pod:1127
7795 msgid "guestfs_command_lines"
7799 #: ../src/guestfs-actions.pod:1129
7803 " guestfs_command_lines (guestfs_h *g,\n"
7804 " char *const *arguments);\n"
7809 #: ../src/guestfs-actions.pod:1133
7811 "This is the same as C<guestfs_command>, but splits the result into a list of "
7816 #: ../src/guestfs-actions.pod:1136
7817 msgid "See also: C<guestfs_sh_lines>"
7821 #: ../src/guestfs-actions.pod:1147
7822 msgid "guestfs_config"
7826 #: ../src/guestfs-actions.pod:1149
7830 " guestfs_config (guestfs_h *g,\n"
7831 " const char *qemuparam,\n"
7832 " const char *qemuvalue);\n"
7837 #: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:771
7839 "This can be used to add arbitrary qemu command line parameters of the form "
7840 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7841 "setting some parameters which would interfere with parameters that we use."
7845 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:776
7846 msgid "The first character of C<param> string must be a C<-> (dash)."
7850 #: ../src/guestfs-actions.pod:1161 ../fish/guestfish-actions.pod:778
7851 msgid "C<value> can be NULL."
7855 #: ../src/guestfs-actions.pod:1167
7856 msgid "guestfs_copy_size"
7860 #: ../src/guestfs-actions.pod:1169
7864 " guestfs_copy_size (guestfs_h *g,\n"
7865 " const char *src,\n"
7866 " const char *dest,\n"
7872 #: ../src/guestfs-actions.pod:1175 ../fish/guestfish-actions.pod:784
7874 "This command copies exactly C<size> bytes from one source device or file "
7875 "C<src> to another destination device or file C<dest>."
7879 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:787
7881 "Note this will fail if the source is too short or if the destination is not "
7886 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1306 ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1781 ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:7228 ../src/guestfs-actions.pod:7262 ../src/guestfs-actions.pod:7763 ../src/guestfs-actions.pod:7782
7888 "This long-running command can generate progress notification messages so "
7889 "that the caller can display a progress bar or indicator. To receive these "
7890 "messages, the caller must register a progress event callback. See "
7891 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7895 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:4360 ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:7463 ../src/guestfs-actions.pod:7483 ../src/guestfs-actions.pod:7569
7896 msgid "(Added in 1.0.87)"
7900 #: ../src/guestfs-actions.pod:1190
7905 #: ../src/guestfs-actions.pod:1192
7909 " guestfs_cp (guestfs_h *g,\n"
7910 " const char *src,\n"
7911 " const char *dest);\n"
7916 #: ../src/guestfs-actions.pod:1197 ../fish/guestfish-actions.pod:794
7918 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7919 "destination filename or destination directory."
7923 #: ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1216 ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:1362 ../src/guestfs-actions.pod:1476 ../src/guestfs-actions.pod:5114 ../src/guestfs-actions.pod:5583
7924 msgid "(Added in 1.0.18)"
7928 #: ../src/guestfs-actions.pod:1204
7929 msgid "guestfs_cp_a"
7933 #: ../src/guestfs-actions.pod:1206
7937 " guestfs_cp_a (guestfs_h *g,\n"
7938 " const char *src,\n"
7939 " const char *dest);\n"
7944 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:801
7946 "This copies a file or directory from C<src> to C<dest> recursively using the "
7951 #: ../src/guestfs-actions.pod:1218
7956 #: ../src/guestfs-actions.pod:1220
7960 " guestfs_dd (guestfs_h *g,\n"
7961 " const char *src,\n"
7962 " const char *dest);\n"
7967 #: ../src/guestfs-actions.pod:1225 ../fish/guestfish-actions.pod:808
7969 "This command copies from one source device or file C<src> to another "
7970 "destination device or file C<dest>. Normally you would use this to copy to "
7971 "or from a device or partition, for example to duplicate a filesystem."
7975 #: ../src/guestfs-actions.pod:1230
7977 "If the destination is a device, it must be as large or larger than the "
7978 "source file or device, otherwise the copy will fail. This command cannot do "
7979 "partial copies (see C<guestfs_copy_size>)."
7983 #: ../src/guestfs-actions.pod:1238
7988 #: ../src/guestfs-actions.pod:1240
7992 " guestfs_df (guestfs_h *g);\n"
7997 #: ../src/guestfs-actions.pod:1243 ../fish/guestfish-actions.pod:821
7998 msgid "This command runs the C<df> command to report disk space used."
8002 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1262
8004 "This command is mostly useful for interactive sessions. It is I<not> "
8005 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8010 #: ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:4470 ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:6966 ../src/guestfs-actions.pod:6990 ../src/guestfs-actions.pod:7609 ../src/guestfs-actions.pod:7622 ../src/guestfs-actions.pod:7635
8011 msgid "(Added in 1.0.54)"
8015 #: ../src/guestfs-actions.pod:1254
8016 msgid "guestfs_df_h"
8020 #: ../src/guestfs-actions.pod:1256
8024 " guestfs_df_h (guestfs_h *g);\n"
8029 #: ../src/guestfs-actions.pod:1259 ../fish/guestfish-actions.pod:831
8031 "This command runs the C<df -h> command to report disk space used in "
8032 "human-readable format."
8036 #: ../src/guestfs-actions.pod:1271
8037 msgid "guestfs_dmesg"
8041 #: ../src/guestfs-actions.pod:1273
8045 " guestfs_dmesg (guestfs_h *g);\n"
8050 #: ../src/guestfs-actions.pod:1276 ../fish/guestfish-actions.pod:842
8052 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8053 "This is sometimes useful for extended debugging of problems."
8057 #: ../src/guestfs-actions.pod:1280
8059 "Another way to get the same information is to enable verbose messages with "
8060 "C<guestfs_set_verbose> or by setting the environment variable "
8061 "C<LIBGUESTFS_DEBUG=1> before running the program."
8065 #: ../src/guestfs-actions.pod:1290
8066 msgid "guestfs_download"
8070 #: ../src/guestfs-actions.pod:1292
8074 " guestfs_download (guestfs_h *g,\n"
8075 " const char *remotefilename,\n"
8076 " const char *filename);\n"
8081 #: ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1322 ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
8083 "Download file C<remotefilename> and save it as C<filename> on the local "
8088 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:7222 ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4797
8089 msgid "C<filename> can also be a named pipe."
8093 #: ../src/guestfs-actions.pod:1302
8094 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8098 #: ../src/guestfs-actions.pod:1313
8099 msgid "guestfs_download_offset"
8103 #: ../src/guestfs-actions.pod:1315
8107 " guestfs_download_offset (guestfs_h *g,\n"
8108 " const char *remotefilename,\n"
8109 " const char *filename,\n"
8110 " int64_t offset,\n"
8116 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:871
8118 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8119 "region must be within the file or device)."
8123 #: ../src/guestfs-actions.pod:1328
8125 "Note that there is no limit on the amount of data that can be downloaded "
8126 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8127 "full amount unless an error occurs."
8131 #: ../src/guestfs-actions.pod:1333
8132 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8136 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:7267
8137 msgid "(Added in 1.5.17)"
8141 #: ../src/guestfs-actions.pod:1344
8142 msgid "guestfs_drop_caches"
8146 #: ../src/guestfs-actions.pod:1346
8150 " guestfs_drop_caches (guestfs_h *g,\n"
8151 " int whattodrop);\n"
8156 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:887
8158 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8159 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8160 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8164 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:892
8165 msgid "Setting C<whattodrop> to 3 should drop everything."
8169 #: ../src/guestfs-actions.pod:1357 ../fish/guestfish-actions.pod:894
8171 "This automatically calls L<sync(2)> before the operation, so that the "
8172 "maximum guest memory is freed."
8176 #: ../src/guestfs-actions.pod:1364
8181 #: ../src/guestfs-actions.pod:1366
8185 " guestfs_du (guestfs_h *g,\n"
8186 " const char *path);\n"
8191 #: ../src/guestfs-actions.pod:1370 ../fish/guestfish-actions.pod:901
8193 "This command runs the C<du -s> command to estimate file space usage for "
8198 #: ../src/guestfs-actions.pod:1373 ../fish/guestfish-actions.pod:904
8200 "C<path> can be a file or a directory. If C<path> is a directory then the "
8201 "estimate includes the contents of the directory and all subdirectories "
8206 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:908
8207 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8211 #: ../src/guestfs-actions.pod:1389
8212 msgid "guestfs_e2fsck_f"
8216 #: ../src/guestfs-actions.pod:1391
8220 " guestfs_e2fsck_f (guestfs_h *g,\n"
8221 " const char *device);\n"
8226 #: ../src/guestfs-actions.pod:1395 ../fish/guestfish-actions.pod:915
8228 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8229 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8234 #: ../src/guestfs-actions.pod:1399
8236 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8237 "Normally you should use C<guestfs_fsck>."
8241 #: ../src/guestfs-actions.pod:1404
8242 msgid "(Added in 1.0.29)"
8246 #: ../src/guestfs-actions.pod:1406
8247 msgid "guestfs_echo_daemon"
8251 #: ../src/guestfs-actions.pod:1408
8255 " guestfs_echo_daemon (guestfs_h *g,\n"
8256 " char *const *words);\n"
8261 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:926
8263 "This command concatenates the list of C<words> passed with single spaces "
8264 "between them and returns the resulting string."
8268 #: ../src/guestfs-actions.pod:1415 ../fish/guestfish-actions.pod:929
8269 msgid "You can use this command to test the connection through to the daemon."
8273 #: ../src/guestfs-actions.pod:1417
8274 msgid "See also C<guestfs_ping_daemon>."
8278 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:2167 ../src/guestfs-actions.pod:6438
8279 msgid "(Added in 1.0.69)"
8283 #: ../src/guestfs-actions.pod:1424
8284 msgid "guestfs_egrep"
8288 #: ../src/guestfs-actions.pod:1426
8292 " guestfs_egrep (guestfs_h *g,\n"
8293 " const char *regex,\n"
8294 " const char *path);\n"
8299 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:937
8300 msgid "This calls the external C<egrep> program and returns the matching lines."
8304 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1460 ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:1563 ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:2500 ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2568 ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:4892 ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6846 ../src/guestfs-actions.pod:6859 ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6907 ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:7725 ../src/guestfs-actions.pod:7744 ../src/guestfs-actions.pod:7830 ../src/guestfs-actions.pod:7849 ../src/guestfs-actions.pod:7895 ../src/guestfs-actions.pod:7914
8305 msgid "(Added in 1.0.66)"
8309 #: ../src/guestfs-actions.pod:1443
8310 msgid "guestfs_egrepi"
8314 #: ../src/guestfs-actions.pod:1445
8318 " guestfs_egrepi (guestfs_h *g,\n"
8319 " const char *regex,\n"
8320 " const char *path);\n"
8325 #: ../src/guestfs-actions.pod:1450 ../fish/guestfish-actions.pod:947
8326 msgid "This calls the external C<egrep -i> program and returns the matching lines."
8330 #: ../src/guestfs-actions.pod:1462
8331 msgid "guestfs_equal"
8335 #: ../src/guestfs-actions.pod:1464
8339 " guestfs_equal (guestfs_h *g,\n"
8340 " const char *file1,\n"
8341 " const char *file2);\n"
8346 #: ../src/guestfs-actions.pod:1469 ../fish/guestfish-actions.pod:957
8348 "This compares the two files C<file1> and C<file2> and returns true if their "
8349 "content is exactly equal, or false otherwise."
8353 #: ../src/guestfs-actions.pod:1472 ../fish/guestfish-actions.pod:960
8354 msgid "The external L<cmp(1)> program is used for the comparison."
8358 #: ../src/guestfs-actions.pod:1478
8359 msgid "guestfs_exists"
8363 #: ../src/guestfs-actions.pod:1480
8367 " guestfs_exists (guestfs_h *g,\n"
8368 " const char *path);\n"
8373 #: ../src/guestfs-actions.pod:1484 ../fish/guestfish-actions.pod:966
8375 "This returns C<true> if and only if there is a file, directory (or anything) "
8376 "with the given C<path> name."
8380 #: ../src/guestfs-actions.pod:1487
8381 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8385 #: ../src/guestfs-actions.pod:1493
8386 msgid "guestfs_fallocate"
8390 #: ../src/guestfs-actions.pod:1495
8394 " guestfs_fallocate (guestfs_h *g,\n"
8395 " const char *path,\n"
8401 #: ../src/guestfs-actions.pod:1500 ../src/guestfs-actions.pod:1526 ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
8403 "This command preallocates a file (containing zero bytes) named C<path> of "
8404 "size C<len> bytes. If the file exists already, it is overwritten."
8408 #: ../src/guestfs-actions.pod:1504 ../fish/guestfish-actions.pod:979
8410 "Do not confuse this with the guestfish-specific C<alloc> command which "
8411 "allocates a file in the host and attaches it as a device."
8415 #: ../src/guestfs-actions.pod:1510 ../fish/guestfish-actions.pod:983
8417 "This function is deprecated. In new code, use the C<fallocate64> call "
8422 #: ../src/guestfs-actions.pod:1519
8423 msgid "guestfs_fallocate64"
8427 #: ../src/guestfs-actions.pod:1521
8431 " guestfs_fallocate64 (guestfs_h *g,\n"
8432 " const char *path,\n"
8438 #: ../src/guestfs-actions.pod:1530
8440 "Note that this call allocates disk blocks for the file. To create a sparse "
8441 "file use C<guestfs_truncate_size> instead."
8445 #: ../src/guestfs-actions.pod:1533
8447 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8448 "oversight it only allowed 30 bit lengths to be specified, effectively "
8449 "limiting the maximum size of files created through that call to 1GB."
8453 #: ../src/guestfs-actions.pod:1538 ../fish/guestfish-actions.pod:1006
8455 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8456 "commands which create a file in the host and attach it as a device."
8460 #: ../src/guestfs-actions.pod:1544
8461 msgid "(Added in 1.3.17)"
8465 #: ../src/guestfs-actions.pod:1546
8466 msgid "guestfs_fgrep"
8470 #: ../src/guestfs-actions.pod:1548
8474 " guestfs_fgrep (guestfs_h *g,\n"
8475 " const char *pattern,\n"
8476 " const char *path);\n"
8481 #: ../src/guestfs-actions.pod:1553 ../fish/guestfish-actions.pod:1014
8482 msgid "This calls the external C<fgrep> program and returns the matching lines."
8486 #: ../src/guestfs-actions.pod:1565
8487 msgid "guestfs_fgrepi"
8491 #: ../src/guestfs-actions.pod:1567
8495 " guestfs_fgrepi (guestfs_h *g,\n"
8496 " const char *pattern,\n"
8497 " const char *path);\n"
8502 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1024
8503 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8507 #: ../src/guestfs-actions.pod:1584
8508 msgid "guestfs_file"
8512 #: ../src/guestfs-actions.pod:1586
8516 " guestfs_file (guestfs_h *g,\n"
8517 " const char *path);\n"
8522 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1034
8524 "This call uses the standard L<file(1)> command to determine the type or "
8525 "contents of the file."
8529 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1037
8531 "This call will also transparently look inside various types of compressed "
8536 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1040
8538 "The exact command which runs is C<file -zb path>. Note in particular that "
8539 "the filename is not prepended to the output (the I<-b> option)."
8543 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1044
8545 "The output depends on the output of the underlying L<file(1)> command and it "
8546 "can change in future in ways beyond our control. In other words, the output "
8547 "is not guaranteed by the ABI."
8551 #: ../src/guestfs-actions.pod:1604
8553 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8554 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8558 #: ../src/guestfs-actions.pod:1612
8559 msgid "guestfs_file_architecture"
8563 #: ../src/guestfs-actions.pod:1614
8567 " guestfs_file_architecture (guestfs_h *g,\n"
8568 " const char *filename);\n"
8573 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1055
8575 "This detects the architecture of the binary C<filename>, and returns it if "
8580 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1058
8581 msgid "Currently defined architectures are:"
8585 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1062
8590 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1064
8592 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8593 "irrespective of the precise processor requirements of the binary."
8597 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1067
8602 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1069
8603 msgid "64 bit x86-64."
8607 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1071
8612 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1073
8613 msgid "32 bit SPARC."
8617 #: ../src/guestfs-actions.pod:1638 ../fish/guestfish-actions.pod:1075
8622 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1077
8623 msgid "64 bit SPARC V9 and above."
8627 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1079
8632 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1081
8633 msgid "Intel Itanium."
8637 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1083
8642 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1085
8643 msgid "32 bit Power PC."
8647 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1087
8652 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1089
8653 msgid "64 bit Power PC."
8657 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1093
8658 msgid "Libguestfs may return other architecture strings in future."
8662 #: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1095
8663 msgid "The function works on at least the following types of files:"
8667 #: ../src/guestfs-actions.pod:1664 ../fish/guestfish-actions.pod:1101
8668 msgid "many types of Un*x and Linux binary"
8672 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1105
8673 msgid "many types of Un*x and Linux shared library"
8677 #: ../src/guestfs-actions.pod:1672 ../fish/guestfish-actions.pod:1109
8678 msgid "Windows Win32 and Win64 binaries"
8682 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1113
8683 msgid "Windows Win32 and Win64 DLLs"
8687 #: ../src/guestfs-actions.pod:1678 ../fish/guestfish-actions.pod:1115
8688 msgid "Win32 binaries and DLLs return C<i386>."
8692 #: ../src/guestfs-actions.pod:1680 ../fish/guestfish-actions.pod:1117
8693 msgid "Win64 binaries and DLLs return C<x86_64>."
8697 #: ../src/guestfs-actions.pod:1684 ../fish/guestfish-actions.pod:1121
8698 msgid "Linux kernel modules"
8702 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1125
8703 msgid "Linux new-style initrd images"
8707 #: ../src/guestfs-actions.pod:1692 ../fish/guestfish-actions.pod:1129
8708 msgid "some non-x86 Linux vmlinuz kernels"
8712 #: ../src/guestfs-actions.pod:1696 ../fish/guestfish-actions.pod:1133
8713 msgid "What it can't do currently:"
8717 #: ../src/guestfs-actions.pod:1702 ../fish/guestfish-actions.pod:1139
8718 msgid "static libraries (libfoo.a)"
8722 #: ../src/guestfs-actions.pod:1706 ../fish/guestfish-actions.pod:1143
8723 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8727 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1147
8728 msgid "x86 Linux vmlinuz kernels"
8732 #: ../src/guestfs-actions.pod:1712 ../fish/guestfish-actions.pod:1149
8734 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8735 "compressed code, and are horribly hard to unpack. If you want to find the "
8736 "architecture of a kernel, use the architecture of the associated initrd or "
8737 "kernel module(s) instead."
8741 #: ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:1885 ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:2601 ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2757 ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2962 ../src/guestfs-actions.pod:3002 ../src/guestfs-actions.pod:3077 ../src/guestfs-actions.pod:3170 ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3539
8742 msgid "(Added in 1.5.3)"
8746 #: ../src/guestfs-actions.pod:1724
8747 msgid "guestfs_filesize"
8751 #: ../src/guestfs-actions.pod:1726
8755 " guestfs_filesize (guestfs_h *g,\n"
8756 " const char *file);\n"
8761 #: ../src/guestfs-actions.pod:1730 ../fish/guestfish-actions.pod:1160
8762 msgid "This command returns the size of C<file> in bytes."
8766 #: ../src/guestfs-actions.pod:1732
8768 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8769 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8770 "devices, use C<guestfs_blockdev_getsize64>."
8774 #: ../src/guestfs-actions.pod:1738
8775 msgid "(Added in 1.0.82)"
8779 #: ../src/guestfs-actions.pod:1740
8780 msgid "guestfs_fill"
8784 #: ../src/guestfs-actions.pod:1742
8788 " guestfs_fill (guestfs_h *g,\n"
8791 " const char *path);\n"
8796 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1170
8798 "This command creates a new file called C<path>. The initial content of the "
8799 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8804 #: ../src/guestfs-actions.pod:1752
8806 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8807 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8808 "bytes use C<guestfs_fill_pattern>."
8812 #: ../src/guestfs-actions.pod:1764
8813 msgid "(Added in 1.0.79)"
8817 #: ../src/guestfs-actions.pod:1766
8818 msgid "guestfs_fill_pattern"
8822 #: ../src/guestfs-actions.pod:1768
8826 " guestfs_fill_pattern (guestfs_h *g,\n"
8827 " const char *pattern,\n"
8829 " const char *path);\n"
8834 #: ../src/guestfs-actions.pod:1774
8836 "This function is like C<guestfs_fill> except that it creates a new file of "
8837 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8838 "pattern is truncated if necessary to ensure the length of the file is "
8839 "exactly C<len> bytes."
8843 #: ../src/guestfs-actions.pod:1786
8844 msgid "(Added in 1.3.12)"
8848 #: ../src/guestfs-actions.pod:1788
8849 msgid "guestfs_find"
8853 #: ../src/guestfs-actions.pod:1790
8857 " guestfs_find (guestfs_h *g,\n"
8858 " const char *directory);\n"
8863 #: ../src/guestfs-actions.pod:1794 ../fish/guestfish-actions.pod:1192
8865 "This command lists out all files and directories, recursively, starting at "
8866 "C<directory>. It is essentially equivalent to running the shell command "
8867 "C<find directory -print> but some post-processing happens on the output, "
8872 #: ../src/guestfs-actions.pod:1799 ../fish/guestfish-actions.pod:1197
8874 "This returns a list of strings I<without any prefix>. Thus if the directory "
8879 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1200
8889 #: ../src/guestfs-actions.pod:1806
8890 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8894 #: ../src/guestfs-actions.pod:1809 ../fish/guestfish-actions.pod:1207
8905 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1212
8906 msgid "If C<directory> is not a directory, then this command returns an error."
8910 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1215
8911 msgid "The returned list is sorted."
8915 #: ../src/guestfs-actions.pod:1819
8916 msgid "See also C<guestfs_find0>."
8920 #: ../src/guestfs-actions.pod:1828 ../src/guestfs-actions.pod:4297 ../src/guestfs-actions.pod:6001
8921 msgid "(Added in 1.0.27)"
8925 #: ../src/guestfs-actions.pod:1830
8926 msgid "guestfs_find0"
8930 #: ../src/guestfs-actions.pod:1832
8934 " guestfs_find0 (guestfs_h *g,\n"
8935 " const char *directory,\n"
8936 " const char *files);\n"
8941 #: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1226
8943 "This command lists out all files and directories, recursively, starting at "
8944 "C<directory>, placing the resulting list in the external file called "
8949 #: ../src/guestfs-actions.pod:1841
8951 "This command works the same way as C<guestfs_find> with the following "
8956 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1237
8957 msgid "The resulting list is written to an external file."
8961 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1241
8963 "Items (filenames) in the result are separated by C<\\0> characters. See "
8964 "L<find(1)> option I<-print0>."
8968 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1246
8969 msgid "This command is not limited in the number of names that it can return."
8973 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1251
8974 msgid "The result list is not sorted."
8978 #: ../src/guestfs-actions.pod:1868
8979 msgid "(Added in 1.0.74)"
8983 #: ../src/guestfs-actions.pod:1870
8984 msgid "guestfs_findfs_label"
8988 #: ../src/guestfs-actions.pod:1872
8992 " guestfs_findfs_label (guestfs_h *g,\n"
8993 " const char *label);\n"
8998 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1261
9000 "This command searches the filesystems and returns the one which has the "
9001 "given label. An error is returned if no such filesystem can be found."
9005 #: ../src/guestfs-actions.pod:1880
9006 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9010 #: ../src/guestfs-actions.pod:1887
9011 msgid "guestfs_findfs_uuid"
9015 #: ../src/guestfs-actions.pod:1889
9019 " guestfs_findfs_uuid (guestfs_h *g,\n"
9020 " const char *uuid);\n"
9025 #: ../src/guestfs-actions.pod:1893 ../fish/guestfish-actions.pod:1271
9027 "This command searches the filesystems and returns the one which has the "
9028 "given UUID. An error is returned if no such filesystem can be found."
9032 #: ../src/guestfs-actions.pod:1897
9033 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9037 #: ../src/guestfs-actions.pod:1904
9038 msgid "guestfs_fsck"
9042 #: ../src/guestfs-actions.pod:1906
9046 " guestfs_fsck (guestfs_h *g,\n"
9047 " const char *fstype,\n"
9048 " const char *device);\n"
9053 #: ../src/guestfs-actions.pod:1911 ../fish/guestfish-actions.pod:1281
9055 "This runs the filesystem checker (fsck) on C<device> which should have "
9056 "filesystem type C<fstype>."
9060 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1284
9062 "The returned integer is the status. See L<fsck(8)> for the list of status "
9063 "codes from C<fsck>."
9067 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1293
9068 msgid "Multiple status codes can be summed together."
9072 #: ../src/guestfs-actions.pod:1927 ../fish/guestfish-actions.pod:1297
9074 "A non-zero return code can mean \"success\", for example if errors have been "
9075 "corrected on the filesystem."
9079 #: ../src/guestfs-actions.pod:1932 ../fish/guestfish-actions.pod:1302
9080 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9084 #: ../src/guestfs-actions.pod:1937 ../fish/guestfish-actions.pod:1307
9085 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9089 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:7768
9090 msgid "(Added in 1.0.16)"
9094 #: ../src/guestfs-actions.pod:1943
9095 msgid "guestfs_get_append"
9099 #: ../src/guestfs-actions.pod:1945
9103 " guestfs_get_append (guestfs_h *g);\n"
9108 #: ../src/guestfs-actions.pod:1948 ../fish/guestfish-actions.pod:1313
9110 "Return the additional kernel options which are added to the guest kernel "
9115 #: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1316
9116 msgid "If C<NULL> then no options are added."
9120 #: ../src/guestfs-actions.pod:1953
9122 "This function returns a string which may be NULL. There is no way to return "
9123 "an error from this function. The string is owned by the guest handle and "
9124 "must I<not> be freed."
9128 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:5679 ../src/guestfs-actions.pod:6161 ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6636 ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:7414 ../src/guestfs-actions.pod:7429 ../src/guestfs-actions.pod:7811
9129 msgid "(Added in 1.0.26)"
9133 #: ../src/guestfs-actions.pod:1959
9134 msgid "guestfs_get_attach_method"
9138 #: ../src/guestfs-actions.pod:1961
9142 " guestfs_get_attach_method (guestfs_h *g);\n"
9147 #: ../src/guestfs-actions.pod:1964
9148 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9152 #: ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:6191
9153 msgid "(Added in 1.9.8)"
9157 #: ../src/guestfs-actions.pod:1971
9158 msgid "guestfs_get_autosync"
9162 #: ../src/guestfs-actions.pod:1973
9166 " guestfs_get_autosync (guestfs_h *g);\n"
9171 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1328
9172 msgid "Get the autosync flag."
9176 #: ../src/guestfs-actions.pod:1982
9177 msgid "guestfs_get_direct"
9181 #: ../src/guestfs-actions.pod:1984
9185 " guestfs_get_direct (guestfs_h *g);\n"
9190 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1334
9191 msgid "Return the direct appliance mode flag."
9195 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:6232
9196 msgid "(Added in 1.0.72)"
9200 #: ../src/guestfs-actions.pod:1993
9201 msgid "guestfs_get_e2label"
9205 #: ../src/guestfs-actions.pod:1995
9209 " guestfs_get_e2label (guestfs_h *g,\n"
9210 " const char *device);\n"
9215 #: ../src/guestfs-actions.pod:1999 ../fish/guestfish-actions.pod:1340
9216 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9220 #: ../src/guestfs-actions.pod:2005 ../fish/guestfish-actions.pod:1343
9222 "This function is deprecated. In new code, use the C<vfs_label> call "
9227 #: ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6269
9228 msgid "(Added in 1.0.15)"
9232 #: ../src/guestfs-actions.pod:2014
9233 msgid "guestfs_get_e2uuid"
9237 #: ../src/guestfs-actions.pod:2016
9241 " guestfs_get_e2uuid (guestfs_h *g,\n"
9242 " const char *device);\n"
9247 #: ../src/guestfs-actions.pod:2020 ../fish/guestfish-actions.pod:1354
9248 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9252 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1357
9253 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9257 #: ../src/guestfs-actions.pod:2035
9258 msgid "guestfs_get_memsize"
9262 #: ../src/guestfs-actions.pod:2037
9266 " guestfs_get_memsize (guestfs_h *g);\n"
9271 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1368
9272 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
9276 #: ../src/guestfs-actions.pod:2043
9278 "If C<guestfs_set_memsize> was not called on this handle, and if "
9279 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9280 "value for memsize."
9284 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2137 ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:6409 ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1432 ../fish/guestfish-actions.pod:4157 ../fish/guestfish-actions.pod:4259
9285 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9289 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:4588 ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4816 ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4847 ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4877 ../src/guestfs-actions.pod:5904 ../src/guestfs-actions.pod:6290 ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:7183
9290 msgid "(Added in 1.0.55)"
9294 #: ../src/guestfs-actions.pod:2054
9295 msgid "guestfs_get_network"
9299 #: ../src/guestfs-actions.pod:2056
9303 " guestfs_get_network (guestfs_h *g);\n"
9308 #: ../src/guestfs-actions.pod:2059 ../fish/guestfish-actions.pod:1382
9309 msgid "This returns the enable network flag."
9313 #: ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:6309
9314 msgid "(Added in 1.5.4)"
9318 #: ../src/guestfs-actions.pod:2065
9319 msgid "guestfs_get_path"
9323 #: ../src/guestfs-actions.pod:2067
9327 " guestfs_get_path (guestfs_h *g);\n"
9332 #: ../src/guestfs-actions.pod:2070 ../fish/guestfish-actions.pod:1388
9333 msgid "Return the current search path."
9337 #: ../src/guestfs-actions.pod:2072 ../fish/guestfish-actions.pod:1390
9339 "This is always non-NULL. If it wasn't set already, then this will return "
9344 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2113
9346 "This function returns a string, or NULL on error. The string is owned by "
9347 "the guest handle and must I<not> be freed."
9351 #: ../src/guestfs-actions.pod:2080
9352 msgid "guestfs_get_pgroup"
9356 #: ../src/guestfs-actions.pod:2082
9360 " guestfs_get_pgroup (guestfs_h *g);\n"
9365 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1397
9366 msgid "This returns the process group flag."
9370 #: ../src/guestfs-actions.pod:2089
9371 msgid "guestfs_get_pid"
9375 #: ../src/guestfs-actions.pod:2091
9379 " guestfs_get_pid (guestfs_h *g);\n"
9384 #: ../src/guestfs-actions.pod:2094 ../fish/guestfish-actions.pod:1405
9386 "Return the process ID of the qemu subprocess. If there is no qemu "
9387 "subprocess, then this will return an error."
9391 #: ../src/guestfs-actions.pod:2097 ../fish/guestfish-actions.pod:1408
9392 msgid "This is an internal call used for debugging and testing."
9396 #: ../src/guestfs-actions.pod:2101
9397 msgid "(Added in 1.0.56)"
9401 #: ../src/guestfs-actions.pod:2103
9402 msgid "guestfs_get_qemu"
9406 #: ../src/guestfs-actions.pod:2105
9410 " guestfs_get_qemu (guestfs_h *g);\n"
9415 #: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1414
9416 msgid "Return the current qemu binary."
9420 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1416
9422 "This is always non-NULL. If it wasn't set already, then this will return "
9423 "the default qemu binary name."
9427 #: ../src/guestfs-actions.pod:2116 ../src/guestfs-actions.pod:6371
9428 msgid "(Added in 1.0.6)"
9432 #: ../src/guestfs-actions.pod:2118
9433 msgid "guestfs_get_recovery_proc"
9437 #: ../src/guestfs-actions.pod:2120
9441 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9446 #: ../src/guestfs-actions.pod:2123 ../fish/guestfish-actions.pod:1423
9447 msgid "Return the recovery process enabled flag."
9451 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4395 ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:5609 ../src/guestfs-actions.pod:5952 ../src/guestfs-actions.pod:6395 ../src/guestfs-actions.pod:7086 ../src/guestfs-actions.pod:7106 ../src/guestfs-actions.pod:7298
9452 msgid "(Added in 1.0.77)"
9456 #: ../src/guestfs-actions.pod:2129
9457 msgid "guestfs_get_selinux"
9461 #: ../src/guestfs-actions.pod:2131
9465 " guestfs_get_selinux (guestfs_h *g);\n"
9470 #: ../src/guestfs-actions.pod:2134
9472 "This returns the current setting of the selinux flag which is passed to the "
9473 "appliance at boot time. See C<guestfs_set_selinux>."
9477 #: ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2205 ../src/guestfs-actions.pod:6414 ../src/guestfs-actions.pod:6472
9478 msgid "(Added in 1.0.67)"
9482 #: ../src/guestfs-actions.pod:2144
9483 msgid "guestfs_get_state"
9487 #: ../src/guestfs-actions.pod:2146
9491 " guestfs_get_state (guestfs_h *g);\n"
9496 #: ../src/guestfs-actions.pod:2149 ../fish/guestfish-actions.pod:1439
9498 "This returns the current state as an opaque integer. This is only useful "
9499 "for printing debug and internal error messages."
9503 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3522 ../src/guestfs-actions.pod:3549 ../fish/guestfish-actions.pod:1442 ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2380 ../fish/guestfish-actions.pod:2418 ../fish/guestfish-actions.pod:2434
9504 msgid "For more information on states, see L<guestfs(3)>."
9508 #: ../src/guestfs-actions.pod:2158
9509 msgid "guestfs_get_trace"
9513 #: ../src/guestfs-actions.pod:2160
9517 " guestfs_get_trace (guestfs_h *g);\n"
9522 #: ../src/guestfs-actions.pod:2163 ../fish/guestfish-actions.pod:1448
9523 msgid "Return the command trace flag."
9527 #: ../src/guestfs-actions.pod:2169
9528 msgid "guestfs_get_umask"
9532 #: ../src/guestfs-actions.pod:2171
9536 " guestfs_get_umask (guestfs_h *g);\n"
9541 #: ../src/guestfs-actions.pod:2174
9543 "Return the current umask. By default the umask is C<022> unless it has been "
9544 "set by calling C<guestfs_umask>."
9548 #: ../src/guestfs-actions.pod:2181
9549 msgid "guestfs_get_verbose"
9553 #: ../src/guestfs-actions.pod:2183
9557 " guestfs_get_verbose (guestfs_h *g);\n"
9562 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1461
9563 msgid "This returns the verbose messages flag."
9567 #: ../src/guestfs-actions.pod:2192
9568 msgid "guestfs_getcon"
9572 #: ../src/guestfs-actions.pod:2194
9576 " guestfs_getcon (guestfs_h *g);\n"
9581 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1467
9582 msgid "This gets the SELinux security context of the daemon."
9586 #: ../src/guestfs-actions.pod:2199
9587 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9591 #: ../src/guestfs-actions.pod:2207
9592 msgid "guestfs_getxattr"
9596 #: ../src/guestfs-actions.pod:2209
9600 " guestfs_getxattr (guestfs_h *g,\n"
9601 " const char *path,\n"
9602 " const char *name,\n"
9603 " size_t *size_r);\n"
9608 #: ../src/guestfs-actions.pod:2215
9610 "Get a single extended attribute from file C<path> named C<name>. This call "
9611 "follows symlinks. If you want to lookup an extended attribute for the "
9612 "symlink itself, use C<guestfs_lgetxattr>."
9616 #: ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:3675
9618 "Normally it is better to get all extended attributes from a file in one go "
9619 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9620 "implementations are buggy and do not provide a way to list out attributes. "
9621 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9622 "extended attributes you want in advance and call this function."
9626 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3682 ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:2514
9628 "Extended attribute values are blobs of binary data. If there is no extended "
9629 "attribute named C<name>, this returns an error."
9633 #: ../src/guestfs-actions.pod:2229
9634 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9638 #: ../src/guestfs-actions.pod:2231 ../src/guestfs-actions.pod:2422 ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:3687 ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5628 ../src/guestfs-actions.pod:5809
9640 "This function returns a buffer, or NULL on error. The size of the returned "
9641 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9646 #: ../src/guestfs-actions.pod:2235 ../src/guestfs-actions.pod:3691
9647 msgid "(Added in 1.7.24)"
9651 #: ../src/guestfs-actions.pod:2237
9652 msgid "guestfs_getxattrs"
9656 #: ../src/guestfs-actions.pod:2239
9659 " struct guestfs_xattr_list *\n"
9660 " guestfs_getxattrs (guestfs_h *g,\n"
9661 " const char *path);\n"
9666 #: ../src/guestfs-actions.pod:2243 ../fish/guestfish-actions.pod:1496
9667 msgid "This call lists the extended attributes of the file or directory C<path>."
9671 #: ../src/guestfs-actions.pod:2246 ../fish/guestfish-actions.pod:1499
9673 "At the system call level, this is a combination of the L<listxattr(2)> and "
9674 "L<getxattr(2)> calls."
9678 #: ../src/guestfs-actions.pod:2249
9679 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9683 #: ../src/guestfs-actions.pod:2251 ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:4391
9685 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9686 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9690 #: ../src/guestfs-actions.pod:2255 ../src/guestfs-actions.pod:3707 ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6491 ../src/guestfs-actions.pod:7876
9691 msgid "(Added in 1.0.59)"
9695 #: ../src/guestfs-actions.pod:2257
9696 msgid "guestfs_glob_expand"
9700 #: ../src/guestfs-actions.pod:2259
9704 " guestfs_glob_expand (guestfs_h *g,\n"
9705 " const char *pattern);\n"
9710 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1508
9712 "This command searches for all the pathnames matching C<pattern> according to "
9713 "the wildcard expansion rules used by the shell."
9717 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1512
9718 msgid "If no paths match, then this returns an empty list (note: not an error)."
9722 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1515
9724 "It is just a wrapper around the C L<glob(3)> function with flags "
9725 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9729 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6684 ../src/guestfs-actions.pod:6701
9730 msgid "(Added in 1.0.50)"
9734 #: ../src/guestfs-actions.pod:2280
9735 msgid "guestfs_grep"
9739 #: ../src/guestfs-actions.pod:2282
9743 " guestfs_grep (guestfs_h *g,\n"
9744 " const char *regex,\n"
9745 " const char *path);\n"
9750 #: ../src/guestfs-actions.pod:2287 ../fish/guestfish-actions.pod:1523
9751 msgid "This calls the external C<grep> program and returns the matching lines."
9755 #: ../src/guestfs-actions.pod:2299
9756 msgid "guestfs_grepi"
9760 #: ../src/guestfs-actions.pod:2301
9764 " guestfs_grepi (guestfs_h *g,\n"
9765 " const char *regex,\n"
9766 " const char *path);\n"
9771 #: ../src/guestfs-actions.pod:2306 ../fish/guestfish-actions.pod:1533
9772 msgid "This calls the external C<grep -i> program and returns the matching lines."
9776 #: ../src/guestfs-actions.pod:2318
9777 msgid "guestfs_grub_install"
9781 #: ../src/guestfs-actions.pod:2320
9785 " guestfs_grub_install (guestfs_h *g,\n"
9786 " const char *root,\n"
9787 " const char *device);\n"
9792 #: ../src/guestfs-actions.pod:2325 ../fish/guestfish-actions.pod:1543
9794 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9795 "the root directory being C<root>."
9799 #: ../src/guestfs-actions.pod:2328 ../fish/guestfish-actions.pod:1546
9801 "Note: If grub-install reports the error \"No suitable drive was found in the "
9802 "generated device map.\" it may be that you need to create a "
9803 "C</boot/grub/device.map> file first that contains the mapping between grub "
9804 "device names and Linux device names. It is usually sufficient to create a "
9809 #: ../src/guestfs-actions.pod:2335 ../fish/guestfish-actions.pod:1553
9817 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1555
9818 msgid "replacing C</dev/vda> with the name of the installation device."
9822 #: ../src/guestfs-actions.pod:2341
9823 msgid "(Added in 1.0.17)"
9827 #: ../src/guestfs-actions.pod:2343
9828 msgid "guestfs_head"
9832 #: ../src/guestfs-actions.pod:2345
9836 " guestfs_head (guestfs_h *g,\n"
9837 " const char *path);\n"
9842 #: ../src/guestfs-actions.pod:2349 ../fish/guestfish-actions.pod:1561
9844 "This command returns up to the first 10 lines of a file as a list of "
9849 #: ../src/guestfs-actions.pod:2361
9850 msgid "guestfs_head_n"
9854 #: ../src/guestfs-actions.pod:2363
9858 " guestfs_head_n (guestfs_h *g,\n"
9860 " const char *path);\n"
9865 #: ../src/guestfs-actions.pod:2368 ../fish/guestfish-actions.pod:1571
9867 "If the parameter C<nrlines> is a positive number, this returns the first "
9868 "C<nrlines> lines of the file C<path>."
9872 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1574
9874 "If the parameter C<nrlines> is a negative number, this returns lines from "
9875 "the file C<path>, excluding the last C<nrlines> lines."
9879 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:6981 ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:4637
9880 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9884 #: ../src/guestfs-actions.pod:2385
9885 msgid "guestfs_hexdump"
9889 #: ../src/guestfs-actions.pod:2387
9893 " guestfs_hexdump (guestfs_h *g,\n"
9894 " const char *path);\n"
9899 #: ../src/guestfs-actions.pod:2391 ../fish/guestfish-actions.pod:1586
9901 "This runs C<hexdump -C> on the given C<path>. The result is the "
9902 "human-readable, canonical hex dump of the file."
9906 #: ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6820
9907 msgid "(Added in 1.0.22)"
9911 #: ../src/guestfs-actions.pod:2402
9912 msgid "guestfs_initrd_cat"
9916 #: ../src/guestfs-actions.pod:2404
9920 " guestfs_initrd_cat (guestfs_h *g,\n"
9921 " const char *initrdpath,\n"
9922 " const char *filename,\n"
9923 " size_t *size_r);\n"
9928 #: ../src/guestfs-actions.pod:2410 ../fish/guestfish-actions.pod:1596
9930 "This command unpacks the file C<filename> from the initrd file called "
9931 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9936 #: ../src/guestfs-actions.pod:2414 ../fish/guestfish-actions.pod:1600
9938 "For example, in guestfish you could use the following command to examine the "
9939 "boot script (usually called C</init>) contained in a Linux initrd or "
9944 #: ../src/guestfs-actions.pod:2418 ../fish/guestfish-actions.pod:1604
9947 " initrd-cat /boot/initrd-<version>.img init\n"
9952 #: ../src/guestfs-actions.pod:2420
9953 msgid "See also C<guestfs_initrd_list>."
9957 #: ../src/guestfs-actions.pod:2431
9958 msgid "guestfs_initrd_list"
9962 #: ../src/guestfs-actions.pod:2433
9966 " guestfs_initrd_list (guestfs_h *g,\n"
9967 " const char *path);\n"
9972 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1615
9973 msgid "This command lists out files contained in an initrd."
9977 #: ../src/guestfs-actions.pod:2439 ../fish/guestfish-actions.pod:1617
9979 "The files are listed without any initial C</> character. The files are "
9980 "listed in the order they appear (not necessarily alphabetical). Directory "
9981 "names are listed as separate items."
9985 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1621
9987 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9988 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9993 #: ../src/guestfs-actions.pod:2453
9994 msgid "guestfs_inotify_add_watch"
9998 #: ../src/guestfs-actions.pod:2455
10002 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10003 " const char *path,\n"
10009 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1629
10010 msgid "Watch C<path> for the events listed in C<mask>."
10014 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1631
10016 "Note that if C<path> is a directory then events within that directory are "
10017 "watched, but this does I<not> happen recursively (in subdirectories)."
10021 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1635
10023 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10024 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10028 #: ../src/guestfs-actions.pod:2474
10029 msgid "guestfs_inotify_close"
10033 #: ../src/guestfs-actions.pod:2476
10037 " guestfs_inotify_close (guestfs_h *g);\n"
10042 #: ../src/guestfs-actions.pod:2479 ../fish/guestfish-actions.pod:1643
10044 "This closes the inotify handle which was previously opened by inotify_init. "
10045 "It removes all watches, throws away any pending events, and deallocates all "
10050 #: ../src/guestfs-actions.pod:2487
10051 msgid "guestfs_inotify_files"
10055 #: ../src/guestfs-actions.pod:2489
10059 " guestfs_inotify_files (guestfs_h *g);\n"
10064 #: ../src/guestfs-actions.pod:2492
10066 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10067 "returns a list of pathnames of objects that were touched. The returned "
10068 "pathnames are sorted and deduplicated."
10072 #: ../src/guestfs-actions.pod:2502
10073 msgid "guestfs_inotify_init"
10077 #: ../src/guestfs-actions.pod:2504
10081 " guestfs_inotify_init (guestfs_h *g,\n"
10082 " int maxevents);\n"
10087 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1659
10089 "This command creates a new inotify handle. The inotify subsystem can be "
10090 "used to notify events which happen to objects in the guest filesystem."
10094 #: ../src/guestfs-actions.pod:2512
10096 "C<maxevents> is the maximum number of events which will be queued up between "
10097 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10098 "passed as C<0>, then the kernel (or previously set) default is used. For "
10099 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10100 "throws away events, but records the fact that it threw them away by setting "
10101 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10102 "C<guestfs_inotify_read>)."
10106 #: ../src/guestfs-actions.pod:2522
10108 "Before any events are generated, you have to add some watches to the "
10109 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10110 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10114 #: ../src/guestfs-actions.pod:2528
10116 "Queued up events should be read periodically by calling "
10117 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10118 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10119 "often enough then you risk the internal queue overflowing."
10123 #: ../src/guestfs-actions.pod:2535
10125 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10126 "This also removes any watches automatically."
10130 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1690
10132 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10133 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10134 "that there is one global inotify handle per libguestfs instance."
10138 #: ../src/guestfs-actions.pod:2548
10139 msgid "guestfs_inotify_read"
10143 #: ../src/guestfs-actions.pod:2550
10146 " struct guestfs_inotify_event_list *\n"
10147 " guestfs_inotify_read (guestfs_h *g);\n"
10152 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1699
10154 "Return the complete queue of events that have happened since the previous "
10159 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1702
10160 msgid "If no events have happened, this returns an empty list."
10164 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1704
10166 "I<Note>: In order to make sure that all events have been read, you must call "
10167 "this function repeatedly until it returns an empty list. The reason is that "
10168 "the call will read events up to the maximum appliance-to-host message size "
10169 "and leave remaining events in the queue."
10173 #: ../src/guestfs-actions.pod:2564
10175 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10176 "there was an error. I<The caller must call "
10177 "C<guestfs_free_inotify_event_list> after use>."
10181 #: ../src/guestfs-actions.pod:2570
10182 msgid "guestfs_inotify_rm_watch"
10186 #: ../src/guestfs-actions.pod:2572
10190 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10196 #: ../src/guestfs-actions.pod:2576
10198 "Remove a previously defined inotify watch. See "
10199 "C<guestfs_inotify_add_watch>."
10203 #: ../src/guestfs-actions.pod:2583
10204 msgid "guestfs_inspect_get_arch"
10208 #: ../src/guestfs-actions.pod:2585
10212 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10213 " const char *root);\n"
10218 #: ../src/guestfs-actions.pod:2589
10220 "This returns the architecture of the inspected operating system. The "
10221 "possible return values are listed under C<guestfs_file_architecture>."
10225 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1725
10227 "If the architecture could not be determined, then the string C<unknown> is "
10232 #: ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2809 ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:3023 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3072 ../src/guestfs-actions.pod:3125 ../src/guestfs-actions.pod:3165 ../src/guestfs-actions.pod:3185 ../src/guestfs-actions.pod:3205 ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3238 ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3399 ../fish/guestfish-actions.pod:1728 ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2047 ../fish/guestfish-actions.pod:2068 ../fish/guestfish-actions.pod:2082 ../fish/guestfish-actions.pod:2122 ../fish/guestfish-actions.pod:2154 ../fish/guestfish-actions.pod:2167 ../fish/guestfish-actions.pod:2180 ../fish/guestfish-actions.pod:2190 ../fish/guestfish-actions.pod:2200 ../fish/guestfish-actions.pod:2212 ../fish/guestfish-actions.pod:2308 ../fish/guestfish-actions.pod:2342
10233 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10237 #: ../src/guestfs-actions.pod:2603
10238 msgid "guestfs_inspect_get_distro"
10242 #: ../src/guestfs-actions.pod:2605
10246 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10247 " const char *root);\n"
10252 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1734
10253 msgid "This returns the distro (distribution) of the inspected operating system."
10257 #: ../src/guestfs-actions.pod:2612 ../fish/guestfish-actions.pod:1737
10258 msgid "Currently defined distros are:"
10262 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1741
10263 msgid "\"archlinux\""
10267 #: ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1743
10268 msgid "Arch Linux."
10272 #: ../src/guestfs-actions.pod:2620 ../fish/guestfish-actions.pod:1745
10277 #: ../src/guestfs-actions.pod:2622 ../fish/guestfish-actions.pod:1747
10282 #: ../src/guestfs-actions.pod:2624 ../fish/guestfish-actions.pod:1749
10287 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1751
10292 #: ../src/guestfs-actions.pod:2628 ../fish/guestfish-actions.pod:1753
10297 #: ../src/guestfs-actions.pod:2630 ../fish/guestfish-actions.pod:1755
10302 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1757
10307 #: ../src/guestfs-actions.pod:2634 ../fish/guestfish-actions.pod:1759
10312 #: ../src/guestfs-actions.pod:2636 ../fish/guestfish-actions.pod:1761
10313 msgid "\"linuxmint\""
10317 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1763
10318 msgid "Linux Mint."
10322 #: ../src/guestfs-actions.pod:2640 ../fish/guestfish-actions.pod:1765
10323 msgid "\"mandriva\""
10327 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1767
10332 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1769
10337 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1771
10342 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1773
10347 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1775
10352 #: ../src/guestfs-actions.pod:2652 ../fish/guestfish-actions.pod:1777
10353 msgid "\"redhat-based\""
10357 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1779
10358 msgid "Some Red Hat-derived distro."
10362 #: ../src/guestfs-actions.pod:2656 ../fish/guestfish-actions.pod:1781
10367 #: ../src/guestfs-actions.pod:2658 ../fish/guestfish-actions.pod:1783
10368 msgid "Red Hat Enterprise Linux."
10372 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1785
10373 msgid "\"scientificlinux\""
10377 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1787
10378 msgid "Scientific Linux."
10382 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1789
10383 msgid "\"slackware\""
10387 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:1791
10392 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1793
10397 #: ../src/guestfs-actions.pod:2670 ../fish/guestfish-actions.pod:1795
10402 #: ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2781 ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:1797 ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:2145
10403 msgid "\"unknown\""
10407 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1799
10408 msgid "The distro could not be determined."
10412 #: ../src/guestfs-actions.pod:2676 ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:1801 ../fish/guestfish-actions.pod:2137
10413 msgid "\"windows\""
10417 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1803
10419 "Windows does not have distributions. This string is returned if the OS type "
10424 #: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:2787 ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:2151
10426 "Future versions of libguestfs may return other strings here. The caller "
10427 "should be prepared to handle any string."
10431 #: ../src/guestfs-actions.pod:2693
10432 msgid "guestfs_inspect_get_drive_mappings"
10436 #: ../src/guestfs-actions.pod:2695
10440 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10441 " const char *root);\n"
10446 #: ../src/guestfs-actions.pod:2699 ../fish/guestfish-actions.pod:1817
10448 "This call is useful for Windows which uses a primitive system of assigning "
10449 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10450 "Windows Registry to find out how disks/partitions are mapped to drive "
10451 "letters, and returns a hash table as in the example below:"
10455 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1823
10458 " C => /dev/vda2\n"
10459 " E => /dev/vdb1\n"
10460 " F => /dev/vdc1\n"
10465 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1827
10467 "Note that keys are drive letters. For Windows, the key is case insensitive "
10468 "and just contains the drive letter, without the customary colon separator "
10473 #: ../src/guestfs-actions.pod:2713 ../fish/guestfish-actions.pod:1831
10475 "In future we may support other operating systems that also used drive "
10476 "letters, but the keys for those might not be case insensitive and might be "
10477 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10482 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1836
10484 "For Windows guests, currently only hard drive mappings are returned. "
10485 "Removable disks (eg. DVD-ROMs) are ignored."
10489 #: ../src/guestfs-actions.pod:2721 ../fish/guestfish-actions.pod:1839
10491 "For guests that do not use drive mappings, or if the drive mappings could "
10492 "not be determined, this returns an empty hash table."
10496 #: ../src/guestfs-actions.pod:2724
10498 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10499 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10503 #: ../src/guestfs-actions.pod:2728 ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:5076 ../src/guestfs-actions.pod:7122
10505 "This function returns a NULL-terminated array of strings, or NULL if there "
10506 "was an error. The array of strings will always have length C<2n+1>, where "
10507 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10508 "caller must free the strings and the array after use>."
10512 #: ../src/guestfs-actions.pod:2734 ../src/guestfs-actions.pod:3190
10513 msgid "(Added in 1.9.17)"
10517 #: ../src/guestfs-actions.pod:2736
10518 msgid "guestfs_inspect_get_filesystems"
10522 #: ../src/guestfs-actions.pod:2738
10526 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10527 " const char *root);\n"
10532 #: ../src/guestfs-actions.pod:2742 ../fish/guestfish-actions.pod:1850
10534 "This returns a list of all the filesystems that we think are associated with "
10535 "this operating system. This includes the root filesystem, other ordinary "
10536 "filesystems, and non-mounted devices like swap partitions."
10540 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1855
10542 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10543 "to be shared between operating systems."
10547 #: ../src/guestfs-actions.pod:2750
10549 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10550 "C<guestfs_inspect_get_mountpoints>."
10554 #: ../src/guestfs-actions.pod:2759
10555 msgid "guestfs_inspect_get_format"
10559 #: ../src/guestfs-actions.pod:2761
10563 " guestfs_inspect_get_format (guestfs_h *g,\n"
10564 " const char *root);\n"
10569 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1865
10571 "This returns the format of the inspected operating system. You can use it "
10572 "to detect install images, live CDs and similar."
10576 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1868
10577 msgid "Currently defined formats are:"
10581 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1872
10582 msgid "\"installed\""
10586 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1874
10587 msgid "This is an installed operating system."
10591 #: ../src/guestfs-actions.pod:2776 ../fish/guestfish-actions.pod:1876
10592 msgid "\"installer\""
10596 #: ../src/guestfs-actions.pod:2778 ../fish/guestfish-actions.pod:1878
10598 "The disk image being inspected is not an installed operating system, but a "
10599 "I<bootable> install disk, live CD, or similar."
10603 #: ../src/guestfs-actions.pod:2783 ../fish/guestfish-actions.pod:1883
10604 msgid "The format of this disk image is not known."
10608 #: ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:3226 ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:6020
10609 msgid "(Added in 1.9.4)"
10613 #: ../src/guestfs-actions.pod:2797
10614 msgid "guestfs_inspect_get_hostname"
10618 #: ../src/guestfs-actions.pod:2799
10622 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10623 " const char *root);\n"
10628 #: ../src/guestfs-actions.pod:2803 ../fish/guestfish-actions.pod:1896
10630 "This function returns the hostname of the operating system as found by "
10631 "inspection of the guest's configuration files."
10635 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1899
10637 "If the hostname could not be determined, then the string C<unknown> is "
10642 #: ../src/guestfs-actions.pod:2814
10643 msgid "(Added in 1.7.9)"
10647 #: ../src/guestfs-actions.pod:2816
10648 msgid "guestfs_inspect_get_icon"
10652 #: ../src/guestfs-actions.pod:2818
10656 " guestfs_inspect_get_icon (guestfs_h *g,\n"
10657 " const char *root,\n"
10658 " size_t *size_r,\n"
10664 #: ../src/guestfs-actions.pod:2829
10667 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
10668 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
10673 #: ../src/guestfs-actions.pod:2832 ../fish/guestfish-actions.pod:1908
10675 "This function returns an icon corresponding to the inspected operating "
10676 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
10677 "to PNG if necessary)."
10681 #: ../src/guestfs-actions.pod:2836 ../fish/guestfish-actions.pod:1912
10683 "If it was not possible to get an icon this function returns a zero-length "
10684 "(non-NULL) buffer. I<Callers must check for this case>."
10688 #: ../src/guestfs-actions.pod:2839 ../fish/guestfish-actions.pod:1915
10690 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
10691 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
10692 "this file will be returned. You can disable favicons by passing the "
10693 "optional C<favicon> boolean as false (default is true)."
10697 #: ../src/guestfs-actions.pod:2845 ../fish/guestfish-actions.pod:1921
10699 "If finding the favicon fails, then we look in other places in the guest for "
10704 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1924
10706 "If the optional C<highquality> boolean is true then only high quality icons "
10707 "are returned, which means only icons of high resolution with an alpha "
10708 "channel. The default (false) is to return any icon we can, even if it is of "
10709 "substandard quality."
10713 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1935
10715 "Unlike most other inspection API calls, the guest's disks must be mounted up "
10716 "before you call this, since it needs to read information from the guest "
10717 "filesystem during the call."
10721 #: ../src/guestfs-actions.pod:2865 ../fish/guestfish-actions.pod:1941
10723 "B<Security:> The icon data comes from the untrusted guest, and should be "
10724 "treated with caution. PNG files have been known to contain exploits. "
10725 "Ensure that libpng (or other relevant libraries) are fully up to date before "
10726 "trying to process or display the icon."
10730 #: ../src/guestfs-actions.pod:2873 ../fish/guestfish-actions.pod:1949
10732 "The PNG image returned can be any size. It might not be square. Libguestfs "
10733 "tries to return the largest, highest quality icon available. The "
10734 "application must scale the icon to the required size."
10738 #: ../src/guestfs-actions.pod:2880 ../fish/guestfish-actions.pod:1956
10740 "Extracting icons from Windows guests requires the external C<wrestool> "
10741 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
10742 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
10743 "installed separately."
10747 #: ../src/guestfs-actions.pod:2887 ../fish/guestfish-actions.pod:1963
10749 "Operating system icons are usually trademarks. Seek legal advice before "
10750 "using trademarks in applications."
10754 #: ../src/guestfs-actions.pod:2896 ../src/guestfs-actions.pod:3721 ../src/guestfs-actions.pod:4975
10755 msgid "(Added in 1.11.12)"
10759 #: ../src/guestfs-actions.pod:2898
10760 msgid "guestfs_inspect_get_icon_va"
10764 #: ../src/guestfs-actions.pod:2900
10768 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
10769 " const char *root,\n"
10770 " size_t *size_r,\n"
10771 " va_list args);\n"
10776 #: ../src/guestfs-actions.pod:2906
10777 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
10781 #: ../src/guestfs-actions.pod:2910
10782 msgid "guestfs_inspect_get_icon_argv"
10786 #: ../src/guestfs-actions.pod:2912
10790 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
10791 " const char *root,\n"
10792 " size_t *size_r,\n"
10793 " const struct guestfs_inspect_get_icon_argv "
10799 #: ../src/guestfs-actions.pod:2918
10800 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
10804 #: ../src/guestfs-actions.pod:2922
10805 msgid "guestfs_inspect_get_major_version"
10809 #: ../src/guestfs-actions.pod:2924
10813 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10814 " const char *root);\n"
10819 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:1974
10820 msgid "This returns the major version number of the inspected operating system."
10824 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:1977
10826 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10827 "popular public names used by the operating system. Notably the operating "
10828 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10829 "1). You can find out the real versions corresponding to releases of Windows "
10830 "by consulting Wikipedia or MSDN."
10834 #: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:1995
10835 msgid "If the version could not be determined, then C<0> is returned."
10839 #: ../src/guestfs-actions.pod:2946
10840 msgid "guestfs_inspect_get_minor_version"
10844 #: ../src/guestfs-actions.pod:2948
10848 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10849 " const char *root);\n"
10854 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:1992
10855 msgid "This returns the minor version number of the inspected operating system."
10859 #: ../src/guestfs-actions.pod:2957
10861 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10862 "C<guestfs_inspect_get_major_version>."
10866 #: ../src/guestfs-actions.pod:2964
10867 msgid "guestfs_inspect_get_mountpoints"
10871 #: ../src/guestfs-actions.pod:2966
10875 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10876 " const char *root);\n"
10881 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2004
10883 "This returns a hash of where we think the filesystems associated with this "
10884 "operating system should be mounted. Callers should note that this is at "
10885 "best an educated guess made by reading configuration files such as "
10886 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10887 "are non-existent or not mountable and callers should be prepared to handle "
10888 "or ignore failures if they try to mount them."
10892 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2013
10894 "Each element in the returned hashtable has a key which is the path of the "
10895 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10896 "mounted there (eg. C</dev/sda1>)."
10900 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2018
10901 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10905 #: ../src/guestfs-actions.pod:2987
10907 "For operating systems like Windows which still use drive letters, this call "
10908 "will only return an entry for the first drive \"mounted on\" C</>. For "
10909 "information about the mapping of drive letters to partitions, see "
10910 "C<guestfs_inspect_get_drive_mappings>."
10914 #: ../src/guestfs-actions.pod:2993
10916 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10917 "C<guestfs_inspect_get_filesystems>."
10921 #: ../src/guestfs-actions.pod:3004
10922 msgid "guestfs_inspect_get_package_format"
10926 #: ../src/guestfs-actions.pod:3006
10930 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10931 " const char *root);\n"
10936 #: ../src/guestfs-actions.pod:3010
10938 "This function and C<guestfs_inspect_get_package_management> return the "
10939 "package format and package management tool used by the inspected operating "
10940 "system. For example for Fedora these functions would return C<rpm> (package "
10941 "format) and C<yum> (package management)."
10945 #: ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:2040
10947 "This returns the string C<unknown> if we could not determine the package "
10948 "format I<or> if the operating system does not have a real packaging system "
10953 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2044
10955 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10956 "Future versions of libguestfs may return other strings."
10960 #: ../src/guestfs-actions.pod:3028 ../src/guestfs-actions.pod:3056
10961 msgid "(Added in 1.7.5)"
10965 #: ../src/guestfs-actions.pod:3030
10966 msgid "guestfs_inspect_get_package_management"
10970 #: ../src/guestfs-actions.pod:3032
10974 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10975 " const char *root);\n"
10980 #: ../src/guestfs-actions.pod:3036
10982 "C<guestfs_inspect_get_package_format> and this function return the package "
10983 "format and package management tool used by the inspected operating system. "
10984 "For example for Fedora these functions would return C<rpm> (package format) "
10985 "and C<yum> (package management)."
10989 #: ../src/guestfs-actions.pod:3042 ../fish/guestfish-actions.pod:2059
10991 "This returns the string C<unknown> if we could not determine the package "
10992 "management tool I<or> if the operating system does not have a real packaging "
10993 "system (eg. Windows)."
10997 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2063
10999 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11000 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11001 "libguestfs may return other strings."
11005 #: ../src/guestfs-actions.pod:3058
11006 msgid "guestfs_inspect_get_product_name"
11010 #: ../src/guestfs-actions.pod:3060
11014 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11015 " const char *root);\n"
11020 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2074
11022 "This returns the product name of the inspected operating system. The "
11023 "product name is generally some freeform string which can be displayed to the "
11024 "user, but should not be parsed by programs."
11028 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2079
11030 "If the product name could not be determined, then the string C<unknown> is "
11035 #: ../src/guestfs-actions.pod:3079
11036 msgid "guestfs_inspect_get_product_variant"
11040 #: ../src/guestfs-actions.pod:3081
11044 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11045 " const char *root);\n"
11050 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2088
11051 msgid "This returns the product variant of the inspected operating system."
11055 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:2091
11057 "For Windows guests, this returns the contents of the Registry key "
11058 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
11059 "which is usually a string such as C<Client> or C<Server> (other values are "
11060 "possible). This can be used to distinguish consumer and enterprise versions "
11061 "of Windows that have the same version number (for example, Windows 7 and "
11062 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11063 "the latter is C<Server>)."
11067 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2100
11069 "For enterprise Linux guests, in future we intend this to return the product "
11070 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11071 "implemented at present."
11075 #: ../src/guestfs-actions.pod:3101 ../fish/guestfish-actions.pod:2104
11077 "If the product variant could not be determined, then the string C<unknown> "
11082 #: ../src/guestfs-actions.pod:3104
11084 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11085 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11089 #: ../src/guestfs-actions.pod:3111
11090 msgid "(Added in 1.9.13)"
11094 #: ../src/guestfs-actions.pod:3113
11095 msgid "guestfs_inspect_get_roots"
11099 #: ../src/guestfs-actions.pod:3115
11103 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11108 #: ../src/guestfs-actions.pod:3118
11110 "This function is a convenient way to get the list of root devices, as "
11111 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11112 "the whole inspection process."
11116 #: ../src/guestfs-actions.pod:3122
11118 "This returns an empty list if either no root devices were found or the "
11119 "caller has not called C<guestfs_inspect_os>."
11123 #: ../src/guestfs-actions.pod:3131
11124 msgid "(Added in 1.7.3)"
11128 #: ../src/guestfs-actions.pod:3133
11129 msgid "guestfs_inspect_get_type"
11133 #: ../src/guestfs-actions.pod:3135
11137 " guestfs_inspect_get_type (guestfs_h *g,\n"
11138 " const char *root);\n"
11143 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2128
11145 "This returns the type of the inspected operating system. Currently defined "
11150 #: ../src/guestfs-actions.pod:3144 ../fish/guestfish-actions.pod:2133
11155 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2135
11156 msgid "Any Linux-based operating system."
11160 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2139
11161 msgid "Any Microsoft Windows operating system."
11165 #: ../src/guestfs-actions.pod:3152 ../fish/guestfish-actions.pod:2141
11166 msgid "\"freebsd\""
11170 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2143
11175 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2147
11176 msgid "The operating system type could not be determined."
11180 #: ../src/guestfs-actions.pod:3172
11181 msgid "guestfs_inspect_get_windows_current_control_set"
11185 #: ../src/guestfs-actions.pod:3174
11189 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11190 " const char *root);\n"
11195 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2160
11197 "This returns the Windows CurrentControlSet of the inspected guest. The "
11198 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11202 #: ../src/guestfs-actions.pod:3181 ../fish/guestfish-actions.pod:2163
11204 "This call assumes that the guest is Windows and that the Registry could be "
11205 "examined by inspection. If this is not the case then an error is returned."
11209 #: ../src/guestfs-actions.pod:3192
11210 msgid "guestfs_inspect_get_windows_systemroot"
11214 #: ../src/guestfs-actions.pod:3194
11218 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11219 " const char *root);\n"
11224 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2173
11226 "This returns the Windows systemroot of the inspected guest. The systemroot "
11227 "is a directory path such as C</WINDOWS>."
11231 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2176
11233 "This call assumes that the guest is Windows and that the systemroot could be "
11234 "determined by inspection. If this is not the case then an error is "
11239 #: ../src/guestfs-actions.pod:3210
11240 msgid "(Added in 1.5.25)"
11244 #: ../src/guestfs-actions.pod:3212
11245 msgid "guestfs_inspect_is_live"
11249 #: ../src/guestfs-actions.pod:3214
11253 " guestfs_inspect_is_live (guestfs_h *g,\n"
11254 " const char *root);\n"
11259 #: ../src/guestfs-actions.pod:3218
11261 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11262 "disk), then this returns true if a live image was detected on the disk."
11266 #: ../src/guestfs-actions.pod:3228
11267 msgid "guestfs_inspect_is_multipart"
11271 #: ../src/guestfs-actions.pod:3230
11275 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11276 " const char *root);\n"
11281 #: ../src/guestfs-actions.pod:3234
11283 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11284 "disk), then this returns true if the disk is part of a set."
11288 #: ../src/guestfs-actions.pod:3244
11289 msgid "guestfs_inspect_is_netinst"
11293 #: ../src/guestfs-actions.pod:3246
11297 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11298 " const char *root);\n"
11303 #: ../src/guestfs-actions.pod:3250
11305 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11306 "disk), then this returns true if the disk is a network installer, ie. not a "
11307 "self-contained install CD but one which is likely to require network access "
11308 "to complete the install."
11312 #: ../src/guestfs-actions.pod:3262
11313 msgid "guestfs_inspect_list_applications"
11317 #: ../src/guestfs-actions.pod:3264
11320 " struct guestfs_application_list *\n"
11321 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11322 " const char *root);\n"
11327 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2218
11328 msgid "Return the list of applications installed in the operating system."
11332 #: ../src/guestfs-actions.pod:3270
11334 "I<Note:> This call works differently from other parts of the inspection "
11335 "API. You have to call C<guestfs_inspect_os>, then "
11336 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11337 "this. Listing applications is a significantly more difficult operation "
11338 "which requires access to the full filesystem. Also note that unlike the "
11339 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11340 "the libguestfs handle, this call actually reads parts of the mounted "
11341 "filesystems during the call."
11345 #: ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:2230
11347 "This returns an empty list if the inspection code was not able to determine "
11348 "the list of applications."
11352 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2233
11353 msgid "The application structure contains the following fields:"
11357 #: ../src/guestfs-actions.pod:3287 ../fish/guestfish-actions.pod:2237
11358 msgid "C<app_name>"
11362 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2239
11364 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11365 "guests, this is the package name."
11369 #: ../src/guestfs-actions.pod:3292 ../fish/guestfish-actions.pod:2242
11370 msgid "C<app_display_name>"
11374 #: ../src/guestfs-actions.pod:3294 ../fish/guestfish-actions.pod:2244
11376 "The display name of the application, sometimes localized to the install "
11377 "language of the guest operating system."
11381 #: ../src/guestfs-actions.pod:3297 ../fish/guestfish-actions.pod:2247
11383 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11384 "to display something can use C<app_name> instead."
11388 #: ../src/guestfs-actions.pod:3300 ../fish/guestfish-actions.pod:2250
11389 msgid "C<app_epoch>"
11393 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2252
11395 "For package managers which use epochs, this contains the epoch of the "
11396 "package (an integer). If unavailable, this is returned as C<0>."
11400 #: ../src/guestfs-actions.pod:3305 ../fish/guestfish-actions.pod:2255
11401 msgid "C<app_version>"
11405 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2257
11407 "The version string of the application or package. If unavailable this is "
11408 "returned as an empty string C<\"\">."
11412 #: ../src/guestfs-actions.pod:3310 ../fish/guestfish-actions.pod:2260
11413 msgid "C<app_release>"
11417 #: ../src/guestfs-actions.pod:3312 ../fish/guestfish-actions.pod:2262
11419 "The release string of the application or package, for package managers that "
11420 "use this. If unavailable this is returned as an empty string C<\"\">."
11424 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2266
11425 msgid "C<app_install_path>"
11429 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2268
11431 "The installation path of the application (on operating systems such as "
11432 "Windows which use installation paths). This path is in the format used by "
11433 "the guest operating system, it is not a libguestfs path."
11437 #: ../src/guestfs-actions.pod:3323 ../fish/guestfish-actions.pod:2273
11438 msgid "If unavailable this is returned as an empty string C<\"\">."
11442 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2275
11443 msgid "C<app_trans_path>"
11447 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2277
11449 "The install path translated into a libguestfs path. If unavailable this is "
11450 "returned as an empty string C<\"\">."
11454 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2280
11455 msgid "C<app_publisher>"
11459 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2282
11461 "The name of the publisher of the application, for package managers that use "
11462 "this. If unavailable this is returned as an empty string C<\"\">."
11466 #: ../src/guestfs-actions.pod:3336 ../fish/guestfish-actions.pod:2286
11471 #: ../src/guestfs-actions.pod:3338 ../fish/guestfish-actions.pod:2288
11473 "The URL (eg. upstream URL) of the application. If unavailable this is "
11474 "returned as an empty string C<\"\">."
11478 #: ../src/guestfs-actions.pod:3341 ../fish/guestfish-actions.pod:2291
11479 msgid "C<app_source_package>"
11483 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2293
11485 "For packaging systems which support this, the name of the source package. "
11486 "If unavailable this is returned as an empty string C<\"\">."
11490 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2296
11491 msgid "C<app_summary>"
11495 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2298
11497 "A short (usually one line) description of the application or package. If "
11498 "unavailable this is returned as an empty string C<\"\">."
11502 #: ../src/guestfs-actions.pod:3351 ../fish/guestfish-actions.pod:2301
11503 msgid "C<app_description>"
11507 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2303
11509 "A longer description of the application or package. If unavailable this is "
11510 "returned as an empty string C<\"\">."
11514 #: ../src/guestfs-actions.pod:3360
11516 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11517 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11522 #: ../src/guestfs-actions.pod:3364
11523 msgid "(Added in 1.7.8)"
11527 #: ../src/guestfs-actions.pod:3366
11528 msgid "guestfs_inspect_os"
11532 #: ../src/guestfs-actions.pod:3368
11536 " guestfs_inspect_os (guestfs_h *g);\n"
11541 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2314
11543 "This function uses other libguestfs functions and certain heuristics to "
11544 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11545 "for operating systems."
11549 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2318
11550 msgid "The list returned is empty if no operating systems were found."
11554 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2320
11556 "If one operating system was found, then this returns a list with a single "
11557 "element, which is the name of the root filesystem of this operating system. "
11558 "It is also possible for this function to return a list containing more than "
11559 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11560 "element being the root filesystem of one of the operating systems."
11564 #: ../src/guestfs-actions.pod:3384
11566 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11567 "functions in order to query further information about each operating system, "
11568 "such as the name and version."
11572 #: ../src/guestfs-actions.pod:3389
11574 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11575 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11576 "the contents. This should be called with no disks currently mounted. The "
11577 "function may also use Augeas, so any existing Augeas handle will be closed."
11581 #: ../src/guestfs-actions.pod:3395 ../fish/guestfish-actions.pod:2338
11583 "This function cannot decrypt encrypted disks. The caller must do that first "
11584 "(supplying the necessary keys) if the disk is encrypted."
11588 #: ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:3814
11589 msgid "See also C<guestfs_list_filesystems>."
11593 #: ../src/guestfs-actions.pod:3409
11594 msgid "guestfs_is_blockdev"
11598 #: ../src/guestfs-actions.pod:3411
11602 " guestfs_is_blockdev (guestfs_h *g,\n"
11603 " const char *path);\n"
11608 #: ../src/guestfs-actions.pod:3415 ../fish/guestfish-actions.pod:2350
11610 "This returns C<true> if and only if there is a block device with the given "
11615 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3447 ../src/guestfs-actions.pod:3477 ../src/guestfs-actions.pod:3492 ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3579
11616 msgid "See also C<guestfs_stat>."
11620 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3496 ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3583
11621 msgid "(Added in 1.5.10)"
11625 #: ../src/guestfs-actions.pod:3424
11626 msgid "guestfs_is_busy"
11630 #: ../src/guestfs-actions.pod:3426
11634 " guestfs_is_busy (guestfs_h *g);\n"
11639 #: ../src/guestfs-actions.pod:3429 ../fish/guestfish-actions.pod:2359
11641 "This returns true iff this handle is busy processing a command (in the "
11646 #: ../src/guestfs-actions.pod:3438
11647 msgid "guestfs_is_chardev"
11651 #: ../src/guestfs-actions.pod:3440
11655 " guestfs_is_chardev (guestfs_h *g,\n"
11656 " const char *path);\n"
11661 #: ../src/guestfs-actions.pod:3444 ../fish/guestfish-actions.pod:2368
11663 "This returns C<true> if and only if there is a character device with the "
11664 "given C<path> name."
11668 #: ../src/guestfs-actions.pod:3453
11669 msgid "guestfs_is_config"
11673 #: ../src/guestfs-actions.pod:3455
11677 " guestfs_is_config (guestfs_h *g);\n"
11682 #: ../src/guestfs-actions.pod:3458 ../fish/guestfish-actions.pod:2377
11684 "This returns true iff this handle is being configured (in the C<CONFIG> "
11689 #: ../src/guestfs-actions.pod:3467
11690 msgid "guestfs_is_dir"
11694 #: ../src/guestfs-actions.pod:3469
11698 " guestfs_is_dir (guestfs_h *g,\n"
11699 " const char *path);\n"
11704 #: ../src/guestfs-actions.pod:3473 ../fish/guestfish-actions.pod:2386
11706 "This returns C<true> if and only if there is a directory with the given "
11707 "C<path> name. Note that it returns false for other objects like files."
11711 #: ../src/guestfs-actions.pod:3483
11712 msgid "guestfs_is_fifo"
11716 #: ../src/guestfs-actions.pod:3485
11720 " guestfs_is_fifo (guestfs_h *g,\n"
11721 " const char *path);\n"
11726 #: ../src/guestfs-actions.pod:3489 ../fish/guestfish-actions.pod:2396
11728 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11729 "given C<path> name."
11733 #: ../src/guestfs-actions.pod:3498
11734 msgid "guestfs_is_file"
11738 #: ../src/guestfs-actions.pod:3500
11742 " guestfs_is_file (guestfs_h *g,\n"
11743 " const char *path);\n"
11748 #: ../src/guestfs-actions.pod:3504 ../fish/guestfish-actions.pod:2405
11750 "This returns C<true> if and only if there is a regular file with the given "
11751 "C<path> name. Note that it returns false for other objects like "
11756 #: ../src/guestfs-actions.pod:3514
11757 msgid "guestfs_is_launching"
11761 #: ../src/guestfs-actions.pod:3516
11765 " guestfs_is_launching (guestfs_h *g);\n"
11770 #: ../src/guestfs-actions.pod:3519 ../fish/guestfish-actions.pod:2415
11772 "This returns true iff this handle is launching the subprocess (in the "
11773 "C<LAUNCHING> state)."
11777 #: ../src/guestfs-actions.pod:3528
11778 msgid "guestfs_is_lv"
11782 #: ../src/guestfs-actions.pod:3530
11786 " guestfs_is_lv (guestfs_h *g,\n"
11787 " const char *device);\n"
11792 #: ../src/guestfs-actions.pod:3534 ../fish/guestfish-actions.pod:2424
11794 "This command tests whether C<device> is a logical volume, and returns true "
11795 "iff this is the case."
11799 #: ../src/guestfs-actions.pod:3541
11800 msgid "guestfs_is_ready"
11804 #: ../src/guestfs-actions.pod:3543
11808 " guestfs_is_ready (guestfs_h *g);\n"
11813 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2431
11815 "This returns true iff this handle is ready to accept commands (in the "
11820 #: ../src/guestfs-actions.pod:3555
11821 msgid "guestfs_is_socket"
11825 #: ../src/guestfs-actions.pod:3557
11829 " guestfs_is_socket (guestfs_h *g,\n"
11830 " const char *path);\n"
11835 #: ../src/guestfs-actions.pod:3561 ../fish/guestfish-actions.pod:2440
11837 "This returns C<true> if and only if there is a Unix domain socket with the "
11838 "given C<path> name."
11842 #: ../src/guestfs-actions.pod:3570
11843 msgid "guestfs_is_symlink"
11847 #: ../src/guestfs-actions.pod:3572
11851 " guestfs_is_symlink (guestfs_h *g,\n"
11852 " const char *path);\n"
11857 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2449
11859 "This returns C<true> if and only if there is a symbolic link with the given "
11864 #: ../src/guestfs-actions.pod:3585
11865 msgid "guestfs_is_zero"
11869 #: ../src/guestfs-actions.pod:3587
11873 " guestfs_is_zero (guestfs_h *g,\n"
11874 " const char *path);\n"
11879 #: ../src/guestfs-actions.pod:3591 ../fish/guestfish-actions.pod:2458
11881 "This returns true iff the file exists and the file is empty or it contains "
11886 #: ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3610
11887 msgid "(Added in 1.11.8)"
11891 #: ../src/guestfs-actions.pod:3598
11892 msgid "guestfs_is_zero_device"
11896 #: ../src/guestfs-actions.pod:3600
11900 " guestfs_is_zero_device (guestfs_h *g,\n"
11901 " const char *device);\n"
11906 #: ../src/guestfs-actions.pod:3604 ../fish/guestfish-actions.pod:2465
11907 msgid "This returns true iff the device exists and contains all zero bytes."
11911 #: ../src/guestfs-actions.pod:3606 ../fish/guestfish-actions.pod:2467
11912 msgid "Note that for large devices this can take a long time to run."
11916 #: ../src/guestfs-actions.pod:3612
11917 msgid "guestfs_kill_subprocess"
11921 #: ../src/guestfs-actions.pod:3614
11925 " guestfs_kill_subprocess (guestfs_h *g);\n"
11930 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2473
11931 msgid "This kills the qemu subprocess. You should never need to call this."
11935 #: ../src/guestfs-actions.pod:3623
11936 msgid "guestfs_launch"
11940 #: ../src/guestfs-actions.pod:3625
11944 " guestfs_launch (guestfs_h *g);\n"
11949 #: ../src/guestfs-actions.pod:3628 ../fish/guestfish-actions.pod:2481
11951 "Internally libguestfs is implemented by running a virtual machine using "
11956 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2484
11958 "You should call this after configuring the handle (eg. adding drives) but "
11959 "before performing any actions."
11963 #: ../src/guestfs-actions.pod:3643
11964 msgid "guestfs_lchown"
11968 #: ../src/guestfs-actions.pod:3645
11972 " guestfs_lchown (guestfs_h *g,\n"
11975 " const char *path);\n"
11980 #: ../src/guestfs-actions.pod:3651
11982 "Change the file owner to C<owner> and group to C<group>. This is like "
11983 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11984 "changed, not the target."
11988 #: ../src/guestfs-actions.pod:3663
11989 msgid "guestfs_lgetxattr"
11993 #: ../src/guestfs-actions.pod:3665
11997 " guestfs_lgetxattr (guestfs_h *g,\n"
11998 " const char *path,\n"
11999 " const char *name,\n"
12000 " size_t *size_r);\n"
12005 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2503
12007 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12008 "is a symlink, then this call returns an extended attribute from the symlink."
12012 #: ../src/guestfs-actions.pod:3685
12013 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12017 #: ../src/guestfs-actions.pod:3693
12018 msgid "guestfs_lgetxattrs"
12022 #: ../src/guestfs-actions.pod:3695
12025 " struct guestfs_xattr_list *\n"
12026 " guestfs_lgetxattrs (guestfs_h *g,\n"
12027 " const char *path);\n"
12032 #: ../src/guestfs-actions.pod:3699
12034 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12035 "then it returns the extended attributes of the link itself."
12039 #: ../src/guestfs-actions.pod:3709
12040 msgid "guestfs_list_9p"
12044 #: ../src/guestfs-actions.pod:3711
12048 " guestfs_list_9p (guestfs_h *g);\n"
12053 #: ../src/guestfs-actions.pod:3714 ../fish/guestfish-actions.pod:2531
12055 "List all 9p filesystems attached to the guest. A list of mount tags is "
12060 #: ../src/guestfs-actions.pod:3723
12061 msgid "guestfs_list_devices"
12065 #: ../src/guestfs-actions.pod:3725
12069 " guestfs_list_devices (guestfs_h *g);\n"
12074 #: ../src/guestfs-actions.pod:3728 ../fish/guestfish-actions.pod:2538
12075 msgid "List all the block devices."
12079 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2540
12080 msgid "The full block device names are returned, eg. C</dev/sda>."
12084 #: ../src/guestfs-actions.pod:3740
12085 msgid "guestfs_list_dm_devices"
12089 #: ../src/guestfs-actions.pod:3742
12093 " guestfs_list_dm_devices (guestfs_h *g);\n"
12098 #: ../src/guestfs-actions.pod:3745 ../fish/guestfish-actions.pod:2548
12099 msgid "List all device mapper devices."
12103 #: ../src/guestfs-actions.pod:3747
12105 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12106 "previous call to C<guestfs_luks_open>."
12110 #: ../src/guestfs-actions.pod:3750
12112 "Device mapper devices which correspond to logical volumes are I<not> "
12113 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
12118 #: ../src/guestfs-actions.pod:3758 ../src/guestfs-actions.pod:5214
12119 msgid "(Added in 1.11.15)"
12123 #: ../src/guestfs-actions.pod:3760
12124 msgid "guestfs_list_filesystems"
12128 #: ../src/guestfs-actions.pod:3762
12132 " guestfs_list_filesystems (guestfs_h *g);\n"
12137 #: ../src/guestfs-actions.pod:3765 ../fish/guestfish-actions.pod:2561
12139 "This inspection command looks for filesystems on partitions, block devices "
12140 "and logical volumes, returning a list of devices containing filesystems and "
12145 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2565
12147 "The return value is a hash, where the keys are the devices containing "
12148 "filesystems, and the values are the filesystem types. For example:"
12152 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2569
12155 " \"/dev/sda1\" => \"ntfs\"\n"
12156 " \"/dev/sda2\" => \"ext2\"\n"
12157 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12158 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12163 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2574
12165 "The value can have the special value \"unknown\", meaning the content of the "
12166 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12170 #: ../src/guestfs-actions.pod:3782
12172 "This command runs other libguestfs commands, which might include "
12173 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12174 "soon after launch and only when nothing is mounted."
12178 #: ../src/guestfs-actions.pod:3786
12180 "Not all of the filesystems returned will be mountable. In particular, swap "
12181 "partitions are returned in the list. Also this command does not check that "
12182 "each filesystem found is valid and mountable, and some filesystems might be "
12183 "mountable but require special options. Filesystems may not all belong to a "
12184 "single logical operating system (use C<guestfs_inspect_os> to look for "
12189 #: ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:5569
12190 msgid "(Added in 1.5.15)"
12194 #: ../src/guestfs-actions.pod:3802
12195 msgid "guestfs_list_partitions"
12199 #: ../src/guestfs-actions.pod:3804
12203 " guestfs_list_partitions (guestfs_h *g);\n"
12208 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2594
12209 msgid "List all the partitions detected on all block devices."
12213 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2596
12214 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12218 #: ../src/guestfs-actions.pod:3811
12220 "This does not return logical volumes. For that you will need to call "
12225 #: ../src/guestfs-actions.pod:3822
12230 #: ../src/guestfs-actions.pod:3824
12234 " guestfs_ll (guestfs_h *g,\n"
12235 " const char *directory);\n"
12240 #: ../src/guestfs-actions.pod:3828 ../fish/guestfish-actions.pod:2607
12242 "List the files in C<directory> (relative to the root directory, there is no "
12243 "cwd) in the format of 'ls -la'."
12247 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
12249 "This command is mostly useful for interactive sessions. It is I<not> "
12250 "intended that you try to parse the output string."
12254 #: ../src/guestfs-actions.pod:3839
12259 #: ../src/guestfs-actions.pod:3841
12263 " guestfs_ln (guestfs_h *g,\n"
12264 " const char *target,\n"
12265 " const char *linkname);\n"
12270 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
12271 msgid "This command creates a hard link using the C<ln> command."
12275 #: ../src/guestfs-actions.pod:3852
12276 msgid "guestfs_ln_f"
12280 #: ../src/guestfs-actions.pod:3854
12284 " guestfs_ln_f (guestfs_h *g,\n"
12285 " const char *target,\n"
12286 " const char *linkname);\n"
12291 #: ../src/guestfs-actions.pod:3859 ../fish/guestfish-actions.pod:2623
12293 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12294 "option removes the link (C<linkname>) if it exists already."
12298 #: ../src/guestfs-actions.pod:3866
12299 msgid "guestfs_ln_s"
12303 #: ../src/guestfs-actions.pod:3868
12307 " guestfs_ln_s (guestfs_h *g,\n"
12308 " const char *target,\n"
12309 " const char *linkname);\n"
12314 #: ../src/guestfs-actions.pod:3873 ../fish/guestfish-actions.pod:2630
12315 msgid "This command creates a symbolic link using the C<ln -s> command."
12319 #: ../src/guestfs-actions.pod:3879
12320 msgid "guestfs_ln_sf"
12324 #: ../src/guestfs-actions.pod:3881
12328 " guestfs_ln_sf (guestfs_h *g,\n"
12329 " const char *target,\n"
12330 " const char *linkname);\n"
12335 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2636
12337 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12338 "option removes the link (C<linkname>) if it exists already."
12342 #: ../src/guestfs-actions.pod:3893
12343 msgid "guestfs_lremovexattr"
12347 #: ../src/guestfs-actions.pod:3895
12351 " guestfs_lremovexattr (guestfs_h *g,\n"
12352 " const char *xattr,\n"
12353 " const char *path);\n"
12358 #: ../src/guestfs-actions.pod:3900
12360 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12361 "link, then it removes an extended attribute of the link itself."
12365 #: ../src/guestfs-actions.pod:3908
12370 #: ../src/guestfs-actions.pod:3910
12374 " guestfs_ls (guestfs_h *g,\n"
12375 " const char *directory);\n"
12380 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2651
12382 "List the files in C<directory> (relative to the root directory, there is no "
12383 "cwd). The '.' and '..' entries are not returned, but hidden files are "
12388 #: ../src/guestfs-actions.pod:3918
12390 "This command is mostly useful for interactive sessions. Programs should "
12391 "probably use C<guestfs_readdir> instead."
12395 #: ../src/guestfs-actions.pod:3927
12396 msgid "guestfs_lsetxattr"
12400 #: ../src/guestfs-actions.pod:3929
12404 " guestfs_lsetxattr (guestfs_h *g,\n"
12405 " const char *xattr,\n"
12406 " const char *val,\n"
12408 " const char *path);\n"
12413 #: ../src/guestfs-actions.pod:3936
12415 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12416 "then it sets an extended attribute of the link itself."
12420 #: ../src/guestfs-actions.pod:3944
12421 msgid "guestfs_lstat"
12425 #: ../src/guestfs-actions.pod:3946
12428 " struct guestfs_stat *\n"
12429 " guestfs_lstat (guestfs_h *g,\n"
12430 " const char *path);\n"
12435 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:6721 ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:4472
12436 msgid "Returns file information for the given C<path>."
12440 #: ../src/guestfs-actions.pod:3952
12442 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12443 "link, then the link is stat-ed, not the file it refers to."
12447 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2676
12448 msgid "This is the same as the C<lstat(2)> system call."
12452 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:6725
12454 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12455 "error. I<The caller must call C<guestfs_free_stat> after use>."
12459 #: ../src/guestfs-actions.pod:3962 ../src/guestfs-actions.pod:6729 ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:7128
12460 msgid "(Added in 0.9.2)"
12464 #: ../src/guestfs-actions.pod:3964
12465 msgid "guestfs_lstatlist"
12469 #: ../src/guestfs-actions.pod:3966
12472 " struct guestfs_stat_list *\n"
12473 " guestfs_lstatlist (guestfs_h *g,\n"
12474 " const char *path,\n"
12475 " char *const *names);\n"
12480 #: ../src/guestfs-actions.pod:3971
12482 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12483 "files, where all files are in the directory C<path>. C<names> is the list "
12484 "of files from this directory."
12488 #: ../src/guestfs-actions.pod:3975 ../fish/guestfish-actions.pod:2686
12490 "On return you get a list of stat structs, with a one-to-one correspondence "
12491 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12492 "then the C<ino> field of that structure is set to C<-1>."
12496 #: ../src/guestfs-actions.pod:3980
12498 "This call is intended for programs that want to efficiently list a directory "
12499 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12500 "for a similarly efficient call for getting extended attributes. Very long "
12501 "directory listings might cause the protocol message size to be exceeded, "
12502 "causing this call to fail. The caller must split up such requests into "
12503 "smaller groups of names."
12507 #: ../src/guestfs-actions.pod:3988
12509 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12510 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12514 #: ../src/guestfs-actions.pod:3994
12515 msgid "guestfs_luks_add_key"
12519 #: ../src/guestfs-actions.pod:3996
12523 " guestfs_luks_add_key (guestfs_h *g,\n"
12524 " const char *device,\n"
12525 " const char *key,\n"
12526 " const char *newkey,\n"
12532 #: ../src/guestfs-actions.pod:4003 ../fish/guestfish-actions.pod:2703
12534 "This command adds a new key on LUKS device C<device>. C<key> is any "
12535 "existing key, and is used to access the device. C<newkey> is the new key to "
12536 "add. C<keyslot> is the key slot that will be replaced."
12540 #: ../src/guestfs-actions.pod:4008
12542 "Note that if C<keyslot> already contains a key, then this command will "
12543 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12547 #: ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:4054 ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4097 ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4151
12549 "This function takes a key or passphrase parameter which could contain "
12550 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12555 #: ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4101
12556 msgid "(Added in 1.5.2)"
12560 #: ../src/guestfs-actions.pod:4020
12561 msgid "guestfs_luks_close"
12565 #: ../src/guestfs-actions.pod:4022
12569 " guestfs_luks_close (guestfs_h *g,\n"
12570 " const char *device);\n"
12575 #: ../src/guestfs-actions.pod:4026
12577 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12578 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12579 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12580 "underlying block device."
12584 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4155 ../src/guestfs-actions.pod:4205 ../src/guestfs-actions.pod:4253
12585 msgid "(Added in 1.5.1)"
12589 #: ../src/guestfs-actions.pod:4036
12590 msgid "guestfs_luks_format"
12594 #: ../src/guestfs-actions.pod:4038
12598 " guestfs_luks_format (guestfs_h *g,\n"
12599 " const char *device,\n"
12600 " const char *key,\n"
12606 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2729
12608 "This command erases existing data on C<device> and formats the device as a "
12609 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12610 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12614 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:6102 ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:6558 ../src/guestfs-actions.pod:6591 ../src/guestfs-actions.pod:7787 ../fish/guestfish-actions.pod:2737 ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2837 ../fish/guestfish-actions.pod:3498 ../fish/guestfish-actions.pod:4018 ../fish/guestfish-actions.pod:4343 ../fish/guestfish-actions.pod:4366 ../fish/guestfish-actions.pod:4388 ../fish/guestfish-actions.pod:5126
12616 "B<This command is dangerous. Without careful use you can easily destroy all "
12621 #: ../src/guestfs-actions.pod:4060
12622 msgid "guestfs_luks_format_cipher"
12626 #: ../src/guestfs-actions.pod:4062
12630 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12631 " const char *device,\n"
12632 " const char *key,\n"
12634 " const char *cipher);\n"
12639 #: ../src/guestfs-actions.pod:4069
12641 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12642 "set the C<cipher> used."
12646 #: ../src/guestfs-actions.pod:4083
12647 msgid "guestfs_luks_kill_slot"
12651 #: ../src/guestfs-actions.pod:4085
12655 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12656 " const char *device,\n"
12657 " const char *key,\n"
12663 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2757
12665 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12666 "device C<device>. C<key> must be one of the I<other> keys."
12670 #: ../src/guestfs-actions.pod:4103
12671 msgid "guestfs_luks_open"
12675 #: ../src/guestfs-actions.pod:4105
12679 " guestfs_luks_open (guestfs_h *g,\n"
12680 " const char *device,\n"
12681 " const char *key,\n"
12682 " const char *mapname);\n"
12687 #: ../src/guestfs-actions.pod:4111 ../fish/guestfish-actions.pod:2768
12689 "This command opens a block device which has been encrypted according to the "
12690 "Linux Unified Key Setup (LUKS) standard."
12694 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:2771
12695 msgid "C<device> is the encrypted block device or partition."
12699 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2773
12701 "The caller must supply one of the keys associated with the LUKS block "
12702 "device, in the C<key> parameter."
12706 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2776
12708 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12709 "writes to this block device are decrypted from and encrypted to the "
12710 "underlying C<device> respectively."
12714 #: ../src/guestfs-actions.pod:4123
12716 "If this block device contains LVM volume groups, then calling "
12717 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12722 #: ../src/guestfs-actions.pod:4127
12723 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
12727 #: ../src/guestfs-actions.pod:4138
12728 msgid "guestfs_luks_open_ro"
12732 #: ../src/guestfs-actions.pod:4140
12736 " guestfs_luks_open_ro (guestfs_h *g,\n"
12737 " const char *device,\n"
12738 " const char *key,\n"
12739 " const char *mapname);\n"
12744 #: ../src/guestfs-actions.pod:4146
12746 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12751 #: ../src/guestfs-actions.pod:4157
12752 msgid "guestfs_lvcreate"
12756 #: ../src/guestfs-actions.pod:4159
12760 " guestfs_lvcreate (guestfs_h *g,\n"
12761 " const char *logvol,\n"
12762 " const char *volgroup,\n"
12768 #: ../src/guestfs-actions.pod:4165 ../fish/guestfish-actions.pod:2804
12770 "This creates an LVM logical volume called C<logvol> on the volume group "
12771 "C<volgroup>, with C<size> megabytes."
12775 #: ../src/guestfs-actions.pod:4172
12776 msgid "guestfs_lvm_canonical_lv_name"
12780 #: ../src/guestfs-actions.pod:4174
12784 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12785 " const char *lvname);\n"
12790 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2811
12792 "This converts alternative naming schemes for LVs that you might find to the "
12793 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12798 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2815
12800 "This command returns an error if the C<lvname> parameter does not refer to a "
12805 #: ../src/guestfs-actions.pod:4185
12806 msgid "See also C<guestfs_is_lv>."
12810 #: ../src/guestfs-actions.pod:4190
12811 msgid "(Added in 1.5.24)"
12815 #: ../src/guestfs-actions.pod:4192
12816 msgid "guestfs_lvm_clear_filter"
12820 #: ../src/guestfs-actions.pod:4194
12824 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12829 #: ../src/guestfs-actions.pod:4197
12831 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12832 "see every block device."
12836 #: ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4242 ../fish/guestfish-actions.pod:2827 ../fish/guestfish-actions.pod:2858
12837 msgid "This command also clears the LVM cache and performs a volume group scan."
12841 #: ../src/guestfs-actions.pod:4207
12842 msgid "guestfs_lvm_remove_all"
12846 #: ../src/guestfs-actions.pod:4209
12850 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12855 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2834
12857 "This command removes all LVM logical volumes, volume groups and physical "
12862 #: ../src/guestfs-actions.pod:4222
12863 msgid "guestfs_lvm_set_filter"
12867 #: ../src/guestfs-actions.pod:4224
12871 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12872 " char *const *devices);\n"
12877 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2844
12879 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12880 "block devices in the list C<devices>, and will ignore all other attached "
12885 #: ../src/guestfs-actions.pod:4232 ../fish/guestfish-actions.pod:2848
12887 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12888 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12889 "there are two types of duplication possible: either cloned PVs/VGs which "
12890 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12891 "same name. In normal operation you cannot create this situation, but you "
12892 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12893 "inside the LVM metadata."
12897 #: ../src/guestfs-actions.pod:4245 ../fish/guestfish-actions.pod:2861
12898 msgid "You can filter whole block devices or individual partitions."
12902 #: ../src/guestfs-actions.pod:4247 ../fish/guestfish-actions.pod:2863
12904 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12905 "filesystem), even if you are not filtering out that VG."
12909 #: ../src/guestfs-actions.pod:4255
12910 msgid "guestfs_lvremove"
12914 #: ../src/guestfs-actions.pod:4257
12918 " guestfs_lvremove (guestfs_h *g,\n"
12919 " const char *device);\n"
12924 #: ../src/guestfs-actions.pod:4261 ../fish/guestfish-actions.pod:2871
12926 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12927 "LV, such as C</dev/VG/LV>."
12931 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2874
12933 "You can also remove all LVs in a volume group by specifying the VG name, "
12938 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:7498
12939 msgid "(Added in 1.0.13)"
12943 #: ../src/guestfs-actions.pod:4271
12944 msgid "guestfs_lvrename"
12948 #: ../src/guestfs-actions.pod:4273
12952 " guestfs_lvrename (guestfs_h *g,\n"
12953 " const char *logvol,\n"
12954 " const char *newlogvol);\n"
12959 #: ../src/guestfs-actions.pod:4278 ../fish/guestfish-actions.pod:2881
12960 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12964 #: ../src/guestfs-actions.pod:4282 ../src/guestfs-actions.pod:7511
12965 msgid "(Added in 1.0.83)"
12969 #: ../src/guestfs-actions.pod:4284
12970 msgid "guestfs_lvresize"
12974 #: ../src/guestfs-actions.pod:4286
12978 " guestfs_lvresize (guestfs_h *g,\n"
12979 " const char *device,\n"
12985 #: ../src/guestfs-actions.pod:4291 ../fish/guestfish-actions.pod:2887
12987 "This resizes (expands or shrinks) an existing LVM logical volume to "
12988 "C<mbytes>. When reducing, data in the reduced part is lost."
12992 #: ../src/guestfs-actions.pod:4299
12993 msgid "guestfs_lvresize_free"
12997 #: ../src/guestfs-actions.pod:4301
13001 " guestfs_lvresize_free (guestfs_h *g,\n"
13002 " const char *lv,\n"
13008 #: ../src/guestfs-actions.pod:4306 ../fish/guestfish-actions.pod:2895
13010 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13011 "remaining free space in the volume group. Commonly you would call this with "
13012 "pc = 100 which expands the logical volume as much as possible, using all "
13013 "remaining free space in the volume group."
13017 #: ../src/guestfs-actions.pod:4314
13018 msgid "(Added in 1.3.3)"
13022 #: ../src/guestfs-actions.pod:4316
13023 msgid "guestfs_lvs"
13027 #: ../src/guestfs-actions.pod:4318
13031 " guestfs_lvs (guestfs_h *g);\n"
13036 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2905
13038 "List all the logical volumes detected. This is the equivalent of the "
13039 "L<lvs(8)> command."
13043 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2908
13045 "This returns a list of the logical volume device names "
13046 "(eg. C</dev/VolGroup00/LogVol00>)."
13050 #: ../src/guestfs-actions.pod:4327
13051 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13055 #: ../src/guestfs-actions.pod:4335
13056 msgid "guestfs_lvs_full"
13060 #: ../src/guestfs-actions.pod:4337
13063 " struct guestfs_lvm_lv_list *\n"
13064 " guestfs_lvs_full (guestfs_h *g);\n"
13069 #: ../src/guestfs-actions.pod:4340 ../fish/guestfish-actions.pod:2917
13071 "List all the logical volumes detected. This is the equivalent of the "
13072 "L<lvs(8)> command. The \"full\" version includes all fields."
13076 #: ../src/guestfs-actions.pod:4343
13078 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13079 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
13084 #: ../src/guestfs-actions.pod:4349
13085 msgid "guestfs_lvuuid"
13089 #: ../src/guestfs-actions.pod:4351
13093 " guestfs_lvuuid (guestfs_h *g,\n"
13094 " const char *device);\n"
13099 #: ../src/guestfs-actions.pod:4355 ../fish/guestfish-actions.pod:2924
13100 msgid "This command returns the UUID of the LVM LV C<device>."
13104 #: ../src/guestfs-actions.pod:4362
13105 msgid "guestfs_lxattrlist"
13109 #: ../src/guestfs-actions.pod:4364
13112 " struct guestfs_xattr_list *\n"
13113 " guestfs_lxattrlist (guestfs_h *g,\n"
13114 " const char *path,\n"
13115 " char *const *names);\n"
13120 #: ../src/guestfs-actions.pod:4369 ../fish/guestfish-actions.pod:2930
13122 "This call allows you to get the extended attributes of multiple files, where "
13123 "all files are in the directory C<path>. C<names> is the list of files from "
13128 #: ../src/guestfs-actions.pod:4373 ../fish/guestfish-actions.pod:2934
13130 "On return you get a flat list of xattr structs which must be interpreted "
13131 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13132 "C<attrval> in this struct is zero-length to indicate there was an error "
13133 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13134 "number (the number of following attributes for this file, which could be "
13135 "C<\"0\">). Then after the first xattr struct are the zero or more "
13136 "attributes for the first named file. This repeats for the second and "
13137 "subsequent files."
13141 #: ../src/guestfs-actions.pod:4383
13143 "This call is intended for programs that want to efficiently list a directory "
13144 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13145 "a similarly efficient call for getting standard stats. Very long directory "
13146 "listings might cause the protocol message size to be exceeded, causing this "
13147 "call to fail. The caller must split up such requests into smaller groups of "
13152 #: ../src/guestfs-actions.pod:4397
13153 msgid "guestfs_mkdir"
13157 #: ../src/guestfs-actions.pod:4399
13161 " guestfs_mkdir (guestfs_h *g,\n"
13162 " const char *path);\n"
13167 #: ../src/guestfs-actions.pod:4403 ../fish/guestfish-actions.pod:2956
13168 msgid "Create a directory named C<path>."
13172 #: ../src/guestfs-actions.pod:4409
13173 msgid "guestfs_mkdir_mode"
13177 #: ../src/guestfs-actions.pod:4411
13181 " guestfs_mkdir_mode (guestfs_h *g,\n"
13182 " const char *path,\n"
13188 #: ../src/guestfs-actions.pod:4416 ../fish/guestfish-actions.pod:2962
13190 "This command creates a directory, setting the initial permissions of the "
13191 "directory to C<mode>."
13195 #: ../src/guestfs-actions.pod:4419 ../fish/guestfish-actions.pod:2965
13197 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13198 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13203 #: ../src/guestfs-actions.pod:4423
13204 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13208 #: ../src/guestfs-actions.pod:4429
13209 msgid "guestfs_mkdir_p"
13213 #: ../src/guestfs-actions.pod:4431
13217 " guestfs_mkdir_p (guestfs_h *g,\n"
13218 " const char *path);\n"
13223 #: ../src/guestfs-actions.pod:4435 ../fish/guestfish-actions.pod:2975
13225 "Create a directory named C<path>, creating any parent directories as "
13226 "necessary. This is like the C<mkdir -p> shell command."
13230 #: ../src/guestfs-actions.pod:4442
13231 msgid "guestfs_mkdtemp"
13235 #: ../src/guestfs-actions.pod:4444
13239 " guestfs_mkdtemp (guestfs_h *g,\n"
13240 " const char *template);\n"
13245 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2982
13247 "This command creates a temporary directory. The C<template> parameter "
13248 "should be a full pathname for the temporary directory name with the final "
13249 "six characters being \"XXXXXX\"."
13253 #: ../src/guestfs-actions.pod:4453 ../fish/guestfish-actions.pod:2987
13255 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13256 "being suitable for Windows filesystems."
13260 #: ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:2990
13261 msgid "The name of the temporary directory that was created is returned."
13265 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:2993
13266 msgid "The temporary directory is created with mode 0700 and is owned by root."
13270 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2996
13272 "The caller is responsible for deleting the temporary directory and its "
13273 "contents after use."
13277 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2999
13278 msgid "See also: L<mkdtemp(3)>"
13282 #: ../src/guestfs-actions.pod:4472
13283 msgid "guestfs_mke2fs_J"
13287 #: ../src/guestfs-actions.pod:4474
13291 " guestfs_mke2fs_J (guestfs_h *g,\n"
13292 " const char *fstype,\n"
13293 " int blocksize,\n"
13294 " const char *device,\n"
13295 " const char *journal);\n"
13300 #: ../src/guestfs-actions.pod:4481 ../fish/guestfish-actions.pod:3005
13302 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13303 "C<journal>. It is equivalent to the command:"
13307 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
13310 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13315 #: ../src/guestfs-actions.pod:4487
13316 msgid "See also C<guestfs_mke2journal>."
13320 #: ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4571 ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4907
13321 msgid "(Added in 1.0.68)"
13325 #: ../src/guestfs-actions.pod:4493
13326 msgid "guestfs_mke2fs_JL"
13330 #: ../src/guestfs-actions.pod:4495
13334 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13335 " const char *fstype,\n"
13336 " int blocksize,\n"
13337 " const char *device,\n"
13338 " const char *label);\n"
13343 #: ../src/guestfs-actions.pod:4502 ../fish/guestfish-actions.pod:3017
13345 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13346 "the journal labeled C<label>."
13350 #: ../src/guestfs-actions.pod:4505
13351 msgid "See also C<guestfs_mke2journal_L>."
13355 #: ../src/guestfs-actions.pod:4511
13356 msgid "guestfs_mke2fs_JU"
13360 #: ../src/guestfs-actions.pod:4513
13364 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13365 " const char *fstype,\n"
13366 " int blocksize,\n"
13367 " const char *device,\n"
13368 " const char *uuid);\n"
13373 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3026
13375 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13376 "the journal with UUID C<uuid>."
13380 #: ../src/guestfs-actions.pod:4523
13381 msgid "See also C<guestfs_mke2journal_U>."
13385 #: ../src/guestfs-actions.pod:4529
13386 msgid "guestfs_mke2journal"
13390 #: ../src/guestfs-actions.pod:4531
13394 " guestfs_mke2journal (guestfs_h *g,\n"
13395 " int blocksize,\n"
13396 " const char *device);\n"
13401 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3035
13403 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13408 #: ../src/guestfs-actions.pod:4539 ../fish/guestfish-actions.pod:3038
13411 " mke2fs -O journal_dev -b blocksize device\n"
13416 #: ../src/guestfs-actions.pod:4545
13417 msgid "guestfs_mke2journal_L"
13421 #: ../src/guestfs-actions.pod:4547
13425 " guestfs_mke2journal_L (guestfs_h *g,\n"
13426 " int blocksize,\n"
13427 " const char *label,\n"
13428 " const char *device);\n"
13433 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3044
13434 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13438 #: ../src/guestfs-actions.pod:4559
13439 msgid "guestfs_mke2journal_U"
13443 #: ../src/guestfs-actions.pod:4561
13447 " guestfs_mke2journal_U (guestfs_h *g,\n"
13448 " int blocksize,\n"
13449 " const char *uuid,\n"
13450 " const char *device);\n"
13455 #: ../src/guestfs-actions.pod:4567 ../fish/guestfish-actions.pod:3050
13456 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13460 #: ../src/guestfs-actions.pod:4573
13461 msgid "guestfs_mkfifo"
13465 #: ../src/guestfs-actions.pod:4575
13469 " guestfs_mkfifo (guestfs_h *g,\n"
13471 " const char *path);\n"
13476 #: ../src/guestfs-actions.pod:4580
13478 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13479 "is just a convenient wrapper around C<guestfs_mknod>."
13483 #: ../src/guestfs-actions.pod:4590
13484 msgid "guestfs_mkfs"
13488 #: ../src/guestfs-actions.pod:4592
13492 " guestfs_mkfs (guestfs_h *g,\n"
13493 " const char *fstype,\n"
13494 " const char *device);\n"
13499 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3066
13501 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13502 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13506 #: ../src/guestfs-actions.pod:4605
13507 msgid "guestfs_mkfs_b"
13511 #: ../src/guestfs-actions.pod:4607
13515 " guestfs_mkfs_b (guestfs_h *g,\n"
13516 " const char *fstype,\n"
13517 " int blocksize,\n"
13518 " const char *device);\n"
13523 #: ../src/guestfs-actions.pod:4613
13525 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13526 "block size of the resulting filesystem. Supported block sizes depend on the "
13527 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13531 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4663 ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3106
13533 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13538 #: ../src/guestfs-actions.pod:4623 ../fish/guestfish-actions.pod:3082
13540 "This function is deprecated. In new code, use the C<mkfs_opts> call "
13545 #: ../src/guestfs-actions.pod:4632
13546 msgid "guestfs_mkfs_opts"
13550 #: ../src/guestfs-actions.pod:4634
13554 " guestfs_mkfs_opts (guestfs_h *g,\n"
13555 " const char *fstype,\n"
13556 " const char *device,\n"
13562 #: ../src/guestfs-actions.pod:4645
13565 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13566 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13567 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
13568 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
13573 #: ../src/guestfs-actions.pod:4650 ../fish/guestfish-actions.pod:3093
13575 "This function creates a filesystem on C<device>. The filesystem type is "
13576 "C<fstype>, for example C<ext3>."
13580 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3100
13581 msgid "C<blocksize>"
13585 #: ../src/guestfs-actions.pod:4659 ../fish/guestfish-actions.pod:3102
13587 "The filesystem block size. Supported block sizes depend on the filesystem "
13588 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13593 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3109
13594 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13598 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3111
13599 msgid "C<features>"
13603 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3113
13604 msgid "This passes the I<-O> parameter to the external mkfs program."
13608 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3115
13610 "For certain filesystem types, this allows extra filesystem features to be "
13611 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13615 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3119
13617 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13622 #: ../src/guestfs-actions.pod:4679 ../fish/guestfish-actions.pod:3122
13627 #: ../src/guestfs-actions.pod:4681 ../fish/guestfish-actions.pod:3124
13629 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
13630 "sets the inode size (only for ext2/3/4 filesystems at present)."
13634 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3127
13635 msgid "C<sectorsize>"
13639 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3129
13641 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
13642 "sets sector size for ufs filesystem."
13646 #: ../src/guestfs-actions.pod:4693
13647 msgid "(Added in 1.7.19)"
13651 #: ../src/guestfs-actions.pod:4695
13652 msgid "guestfs_mkfs_opts_va"
13656 #: ../src/guestfs-actions.pod:4697
13660 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13661 " const char *fstype,\n"
13662 " const char *device,\n"
13663 " va_list args);\n"
13668 #: ../src/guestfs-actions.pod:4703
13669 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13673 #: ../src/guestfs-actions.pod:4707
13674 msgid "guestfs_mkfs_opts_argv"
13678 #: ../src/guestfs-actions.pod:4709
13682 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13683 " const char *fstype,\n"
13684 " const char *device,\n"
13685 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13690 #: ../src/guestfs-actions.pod:4715
13691 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13695 #: ../src/guestfs-actions.pod:4719
13696 msgid "guestfs_mkmountpoint"
13700 #: ../src/guestfs-actions.pod:4721
13704 " guestfs_mkmountpoint (guestfs_h *g,\n"
13705 " const char *exemptpath);\n"
13710 #: ../src/guestfs-actions.pod:4725
13712 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13713 "that can be used to create extra mountpoints before mounting the first "
13718 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3144
13720 "These calls are I<only> necessary in some very limited circumstances, mainly "
13721 "the case where you want to mount a mix of unrelated and/or read-only "
13722 "filesystems together."
13726 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3148
13728 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13729 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13730 "inside that. You can unpack this as follows in guestfish:"
13734 #: ../src/guestfs-actions.pod:4738 ../fish/guestfish-actions.pod:3153
13737 " add-ro Fedora-11-i686-Live.iso\n"
13739 " mkmountpoint /cd\n"
13740 " mkmountpoint /sqsh\n"
13741 " mkmountpoint /ext3fs\n"
13742 " mount /dev/sda /cd\n"
13743 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13744 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13749 #: ../src/guestfs-actions.pod:4747 ../fish/guestfish-actions.pod:3162
13750 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13754 #: ../src/guestfs-actions.pod:4749
13756 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13757 "may get unexpected errors if you try to mix these calls. It is safest to "
13758 "manually unmount filesystems and remove mountpoints after use."
13762 #: ../src/guestfs-actions.pod:4753
13764 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13765 "first, so for this to work for manual mountpoints, you must ensure that the "
13766 "innermost mountpoints have the longest pathnames, as in the example code "
13771 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3173
13772 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13776 #: ../src/guestfs-actions.pod:4760
13778 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13779 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13780 "can also trigger these issues."
13784 #: ../src/guestfs-actions.pod:4766 ../src/guestfs-actions.pod:5082 ../src/guestfs-actions.pod:6086
13785 msgid "(Added in 1.0.62)"
13789 #: ../src/guestfs-actions.pod:4768
13790 msgid "guestfs_mknod"
13794 #: ../src/guestfs-actions.pod:4770
13798 " guestfs_mknod (guestfs_h *g,\n"
13802 " const char *path);\n"
13807 #: ../src/guestfs-actions.pod:4777 ../fish/guestfish-actions.pod:3183
13809 "This call creates block or character special devices, or named pipes "
13814 #: ../src/guestfs-actions.pod:4780 ../fish/guestfish-actions.pod:3186
13816 "The C<mode> parameter should be the mode, using the standard constants. "
13817 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13818 "used when creating block and character special devices."
13822 #: ../src/guestfs-actions.pod:4785
13824 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13825 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13826 "regular file). These constants are available in the standard Linux header "
13827 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13828 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13829 "the appropriate constant for you."
13833 #: ../src/guestfs-actions.pod:4799
13834 msgid "guestfs_mknod_b"
13838 #: ../src/guestfs-actions.pod:4801
13842 " guestfs_mknod_b (guestfs_h *g,\n"
13846 " const char *path);\n"
13851 #: ../src/guestfs-actions.pod:4808
13853 "This call creates a block device node called C<path> with mode C<mode> and "
13854 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13855 "wrapper around C<guestfs_mknod>."
13859 #: ../src/guestfs-actions.pod:4818
13860 msgid "guestfs_mknod_c"
13864 #: ../src/guestfs-actions.pod:4820
13868 " guestfs_mknod_c (guestfs_h *g,\n"
13872 " const char *path);\n"
13877 #: ../src/guestfs-actions.pod:4827
13879 "This call creates a char device node called C<path> with mode C<mode> and "
13880 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13881 "wrapper around C<guestfs_mknod>."
13885 #: ../src/guestfs-actions.pod:4837
13886 msgid "guestfs_mkswap"
13890 #: ../src/guestfs-actions.pod:4839
13894 " guestfs_mkswap (guestfs_h *g,\n"
13895 " const char *device);\n"
13900 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3225
13901 msgid "Create a swap partition on C<device>."
13905 #: ../src/guestfs-actions.pod:4849
13906 msgid "guestfs_mkswap_L"
13910 #: ../src/guestfs-actions.pod:4851
13914 " guestfs_mkswap_L (guestfs_h *g,\n"
13915 " const char *label,\n"
13916 " const char *device);\n"
13921 #: ../src/guestfs-actions.pod:4856 ../fish/guestfish-actions.pod:3231
13922 msgid "Create a swap partition on C<device> with label C<label>."
13926 #: ../src/guestfs-actions.pod:4858 ../fish/guestfish-actions.pod:3233
13928 "Note that you cannot attach a swap label to a block device "
13929 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13930 "the kernel or swap tools."
13934 #: ../src/guestfs-actions.pod:4866
13935 msgid "guestfs_mkswap_U"
13939 #: ../src/guestfs-actions.pod:4868
13943 " guestfs_mkswap_U (guestfs_h *g,\n"
13944 " const char *uuid,\n"
13945 " const char *device);\n"
13950 #: ../src/guestfs-actions.pod:4873 ../fish/guestfish-actions.pod:3241
13951 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13955 #: ../src/guestfs-actions.pod:4879
13956 msgid "guestfs_mkswap_file"
13960 #: ../src/guestfs-actions.pod:4881
13964 " guestfs_mkswap_file (guestfs_h *g,\n"
13965 " const char *path);\n"
13970 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3247
13971 msgid "Create a swap file."
13975 #: ../src/guestfs-actions.pod:4887
13977 "This command just writes a swap file signature to an existing file. To "
13978 "create the file itself, use something like C<guestfs_fallocate>."
13982 #: ../src/guestfs-actions.pod:4894
13983 msgid "guestfs_modprobe"
13987 #: ../src/guestfs-actions.pod:4896
13991 " guestfs_modprobe (guestfs_h *g,\n"
13992 " const char *modulename);\n"
13997 #: ../src/guestfs-actions.pod:4900 ../fish/guestfish-actions.pod:3256
13998 msgid "This loads a kernel module in the appliance."
14002 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3258
14004 "The kernel module must have been whitelisted when libguestfs was built (see "
14005 "C<appliance/kmod.whitelist.in> in the source)."
14009 #: ../src/guestfs-actions.pod:4909
14010 msgid "guestfs_mount"
14014 #: ../src/guestfs-actions.pod:4911
14018 " guestfs_mount (guestfs_h *g,\n"
14019 " const char *device,\n"
14020 " const char *mountpoint);\n"
14025 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3265
14027 "Mount a guest disk at a position in the filesystem. Block devices are named "
14028 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14029 "those block devices contain partitions, they will have the usual names "
14030 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14034 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3271
14036 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14037 "mounted on C</> before others can be mounted. Other filesystems can only be "
14038 "mounted on directories which already exist."
14042 #: ../src/guestfs-actions.pod:4927 ../fish/guestfish-actions.pod:3276
14044 "The mounted filesystem is writable, if we have sufficient permissions on the "
14045 "underlying device."
14049 #: ../src/guestfs-actions.pod:4930
14051 "B<Important note:> When you use this call, the filesystem options C<sync> "
14052 "and C<noatime> are set implicitly. This was originally done because we "
14053 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14054 "very large negative performance impact and negligible effect on "
14055 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14056 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14057 "(use an empty string for the first parameter if you don't want any options)."
14061 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3289
14063 "This function is deprecated. In new code, use the C<mount_options> call "
14068 #: ../src/guestfs-actions.pod:4951
14069 msgid "guestfs_mount_9p"
14073 #: ../src/guestfs-actions.pod:4953
14077 " guestfs_mount_9p (guestfs_h *g,\n"
14078 " const char *mounttag,\n"
14079 " const char *mountpoint,\n"
14085 #: ../src/guestfs-actions.pod:4964
14088 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
14093 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3300
14095 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14100 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3303
14102 "If required, C<trans=virtio> will be automatically added to the options. "
14103 "Any other options required can be passed in the optional C<options> "
14108 #: ../src/guestfs-actions.pod:4977
14109 msgid "guestfs_mount_9p_va"
14113 #: ../src/guestfs-actions.pod:4979
14117 " guestfs_mount_9p_va (guestfs_h *g,\n"
14118 " const char *mounttag,\n"
14119 " const char *mountpoint,\n"
14120 " va_list args);\n"
14125 #: ../src/guestfs-actions.pod:4985
14126 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
14130 #: ../src/guestfs-actions.pod:4989
14131 msgid "guestfs_mount_9p_argv"
14135 #: ../src/guestfs-actions.pod:4991
14139 " guestfs_mount_9p_argv (guestfs_h *g,\n"
14140 " const char *mounttag,\n"
14141 " const char *mountpoint,\n"
14142 " const struct guestfs_mount_9p_argv *optargs);\n"
14147 #: ../src/guestfs-actions.pod:4997
14148 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
14152 #: ../src/guestfs-actions.pod:5001
14153 msgid "guestfs_mount_loop"
14157 #: ../src/guestfs-actions.pod:5003
14161 " guestfs_mount_loop (guestfs_h *g,\n"
14162 " const char *file,\n"
14163 " const char *mountpoint);\n"
14168 #: ../src/guestfs-actions.pod:5008 ../fish/guestfish-actions.pod:3313
14170 "This command lets you mount C<file> (a filesystem image in a file) on a "
14171 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14176 #: ../src/guestfs-actions.pod:5016
14177 msgid "guestfs_mount_options"
14181 #: ../src/guestfs-actions.pod:5018
14185 " guestfs_mount_options (guestfs_h *g,\n"
14186 " const char *options,\n"
14187 " const char *device,\n"
14188 " const char *mountpoint);\n"
14193 #: ../src/guestfs-actions.pod:5024
14195 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14196 "the mount options as for the L<mount(8)> I<-o> flag."
14200 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3325
14202 "If the C<options> parameter is an empty string, then no options are passed "
14203 "(all options default to whatever the filesystem uses)."
14207 #: ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5065
14208 msgid "(Added in 1.0.10)"
14212 #: ../src/guestfs-actions.pod:5036
14213 msgid "guestfs_mount_ro"
14217 #: ../src/guestfs-actions.pod:5038
14221 " guestfs_mount_ro (guestfs_h *g,\n"
14222 " const char *device,\n"
14223 " const char *mountpoint);\n"
14228 #: ../src/guestfs-actions.pod:5043
14230 "This is the same as the C<guestfs_mount> command, but it mounts the "
14231 "filesystem with the read-only (I<-o ro>) flag."
14235 #: ../src/guestfs-actions.pod:5050
14236 msgid "guestfs_mount_vfs"
14240 #: ../src/guestfs-actions.pod:5052
14244 " guestfs_mount_vfs (guestfs_h *g,\n"
14245 " const char *options,\n"
14246 " const char *vfstype,\n"
14247 " const char *device,\n"
14248 " const char *mountpoint);\n"
14253 #: ../src/guestfs-actions.pod:5059
14255 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14256 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
14261 #: ../src/guestfs-actions.pod:5067
14262 msgid "guestfs_mountpoints"
14266 #: ../src/guestfs-actions.pod:5069
14270 " guestfs_mountpoints (guestfs_h *g);\n"
14275 #: ../src/guestfs-actions.pod:5072
14277 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14278 "devices. This one returns a hash table (map) of device name to directory "
14279 "where the device is mounted."
14283 #: ../src/guestfs-actions.pod:5084
14284 msgid "guestfs_mounts"
14288 #: ../src/guestfs-actions.pod:5086
14292 " guestfs_mounts (guestfs_h *g);\n"
14297 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3356
14299 "This returns the list of currently mounted filesystems. It returns the list "
14300 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14304 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3359
14305 msgid "Some internal mounts are not shown."
14309 #: ../src/guestfs-actions.pod:5094
14310 msgid "See also: C<guestfs_mountpoints>"
14314 #: ../src/guestfs-actions.pod:5102
14319 #: ../src/guestfs-actions.pod:5104
14323 " guestfs_mv (guestfs_h *g,\n"
14324 " const char *src,\n"
14325 " const char *dest);\n"
14330 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3367
14332 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14333 "destination filename or destination directory."
14337 #: ../src/guestfs-actions.pod:5116
14338 msgid "guestfs_ntfs_3g_probe"
14342 #: ../src/guestfs-actions.pod:5118
14346 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14348 " const char *device);\n"
14353 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3374
14355 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14356 "C<device> for mountability. (Not all NTFS volumes can be mounted "
14357 "read-write, and some cannot be mounted at all)."
14361 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3378
14363 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14364 "can be mounted read-write. Set it to false if you want to test if the "
14365 "volume can be mounted read-only."
14369 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3382
14371 "The return value is an integer which C<0> if the operation would succeed, or "
14372 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14376 #: ../src/guestfs-actions.pod:5137
14377 msgid "(Added in 1.0.43)"
14381 #: ../src/guestfs-actions.pod:5139
14382 msgid "guestfs_ntfsresize"
14386 #: ../src/guestfs-actions.pod:5141
14390 " guestfs_ntfsresize (guestfs_h *g,\n"
14391 " const char *device);\n"
14396 #: ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5184 ../fish/guestfish-actions.pod:3390 ../fish/guestfish-actions.pod:3414
14398 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14399 "size of the underlying device."
14403 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3393
14405 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14406 "consistency check (for safety). You have to boot into Windows to perform "
14407 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14408 "resize filesystems which have been marked in this way. So in effect it is "
14409 "not possible to call ntfsresize multiple times on a single filesystem "
14410 "without booting into Windows between each resize."
14414 #: ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5210 ../fish/guestfish-actions.pod:3401 ../fish/guestfish-actions.pod:3440
14415 msgid "See also L<ntfsresize(8)>."
14419 #: ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3451
14421 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
14426 #: ../src/guestfs-actions.pod:5169
14427 msgid "guestfs_ntfsresize_opts"
14431 #: ../src/guestfs-actions.pod:5171
14435 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
14436 " const char *device,\n"
14442 #: ../src/guestfs-actions.pod:5181
14445 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
14446 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
14451 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3423
14453 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
14454 "resized to fit the container (eg. partition)."
14458 #: ../src/guestfs-actions.pod:5196 ../fish/guestfish-actions.pod:3426
14463 #: ../src/guestfs-actions.pod:5198 ../fish/guestfish-actions.pod:3428
14465 "If this option is true, then force the resize of the filesystem even if the "
14466 "filesystem is marked as requiring a consistency check."
14470 #: ../src/guestfs-actions.pod:5201
14472 "After the resize operation, the filesystem is always marked as requiring a "
14473 "consistency check (for safety). You have to boot into Windows to perform "
14474 "this check and clear this condition. If you I<don't> set the C<force> "
14475 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
14476 "times on a single filesystem without booting into Windows between each "
14481 #: ../src/guestfs-actions.pod:5216
14482 msgid "guestfs_ntfsresize_opts_va"
14486 #: ../src/guestfs-actions.pod:5218
14490 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
14491 " const char *device,\n"
14492 " va_list args);\n"
14497 #: ../src/guestfs-actions.pod:5223
14498 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
14502 #: ../src/guestfs-actions.pod:5227
14503 msgid "guestfs_ntfsresize_opts_argv"
14507 #: ../src/guestfs-actions.pod:5229
14511 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
14512 " const char *device,\n"
14513 " const struct guestfs_ntfsresize_opts_argv "
14519 #: ../src/guestfs-actions.pod:5234
14520 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
14524 #: ../src/guestfs-actions.pod:5238
14525 msgid "guestfs_ntfsresize_size"
14529 #: ../src/guestfs-actions.pod:5240
14533 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14534 " const char *device,\n"
14535 " int64_t size);\n"
14540 #: ../src/guestfs-actions.pod:5245
14542 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14543 "to specify the new size (in bytes) explicitly."
14547 #: ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5693 ../src/guestfs-actions.pod:5766 ../src/guestfs-actions.pod:6034 ../src/guestfs-actions.pod:7655
14548 msgid "(Added in 1.3.14)"
14552 #: ../src/guestfs-actions.pod:5259
14553 msgid "guestfs_part_add"
14557 #: ../src/guestfs-actions.pod:5261
14561 " guestfs_part_add (guestfs_h *g,\n"
14562 " const char *device,\n"
14563 " const char *prlogex,\n"
14564 " int64_t startsect,\n"
14565 " int64_t endsect);\n"
14570 #: ../src/guestfs-actions.pod:5268
14572 "This command adds a partition to C<device>. If there is no partition table "
14573 "on the device, call C<guestfs_part_init> first."
14577 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3465
14579 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14580 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14581 "C<logical>) and C<e> (or C<extended>) partition types."
14585 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3470
14587 "C<startsect> and C<endsect> are the start and end of the partition in "
14588 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14589 "from the end of the disk (C<-1> is the last sector)."
14593 #: ../src/guestfs-actions.pod:5280
14595 "Creating a partition which covers the whole disk is not so easy. Use "
14596 "C<guestfs_part_disk> to do that."
14600 #: ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5323 ../src/guestfs-actions.pod:5376 ../src/guestfs-actions.pod:5454 ../src/guestfs-actions.pod:5492 ../src/guestfs-actions.pod:5511 ../src/guestfs-actions.pod:5551
14601 msgid "(Added in 1.0.78)"
14605 #: ../src/guestfs-actions.pod:5287
14606 msgid "guestfs_part_del"
14610 #: ../src/guestfs-actions.pod:5289
14614 " guestfs_part_del (guestfs_h *g,\n"
14615 " const char *device,\n"
14621 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3481
14622 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14626 #: ../src/guestfs-actions.pod:5296 ../fish/guestfish-actions.pod:3483
14628 "Note that in the case of MBR partitioning, deleting an extended partition "
14629 "also deletes any logical partitions it contains."
14633 #: ../src/guestfs-actions.pod:5304
14634 msgid "guestfs_part_disk"
14638 #: ../src/guestfs-actions.pod:5306
14642 " guestfs_part_disk (guestfs_h *g,\n"
14643 " const char *device,\n"
14644 " const char *parttype);\n"
14649 #: ../src/guestfs-actions.pod:5311
14651 "This command is simply a combination of C<guestfs_part_init> followed by "
14652 "C<guestfs_part_add> to create a single primary partition covering the whole "
14657 #: ../src/guestfs-actions.pod:5315
14659 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14660 "possible values are described in C<guestfs_part_init>."
14664 #: ../src/guestfs-actions.pod:5325
14665 msgid "guestfs_part_get_bootable"
14669 #: ../src/guestfs-actions.pod:5327
14673 " guestfs_part_get_bootable (guestfs_h *g,\n"
14674 " const char *device,\n"
14680 #: ../src/guestfs-actions.pod:5332 ../fish/guestfish-actions.pod:3505
14682 "This command returns true if the partition C<partnum> on C<device> has the "
14683 "bootable flag set."
14687 #: ../src/guestfs-actions.pod:5335
14688 msgid "See also C<guestfs_part_set_bootable>."
14692 #: ../src/guestfs-actions.pod:5341
14693 msgid "guestfs_part_get_mbr_id"
14697 #: ../src/guestfs-actions.pod:5343
14701 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14702 " const char *device,\n"
14708 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3514
14710 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14711 "partition C<partnum>."
14715 #: ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5527
14717 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14718 "undefined results for other partition table types (see "
14719 "C<guestfs_part_get_parttype>)."
14723 #: ../src/guestfs-actions.pod:5359
14724 msgid "guestfs_part_get_parttype"
14728 #: ../src/guestfs-actions.pod:5361
14732 " guestfs_part_get_parttype (guestfs_h *g,\n"
14733 " const char *device);\n"
14738 #: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:3525
14740 "This command examines the partition table on C<device> and returns the "
14741 "partition table type (format) being used."
14745 #: ../src/guestfs-actions.pod:5368
14747 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14748 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14749 "possible, although unusual. See C<guestfs_part_init> for a full list."
14753 #: ../src/guestfs-actions.pod:5378
14754 msgid "guestfs_part_init"
14758 #: ../src/guestfs-actions.pod:5380
14762 " guestfs_part_init (guestfs_h *g,\n"
14763 " const char *device,\n"
14764 " const char *parttype);\n"
14769 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3537
14771 "This creates an empty partition table on C<device> of one of the partition "
14772 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14773 "(for large disks)."
14777 #: ../src/guestfs-actions.pod:5389
14779 "Initially there are no partitions. Following this, you should call "
14780 "C<guestfs_part_add> for each partition required."
14784 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3544
14785 msgid "Possible values for C<parttype> are:"
14789 #: ../src/guestfs-actions.pod:5396 ../fish/guestfish-actions.pod:3548
14790 msgid "B<efi> | B<gpt>"
14794 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3550
14795 msgid "Intel EFI / GPT partition table."
14799 #: ../src/guestfs-actions.pod:5400 ../fish/guestfish-actions.pod:3552
14801 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14802 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14803 "the C<mbr> format."
14807 #: ../src/guestfs-actions.pod:5404 ../fish/guestfish-actions.pod:3556
14808 msgid "B<mbr> | B<msdos>"
14812 #: ../src/guestfs-actions.pod:5406 ../fish/guestfish-actions.pod:3558
14814 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14815 "Windows. This partition type will B<only> work for device sizes up to 2 "
14816 "TB. For large disks we recommend using C<gpt>."
14820 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3565
14821 msgid "Other partition table types that may work but are not supported include:"
14825 #: ../src/guestfs-actions.pod:5418 ../fish/guestfish-actions.pod:3570
14830 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3572
14831 msgid "AIX disk labels."
14835 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3574
14836 msgid "B<amiga> | B<rdb>"
14840 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3576
14841 msgid "Amiga \"Rigid Disk Block\" format."
14845 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3578
14850 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3580
14851 msgid "BSD disk labels."
14855 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3582
14860 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3584
14861 msgid "DASD, used on IBM mainframes."
14865 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3586
14870 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3588
14871 msgid "MIPS/SGI volumes."
14875 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3590
14880 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3592
14881 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14885 #: ../src/guestfs-actions.pod:5442 ../fish/guestfish-actions.pod:3594
14890 #: ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3596
14891 msgid "NEC PC-98 format, common in Japan apparently."
14895 #: ../src/guestfs-actions.pod:5446 ../fish/guestfish-actions.pod:3598
14900 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3600
14901 msgid "Sun disk labels."
14905 #: ../src/guestfs-actions.pod:5456
14906 msgid "guestfs_part_list"
14910 #: ../src/guestfs-actions.pod:5458
14913 " struct guestfs_partition_list *\n"
14914 " guestfs_part_list (guestfs_h *g,\n"
14915 " const char *device);\n"
14920 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3608
14922 "This command parses the partition table on C<device> and returns the list of "
14923 "partitions found."
14927 #: ../src/guestfs-actions.pod:5465 ../fish/guestfish-actions.pod:3611
14928 msgid "The fields in the returned structure are:"
14932 #: ../src/guestfs-actions.pod:5469 ../fish/guestfish-actions.pod:3615
14933 msgid "B<part_num>"
14937 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3617
14938 msgid "Partition number, counting from 1."
14942 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3619
14943 msgid "B<part_start>"
14947 #: ../src/guestfs-actions.pod:5475
14949 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14950 "the device's sector size, see C<guestfs_blockdev_getss>."
14954 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3624
14955 msgid "B<part_end>"
14959 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3626
14960 msgid "End of the partition in bytes."
14964 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3628
14965 msgid "B<part_size>"
14969 #: ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:3630
14970 msgid "Size of the partition in bytes."
14974 #: ../src/guestfs-actions.pod:5488
14976 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14977 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14982 #: ../src/guestfs-actions.pod:5494
14983 msgid "guestfs_part_set_bootable"
14987 #: ../src/guestfs-actions.pod:5496
14991 " guestfs_part_set_bootable (guestfs_h *g,\n"
14992 " const char *device,\n"
14994 " int bootable);\n"
14999 #: ../src/guestfs-actions.pod:5502 ../fish/guestfish-actions.pod:3638
15001 "This sets the bootable flag on partition numbered C<partnum> on device "
15002 "C<device>. Note that partitions are numbered from 1."
15006 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3641
15008 "The bootable flag is used by some operating systems (notably Windows) to "
15009 "determine which partition to boot from. It is by no means universally "
15014 #: ../src/guestfs-actions.pod:5513
15015 msgid "guestfs_part_set_mbr_id"
15019 #: ../src/guestfs-actions.pod:5515
15023 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15024 " const char *device,\n"
15031 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3649
15033 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15034 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15035 "documentation are in fact hexadecimal numbers, but usually documented "
15036 "without any leading \"0x\" which might be confusing."
15040 #: ../src/guestfs-actions.pod:5535
15041 msgid "guestfs_part_set_name"
15045 #: ../src/guestfs-actions.pod:5537
15049 " guestfs_part_set_name (guestfs_h *g,\n"
15050 " const char *device,\n"
15052 " const char *name);\n"
15057 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3663
15059 "This sets the partition name on partition numbered C<partnum> on device "
15060 "C<device>. Note that partitions are numbered from 1."
15064 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3666
15066 "The partition name can only be set on certain types of partition table. "
15067 "This works on C<gpt> but not on C<mbr> partitions."
15071 #: ../src/guestfs-actions.pod:5553
15072 msgid "guestfs_part_to_dev"
15076 #: ../src/guestfs-actions.pod:5555
15080 " guestfs_part_to_dev (guestfs_h *g,\n"
15081 " const char *partition);\n"
15086 #: ../src/guestfs-actions.pod:5559 ../fish/guestfish-actions.pod:3673
15088 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15089 "partition number, returning the device name (eg. \"/dev/sdb\")."
15093 #: ../src/guestfs-actions.pod:5563
15095 "The named partition must exist, for example as a string returned from "
15096 "C<guestfs_list_partitions>."
15100 #: ../src/guestfs-actions.pod:5571
15101 msgid "guestfs_ping_daemon"
15105 #: ../src/guestfs-actions.pod:5573
15109 " guestfs_ping_daemon (guestfs_h *g);\n"
15114 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3684
15116 "This is a test probe into the guestfs daemon running inside the qemu "
15117 "subprocess. Calling this function checks that the daemon responds to the "
15118 "ping message, without affecting the daemon or attached block device(s) in "
15123 #: ../src/guestfs-actions.pod:5585
15124 msgid "guestfs_pread"
15128 #: ../src/guestfs-actions.pod:5587
15132 " guestfs_pread (guestfs_h *g,\n"
15133 " const char *path,\n"
15135 " int64_t offset,\n"
15136 " size_t *size_r);\n"
15141 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3693
15143 "This command lets you read part of a file. It reads C<count> bytes of the "
15144 "file, starting at C<offset>, from file C<path>."
15148 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:3696 ../fish/guestfish-actions.pod:3711
15150 "This may read fewer bytes than requested. For further details see the "
15151 "L<pread(2)> system call."
15155 #: ../src/guestfs-actions.pod:5600
15156 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15160 #: ../src/guestfs-actions.pod:5611
15161 msgid "guestfs_pread_device"
15165 #: ../src/guestfs-actions.pod:5613
15169 " guestfs_pread_device (guestfs_h *g,\n"
15170 " const char *device,\n"
15172 " int64_t offset,\n"
15173 " size_t *size_r);\n"
15178 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:3708
15180 "This command lets you read part of a file. It reads C<count> bytes of "
15181 "C<device>, starting at C<offset>."
15185 #: ../src/guestfs-actions.pod:5626
15186 msgid "See also C<guestfs_pread>."
15190 #: ../src/guestfs-actions.pod:5635
15191 msgid "(Added in 1.5.21)"
15195 #: ../src/guestfs-actions.pod:5637
15196 msgid "guestfs_pvcreate"
15200 #: ../src/guestfs-actions.pod:5639
15204 " guestfs_pvcreate (guestfs_h *g,\n"
15205 " const char *device);\n"
15210 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3723
15212 "This creates an LVM physical volume on the named C<device>, where C<device> "
15213 "should usually be a partition name such as C</dev/sda1>."
15217 #: ../src/guestfs-actions.pod:5651
15218 msgid "guestfs_pvremove"
15222 #: ../src/guestfs-actions.pod:5653
15226 " guestfs_pvremove (guestfs_h *g,\n"
15227 " const char *device);\n"
15232 #: ../src/guestfs-actions.pod:5657 ../fish/guestfish-actions.pod:3731
15234 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15239 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3734
15241 "The implementation uses the C<pvremove> command which refuses to wipe "
15242 "physical volumes that contain any volume groups, so you have to remove those "
15247 #: ../src/guestfs-actions.pod:5668
15248 msgid "guestfs_pvresize"
15252 #: ../src/guestfs-actions.pod:5670
15256 " guestfs_pvresize (guestfs_h *g,\n"
15257 " const char *device);\n"
15262 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3742
15264 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15265 "the new size of the underlying device."
15269 #: ../src/guestfs-actions.pod:5681
15270 msgid "guestfs_pvresize_size"
15274 #: ../src/guestfs-actions.pod:5683
15278 " guestfs_pvresize_size (guestfs_h *g,\n"
15279 " const char *device,\n"
15280 " int64_t size);\n"
15285 #: ../src/guestfs-actions.pod:5688
15287 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15288 "specify the new size (in bytes) explicitly."
15292 #: ../src/guestfs-actions.pod:5695
15293 msgid "guestfs_pvs"
15297 #: ../src/guestfs-actions.pod:5697
15301 " guestfs_pvs (guestfs_h *g);\n"
15306 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3756
15308 "List all the physical volumes detected. This is the equivalent of the "
15309 "L<pvs(8)> command."
15313 #: ../src/guestfs-actions.pod:5703 ../fish/guestfish-actions.pod:3759
15315 "This returns a list of just the device names that contain PVs "
15316 "(eg. C</dev/sda2>)."
15320 #: ../src/guestfs-actions.pod:5706
15321 msgid "See also C<guestfs_pvs_full>."
15325 #: ../src/guestfs-actions.pod:5714
15326 msgid "guestfs_pvs_full"
15330 #: ../src/guestfs-actions.pod:5716
15333 " struct guestfs_lvm_pv_list *\n"
15334 " guestfs_pvs_full (guestfs_h *g);\n"
15339 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:3768
15341 "List all the physical volumes detected. This is the equivalent of the "
15342 "L<pvs(8)> command. The \"full\" version includes all fields."
15346 #: ../src/guestfs-actions.pod:5722
15348 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15349 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
15354 #: ../src/guestfs-actions.pod:5728
15355 msgid "guestfs_pvuuid"
15359 #: ../src/guestfs-actions.pod:5730
15363 " guestfs_pvuuid (guestfs_h *g,\n"
15364 " const char *device);\n"
15369 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3775
15370 msgid "This command returns the UUID of the LVM PV C<device>."
15374 #: ../src/guestfs-actions.pod:5741
15375 msgid "guestfs_pwrite"
15379 #: ../src/guestfs-actions.pod:5743
15383 " guestfs_pwrite (guestfs_h *g,\n"
15384 " const char *path,\n"
15385 " const char *content,\n"
15386 " size_t content_size,\n"
15387 " int64_t offset);\n"
15392 #: ../src/guestfs-actions.pod:5750 ../fish/guestfish-actions.pod:3781
15394 "This command writes to part of a file. It writes the data buffer C<content> "
15395 "to the file C<path> starting at offset C<offset>."
15399 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3784
15401 "This command implements the L<pwrite(2)> system call, and like that system "
15402 "call it may not write the full data requested. The return value is the "
15403 "number of bytes that were actually written to the file. This could even be "
15404 "0, although short writes are unlikely for regular files in ordinary "
15409 #: ../src/guestfs-actions.pod:5759
15410 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15414 #: ../src/guestfs-actions.pod:5768
15415 msgid "guestfs_pwrite_device"
15419 #: ../src/guestfs-actions.pod:5770
15423 " guestfs_pwrite_device (guestfs_h *g,\n"
15424 " const char *device,\n"
15425 " const char *content,\n"
15426 " size_t content_size,\n"
15427 " int64_t offset);\n"
15432 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3799
15434 "This command writes to part of a device. It writes the data buffer "
15435 "C<content> to C<device> starting at offset C<offset>."
15439 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3802
15441 "This command implements the L<pwrite(2)> system call, and like that system "
15442 "call it may not write the full data requested (although short writes to disk "
15443 "devices and partitions are probably impossible with standard Linux kernels)."
15447 #: ../src/guestfs-actions.pod:5785
15448 msgid "See also C<guestfs_pwrite>."
15452 #: ../src/guestfs-actions.pod:5792
15453 msgid "(Added in 1.5.20)"
15457 #: ../src/guestfs-actions.pod:5794
15458 msgid "guestfs_read_file"
15462 #: ../src/guestfs-actions.pod:5796
15466 " guestfs_read_file (guestfs_h *g,\n"
15467 " const char *path,\n"
15468 " size_t *size_r);\n"
15473 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3816
15474 msgid "This calls returns the contents of the file C<path> as a buffer."
15478 #: ../src/guestfs-actions.pod:5804
15480 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15481 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15482 "function is limited in the total size of file that can be handled."
15486 #: ../src/guestfs-actions.pod:5816
15487 msgid "(Added in 1.0.63)"
15491 #: ../src/guestfs-actions.pod:5818
15492 msgid "guestfs_read_lines"
15496 #: ../src/guestfs-actions.pod:5820
15500 " guestfs_read_lines (guestfs_h *g,\n"
15501 " const char *path);\n"
15506 #: ../src/guestfs-actions.pod:5826 ../fish/guestfish-actions.pod:3833
15508 "The file contents are returned as a list of lines. Trailing C<LF> and "
15509 "C<CRLF> character sequences are I<not> returned."
15513 #: ../src/guestfs-actions.pod:5829
15515 "Note that this function cannot correctly handle binary files (specifically, "
15516 "files containing C<\\0> character which is treated as end of line). For "
15517 "those you need to use the C<guestfs_read_file> function which has a more "
15518 "complex interface."
15522 #: ../src/guestfs-actions.pod:5840
15523 msgid "guestfs_readdir"
15527 #: ../src/guestfs-actions.pod:5842
15530 " struct guestfs_dirent_list *\n"
15531 " guestfs_readdir (guestfs_h *g,\n"
15532 " const char *dir);\n"
15537 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3845
15538 msgid "This returns the list of directory entries in directory C<dir>."
15542 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3847
15544 "All entries in the directory are returned, including C<.> and C<..>. The "
15545 "entries are I<not> sorted, but returned in the same order as the underlying "
15550 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3851
15552 "Also this call returns basic file type information about each file. The "
15553 "C<ftyp> field will contain one of the following characters:"
15557 #: ../src/guestfs-actions.pod:5857 ../fish/guestfish-actions.pod:3856
15562 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3858
15563 msgid "Block special"
15567 #: ../src/guestfs-actions.pod:5861 ../fish/guestfish-actions.pod:3860
15572 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3862
15573 msgid "Char special"
15577 #: ../src/guestfs-actions.pod:5865 ../fish/guestfish-actions.pod:3864
15582 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3866
15587 #: ../src/guestfs-actions.pod:5869 ../fish/guestfish-actions.pod:3868
15592 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3870
15593 msgid "FIFO (named pipe)"
15597 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3872
15602 #: ../src/guestfs-actions.pod:5875 ../fish/guestfish-actions.pod:3874
15603 msgid "Symbolic link"
15607 #: ../src/guestfs-actions.pod:5877 ../fish/guestfish-actions.pod:3876
15612 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3878
15613 msgid "Regular file"
15617 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3880
15622 #: ../src/guestfs-actions.pod:5883 ../fish/guestfish-actions.pod:3882
15627 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3884
15632 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3886
15633 msgid "Unknown file type"
15637 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3888
15642 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3890
15643 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15647 #: ../src/guestfs-actions.pod:5896
15649 "This function is primarily intended for use by programs. To get a simple "
15650 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15651 "consumption, use C<guestfs_ll>."
15655 #: ../src/guestfs-actions.pod:5900
15657 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15658 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
15663 #: ../src/guestfs-actions.pod:5906
15664 msgid "guestfs_readlink"
15668 #: ../src/guestfs-actions.pod:5908
15672 " guestfs_readlink (guestfs_h *g,\n"
15673 " const char *path);\n"
15678 #: ../src/guestfs-actions.pod:5912 ../fish/guestfish-actions.pod:3903
15679 msgid "This command reads the target of a symbolic link."
15683 #: ../src/guestfs-actions.pod:5919
15684 msgid "guestfs_readlinklist"
15688 #: ../src/guestfs-actions.pod:5921
15692 " guestfs_readlinklist (guestfs_h *g,\n"
15693 " const char *path,\n"
15694 " char *const *names);\n"
15699 #: ../src/guestfs-actions.pod:5926 ../fish/guestfish-actions.pod:3909
15701 "This call allows you to do a C<readlink> operation on multiple files, where "
15702 "all files are in the directory C<path>. C<names> is the list of files from "
15707 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3913
15709 "On return you get a list of strings, with a one-to-one correspondence to the "
15710 "C<names> list. Each string is the value of the symbolic link."
15714 #: ../src/guestfs-actions.pod:5934 ../fish/guestfish-actions.pod:3917
15716 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15717 "result string is the empty string C<\"\">. However the whole operation is "
15718 "completed even if there were C<readlink(2)> errors, and so you can call this "
15719 "function with names where you don't know if they are symbolic links already "
15720 "(albeit slightly less efficient)."
15724 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3924
15726 "This call is intended for programs that want to efficiently list a directory "
15727 "contents without making many round-trips. Very long directory listings "
15728 "might cause the protocol message size to be exceeded, causing this call to "
15729 "fail. The caller must split up such requests into smaller groups of names."
15733 #: ../src/guestfs-actions.pod:5954
15734 msgid "guestfs_realpath"
15738 #: ../src/guestfs-actions.pod:5956
15742 " guestfs_realpath (guestfs_h *g,\n"
15743 " const char *path);\n"
15748 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:3935
15750 "Return the canonicalized absolute pathname of C<path>. The returned path "
15751 "has no C<.>, C<..> or symbolic link path elements."
15755 #: ../src/guestfs-actions.pod:5968
15756 msgid "guestfs_removexattr"
15760 #: ../src/guestfs-actions.pod:5970
15764 " guestfs_removexattr (guestfs_h *g,\n"
15765 " const char *xattr,\n"
15766 " const char *path);\n"
15771 #: ../src/guestfs-actions.pod:5975 ../fish/guestfish-actions.pod:3942
15772 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
15776 #: ../src/guestfs-actions.pod:5978
15777 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15781 #: ../src/guestfs-actions.pod:5984
15782 msgid "guestfs_resize2fs"
15786 #: ../src/guestfs-actions.pod:5986
15790 " guestfs_resize2fs (guestfs_h *g,\n"
15791 " const char *device);\n"
15796 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:3951
15798 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15799 "underlying device."
15803 #: ../src/guestfs-actions.pod:5993
15805 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15806 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15807 "sometimes gives an error about this and sometimes not. In any case, it is "
15808 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15812 #: ../src/guestfs-actions.pod:6003
15813 msgid "guestfs_resize2fs_M"
15817 #: ../src/guestfs-actions.pod:6005
15821 " guestfs_resize2fs_M (guestfs_h *g,\n"
15822 " const char *device);\n"
15827 #: ../src/guestfs-actions.pod:6009
15829 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15830 "resized to its minimum size. This works like the I<-M> option to the "
15831 "C<resize2fs> command."
15835 #: ../src/guestfs-actions.pod:6013
15837 "To get the resulting size of the filesystem you should call "
15838 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15839 "These two numbers, multiplied together, give the resulting size of the "
15840 "minimal filesystem in bytes."
15844 #: ../src/guestfs-actions.pod:6022
15845 msgid "guestfs_resize2fs_size"
15849 #: ../src/guestfs-actions.pod:6024
15853 " guestfs_resize2fs_size (guestfs_h *g,\n"
15854 " const char *device,\n"
15855 " int64_t size);\n"
15860 #: ../src/guestfs-actions.pod:6029
15862 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15863 "to specify the new size (in bytes) explicitly."
15867 #: ../src/guestfs-actions.pod:6036
15872 #: ../src/guestfs-actions.pod:6038
15876 " guestfs_rm (guestfs_h *g,\n"
15877 " const char *path);\n"
15882 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:3984
15883 msgid "Remove the single file C<path>."
15887 #: ../src/guestfs-actions.pod:6048
15888 msgid "guestfs_rm_rf"
15892 #: ../src/guestfs-actions.pod:6050
15896 " guestfs_rm_rf (guestfs_h *g,\n"
15897 " const char *path);\n"
15902 #: ../src/guestfs-actions.pod:6054 ../fish/guestfish-actions.pod:3990
15904 "Remove the file or directory C<path>, recursively removing the contents if "
15905 "its a directory. This is like the C<rm -rf> shell command."
15909 #: ../src/guestfs-actions.pod:6062
15910 msgid "guestfs_rmdir"
15914 #: ../src/guestfs-actions.pod:6064
15918 " guestfs_rmdir (guestfs_h *g,\n"
15919 " const char *path);\n"
15924 #: ../src/guestfs-actions.pod:6068 ../fish/guestfish-actions.pod:3998
15925 msgid "Remove the single directory C<path>."
15929 #: ../src/guestfs-actions.pod:6074
15930 msgid "guestfs_rmmountpoint"
15934 #: ../src/guestfs-actions.pod:6076
15938 " guestfs_rmmountpoint (guestfs_h *g,\n"
15939 " const char *exemptpath);\n"
15944 #: ../src/guestfs-actions.pod:6080
15946 "This calls removes a mountpoint that was previously created with "
15947 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15951 #: ../src/guestfs-actions.pod:6088
15952 msgid "guestfs_scrub_device"
15956 #: ../src/guestfs-actions.pod:6090
15960 " guestfs_scrub_device (guestfs_h *g,\n"
15961 " const char *device);\n"
15966 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4012
15968 "This command writes patterns over C<device> to make data retrieval more "
15973 #: ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4015 ../fish/guestfish-actions.pod:4030 ../fish/guestfish-actions.pod:4043
15975 "It is an interface to the L<scrub(1)> program. See that manual page for "
15980 #: ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6123 ../src/guestfs-actions.pod:6142
15981 msgid "(Added in 1.0.52)"
15985 #: ../src/guestfs-actions.pod:6107
15986 msgid "guestfs_scrub_file"
15990 #: ../src/guestfs-actions.pod:6109
15994 " guestfs_scrub_file (guestfs_h *g,\n"
15995 " const char *file);\n"
16000 #: ../src/guestfs-actions.pod:6113 ../fish/guestfish-actions.pod:4025
16002 "This command writes patterns over a file to make data retrieval more "
16007 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4028
16008 msgid "The file is I<removed> after scrubbing."
16012 #: ../src/guestfs-actions.pod:6125
16013 msgid "guestfs_scrub_freespace"
16017 #: ../src/guestfs-actions.pod:6127
16021 " guestfs_scrub_freespace (guestfs_h *g,\n"
16022 " const char *dir);\n"
16027 #: ../src/guestfs-actions.pod:6131
16029 "This command creates the directory C<dir> and then fills it with files until "
16030 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16031 "and deletes them. The intention is to scrub any free space on the partition "
16032 "containing C<dir>."
16036 #: ../src/guestfs-actions.pod:6144
16037 msgid "guestfs_set_append"
16041 #: ../src/guestfs-actions.pod:6146
16045 " guestfs_set_append (guestfs_h *g,\n"
16046 " const char *append);\n"
16051 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4052
16053 "This function is used to add additional options to the guest kernel command "
16058 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4055
16060 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16061 "environment variable."
16065 #: ../src/guestfs-actions.pod:6156 ../fish/guestfish-actions.pod:4058
16067 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16068 "(libguestfs always adds a few of its own)."
16072 #: ../src/guestfs-actions.pod:6163
16073 msgid "guestfs_set_attach_method"
16077 #: ../src/guestfs-actions.pod:6165
16081 " guestfs_set_attach_method (guestfs_h *g,\n"
16082 " const char *attachmethod);\n"
16087 #: ../src/guestfs-actions.pod:6169 ../fish/guestfish-actions.pod:4067
16089 "Set the method that libguestfs uses to connect to the back end guestfsd "
16090 "daemon. Possible methods are:"
16094 #: ../src/guestfs-actions.pod:6176 ../fish/guestfish-actions.pod:4074
16096 "Launch an appliance and connect to it. This is the ordinary method and the "
16101 #: ../src/guestfs-actions.pod:6179 ../fish/guestfish-actions.pod:4077
16102 msgid "C<unix:I<path>>"
16106 #: ../src/guestfs-actions.pod:6181 ../fish/guestfish-actions.pod:4079
16107 msgid "Connect to the Unix domain socket I<path>."
16111 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4081
16113 "This method lets you connect to an existing daemon or (using virtio-serial) "
16114 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16115 "RUNNING DAEMONS>."
16119 #: ../src/guestfs-actions.pod:6193
16120 msgid "guestfs_set_autosync"
16124 #: ../src/guestfs-actions.pod:6195
16128 " guestfs_set_autosync (guestfs_h *g,\n"
16129 " int autosync);\n"
16134 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4093
16136 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16137 "effort attempt to make filesystems consistent and synchronized when the "
16138 "handle is closed (also if the program exits without closing handles)."
16142 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4098
16144 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16145 "disabled by default)."
16149 #: ../src/guestfs-actions.pod:6211
16150 msgid "guestfs_set_direct"
16154 #: ../src/guestfs-actions.pod:6213
16158 " guestfs_set_direct (guestfs_h *g,\n"
16164 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4107
16166 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16167 "passed directly through to the appliance once it is launched."
16171 #: ../src/guestfs-actions.pod:6221
16173 "One consequence of this is that log messages aren't caught by the library "
16174 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16179 #: ../src/guestfs-actions.pod:6225 ../fish/guestfish-actions.pod:4115
16180 msgid "You probably don't want to use this unless you know what you are doing."
16184 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4118
16185 msgid "The default is disabled."
16189 #: ../src/guestfs-actions.pod:6234
16190 msgid "guestfs_set_e2label"
16194 #: ../src/guestfs-actions.pod:6236
16198 " guestfs_set_e2label (guestfs_h *g,\n"
16199 " const char *device,\n"
16200 " const char *label);\n"
16205 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4124
16207 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16208 "C<label>. Filesystem labels are limited to 16 characters."
16212 #: ../src/guestfs-actions.pod:6245
16214 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16215 "the existing label on a filesystem."
16219 #: ../src/guestfs-actions.pod:6252
16220 msgid "guestfs_set_e2uuid"
16224 #: ../src/guestfs-actions.pod:6254
16228 " guestfs_set_e2uuid (guestfs_h *g,\n"
16229 " const char *device,\n"
16230 " const char *uuid);\n"
16235 #: ../src/guestfs-actions.pod:6259 ../fish/guestfish-actions.pod:4135
16237 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16238 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16239 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16243 #: ../src/guestfs-actions.pod:6264
16245 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16246 "the existing UUID of a filesystem."
16250 #: ../src/guestfs-actions.pod:6271
16251 msgid "guestfs_set_memsize"
16255 #: ../src/guestfs-actions.pod:6273
16259 " guestfs_set_memsize (guestfs_h *g,\n"
16265 #: ../src/guestfs-actions.pod:6277
16267 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16268 "This only has any effect if called before C<guestfs_launch>."
16272 #: ../src/guestfs-actions.pod:6281 ../fish/guestfish-actions.pod:4153
16274 "You can also change this by setting the environment variable "
16275 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16279 #: ../src/guestfs-actions.pod:6292
16280 msgid "guestfs_set_network"
16284 #: ../src/guestfs-actions.pod:6294
16288 " guestfs_set_network (guestfs_h *g,\n"
16294 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4166
16296 "If C<network> is true, then the network is enabled in the libguestfs "
16297 "appliance. The default is false."
16301 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4169
16303 "This affects whether commands are able to access the network (see "
16304 "L<guestfs(3)/RUNNING COMMANDS>)."
16308 #: ../src/guestfs-actions.pod:6304
16310 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16315 #: ../src/guestfs-actions.pod:6311
16316 msgid "guestfs_set_path"
16320 #: ../src/guestfs-actions.pod:6313
16324 " guestfs_set_path (guestfs_h *g,\n"
16325 " const char *searchpath);\n"
16330 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4181
16331 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16335 #: ../src/guestfs-actions.pod:6319 ../fish/guestfish-actions.pod:4183
16337 "The default is C<$libdir/guestfs> unless overridden by setting "
16338 "C<LIBGUESTFS_PATH> environment variable."
16342 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4186
16343 msgid "Setting C<path> to C<NULL> restores the default path."
16347 #: ../src/guestfs-actions.pod:6328
16348 msgid "guestfs_set_pgroup"
16352 #: ../src/guestfs-actions.pod:6330
16356 " guestfs_set_pgroup (guestfs_h *g,\n"
16362 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4194
16364 "If C<pgroup> is true, child processes are placed into their own process "
16369 #: ../src/guestfs-actions.pod:6337 ../fish/guestfish-actions.pod:4197
16371 "The practical upshot of this is that signals like C<SIGINT> (from users "
16372 "pressing C<^C>) won't be received by the child process."
16376 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4200
16378 "The default for this flag is false, because usually you want C<^C> to kill "
16383 #: ../src/guestfs-actions.pod:6345
16384 msgid "guestfs_set_qemu"
16388 #: ../src/guestfs-actions.pod:6347
16392 " guestfs_set_qemu (guestfs_h *g,\n"
16393 " const char *qemu);\n"
16398 #: ../src/guestfs-actions.pod:6351 ../fish/guestfish-actions.pod:4209
16399 msgid "Set the qemu binary that we will use."
16403 #: ../src/guestfs-actions.pod:6353 ../fish/guestfish-actions.pod:4211
16404 msgid "The default is chosen when the library was compiled by the configure script."
16408 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4214
16410 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16415 #: ../src/guestfs-actions.pod:6359 ../fish/guestfish-actions.pod:4217
16416 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16420 #: ../src/guestfs-actions.pod:6361 ../fish/guestfish-actions.pod:4219
16422 "Note that you should call this function as early as possible after creating "
16423 "the handle. This is because some pre-launch operations depend on testing "
16424 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16425 "don't retest features, and so you might see inconsistent results. Using the "
16426 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16427 "the qemu binary at the same time as the handle is created."
16431 #: ../src/guestfs-actions.pod:6373
16432 msgid "guestfs_set_recovery_proc"
16436 #: ../src/guestfs-actions.pod:6375
16440 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16441 " int recoveryproc);\n"
16446 #: ../src/guestfs-actions.pod:6379
16448 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16449 "not create a recovery process. The purpose of the recovery process is to "
16450 "stop runaway qemu processes in the case where the main program aborts "
16455 #: ../src/guestfs-actions.pod:6384
16457 "This only has any effect if called before C<guestfs_launch>, and the default "
16462 #: ../src/guestfs-actions.pod:6387 ../fish/guestfish-actions.pod:4241
16464 "About the only time when you would want to disable this is if the main "
16465 "process will fork itself into the background (\"daemonize\" itself). In "
16466 "this case the recovery process thinks that the main program has disappeared "
16467 "and so kills qemu, which is not very helpful."
16471 #: ../src/guestfs-actions.pod:6397
16472 msgid "guestfs_set_selinux"
16476 #: ../src/guestfs-actions.pod:6399
16480 " guestfs_set_selinux (guestfs_h *g,\n"
16486 #: ../src/guestfs-actions.pod:6403 ../fish/guestfish-actions.pod:4253
16488 "This sets the selinux flag that is passed to the appliance at boot time. "
16489 "The default is C<selinux=0> (disabled)."
16493 #: ../src/guestfs-actions.pod:6406 ../fish/guestfish-actions.pod:4256
16495 "Note that if SELinux is enabled, it is always in Permissive mode "
16496 "(C<enforcing=0>)."
16500 #: ../src/guestfs-actions.pod:6416
16501 msgid "guestfs_set_trace"
16505 #: ../src/guestfs-actions.pod:6418
16509 " guestfs_set_trace (guestfs_h *g,\n"
16515 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4268
16517 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16518 "return values are traced."
16522 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4271
16524 "If you want to trace C API calls into libguestfs (and other libraries) then "
16525 "possibly a better way is to use the external ltrace(1) command."
16529 #: ../src/guestfs-actions.pod:6429 ../fish/guestfish-actions.pod:4275
16531 "Command traces are disabled unless the environment variable "
16532 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16536 #: ../src/guestfs-actions.pod:6432
16538 "Trace messages are normally sent to C<stderr>, unless you register a "
16539 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16543 #: ../src/guestfs-actions.pod:6440
16544 msgid "guestfs_set_verbose"
16548 #: ../src/guestfs-actions.pod:6442
16552 " guestfs_set_verbose (guestfs_h *g,\n"
16558 #: ../src/guestfs-actions.pod:6446 ../fish/guestfish-actions.pod:4288
16559 msgid "If C<verbose> is true, this turns on verbose messages."
16563 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4290
16565 "Verbose messages are disabled unless the environment variable "
16566 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16570 #: ../src/guestfs-actions.pod:6451
16572 "Verbose messages are normally sent to C<stderr>, unless you register a "
16573 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16577 #: ../src/guestfs-actions.pod:6459
16578 msgid "guestfs_setcon"
16582 #: ../src/guestfs-actions.pod:6461
16586 " guestfs_setcon (guestfs_h *g,\n"
16587 " const char *context);\n"
16592 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4301
16594 "This sets the SELinux security context of the daemon to the string "
16599 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4304
16600 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16604 #: ../src/guestfs-actions.pod:6474
16605 msgid "guestfs_setxattr"
16609 #: ../src/guestfs-actions.pod:6476
16613 " guestfs_setxattr (guestfs_h *g,\n"
16614 " const char *xattr,\n"
16615 " const char *val,\n"
16617 " const char *path);\n"
16622 #: ../src/guestfs-actions.pod:6483 ../fish/guestfish-actions.pod:4310
16624 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16625 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16629 #: ../src/guestfs-actions.pod:6487
16630 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16634 #: ../src/guestfs-actions.pod:6493
16635 msgid "guestfs_sfdisk"
16639 #: ../src/guestfs-actions.pod:6495
16643 " guestfs_sfdisk (guestfs_h *g,\n"
16644 " const char *device,\n"
16648 " char *const *lines);\n"
16653 #: ../src/guestfs-actions.pod:6503 ../fish/guestfish-actions.pod:4320
16655 "This is a direct interface to the L<sfdisk(8)> program for creating "
16656 "partitions on block devices."
16660 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4323
16661 msgid "C<device> should be a block device, for example C</dev/sda>."
16665 #: ../src/guestfs-actions.pod:6508 ../fish/guestfish-actions.pod:4325
16667 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16668 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
16669 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16670 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16671 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16672 "the kernel) cannot work out the right geometry and you will need to tell it."
16676 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4333
16678 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16679 "refer to the L<sfdisk(8)> manpage."
16683 #: ../src/guestfs-actions.pod:6519 ../fish/guestfish-actions.pod:4336
16685 "To create a single partition occupying the whole disk, you would pass "
16686 "C<lines> as a single element list, when the single element being the string "
16691 #: ../src/guestfs-actions.pod:6523
16692 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16696 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6561 ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4346 ../fish/guestfish-actions.pod:4369 ../fish/guestfish-actions.pod:4391
16697 msgid "This function is deprecated. In new code, use the C<part_add> call instead."
16701 #: ../src/guestfs-actions.pod:6540
16702 msgid "guestfs_sfdiskM"
16706 #: ../src/guestfs-actions.pod:6542
16710 " guestfs_sfdiskM (guestfs_h *g,\n"
16711 " const char *device,\n"
16712 " char *const *lines);\n"
16717 #: ../src/guestfs-actions.pod:6547
16719 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16720 "partition sizes are specified in megabytes only (rounded to the nearest "
16721 "cylinder) and you don't need to specify the cyls, heads and sectors "
16722 "parameters which were rarely if ever used anyway."
16726 #: ../src/guestfs-actions.pod:6553
16728 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16729 "C<guestfs_part_disk>"
16733 #: ../src/guestfs-actions.pod:6570
16734 msgid "guestfs_sfdisk_N"
16738 #: ../src/guestfs-actions.pod:6572
16742 " guestfs_sfdisk_N (guestfs_h *g,\n"
16743 " const char *device,\n"
16748 " const char *line);\n"
16753 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4380
16755 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16756 "(note: C<n> counts from 1)."
16760 #: ../src/guestfs-actions.pod:6584
16762 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16763 "for the cyls/heads/sectors parameters."
16767 #: ../src/guestfs-actions.pod:6587
16768 msgid "See also: C<guestfs_part_add>"
16772 #: ../src/guestfs-actions.pod:6603
16773 msgid "guestfs_sfdisk_disk_geometry"
16777 #: ../src/guestfs-actions.pod:6605
16781 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16782 " const char *device);\n"
16787 #: ../src/guestfs-actions.pod:6609
16789 "This displays the disk geometry of C<device> read from the partition table. "
16790 "Especially in the case where the underlying block device has been resized, "
16791 "this can be different from the kernel's idea of the geometry (see "
16792 "C<guestfs_sfdisk_kernel_geometry>)."
16796 #: ../src/guestfs-actions.pod:6614 ../src/guestfs-actions.pod:6630 ../fish/guestfish-actions.pod:4407 ../fish/guestfish-actions.pod:4416
16797 msgid "The result is in human-readable format, and not designed to be parsed."
16801 #: ../src/guestfs-actions.pod:6622
16802 msgid "guestfs_sfdisk_kernel_geometry"
16806 #: ../src/guestfs-actions.pod:6624
16810 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16811 " const char *device);\n"
16816 #: ../src/guestfs-actions.pod:6628 ../fish/guestfish-actions.pod:4414
16817 msgid "This displays the kernel's idea of the geometry of C<device>."
16821 #: ../src/guestfs-actions.pod:6638
16822 msgid "guestfs_sfdisk_l"
16826 #: ../src/guestfs-actions.pod:6640
16830 " guestfs_sfdisk_l (guestfs_h *g,\n"
16831 " const char *device);\n"
16836 #: ../src/guestfs-actions.pod:6644 ../fish/guestfish-actions.pod:4423
16838 "This displays the partition table on C<device>, in the human-readable output "
16839 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16843 #: ../src/guestfs-actions.pod:6648
16844 msgid "See also: C<guestfs_part_list>"
16848 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4429
16850 "This function is deprecated. In new code, use the C<part_list> call "
16855 #: ../src/guestfs-actions.pod:6662
16860 #: ../src/guestfs-actions.pod:6664
16864 " guestfs_sh (guestfs_h *g,\n"
16865 " const char *command);\n"
16870 #: ../src/guestfs-actions.pod:6668 ../fish/guestfish-actions.pod:4440
16872 "This call runs a command from the guest filesystem via the guest's "
16877 #: ../src/guestfs-actions.pod:6671
16878 msgid "This is like C<guestfs_command>, but passes the command to:"
16882 #: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4445
16885 " /bin/sh -c \"command\"\n"
16890 #: ../src/guestfs-actions.pod:6675 ../fish/guestfish-actions.pod:4447
16892 "Depending on the guest's shell, this usually results in wildcards being "
16893 "expanded, shell expressions being interpolated and so on."
16897 #: ../src/guestfs-actions.pod:6679
16898 msgid "All the provisos about C<guestfs_command> apply to this call."
16902 #: ../src/guestfs-actions.pod:6686
16903 msgid "guestfs_sh_lines"
16907 #: ../src/guestfs-actions.pod:6688
16911 " guestfs_sh_lines (guestfs_h *g,\n"
16912 " const char *command);\n"
16917 #: ../src/guestfs-actions.pod:6692
16919 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16924 #: ../src/guestfs-actions.pod:6695
16925 msgid "See also: C<guestfs_command_lines>"
16929 #: ../src/guestfs-actions.pod:6703
16930 msgid "guestfs_sleep"
16934 #: ../src/guestfs-actions.pod:6705
16938 " guestfs_sleep (guestfs_h *g,\n"
16944 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4466
16945 msgid "Sleep for C<secs> seconds."
16949 #: ../src/guestfs-actions.pod:6713
16950 msgid "(Added in 1.0.41)"
16954 #: ../src/guestfs-actions.pod:6715 ../src/guestfs-structs.pod:109
16955 msgid "guestfs_stat"
16959 #: ../src/guestfs-actions.pod:6717
16962 " struct guestfs_stat *\n"
16963 " guestfs_stat (guestfs_h *g,\n"
16964 " const char *path);\n"
16969 #: ../src/guestfs-actions.pod:6723 ../fish/guestfish-actions.pod:4474
16970 msgid "This is the same as the C<stat(2)> system call."
16974 #: ../src/guestfs-actions.pod:6731 ../src/guestfs-structs.pod:135
16975 msgid "guestfs_statvfs"
16979 #: ../src/guestfs-actions.pod:6733
16982 " struct guestfs_statvfs *\n"
16983 " guestfs_statvfs (guestfs_h *g,\n"
16984 " const char *path);\n"
16989 #: ../src/guestfs-actions.pod:6737 ../fish/guestfish-actions.pod:4480
16991 "Returns file system statistics for any mounted file system. C<path> should "
16992 "be a file or directory in the mounted file system (typically it is the mount "
16993 "point itself, but it doesn't need to be)."
16997 #: ../src/guestfs-actions.pod:6741 ../fish/guestfish-actions.pod:4484
16998 msgid "This is the same as the C<statvfs(2)> system call."
17002 #: ../src/guestfs-actions.pod:6743
17004 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17005 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17009 #: ../src/guestfs-actions.pod:6749
17010 msgid "guestfs_strings"
17014 #: ../src/guestfs-actions.pod:6751
17018 " guestfs_strings (guestfs_h *g,\n"
17019 " const char *path);\n"
17024 #: ../src/guestfs-actions.pod:6755 ../fish/guestfish-actions.pod:4490
17026 "This runs the L<strings(1)> command on a file and returns the list of "
17027 "printable strings found."
17031 #: ../src/guestfs-actions.pod:6767
17032 msgid "guestfs_strings_e"
17036 #: ../src/guestfs-actions.pod:6769
17040 " guestfs_strings_e (guestfs_h *g,\n"
17041 " const char *encoding,\n"
17042 " const char *path);\n"
17047 #: ../src/guestfs-actions.pod:6774
17049 "This is like the C<guestfs_strings> command, but allows you to specify the "
17050 "encoding of strings that are looked for in the source file C<path>."
17054 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4504
17055 msgid "Allowed encodings are:"
17059 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4508
17064 #: ../src/guestfs-actions.pod:6784
17066 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17067 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17071 #: ../src/guestfs-actions.pod:6787 ../fish/guestfish-actions.pod:4513
17076 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4515
17077 msgid "Single 8-bit-byte characters."
17081 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4517
17086 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4519
17087 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17091 #: ../src/guestfs-actions.pod:6796 ../fish/guestfish-actions.pod:4522
17092 msgid "l (lower case letter L)"
17096 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4524
17098 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17099 "examining binaries in Windows guests."
17103 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4527
17108 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4529
17109 msgid "32-bit big endian such as UCS-4BE."
17113 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4531
17118 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4533
17119 msgid "32-bit little endian such as UCS-4LE."
17123 #: ../src/guestfs-actions.pod:6811 ../fish/guestfish-actions.pod:4537
17124 msgid "The returned strings are transcoded to UTF-8."
17128 #: ../src/guestfs-actions.pod:6822
17129 msgid "guestfs_swapoff_device"
17133 #: ../src/guestfs-actions.pod:6824
17137 " guestfs_swapoff_device (guestfs_h *g,\n"
17138 " const char *device);\n"
17143 #: ../src/guestfs-actions.pod:6828
17145 "This command disables the libguestfs appliance swap device or partition "
17146 "named C<device>. See C<guestfs_swapon_device>."
17150 #: ../src/guestfs-actions.pod:6836
17151 msgid "guestfs_swapoff_file"
17155 #: ../src/guestfs-actions.pod:6838
17159 " guestfs_swapoff_file (guestfs_h *g,\n"
17160 " const char *file);\n"
17165 #: ../src/guestfs-actions.pod:6842 ../fish/guestfish-actions.pod:4554
17166 msgid "This command disables the libguestfs appliance swap on file."
17170 #: ../src/guestfs-actions.pod:6848
17171 msgid "guestfs_swapoff_label"
17175 #: ../src/guestfs-actions.pod:6850
17179 " guestfs_swapoff_label (guestfs_h *g,\n"
17180 " const char *label);\n"
17185 #: ../src/guestfs-actions.pod:6854 ../fish/guestfish-actions.pod:4560
17187 "This command disables the libguestfs appliance swap on labeled swap "
17192 #: ../src/guestfs-actions.pod:6861
17193 msgid "guestfs_swapoff_uuid"
17197 #: ../src/guestfs-actions.pod:6863
17201 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17202 " const char *uuid);\n"
17207 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4567
17209 "This command disables the libguestfs appliance swap partition with the given "
17214 #: ../src/guestfs-actions.pod:6874
17215 msgid "guestfs_swapon_device"
17219 #: ../src/guestfs-actions.pod:6876
17223 " guestfs_swapon_device (guestfs_h *g,\n"
17224 " const char *device);\n"
17229 #: ../src/guestfs-actions.pod:6880
17231 "This command enables the libguestfs appliance to use the swap device or "
17232 "partition named C<device>. The increased memory is made available for all "
17233 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17237 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4579
17239 "Note that you should not swap to existing guest swap partitions unless you "
17240 "know what you are doing. They may contain hibernation information, or other "
17241 "information that the guest doesn't want you to trash. You also risk leaking "
17242 "information about the host to the guest this way. Instead, attach a new "
17243 "host device to the guest and swap on that."
17247 #: ../src/guestfs-actions.pod:6896
17248 msgid "guestfs_swapon_file"
17252 #: ../src/guestfs-actions.pod:6898
17256 " guestfs_swapon_file (guestfs_h *g,\n"
17257 " const char *file);\n"
17262 #: ../src/guestfs-actions.pod:6902
17264 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17269 #: ../src/guestfs-actions.pod:6909
17270 msgid "guestfs_swapon_label"
17274 #: ../src/guestfs-actions.pod:6911
17278 " guestfs_swapon_label (guestfs_h *g,\n"
17279 " const char *label);\n"
17284 #: ../src/guestfs-actions.pod:6915
17286 "This command enables swap to a labeled swap partition. See "
17287 "C<guestfs_swapon_device> for other notes."
17291 #: ../src/guestfs-actions.pod:6922
17292 msgid "guestfs_swapon_uuid"
17296 #: ../src/guestfs-actions.pod:6924
17300 " guestfs_swapon_uuid (guestfs_h *g,\n"
17301 " const char *uuid);\n"
17306 #: ../src/guestfs-actions.pod:6928
17308 "This command enables swap to a swap partition with the given UUID. See "
17309 "C<guestfs_swapon_device> for other notes."
17313 #: ../src/guestfs-actions.pod:6935
17314 msgid "guestfs_sync"
17318 #: ../src/guestfs-actions.pod:6937
17322 " guestfs_sync (guestfs_h *g);\n"
17327 #: ../src/guestfs-actions.pod:6940 ../fish/guestfish-actions.pod:4611
17329 "This syncs the disk, so that any writes are flushed through to the "
17330 "underlying disk image."
17334 #: ../src/guestfs-actions.pod:6943 ../fish/guestfish-actions.pod:4614
17336 "You should always call this if you have modified a disk image, before "
17337 "closing the handle."
17341 #: ../src/guestfs-actions.pod:6950
17342 msgid "guestfs_tail"
17346 #: ../src/guestfs-actions.pod:6952
17350 " guestfs_tail (guestfs_h *g,\n"
17351 " const char *path);\n"
17356 #: ../src/guestfs-actions.pod:6956 ../fish/guestfish-actions.pod:4621
17357 msgid "This command returns up to the last 10 lines of a file as a list of strings."
17361 #: ../src/guestfs-actions.pod:6968
17362 msgid "guestfs_tail_n"
17366 #: ../src/guestfs-actions.pod:6970
17370 " guestfs_tail_n (guestfs_h *g,\n"
17372 " const char *path);\n"
17377 #: ../src/guestfs-actions.pod:6975 ../fish/guestfish-actions.pod:4631
17379 "If the parameter C<nrlines> is a positive number, this returns the last "
17380 "C<nrlines> lines of the file C<path>."
17384 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4634
17386 "If the parameter C<nrlines> is a negative number, this returns lines from "
17387 "the file C<path>, starting with the C<-nrlines>th line."
17391 #: ../src/guestfs-actions.pod:6992
17392 msgid "guestfs_tar_in"
17396 #: ../src/guestfs-actions.pod:6994
17400 " guestfs_tar_in (guestfs_h *g,\n"
17401 " const char *tarfile,\n"
17402 " const char *directory);\n"
17407 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4646
17409 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17410 "tar file) into C<directory>."
17414 #: ../src/guestfs-actions.pod:7002
17415 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17419 #: ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7024 ../src/guestfs-actions.pod:7040 ../src/guestfs-actions.pod:7056
17420 msgid "(Added in 1.0.3)"
17424 #: ../src/guestfs-actions.pod:7009
17425 msgid "guestfs_tar_out"
17429 #: ../src/guestfs-actions.pod:7011
17433 " guestfs_tar_out (guestfs_h *g,\n"
17434 " const char *directory,\n"
17435 " const char *tarfile);\n"
17440 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4658
17442 "This command packs the contents of C<directory> and downloads it to local "
17447 #: ../src/guestfs-actions.pod:7019
17449 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17450 "C<guestfs_txz_out>."
17454 #: ../src/guestfs-actions.pod:7026
17455 msgid "guestfs_tgz_in"
17459 #: ../src/guestfs-actions.pod:7028
17463 " guestfs_tgz_in (guestfs_h *g,\n"
17464 " const char *tarball,\n"
17465 " const char *directory);\n"
17470 #: ../src/guestfs-actions.pod:7033 ../fish/guestfish-actions.pod:4670
17472 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17473 "tar file) into C<directory>."
17477 #: ../src/guestfs-actions.pod:7036
17478 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17482 #: ../src/guestfs-actions.pod:7042
17483 msgid "guestfs_tgz_out"
17487 #: ../src/guestfs-actions.pod:7044
17491 " guestfs_tgz_out (guestfs_h *g,\n"
17492 " const char *directory,\n"
17493 " const char *tarball);\n"
17498 #: ../src/guestfs-actions.pod:7049 ../fish/guestfish-actions.pod:4681
17500 "This command packs the contents of C<directory> and downloads it to local "
17505 #: ../src/guestfs-actions.pod:7052
17506 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17510 #: ../src/guestfs-actions.pod:7058
17511 msgid "guestfs_touch"
17515 #: ../src/guestfs-actions.pod:7060
17519 " guestfs_touch (guestfs_h *g,\n"
17520 " const char *path);\n"
17525 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4692
17527 "Touch acts like the L<touch(1)> command. It can be used to update the "
17528 "timestamps on a file, or, if the file does not exist, to create a new "
17529 "zero-length file."
17533 #: ../src/guestfs-actions.pod:7068 ../fish/guestfish-actions.pod:4696
17535 "This command only works on regular files, and will fail on other file types "
17536 "such as directories, symbolic links, block special etc."
17540 #: ../src/guestfs-actions.pod:7075
17541 msgid "guestfs_truncate"
17545 #: ../src/guestfs-actions.pod:7077
17549 " guestfs_truncate (guestfs_h *g,\n"
17550 " const char *path);\n"
17555 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4703
17557 "This command truncates C<path> to a zero-length file. The file must exist "
17562 #: ../src/guestfs-actions.pod:7088
17563 msgid "guestfs_truncate_size"
17567 #: ../src/guestfs-actions.pod:7090
17571 " guestfs_truncate_size (guestfs_h *g,\n"
17572 " const char *path,\n"
17573 " int64_t size);\n"
17578 #: ../src/guestfs-actions.pod:7095 ../fish/guestfish-actions.pod:4710
17580 "This command truncates C<path> to size C<size> bytes. The file must exist "
17585 #: ../src/guestfs-actions.pod:7098
17587 "If the current file size is less than C<size> then the file is extended to "
17588 "the required size with zero bytes. This creates a sparse file (ie. disk "
17589 "blocks are not allocated for the file until you write to it). To create a "
17590 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17594 #: ../src/guestfs-actions.pod:7108
17595 msgid "guestfs_tune2fs_l"
17599 #: ../src/guestfs-actions.pod:7110
17603 " guestfs_tune2fs_l (guestfs_h *g,\n"
17604 " const char *device);\n"
17609 #: ../src/guestfs-actions.pod:7114 ../fish/guestfish-actions.pod:4723
17611 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17616 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4726
17618 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17619 "for more details. The list of fields returned isn't clearly defined, and "
17620 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17621 "and the filesystem itself."
17625 #: ../src/guestfs-actions.pod:7130
17626 msgid "guestfs_txz_in"
17630 #: ../src/guestfs-actions.pod:7132
17634 " guestfs_txz_in (guestfs_h *g,\n"
17635 " const char *tarball,\n"
17636 " const char *directory);\n"
17641 #: ../src/guestfs-actions.pod:7137 ../fish/guestfish-actions.pod:4735
17643 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17644 "tar file) into C<directory>."
17648 #: ../src/guestfs-actions.pod:7144
17649 msgid "guestfs_txz_out"
17653 #: ../src/guestfs-actions.pod:7146
17657 " guestfs_txz_out (guestfs_h *g,\n"
17658 " const char *directory,\n"
17659 " const char *tarball);\n"
17664 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4744
17666 "This command packs the contents of C<directory> and downloads it to local "
17667 "file C<tarball> (as an xz compressed tar archive)."
17671 #: ../src/guestfs-actions.pod:7158
17672 msgid "guestfs_umask"
17676 #: ../src/guestfs-actions.pod:7160
17680 " guestfs_umask (guestfs_h *g,\n"
17686 #: ../src/guestfs-actions.pod:7164 ../fish/guestfish-actions.pod:4753
17688 "This function sets the mask used for creating new files and device nodes to "
17693 #: ../src/guestfs-actions.pod:7167 ../fish/guestfish-actions.pod:4756
17695 "Typical umask values would be C<022> which creates new files with "
17696 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17697 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17701 #: ../src/guestfs-actions.pod:7172 ../fish/guestfish-actions.pod:4761
17703 "The default umask is C<022>. This is important because it means that "
17704 "directories and device nodes will be created with C<0644> or C<0755> mode "
17705 "even if you specify C<0777>."
17709 #: ../src/guestfs-actions.pod:7176
17711 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17712 "C<guestfs_mkdir>."
17716 #: ../src/guestfs-actions.pod:7179 ../fish/guestfish-actions.pod:4768
17717 msgid "This call returns the previous umask."
17721 #: ../src/guestfs-actions.pod:7185
17722 msgid "guestfs_umount"
17726 #: ../src/guestfs-actions.pod:7187
17730 " guestfs_umount (guestfs_h *g,\n"
17731 " const char *pathordevice);\n"
17736 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4776
17738 "This unmounts the given filesystem. The filesystem may be specified either "
17739 "by its mountpoint (path) or the device which contains the filesystem."
17743 #: ../src/guestfs-actions.pod:7199
17744 msgid "guestfs_umount_all"
17748 #: ../src/guestfs-actions.pod:7201
17752 " guestfs_umount_all (guestfs_h *g);\n"
17757 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4786
17758 msgid "This unmounts all mounted filesystems."
17762 #: ../src/guestfs-actions.pod:7206 ../fish/guestfish-actions.pod:4788
17763 msgid "Some internal mounts are not unmounted by this call."
17767 #: ../src/guestfs-actions.pod:7212
17768 msgid "guestfs_upload"
17772 #: ../src/guestfs-actions.pod:7214
17776 " guestfs_upload (guestfs_h *g,\n"
17777 " const char *filename,\n"
17778 " const char *remotefilename);\n"
17783 #: ../src/guestfs-actions.pod:7219 ../src/guestfs-actions.pod:7243 ../fish/guestfish-actions.pod:4794 ../fish/guestfish-actions.pod:4807
17784 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17788 #: ../src/guestfs-actions.pod:7224
17789 msgid "See also C<guestfs_download>."
17793 #: ../src/guestfs-actions.pod:7235
17794 msgid "guestfs_upload_offset"
17798 #: ../src/guestfs-actions.pod:7237
17802 " guestfs_upload_offset (guestfs_h *g,\n"
17803 " const char *filename,\n"
17804 " const char *remotefilename,\n"
17805 " int64_t offset);\n"
17810 #: ../src/guestfs-actions.pod:7246 ../fish/guestfish-actions.pod:4810
17812 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17813 "The intention is to overwrite parts of existing files or devices, although "
17814 "if a non-existant file is specified then it is created with a \"hole\" "
17815 "before C<offset>. The size of the data written is implicit in the size of "
17816 "the source C<filename>."
17820 #: ../src/guestfs-actions.pod:7253
17822 "Note that there is no limit on the amount of data that can be uploaded with "
17823 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17824 "full amount unless an error occurs."
17828 #: ../src/guestfs-actions.pod:7258
17829 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17833 #: ../src/guestfs-actions.pod:7269
17834 msgid "guestfs_utimens"
17838 #: ../src/guestfs-actions.pod:7271
17842 " guestfs_utimens (guestfs_h *g,\n"
17843 " const char *path,\n"
17844 " int64_t atsecs,\n"
17845 " int64_t atnsecs,\n"
17846 " int64_t mtsecs,\n"
17847 " int64_t mtnsecs);\n"
17852 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4830
17853 msgid "This command sets the timestamps of a file with nanosecond precision."
17857 #: ../src/guestfs-actions.pod:7282 ../fish/guestfish-actions.pod:4833
17859 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17864 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4836
17866 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17867 "nanoseconds from the epoch."
17871 #: ../src/guestfs-actions.pod:7288 ../fish/guestfish-actions.pod:4839
17873 "If the C<*nsecs> field contains the special value C<-1> then the "
17874 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17875 "ignored in this case)."
17879 #: ../src/guestfs-actions.pod:7292 ../fish/guestfish-actions.pod:4843
17881 "If the C<*nsecs> field contains the special value C<-2> then the "
17882 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17887 #: ../src/guestfs-actions.pod:7300 ../src/guestfs-structs.pod:175
17888 msgid "guestfs_version"
17892 #: ../src/guestfs-actions.pod:7302
17895 " struct guestfs_version *\n"
17896 " guestfs_version (guestfs_h *g);\n"
17901 #: ../src/guestfs-actions.pod:7305 ../fish/guestfish-actions.pod:4851
17902 msgid "Return the libguestfs version number that the program is linked against."
17906 #: ../src/guestfs-actions.pod:7308 ../fish/guestfish-actions.pod:4854
17908 "Note that because of dynamic linking this is not necessarily the version of "
17909 "libguestfs that you compiled against. You can compile the program, and then "
17910 "at runtime dynamically link against a completely different C<libguestfs.so> "
17915 #: ../src/guestfs-actions.pod:7313 ../fish/guestfish-actions.pod:4859
17917 "This call was added in version C<1.0.58>. In previous versions of "
17918 "libguestfs there was no way to get the version number. From C code you can "
17919 "use dynamic linker functions to find out if this symbol exists (if it "
17920 "doesn't, then it's an earlier version)."
17924 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4865
17926 "The call returns a structure with four elements. The first three (C<major>, "
17927 "C<minor> and C<release>) are numbers and correspond to the usual version "
17928 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17929 "but may be used for distro-specific information."
17933 #: ../src/guestfs-actions.pod:7325 ../fish/guestfish-actions.pod:4871
17934 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
17938 #: ../src/guestfs-actions.pod:7328 ../fish/guestfish-actions.pod:4874
17939 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17943 #: ../src/guestfs-actions.pod:7330
17945 "I<Note:> Don't use this call to test for availability of features. In "
17946 "enterprise distributions we backport features from later versions into "
17947 "earlier versions, making this an unreliable way to test for features. Use "
17948 "C<guestfs_available> instead."
17952 #: ../src/guestfs-actions.pod:7336
17954 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17955 "error. I<The caller must call C<guestfs_free_version> after use>."
17959 #: ../src/guestfs-actions.pod:7340
17960 msgid "(Added in 1.0.58)"
17964 #: ../src/guestfs-actions.pod:7342
17965 msgid "guestfs_vfs_label"
17969 #: ../src/guestfs-actions.pod:7344
17973 " guestfs_vfs_label (guestfs_h *g,\n"
17974 " const char *device);\n"
17979 #: ../src/guestfs-actions.pod:7348 ../fish/guestfish-actions.pod:4886
17980 msgid "This returns the filesystem label of the filesystem on C<device>."
17984 #: ../src/guestfs-actions.pod:7351 ../fish/guestfish-actions.pod:4889
17985 msgid "If the filesystem is unlabeled, this returns the empty string."
17989 #: ../src/guestfs-actions.pod:7353
17990 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17994 #: ../src/guestfs-actions.pod:7358 ../src/guestfs-actions.pod:7395
17995 msgid "(Added in 1.3.18)"
17999 #: ../src/guestfs-actions.pod:7360
18000 msgid "guestfs_vfs_type"
18004 #: ../src/guestfs-actions.pod:7362
18008 " guestfs_vfs_type (guestfs_h *g,\n"
18009 " const char *device);\n"
18014 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4897
18016 "This command gets the filesystem type corresponding to the filesystem on "
18021 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4900
18023 "For most filesystems, the result is the name of the Linux VFS module which "
18024 "would be used to mount this filesystem if you mounted it without specifying "
18025 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18029 #: ../src/guestfs-actions.pod:7379
18030 msgid "guestfs_vfs_uuid"
18034 #: ../src/guestfs-actions.pod:7381
18038 " guestfs_vfs_uuid (guestfs_h *g,\n"
18039 " const char *device);\n"
18044 #: ../src/guestfs-actions.pod:7385 ../fish/guestfish-actions.pod:4909
18045 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18049 #: ../src/guestfs-actions.pod:7388 ../fish/guestfish-actions.pod:4912
18050 msgid "If the filesystem does not have a UUID, this returns the empty string."
18054 #: ../src/guestfs-actions.pod:7390
18055 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18059 #: ../src/guestfs-actions.pod:7397
18060 msgid "guestfs_vg_activate"
18064 #: ../src/guestfs-actions.pod:7399
18068 " guestfs_vg_activate (guestfs_h *g,\n"
18070 " char *const *volgroups);\n"
18075 #: ../src/guestfs-actions.pod:7404 ../fish/guestfish-actions.pod:4920
18077 "This command activates or (if C<activate> is false) deactivates all logical "
18078 "volumes in the listed volume groups C<volgroups>."
18082 #: ../src/guestfs-actions.pod:7407 ../fish/guestfish-actions.pod:4923
18083 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18087 #: ../src/guestfs-actions.pod:7409 ../fish/guestfish-actions.pod:4925
18089 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18090 "activated or deactivated."
18094 #: ../src/guestfs-actions.pod:7416
18095 msgid "guestfs_vg_activate_all"
18099 #: ../src/guestfs-actions.pod:7418
18103 " guestfs_vg_activate_all (guestfs_h *g,\n"
18104 " int activate);\n"
18109 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4932
18111 "This command activates or (if C<activate> is false) deactivates all logical "
18112 "volumes in all volume groups."
18116 #: ../src/guestfs-actions.pod:7425 ../fish/guestfish-actions.pod:4935
18117 msgid "This command is the same as running C<vgchange -a y|n>"
18121 #: ../src/guestfs-actions.pod:7431
18122 msgid "guestfs_vgcreate"
18126 #: ../src/guestfs-actions.pod:7433
18130 " guestfs_vgcreate (guestfs_h *g,\n"
18131 " const char *volgroup,\n"
18132 " char *const *physvols);\n"
18137 #: ../src/guestfs-actions.pod:7438 ../fish/guestfish-actions.pod:4941
18139 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18140 "of physical volumes C<physvols>."
18144 #: ../src/guestfs-actions.pod:7445
18145 msgid "guestfs_vglvuuids"
18149 #: ../src/guestfs-actions.pod:7447
18153 " guestfs_vglvuuids (guestfs_h *g,\n"
18154 " const char *vgname);\n"
18159 #: ../src/guestfs-actions.pod:7451 ../fish/guestfish-actions.pod:4948
18161 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18162 "volumes created in this volume group."
18166 #: ../src/guestfs-actions.pod:7454
18168 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18169 "associate logical volumes and volume groups."
18173 #: ../src/guestfs-actions.pod:7457
18174 msgid "See also C<guestfs_vgpvuuids>."
18178 #: ../src/guestfs-actions.pod:7465
18179 msgid "guestfs_vgpvuuids"
18183 #: ../src/guestfs-actions.pod:7467
18187 " guestfs_vgpvuuids (guestfs_h *g,\n"
18188 " const char *vgname);\n"
18193 #: ../src/guestfs-actions.pod:7471 ../fish/guestfish-actions.pod:4960
18195 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18196 "volumes that this volume group resides on."
18200 #: ../src/guestfs-actions.pod:7474
18202 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18203 "associate physical volumes and volume groups."
18207 #: ../src/guestfs-actions.pod:7477
18208 msgid "See also C<guestfs_vglvuuids>."
18212 #: ../src/guestfs-actions.pod:7485
18213 msgid "guestfs_vgremove"
18217 #: ../src/guestfs-actions.pod:7487
18221 " guestfs_vgremove (guestfs_h *g,\n"
18222 " const char *vgname);\n"
18227 #: ../src/guestfs-actions.pod:7491 ../fish/guestfish-actions.pod:4972
18228 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18232 #: ../src/guestfs-actions.pod:7493 ../fish/guestfish-actions.pod:4974
18233 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
18237 #: ../src/guestfs-actions.pod:7500
18238 msgid "guestfs_vgrename"
18242 #: ../src/guestfs-actions.pod:7502
18246 " guestfs_vgrename (guestfs_h *g,\n"
18247 " const char *volgroup,\n"
18248 " const char *newvolgroup);\n"
18253 #: ../src/guestfs-actions.pod:7507 ../fish/guestfish-actions.pod:4981
18254 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18258 #: ../src/guestfs-actions.pod:7513
18259 msgid "guestfs_vgs"
18263 #: ../src/guestfs-actions.pod:7515
18267 " guestfs_vgs (guestfs_h *g);\n"
18272 #: ../src/guestfs-actions.pod:7518 ../fish/guestfish-actions.pod:4987
18274 "List all the volumes groups detected. This is the equivalent of the "
18275 "L<vgs(8)> command."
18279 #: ../src/guestfs-actions.pod:7521 ../fish/guestfish-actions.pod:4990
18281 "This returns a list of just the volume group names that were detected "
18282 "(eg. C<VolGroup00>)."
18286 #: ../src/guestfs-actions.pod:7524
18287 msgid "See also C<guestfs_vgs_full>."
18291 #: ../src/guestfs-actions.pod:7532
18292 msgid "guestfs_vgs_full"
18296 #: ../src/guestfs-actions.pod:7534
18299 " struct guestfs_lvm_vg_list *\n"
18300 " guestfs_vgs_full (guestfs_h *g);\n"
18305 #: ../src/guestfs-actions.pod:7537 ../fish/guestfish-actions.pod:4999
18307 "List all the volumes groups detected. This is the equivalent of the "
18308 "L<vgs(8)> command. The \"full\" version includes all fields."
18312 #: ../src/guestfs-actions.pod:7540
18314 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18315 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
18320 #: ../src/guestfs-actions.pod:7546
18321 msgid "guestfs_vgscan"
18325 #: ../src/guestfs-actions.pod:7548
18329 " guestfs_vgscan (guestfs_h *g);\n"
18334 #: ../src/guestfs-actions.pod:7551 ../fish/guestfish-actions.pod:5006
18336 "This rescans all block devices and rebuilds the list of LVM physical "
18337 "volumes, volume groups and logical volumes."
18341 #: ../src/guestfs-actions.pod:7558
18342 msgid "guestfs_vguuid"
18346 #: ../src/guestfs-actions.pod:7560
18350 " guestfs_vguuid (guestfs_h *g,\n"
18351 " const char *vgname);\n"
18356 #: ../src/guestfs-actions.pod:7564 ../fish/guestfish-actions.pod:5013
18357 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18361 #: ../src/guestfs-actions.pod:7571
18362 msgid "guestfs_wait_ready"
18366 #: ../src/guestfs-actions.pod:7573
18370 " guestfs_wait_ready (guestfs_h *g);\n"
18375 #: ../src/guestfs-actions.pod:7576
18376 msgid "This function is a no op."
18380 #: ../src/guestfs-actions.pod:7578
18382 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
18383 "calling C<guestfs_launch> to wait for the launch to complete. However this "
18384 "is no longer necessary because C<guestfs_launch> now does the waiting."
18388 #: ../src/guestfs-actions.pod:7583
18390 "If you see any calls to this function in code then you can just remove them, "
18391 "unless you want to retain compatibility with older versions of the API."
18395 #: ../src/guestfs-actions.pod:7589
18396 msgid "This function is deprecated. In new code, use the C<launch> call instead."
18400 #: ../src/guestfs-actions.pod:7598
18401 msgid "guestfs_wc_c"
18405 #: ../src/guestfs-actions.pod:7600
18409 " guestfs_wc_c (guestfs_h *g,\n"
18410 " const char *path);\n"
18415 #: ../src/guestfs-actions.pod:7604 ../fish/guestfish-actions.pod:5019
18417 "This command counts the characters in a file, using the C<wc -c> external "
18422 #: ../src/guestfs-actions.pod:7611
18423 msgid "guestfs_wc_l"
18427 #: ../src/guestfs-actions.pod:7613
18431 " guestfs_wc_l (guestfs_h *g,\n"
18432 " const char *path);\n"
18437 #: ../src/guestfs-actions.pod:7617 ../fish/guestfish-actions.pod:5026
18439 "This command counts the lines in a file, using the C<wc -l> external "
18444 #: ../src/guestfs-actions.pod:7624
18445 msgid "guestfs_wc_w"
18449 #: ../src/guestfs-actions.pod:7626
18453 " guestfs_wc_w (guestfs_h *g,\n"
18454 " const char *path);\n"
18459 #: ../src/guestfs-actions.pod:7630 ../fish/guestfish-actions.pod:5033
18461 "This command counts the words in a file, using the C<wc -w> external "
18466 #: ../src/guestfs-actions.pod:7637
18467 msgid "guestfs_write"
18471 #: ../src/guestfs-actions.pod:7639
18475 " guestfs_write (guestfs_h *g,\n"
18476 " const char *path,\n"
18477 " const char *content,\n"
18478 " size_t content_size);\n"
18483 #: ../src/guestfs-actions.pod:7645 ../fish/guestfish-actions.pod:5040
18485 "This call creates a file called C<path>. The content of the file is the "
18486 "string C<content> (which can contain any 8 bit data)."
18490 #: ../src/guestfs-actions.pod:7648
18491 msgid "See also C<guestfs_write_append>."
18495 #: ../src/guestfs-actions.pod:7657
18496 msgid "guestfs_write_append"
18500 #: ../src/guestfs-actions.pod:7659
18504 " guestfs_write_append (guestfs_h *g,\n"
18505 " const char *path,\n"
18506 " const char *content,\n"
18507 " size_t content_size);\n"
18512 #: ../src/guestfs-actions.pod:7665 ../fish/guestfish-actions.pod:5052
18514 "This call appends C<content> to the end of file C<path>. If C<path> does "
18515 "not exist, then a new file is created."
18519 #: ../src/guestfs-actions.pod:7668
18520 msgid "See also C<guestfs_write>."
18524 #: ../src/guestfs-actions.pod:7675
18525 msgid "guestfs_write_file"
18529 #: ../src/guestfs-actions.pod:7677
18533 " guestfs_write_file (guestfs_h *g,\n"
18534 " const char *path,\n"
18535 " const char *content,\n"
18541 #: ../src/guestfs-actions.pod:7683 ../fish/guestfish-actions.pod:5064
18543 "This call creates a file called C<path>. The contents of the file is the "
18544 "string C<content> (which can contain any 8 bit data), with length C<size>."
18548 #: ../src/guestfs-actions.pod:7687 ../fish/guestfish-actions.pod:5068
18550 "As a special case, if C<size> is C<0> then the length is calculated using "
18551 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18555 #: ../src/guestfs-actions.pod:7691 ../fish/guestfish-actions.pod:5072
18557 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18558 "I<not> work, even if the length is specified."
18562 #: ../src/guestfs-actions.pod:7699 ../fish/guestfish-actions.pod:5078
18563 msgid "This function is deprecated. In new code, use the C<write> call instead."
18567 #: ../src/guestfs-actions.pod:7708
18568 msgid "guestfs_zegrep"
18572 #: ../src/guestfs-actions.pod:7710
18576 " guestfs_zegrep (guestfs_h *g,\n"
18577 " const char *regex,\n"
18578 " const char *path);\n"
18583 #: ../src/guestfs-actions.pod:7715 ../fish/guestfish-actions.pod:5089
18584 msgid "This calls the external C<zegrep> program and returns the matching lines."
18588 #: ../src/guestfs-actions.pod:7727
18589 msgid "guestfs_zegrepi"
18593 #: ../src/guestfs-actions.pod:7729
18597 " guestfs_zegrepi (guestfs_h *g,\n"
18598 " const char *regex,\n"
18599 " const char *path);\n"
18604 #: ../src/guestfs-actions.pod:7734 ../fish/guestfish-actions.pod:5099
18605 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
18609 #: ../src/guestfs-actions.pod:7746
18610 msgid "guestfs_zero"
18614 #: ../src/guestfs-actions.pod:7748
18618 " guestfs_zero (guestfs_h *g,\n"
18619 " const char *device);\n"
18624 #: ../src/guestfs-actions.pod:7752 ../fish/guestfish-actions.pod:5109
18625 msgid "This command writes zeroes over the first few blocks of C<device>."
18629 #: ../src/guestfs-actions.pod:7754 ../fish/guestfish-actions.pod:5111
18631 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18632 "securely wipe the device). It should be sufficient to remove any partition "
18633 "tables, filesystem superblocks and so on."
18637 #: ../src/guestfs-actions.pod:7758
18639 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
18640 "C<guestfs_is_zero_device>"
18644 #: ../src/guestfs-actions.pod:7770
18645 msgid "guestfs_zero_device"
18649 #: ../src/guestfs-actions.pod:7772
18653 " guestfs_zero_device (guestfs_h *g,\n"
18654 " const char *device);\n"
18659 #: ../src/guestfs-actions.pod:7776
18661 "This command writes zeroes over the entire C<device>. Compare with "
18662 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18666 #: ../src/guestfs-actions.pod:7790
18667 msgid "(Added in 1.3.1)"
18671 #: ../src/guestfs-actions.pod:7792
18672 msgid "guestfs_zerofree"
18676 #: ../src/guestfs-actions.pod:7794
18680 " guestfs_zerofree (guestfs_h *g,\n"
18681 " const char *device);\n"
18686 #: ../src/guestfs-actions.pod:7798 ../fish/guestfish-actions.pod:5133
18688 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18689 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18690 "possible to compress the filesystem more effectively."
18694 #: ../src/guestfs-actions.pod:7803 ../fish/guestfish-actions.pod:5138
18695 msgid "You should B<not> run this program if the filesystem is mounted."
18699 #: ../src/guestfs-actions.pod:7806 ../fish/guestfish-actions.pod:5141
18701 "It is possible that using this program can damage the filesystem or data on "
18706 #: ../src/guestfs-actions.pod:7813
18707 msgid "guestfs_zfgrep"
18711 #: ../src/guestfs-actions.pod:7815
18715 " guestfs_zfgrep (guestfs_h *g,\n"
18716 " const char *pattern,\n"
18717 " const char *path);\n"
18722 #: ../src/guestfs-actions.pod:7820 ../fish/guestfish-actions.pod:5148
18723 msgid "This calls the external C<zfgrep> program and returns the matching lines."
18727 #: ../src/guestfs-actions.pod:7832
18728 msgid "guestfs_zfgrepi"
18732 #: ../src/guestfs-actions.pod:7834
18736 " guestfs_zfgrepi (guestfs_h *g,\n"
18737 " const char *pattern,\n"
18738 " const char *path);\n"
18743 #: ../src/guestfs-actions.pod:7839 ../fish/guestfish-actions.pod:5158
18744 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
18748 #: ../src/guestfs-actions.pod:7851
18749 msgid "guestfs_zfile"
18753 #: ../src/guestfs-actions.pod:7853
18757 " guestfs_zfile (guestfs_h *g,\n"
18758 " const char *meth,\n"
18759 " const char *path);\n"
18764 #: ../src/guestfs-actions.pod:7858 ../fish/guestfish-actions.pod:5168
18765 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
18769 #: ../src/guestfs-actions.pod:7861 ../fish/guestfish-actions.pod:5171
18770 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18774 #: ../src/guestfs-actions.pod:7863
18776 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18781 #: ../src/guestfs-actions.pod:7869 ../fish/guestfish-actions.pod:5176
18782 msgid "This function is deprecated. In new code, use the C<file> call instead."
18786 #: ../src/guestfs-actions.pod:7878
18787 msgid "guestfs_zgrep"
18791 #: ../src/guestfs-actions.pod:7880
18795 " guestfs_zgrep (guestfs_h *g,\n"
18796 " const char *regex,\n"
18797 " const char *path);\n"
18802 #: ../src/guestfs-actions.pod:7885 ../fish/guestfish-actions.pod:5187
18803 msgid "This calls the external C<zgrep> program and returns the matching lines."
18807 #: ../src/guestfs-actions.pod:7897
18808 msgid "guestfs_zgrepi"
18812 #: ../src/guestfs-actions.pod:7899
18816 " guestfs_zgrepi (guestfs_h *g,\n"
18817 " const char *regex,\n"
18818 " const char *path);\n"
18823 #: ../src/guestfs-actions.pod:7904 ../fish/guestfish-actions.pod:5197
18824 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
18828 #: ../src/guestfs-availability.pod:3
18833 #: ../src/guestfs-availability.pod:5
18835 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
18836 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
18837 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
18838 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
18839 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
18843 #: ../src/guestfs-availability.pod:21
18848 #: ../src/guestfs-availability.pod:23
18849 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
18853 #: ../src/guestfs-availability.pod:26
18858 #: ../src/guestfs-availability.pod:28
18860 "The following functions: L</guestfs_inotify_add_watch> "
18861 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
18862 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18866 #: ../src/guestfs-availability.pod:36
18867 msgid "B<linuxfsuuid>"
18871 #: ../src/guestfs-availability.pod:38
18873 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
18874 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18878 #: ../src/guestfs-availability.pod:45
18879 msgid "B<linuxmodules>"
18883 #: ../src/guestfs-availability.pod:47
18884 msgid "The following functions: L</guestfs_modprobe>"
18888 #: ../src/guestfs-availability.pod:50
18889 msgid "B<linuxxattrs>"
18893 #: ../src/guestfs-availability.pod:52
18895 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
18896 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
18897 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
18898 "L</guestfs_setxattr>"
18902 #: ../src/guestfs-availability.pod:63
18907 #: ../src/guestfs-availability.pod:65
18909 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
18910 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
18911 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18915 #: ../src/guestfs-availability.pod:74
18920 #: ../src/guestfs-availability.pod:76
18922 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
18923 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
18924 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
18925 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
18926 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
18927 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
18928 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
18929 "L</guestfs_vgs_full>"
18933 #: ../src/guestfs-availability.pod:99
18938 #: ../src/guestfs-availability.pod:101
18940 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
18941 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
18945 #: ../src/guestfs-availability.pod:107
18950 #: ../src/guestfs-availability.pod:109
18951 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18955 #: ../src/guestfs-availability.pod:112
18956 msgid "B<ntfsprogs>"
18960 #: ../src/guestfs-availability.pod:114
18962 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
18963 "L</guestfs_ntfsresize_size>"
18967 #: ../src/guestfs-availability.pod:119
18968 msgid "B<realpath>"
18972 #: ../src/guestfs-availability.pod:121
18973 msgid "The following functions: L</guestfs_realpath>"
18977 #: ../src/guestfs-availability.pod:124
18982 #: ../src/guestfs-availability.pod:126
18984 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
18985 "L</guestfs_scrub_freespace>"
18989 #: ../src/guestfs-availability.pod:131
18994 #: ../src/guestfs-availability.pod:133
18995 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18999 #: ../src/guestfs-availability.pod:137
19004 #: ../src/guestfs-availability.pod:139
19005 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19009 #: ../src/guestfs-availability.pod:143
19010 msgid "B<zerofree>"
19014 #: ../src/guestfs-availability.pod:145
19015 msgid "The following functions: L</guestfs_zerofree>"
19019 #: ../src/guestfs-structs.pod:1
19020 msgid "guestfs_int_bool"
19024 #: ../src/guestfs-structs.pod:3
19027 " struct guestfs_int_bool {\n"
19035 #: ../src/guestfs-structs.pod:8
19038 " struct guestfs_int_bool_list {\n"
19039 " uint32_t len; /* Number of elements in list. */\n"
19040 " struct guestfs_int_bool *val; /* Elements. */\n"
19046 #: ../src/guestfs-structs.pod:13
19049 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19050 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19055 #: ../src/guestfs-structs.pod:16
19056 msgid "guestfs_lvm_pv"
19060 #: ../src/guestfs-structs.pod:18
19063 " struct guestfs_lvm_pv {\n"
19064 " char *pv_name;\n"
19065 " /* The next field is NOT nul-terminated, be careful when printing it: "
19067 " char pv_uuid[32];\n"
19069 " uint64_t pv_size;\n"
19070 " uint64_t dev_size;\n"
19071 " uint64_t pv_free;\n"
19072 " uint64_t pv_used;\n"
19073 " char *pv_attr;\n"
19074 " int64_t pv_pe_count;\n"
19075 " int64_t pv_pe_alloc_count;\n"
19076 " char *pv_tags;\n"
19077 " uint64_t pe_start;\n"
19078 " int64_t pv_mda_count;\n"
19079 " uint64_t pv_mda_free;\n"
19085 #: ../src/guestfs-structs.pod:36
19088 " struct guestfs_lvm_pv_list {\n"
19089 " uint32_t len; /* Number of elements in list. */\n"
19090 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19096 #: ../src/guestfs-structs.pod:41
19099 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19100 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19105 #: ../src/guestfs-structs.pod:44
19106 msgid "guestfs_lvm_vg"
19110 #: ../src/guestfs-structs.pod:46
19113 " struct guestfs_lvm_vg {\n"
19114 " char *vg_name;\n"
19115 " /* The next field is NOT nul-terminated, be careful when printing it: "
19117 " char vg_uuid[32];\n"
19119 " char *vg_attr;\n"
19120 " uint64_t vg_size;\n"
19121 " uint64_t vg_free;\n"
19122 " char *vg_sysid;\n"
19123 " uint64_t vg_extent_size;\n"
19124 " int64_t vg_extent_count;\n"
19125 " int64_t vg_free_count;\n"
19126 " int64_t max_lv;\n"
19127 " int64_t max_pv;\n"
19128 " int64_t pv_count;\n"
19129 " int64_t lv_count;\n"
19130 " int64_t snap_count;\n"
19131 " int64_t vg_seqno;\n"
19132 " char *vg_tags;\n"
19133 " int64_t vg_mda_count;\n"
19134 " uint64_t vg_mda_free;\n"
19140 #: ../src/guestfs-structs.pod:69
19143 " struct guestfs_lvm_vg_list {\n"
19144 " uint32_t len; /* Number of elements in list. */\n"
19145 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19151 #: ../src/guestfs-structs.pod:74
19154 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19155 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19160 #: ../src/guestfs-structs.pod:77
19161 msgid "guestfs_lvm_lv"
19165 #: ../src/guestfs-structs.pod:79
19168 " struct guestfs_lvm_lv {\n"
19169 " char *lv_name;\n"
19170 " /* The next field is NOT nul-terminated, be careful when printing it: "
19172 " char lv_uuid[32];\n"
19173 " char *lv_attr;\n"
19174 " int64_t lv_major;\n"
19175 " int64_t lv_minor;\n"
19176 " int64_t lv_kernel_major;\n"
19177 " int64_t lv_kernel_minor;\n"
19178 " uint64_t lv_size;\n"
19179 " int64_t seg_count;\n"
19181 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19182 " float snap_percent;\n"
19183 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19184 " float copy_percent;\n"
19185 " char *move_pv;\n"
19186 " char *lv_tags;\n"
19187 " char *mirror_log;\n"
19188 " char *modules;\n"
19194 #: ../src/guestfs-structs.pod:101
19197 " struct guestfs_lvm_lv_list {\n"
19198 " uint32_t len; /* Number of elements in list. */\n"
19199 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19205 #: ../src/guestfs-structs.pod:106
19208 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19209 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19214 #: ../src/guestfs-structs.pod:111
19217 " struct guestfs_stat {\n"
19221 " int64_t nlink;\n"
19226 " int64_t blksize;\n"
19227 " int64_t blocks;\n"
19228 " int64_t atime;\n"
19229 " int64_t mtime;\n"
19230 " int64_t ctime;\n"
19236 #: ../src/guestfs-structs.pod:127
19239 " struct guestfs_stat_list {\n"
19240 " uint32_t len; /* Number of elements in list. */\n"
19241 " struct guestfs_stat *val; /* Elements. */\n"
19247 #: ../src/guestfs-structs.pod:132
19250 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19251 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19256 #: ../src/guestfs-structs.pod:137
19259 " struct guestfs_statvfs {\n"
19260 " int64_t bsize;\n"
19261 " int64_t frsize;\n"
19262 " int64_t blocks;\n"
19263 " int64_t bfree;\n"
19264 " int64_t bavail;\n"
19265 " int64_t files;\n"
19266 " int64_t ffree;\n"
19267 " int64_t favail;\n"
19270 " int64_t namemax;\n"
19276 #: ../src/guestfs-structs.pod:151
19279 " struct guestfs_statvfs_list {\n"
19280 " uint32_t len; /* Number of elements in list. */\n"
19281 " struct guestfs_statvfs *val; /* Elements. */\n"
19287 #: ../src/guestfs-structs.pod:156
19290 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19291 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19296 #: ../src/guestfs-structs.pod:159
19297 msgid "guestfs_dirent"
19301 #: ../src/guestfs-structs.pod:161
19304 " struct guestfs_dirent {\n"
19313 #: ../src/guestfs-structs.pod:167
19316 " struct guestfs_dirent_list {\n"
19317 " uint32_t len; /* Number of elements in list. */\n"
19318 " struct guestfs_dirent *val; /* Elements. */\n"
19324 #: ../src/guestfs-structs.pod:172
19327 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19328 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19333 #: ../src/guestfs-structs.pod:177
19336 " struct guestfs_version {\n"
19337 " int64_t major;\n"
19338 " int64_t minor;\n"
19339 " int64_t release;\n"
19346 #: ../src/guestfs-structs.pod:184
19349 " struct guestfs_version_list {\n"
19350 " uint32_t len; /* Number of elements in list. */\n"
19351 " struct guestfs_version *val; /* Elements. */\n"
19357 #: ../src/guestfs-structs.pod:189
19360 " void guestfs_free_version (struct guestfs_free_version *);\n"
19361 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19366 #: ../src/guestfs-structs.pod:192
19367 msgid "guestfs_xattr"
19371 #: ../src/guestfs-structs.pod:194
19374 " struct guestfs_xattr {\n"
19375 " char *attrname;\n"
19376 " /* The next two fields describe a byte array. */\n"
19377 " uint32_t attrval_len;\n"
19378 " char *attrval;\n"
19384 #: ../src/guestfs-structs.pod:201
19387 " struct guestfs_xattr_list {\n"
19388 " uint32_t len; /* Number of elements in list. */\n"
19389 " struct guestfs_xattr *val; /* Elements. */\n"
19395 #: ../src/guestfs-structs.pod:206
19398 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19399 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19404 #: ../src/guestfs-structs.pod:209
19405 msgid "guestfs_inotify_event"
19409 #: ../src/guestfs-structs.pod:211
19412 " struct guestfs_inotify_event {\n"
19413 " int64_t in_wd;\n"
19414 " uint32_t in_mask;\n"
19415 " uint32_t in_cookie;\n"
19416 " char *in_name;\n"
19422 #: ../src/guestfs-structs.pod:218
19425 " struct guestfs_inotify_event_list {\n"
19426 " uint32_t len; /* Number of elements in list. */\n"
19427 " struct guestfs_inotify_event *val; /* Elements. */\n"
19433 #: ../src/guestfs-structs.pod:223
19436 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
19437 " void guestfs_free_inotify_event_list (struct "
19438 "guestfs_free_inotify_event_list *);\n"
19443 #: ../src/guestfs-structs.pod:226
19444 msgid "guestfs_partition"
19448 #: ../src/guestfs-structs.pod:228
19451 " struct guestfs_partition {\n"
19452 " int32_t part_num;\n"
19453 " uint64_t part_start;\n"
19454 " uint64_t part_end;\n"
19455 " uint64_t part_size;\n"
19461 #: ../src/guestfs-structs.pod:235
19464 " struct guestfs_partition_list {\n"
19465 " uint32_t len; /* Number of elements in list. */\n"
19466 " struct guestfs_partition *val; /* Elements. */\n"
19472 #: ../src/guestfs-structs.pod:240
19475 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
19476 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
19481 #: ../src/guestfs-structs.pod:243
19482 msgid "guestfs_application"
19486 #: ../src/guestfs-structs.pod:245
19489 " struct guestfs_application {\n"
19490 " char *app_name;\n"
19491 " char *app_display_name;\n"
19492 " int32_t app_epoch;\n"
19493 " char *app_version;\n"
19494 " char *app_release;\n"
19495 " char *app_install_path;\n"
19496 " char *app_trans_path;\n"
19497 " char *app_publisher;\n"
19498 " char *app_url;\n"
19499 " char *app_source_package;\n"
19500 " char *app_summary;\n"
19501 " char *app_description;\n"
19507 #: ../src/guestfs-structs.pod:260
19510 " struct guestfs_application_list {\n"
19511 " uint32_t len; /* Number of elements in list. */\n"
19512 " struct guestfs_application *val; /* Elements. */\n"
19518 #: ../src/guestfs-structs.pod:265
19521 " void guestfs_free_application (struct guestfs_free_application *);\n"
19522 " void guestfs_free_application_list (struct guestfs_free_application_list "
19528 #: ../fish/guestfish.pod:5
19529 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19533 #: ../fish/guestfish.pod:9
19536 " guestfish [--options] [commands]\n"
19541 #: ../fish/guestfish.pod:11
19549 #: ../fish/guestfish.pod:13
19552 " guestfish [--ro|--rw] -a disk.img\n"
19557 #: ../fish/guestfish.pod:15
19560 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19565 #: ../fish/guestfish.pod:17
19568 " guestfish -d libvirt-domain\n"
19573 #: ../fish/guestfish.pod:19
19576 " guestfish [--ro|--rw] -a disk.img -i\n"
19581 #: ../fish/guestfish.pod:21
19584 " guestfish -d libvirt-domain -i\n"
19589 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19594 #: ../fish/guestfish.pod:25
19596 "Using guestfish in read/write mode on live virtual machines can be "
19597 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19598 "option to use guestfish safely if the disk image or virtual machine might be "
19603 #: ../fish/guestfish.pod:32
19605 "Guestfish is a shell and command-line tool for examining and modifying "
19606 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19607 "functionality of the guestfs API, see L<guestfs(3)>."
19611 #: ../fish/guestfish.pod:36
19613 "Guestfish gives you structured access to the libguestfs API, from shell "
19614 "scripts or the command line or interactively. If you want to rescue a "
19615 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19620 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:1007 ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
19625 #: ../fish/guestfish.pod:43
19626 msgid "As an interactive shell"
19630 #: ../fish/guestfish.pod:45
19638 #: ../fish/guestfish.pod:47
19641 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19642 " editing virtual machine filesystems.\n"
19647 #: ../fish/guestfish.pod:50
19650 " Type: 'help' for a list of commands\n"
19651 " 'man' to read the manual\n"
19652 " 'quit' to quit the shell\n"
19657 #: ../fish/guestfish.pod:54
19660 " ><fs> add-ro disk.img\n"
19662 " ><fs> list-filesystems\n"
19663 " /dev/sda1: ext4\n"
19664 " /dev/vg_guest/lv_root: ext4\n"
19665 " /dev/vg_guest/lv_swap: swap\n"
19666 " ><fs> mount /dev/vg_guest/lv_root /\n"
19667 " ><fs> cat /etc/fstab\n"
19669 " # Created by anaconda\n"
19676 #: ../fish/guestfish.pod:67
19677 msgid "From shell scripts"
19681 #: ../fish/guestfish.pod:69
19682 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19686 #: ../fish/guestfish.pod:71
19689 " guestfish <<_EOF_\n"
19692 " mount /dev/vg_guest/lv_root /\n"
19693 " write /etc/motd \"Welcome, new users\"\n"
19699 #: ../fish/guestfish.pod:78
19700 msgid "List the LVM logical volumes in a disk image:"
19704 #: ../fish/guestfish.pod:80
19707 " guestfish -a disk.img --ro <<_EOF_\n"
19715 #: ../fish/guestfish.pod:85
19716 msgid "List all the filesystems in a disk image:"
19720 #: ../fish/guestfish.pod:87
19723 " guestfish -a disk.img --ro <<_EOF_\n"
19725 " list-filesystems\n"
19731 #: ../fish/guestfish.pod:92
19732 msgid "On one command line"
19736 #: ../fish/guestfish.pod:94
19737 msgid "Update C</etc/resolv.conf> in a guest:"
19741 #: ../fish/guestfish.pod:96
19745 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19746 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19751 #: ../fish/guestfish.pod:100
19752 msgid "Edit C</boot/grub/grub.conf> interactively:"
19756 #: ../fish/guestfish.pod:102
19759 " guestfish --rw --add disk.img \\\n"
19760 " --mount /dev/vg_guest/lv_root \\\n"
19761 " --mount /dev/sda1:/boot \\\n"
19762 " edit /boot/grub/grub.conf\n"
19767 #: ../fish/guestfish.pod:107
19768 msgid "Mount disks automatically"
19772 #: ../fish/guestfish.pod:109
19774 "Use the I<-i> option to automatically mount the disks from a virtual "
19779 #: ../fish/guestfish.pod:112
19782 " guestfish --ro -a disk.img -i cat /etc/group\n"
19787 #: ../fish/guestfish.pod:114
19790 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19795 #: ../fish/guestfish.pod:116
19796 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19800 #: ../fish/guestfish.pod:118
19803 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19808 #: ../fish/guestfish.pod:120
19809 msgid "As a script interpreter"
19813 #: ../fish/guestfish.pod:122
19814 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19818 #: ../fish/guestfish.pod:124
19821 " #!/usr/bin/guestfish -f\n"
19822 " sparse test1.img 100M\n"
19824 " part-disk /dev/sda mbr\n"
19825 " mkfs ext2 /dev/sda1\n"
19830 #: ../fish/guestfish.pod:130
19831 msgid "Start with a prepared disk"
19835 #: ../fish/guestfish.pod:132
19837 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19838 "single ext2-formatted partition:"
19842 #: ../fish/guestfish.pod:135
19845 " guestfish -N fs\n"
19850 #: ../fish/guestfish.pod:137
19851 msgid "To list what is available do:"
19855 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:998
19858 " guestfish -N help | less\n"
19863 #: ../fish/guestfish.pod:141
19864 msgid "Remote control"
19868 #: ../fish/guestfish.pod:143
19871 " eval \"`guestfish --listen`\"\n"
19872 " guestfish --remote add-ro disk.img\n"
19873 " guestfish --remote run\n"
19874 " guestfish --remote lvs\n"
19879 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
19884 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143 ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
19889 #: ../fish/guestfish.pod:154
19890 msgid "Displays general help on options."
19894 #: ../fish/guestfish.pod:156
19899 #: ../fish/guestfish.pod:158
19900 msgid "B<--cmd-help>"
19904 #: ../fish/guestfish.pod:160
19905 msgid "Lists all available guestfish commands."
19909 #: ../fish/guestfish.pod:162
19914 #: ../fish/guestfish.pod:164
19915 msgid "B<--cmd-help cmd>"
19919 #: ../fish/guestfish.pod:166
19920 msgid "Displays detailed help on a single command C<cmd>."
19924 #: ../fish/guestfish.pod:168
19925 msgid "B<-a image>"
19929 #: ../fish/guestfish.pod:170
19930 msgid "B<--add image>"
19934 #: ../fish/guestfish.pod:172
19935 msgid "Add a block device or virtual machine image to the shell."
19939 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19941 "The format of the disk image is auto-detected. To override this and force a "
19942 "particular format use the I<--format=..> option."
19946 #: ../fish/guestfish.pod:177
19948 "Using this flag is mostly equivalent to using the C<add> command, with "
19949 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19950 "the I<--format=...> flag was given."
19954 #: ../fish/guestfish.pod:181
19959 #: ../fish/guestfish.pod:183
19960 msgid "B<--connect URI>"
19964 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19966 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19967 "URI to use. The default is to use the default libvirt connection."
19971 #: ../fish/guestfish.pod:189
19976 #: ../fish/guestfish.pod:191
19978 "If using the I<--listen> option and a csh-like shell, use this option. See "
19979 "section L</REMOTE CONTROL AND CSH> below."
19983 #: ../fish/guestfish.pod:194
19984 msgid "B<-d libvirt-domain>"
19988 #: ../fish/guestfish.pod:196
19989 msgid "B<--domain libvirt-domain>"
19993 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19995 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19996 "used, then any libvirt domain can be used. However in write mode, only "
19997 "libvirt domains which are shut down can be named here."
20001 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
20002 msgid "Domain UUIDs can be used instead of names."
20006 #: ../fish/guestfish.pod:204
20008 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20009 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20010 "if the I<--format:...> flag was given."
20014 #: ../fish/guestfish.pod:208
20019 #: ../fish/guestfish.pod:210
20020 msgid "B<--no-dest-paths>"
20024 #: ../fish/guestfish.pod:212
20026 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20027 "to hit the tab key to complete paths on the guest filesystem, but this "
20028 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20029 "allow this feature to be disabled."
20033 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
20034 msgid "B<--echo-keys>"
20038 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
20040 "When prompting for keys and passphrases, guestfish normally turns echoing "
20041 "off so you cannot see what you are typing. If you are not worried about "
20042 "Tempest attacks and there is no one else in the room you can specify this "
20043 "flag to see what you are typing."
20047 #: ../fish/guestfish.pod:224
20052 #: ../fish/guestfish.pod:226
20053 msgid "B<--file file>"
20057 #: ../fish/guestfish.pod:228
20058 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20062 #: ../fish/guestfish.pod:231
20065 " #!/usr/bin/guestfish -f\n"
20070 #: ../fish/guestfish.pod:233
20071 msgid "B<--format=raw|qcow2|..>"
20075 #: ../fish/guestfish.pod:235
20076 msgid "B<--format>"
20080 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
20082 "The default for the I<-a> option is to auto-detect the format of the disk "
20083 "image. Using this forces the disk format for I<-a> options which follow on "
20084 "the command line. Using I<--format> with no argument switches back to "
20085 "auto-detection for subsequent I<-a> options."
20089 #: ../fish/guestfish.pod:244
20092 " guestfish --format=raw -a disk.img\n"
20097 #: ../fish/guestfish.pod:246
20098 msgid "forces raw format (no auto-detection) for C<disk.img>."
20102 #: ../fish/guestfish.pod:248
20105 " guestfish --format=raw -a disk.img --format -a another.img\n"
20110 #: ../fish/guestfish.pod:250
20112 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
20113 "auto-detection for C<another.img>."
20117 #: ../fish/guestfish.pod:253
20119 "If you have untrusted raw-format guest disk images, you should use this "
20120 "option to specify the disk format. This avoids a possible security problem "
20121 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20125 #: ../fish/guestfish.pod:258
20130 #: ../fish/guestfish.pod:260
20131 msgid "B<--inspector>"
20135 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
20137 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20138 "system and mount filesystems as they would be mounted on the real virtual "
20143 #: ../fish/guestfish.pod:266
20144 msgid "Typical usage is either:"
20148 #: ../fish/guestfish.pod:268
20151 " guestfish -d myguest -i\n"
20156 #: ../fish/guestfish.pod:270
20157 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20161 #: ../fish/guestfish.pod:272
20164 " guestfish --ro -d myguest -i\n"
20169 #: ../fish/guestfish.pod:274
20170 msgid "(for active domains, readonly), or specify the block device directly:"
20174 #: ../fish/guestfish.pod:276
20177 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
20182 #: ../fish/guestfish.pod:278
20184 "Note that the command line syntax changed slightly over older versions of "
20185 "guestfish. You can still use the old syntax:"
20189 #: ../fish/guestfish.pod:281
20192 " guestfish [--ro] -i disk.img\n"
20197 #: ../fish/guestfish.pod:283
20200 " guestfish [--ro] -i libvirt-domain\n"
20205 #: ../fish/guestfish.pod:285
20207 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20208 "then using other commands to mount the filesystems that were found."
20212 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20213 msgid "B<--keys-from-stdin>"
20217 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
20219 "Read key or passphrase parameters from stdin. The default is to try to read "
20220 "passphrases from the user by opening C</dev/tty>."
20224 #: ../fish/guestfish.pod:294
20225 msgid "B<--listen>"
20229 #: ../fish/guestfish.pod:296
20231 "Fork into the background and listen for remote commands. See section "
20232 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20236 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20241 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
20243 "Connect to a live virtual machine. (Experimental, see "
20244 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
20248 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20249 msgid "B<-m dev[:mountpoint[:options]]>"
20253 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
20254 msgid "B<--mount dev[:mountpoint[:options]]>"
20258 #: ../fish/guestfish.pod:308
20259 msgid "Mount the named partition or logical volume on the given mountpoint."
20263 #: ../fish/guestfish.pod:310
20264 msgid "If the mountpoint is omitted, it defaults to C</>."
20268 #: ../fish/guestfish.pod:312
20269 msgid "You have to mount something on C</> before most commands will work."
20273 #: ../fish/guestfish.pod:314
20275 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20280 #: ../fish/guestfish.pod:317
20282 "If you don't know what filesystems a disk image contains, you can either run "
20283 "guestfish without this option, then list the partitions, filesystems and LVs "
20284 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20285 "commands), or you can use the L<virt-filesystems(1)> program."
20289 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
20291 "The third (and rarely used) part of the mount parameter is the list of mount "
20292 "options used to mount the underlying filesystem. If this is not given, then "
20293 "the mount options are either the empty string or C<ro> (the latter if the "
20294 "I<--ro> flag is used). By specifying the mount options, you override this "
20295 "default choice. Probably the only time you would use this is to enable ACLs "
20296 "and/or extended attributes if the filesystem can support them:"
20300 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
20303 " -m /dev/sda1:/:acl,user_xattr\n"
20308 #: ../fish/guestfish.pod:333
20309 msgid "Using this flag is equivalent to using the C<mount-options> command."
20313 #: ../fish/guestfish.pod:335
20318 #: ../fish/guestfish.pod:337
20319 msgid "B<--no-sync>"
20323 #: ../fish/guestfish.pod:339
20325 "Disable autosync. This is enabled by default. See the discussion of "
20326 "autosync in the L<guestfs(3)> manpage."
20330 #: ../fish/guestfish.pod:342
20335 #: ../fish/guestfish.pod:344
20336 msgid "B<--new type>"
20340 #: ../fish/guestfish.pod:346
20345 #: ../fish/guestfish.pod:348
20347 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
20348 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20349 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20354 #: ../fish/guestfish.pod:353
20355 msgid "B<--progress-bars>"
20359 #: ../fish/guestfish.pod:355
20360 msgid "Enable progress bars, even when guestfish is used non-interactively."
20364 #: ../fish/guestfish.pod:357
20366 "Progress bars are enabled by default when guestfish is used as an "
20367 "interactive shell."
20371 #: ../fish/guestfish.pod:360
20372 msgid "B<--no-progress-bars>"
20376 #: ../fish/guestfish.pod:362
20377 msgid "Disable progress bars."
20381 #: ../fish/guestfish.pod:364
20382 msgid "B<--remote[=pid]>"
20386 #: ../fish/guestfish.pod:366
20388 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20389 "CONTROL GUESTFISH OVER A SOCKET> below."
20393 #: ../fish/guestfish.pod:369
20398 #: ../fish/guestfish.pod:371
20403 #: ../fish/guestfish.pod:373
20405 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20406 "mounts are done read-only."
20410 #: ../fish/guestfish.pod:376
20412 "The option must always be used if the disk image or virtual machine might be "
20413 "running, and is generally recommended in cases where you don't need write "
20414 "access to the disk."
20418 #: ../fish/guestfish.pod:380
20420 "Note that prepared disk images created with I<-N> are not affected by this "
20421 "option. Also commands like C<add> are not affected - you have to specify "
20422 "the C<readonly:true> option explicitly if you need it."
20426 #: ../fish/guestfish.pod:384
20427 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
20431 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
20432 msgid "B<--selinux>"
20436 #: ../fish/guestfish.pod:388
20437 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
20441 #: ../fish/guestfish.pod:390
20446 #: ../fish/guestfish.pod:392
20447 msgid "B<--verbose>"
20451 #: ../fish/guestfish.pod:394
20453 "Enable very verbose messages. This is particularly useful if you find a "
20458 #: ../fish/guestfish.pod:397
20463 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
20464 msgid "B<--version>"
20468 #: ../fish/guestfish.pod:401
20469 msgid "Display the guestfish / libguestfs version number and exit."
20473 #: ../fish/guestfish.pod:403
20478 #: ../fish/guestfish.pod:405
20483 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
20485 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20486 "mounts are done read-write."
20490 #: ../fish/guestfish.pod:410
20491 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
20495 #: ../fish/guestfish.pod:412
20500 #: ../fish/guestfish.pod:414
20501 msgid "Echo each command before executing it."
20505 #: ../fish/guestfish.pod:418
20506 msgid "COMMANDS ON COMMAND LINE"
20510 #: ../fish/guestfish.pod:420
20511 msgid "Any additional (non-option) arguments are treated as commands to execute."
20515 #: ../fish/guestfish.pod:423
20517 "Commands to execute should be separated by a colon (C<:>), where the colon "
20518 "is a separate parameter. Thus:"
20522 #: ../fish/guestfish.pod:426
20525 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20530 #: ../fish/guestfish.pod:428
20532 "If there are no additional arguments, then we enter a shell, either an "
20533 "interactive shell with a prompt (if the input is a terminal) or a "
20534 "non-interactive shell."
20538 #: ../fish/guestfish.pod:432
20540 "In either command line mode or non-interactive shell, the first command that "
20541 "gives an error causes the whole shell to exit. In interactive mode (with a "
20542 "prompt) if a command fails, you can continue to enter commands."
20546 #: ../fish/guestfish.pod:437
20547 msgid "USING launch (OR run)"
20551 #: ../fish/guestfish.pod:439
20553 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20554 "then launch it, then mount any disks you need, and finally issue "
20555 "actions/commands. So the general order of the day is:"
20559 #: ../fish/guestfish.pod:447
20560 msgid "add or -a/--add"
20564 #: ../fish/guestfish.pod:451
20565 msgid "launch (aka run)"
20569 #: ../fish/guestfish.pod:455
20570 msgid "mount or -m/--mount"
20574 #: ../fish/guestfish.pod:459
20575 msgid "any other commands"
20579 #: ../fish/guestfish.pod:463
20581 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20582 "guest before mounting or performing any other commands."
20586 #: ../fish/guestfish.pod:466
20588 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20589 "I<--new> options were given then C<run> is done automatically, simply "
20590 "because guestfish can't perform the action you asked for without doing this."
20594 #: ../fish/guestfish.pod:471
20595 msgid "OPENING DISKS FOR READ AND WRITE"
20599 #: ../fish/guestfish.pod:473
20601 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20602 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20603 "I<-i> and I<-m> open disk images read-only or for writing."
20607 #: ../fish/guestfish.pod:478
20609 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20610 "opening disk images supplied on the command line for write. To open a disk "
20611 "image read-only you have to do I<-a image --ro>."
20615 #: ../fish/guestfish.pod:482
20617 "This matters: If you accidentally open a live VM disk image writable then "
20618 "you will cause irreversible disk corruption."
20622 #: ../fish/guestfish.pod:485
20624 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20625 "images will be opened read-only. You will have to either specify "
20626 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20627 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20628 "access for disk images specified by those other command line options."
20632 #: ../fish/guestfish.pod:492
20634 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20635 "which does nothing (it is already the default). However it is highly "
20636 "recommended that you use this option to indicate that you need write access, "
20637 "and prepare your scripts for the day when this option will be required for "
20642 #: ../fish/guestfish.pod:498
20644 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20645 "other libguestfs program apart from guestfish and guestmount."
20649 #: ../fish/guestfish.pod:501
20654 #: ../fish/guestfish.pod:503
20656 "You can quote ordinary parameters using either single or double quotes. For "
20661 #: ../fish/guestfish.pod:506
20664 " add \"file with a space.img\"\n"
20669 #: ../fish/guestfish.pod:508
20672 " rm '/file name'\n"
20677 #: ../fish/guestfish.pod:510
20685 #: ../fish/guestfish.pod:512
20687 "A few commands require a list of strings to be passed. For these, use a "
20688 "whitespace-separated list, enclosed in quotes. Strings containing "
20689 "whitespace to be passed through must be enclosed in single quotes. A "
20690 "literal single quote must be escaped with a backslash."
20694 #: ../fish/guestfish.pod:517
20697 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20698 " command \"/bin/echo 'foo bar'\"\n"
20699 " command \"/bin/echo \\'foo\\'\"\n"
20704 #: ../fish/guestfish.pod:521
20705 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
20709 #: ../fish/guestfish.pod:523
20711 "In double-quoted arguments (only) use backslash to insert special "
20716 #: ../fish/guestfish.pod:528
20721 #: ../fish/guestfish.pod:530
20722 msgid "Alert (bell) character."
20726 #: ../fish/guestfish.pod:532
20731 #: ../fish/guestfish.pod:534
20732 msgid "Backspace character."
20736 #: ../fish/guestfish.pod:536
20741 #: ../fish/guestfish.pod:538
20742 msgid "Form feed character."
20746 #: ../fish/guestfish.pod:540
20751 #: ../fish/guestfish.pod:542
20752 msgid "Newline character."
20756 #: ../fish/guestfish.pod:544
20761 #: ../fish/guestfish.pod:546
20762 msgid "Carriage return character."
20766 #: ../fish/guestfish.pod:548
20771 #: ../fish/guestfish.pod:550
20772 msgid "Horizontal tab character."
20776 #: ../fish/guestfish.pod:552
20781 #: ../fish/guestfish.pod:554
20782 msgid "Vertical tab character."
20786 #: ../fish/guestfish.pod:556
20791 #: ../fish/guestfish.pod:558
20792 msgid "A literal double quote character."
20796 #: ../fish/guestfish.pod:560
20801 #: ../fish/guestfish.pod:562
20803 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
20808 #: ../fish/guestfish.pod:565
20813 #: ../fish/guestfish.pod:567
20814 msgid "A character with hex value I<hh>. There must be precisely 2 hex digits."
20818 #: ../fish/guestfish.pod:570
20820 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
20825 #: ../fish/guestfish.pod:573
20830 #: ../fish/guestfish.pod:575
20831 msgid "A literal backslash character."
20835 #: ../fish/guestfish.pod:579
20836 msgid "OPTIONAL ARGUMENTS"
20840 #: ../fish/guestfish.pod:581
20842 "Some commands take optional arguments. These arguments appear in this "
20843 "documentation as C<[argname:..]>. You can use them as in these examples:"
20847 #: ../fish/guestfish.pod:585
20850 " add-drive-opts filename\n"
20855 #: ../fish/guestfish.pod:587
20858 " add-drive-opts filename readonly:true\n"
20863 #: ../fish/guestfish.pod:589
20866 " add-drive-opts filename format:qcow2 readonly:false\n"
20871 #: ../fish/guestfish.pod:591
20873 "Each optional argument can appear at most once. All optional arguments must "
20874 "appear after the required ones."
20878 #: ../fish/guestfish.pod:594
20883 #: ../fish/guestfish.pod:596
20884 msgid "This section applies to all commands which can take integers as parameters."
20888 #: ../fish/guestfish.pod:599
20889 msgid "SIZE SUFFIX"
20893 #: ../fish/guestfish.pod:601
20895 "When the command takes a parameter measured in bytes, you can use one of the "
20896 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20900 #: ../fish/guestfish.pod:607
20901 msgid "B<k> or B<K> or B<KiB>"
20905 #: ../fish/guestfish.pod:609
20906 msgid "The size in kilobytes (multiplied by 1024)."
20910 #: ../fish/guestfish.pod:611
20915 #: ../fish/guestfish.pod:613
20916 msgid "The size in SI 1000 byte units."
20920 #: ../fish/guestfish.pod:615
20921 msgid "B<M> or B<MiB>"
20925 #: ../fish/guestfish.pod:617
20926 msgid "The size in megabytes (multiplied by 1048576)."
20930 #: ../fish/guestfish.pod:619
20935 #: ../fish/guestfish.pod:621
20936 msgid "The size in SI 1000000 byte units."
20940 #: ../fish/guestfish.pod:623
20941 msgid "B<G> or B<GiB>"
20945 #: ../fish/guestfish.pod:625
20946 msgid "The size in gigabytes (multiplied by 2**30)."
20950 #: ../fish/guestfish.pod:627
20955 #: ../fish/guestfish.pod:629
20956 msgid "The size in SI 10**9 byte units."
20960 #: ../fish/guestfish.pod:631
20961 msgid "B<T> or B<TiB>"
20965 #: ../fish/guestfish.pod:633
20966 msgid "The size in terabytes (multiplied by 2**40)."
20970 #: ../fish/guestfish.pod:635
20975 #: ../fish/guestfish.pod:637
20976 msgid "The size in SI 10**12 byte units."
20980 #: ../fish/guestfish.pod:639
20981 msgid "B<P> or B<PiB>"
20985 #: ../fish/guestfish.pod:641
20986 msgid "The size in petabytes (multiplied by 2**50)."
20990 #: ../fish/guestfish.pod:643
20995 #: ../fish/guestfish.pod:645
20996 msgid "The size in SI 10**15 byte units."
21000 #: ../fish/guestfish.pod:647
21001 msgid "B<E> or B<EiB>"
21005 #: ../fish/guestfish.pod:649
21006 msgid "The size in exabytes (multiplied by 2**60)."
21010 #: ../fish/guestfish.pod:651
21015 #: ../fish/guestfish.pod:653
21016 msgid "The size in SI 10**18 byte units."
21020 #: ../fish/guestfish.pod:655
21021 msgid "B<Z> or B<ZiB>"
21025 #: ../fish/guestfish.pod:657
21026 msgid "The size in zettabytes (multiplied by 2**70)."
21030 #: ../fish/guestfish.pod:659
21035 #: ../fish/guestfish.pod:661
21036 msgid "The size in SI 10**21 byte units."
21040 #: ../fish/guestfish.pod:663
21041 msgid "B<Y> or B<YiB>"
21045 #: ../fish/guestfish.pod:665
21046 msgid "The size in yottabytes (multiplied by 2**80)."
21050 #: ../fish/guestfish.pod:667
21055 #: ../fish/guestfish.pod:669
21056 msgid "The size in SI 10**24 byte units."
21060 #: ../fish/guestfish.pod:675
21063 " truncate-size /file 1G\n"
21068 #: ../fish/guestfish.pod:677
21069 msgid "would truncate the file to 1 gigabyte."
21073 #: ../fish/guestfish.pod:679
21075 "Be careful because a few commands take sizes in kilobytes or megabytes "
21076 "(eg. the parameter to L</memsize> is specified in megabytes already). "
21077 "Adding a suffix will probably not do what you expect."
21081 #: ../fish/guestfish.pod:683
21082 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21086 #: ../fish/guestfish.pod:685
21088 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21089 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21093 #: ../fish/guestfish.pod:688
21096 " 1234 decimal number 1234\n"
21097 " 02322 octal number, equivalent to decimal 1234\n"
21098 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21103 #: ../fish/guestfish.pod:692
21105 "When using the C<chmod> command, you almost always want to specify an octal "
21106 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21107 "L<chmod(1)> program):"
21111 #: ../fish/guestfish.pod:696
21114 " chmod 0777 /public # OK\n"
21115 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21120 #: ../fish/guestfish.pod:699
21122 "Commands that return numbers usually print them in decimal, but some "
21123 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21124 "octal, preceeded by C<0>)."
21128 #: ../fish/guestfish.pod:703
21129 msgid "WILDCARDS AND GLOBBING"
21133 #: ../fish/guestfish.pod:705
21135 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21136 "(globbing) by default. So for example the following will not do what you "
21141 #: ../fish/guestfish.pod:709
21149 #: ../fish/guestfish.pod:711
21151 "Assuming you don't have a directory called literally C</home/*> then the "
21152 "above command will return an error."
21156 #: ../fish/guestfish.pod:714
21157 msgid "To perform wildcard expansion, use the C<glob> command."
21161 #: ../fish/guestfish.pod:716
21164 " glob rm-rf /home/*\n"
21169 #: ../fish/guestfish.pod:718
21171 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21172 "many times), equivalent to:"
21176 #: ../fish/guestfish.pod:721
21179 " rm-rf /home/jim\n"
21180 " rm-rf /home/joe\n"
21181 " rm-rf /home/mary\n"
21186 #: ../fish/guestfish.pod:725
21187 msgid "C<glob> only works on simple guest paths and not on device names."
21191 #: ../fish/guestfish.pod:727
21193 "If you have several parameters, each containing a wildcard, then glob will "
21194 "perform a Cartesian product."
21198 #: ../fish/guestfish.pod:730
21203 #: ../fish/guestfish.pod:732
21205 "Any line which starts with a I<#> character is treated as a comment and "
21206 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
21207 "a command. For example:"
21211 #: ../fish/guestfish.pod:736
21214 " # this is a comment\n"
21215 " # this is a comment\n"
21216 " foo # NOT a comment\n"
21221 #: ../fish/guestfish.pod:740
21222 msgid "Blank lines are also ignored."
21226 #: ../fish/guestfish.pod:742
21227 msgid "RUNNING COMMANDS LOCALLY"
21231 #: ../fish/guestfish.pod:744
21233 "Any line which starts with a I<!> character is treated as a command sent to "
21234 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
21238 #: ../fish/guestfish.pod:748
21242 " tgz-out /remote local/remote-data.tar.gz\n"
21247 #: ../fish/guestfish.pod:751
21249 "will create a directory C<local> on the host, and then export the contents "
21250 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
21251 "(See C<tgz-out>)."
21255 #: ../fish/guestfish.pod:755
21257 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
21258 "effect, due to the way that subprocesses work in Unix."
21262 #: ../fish/guestfish.pod:758
21263 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
21267 #: ../fish/guestfish.pod:760
21269 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
21270 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
21271 "and executed as guestfish commands."
21275 #: ../fish/guestfish.pod:764
21277 "Thus you can use shell script to construct arbitrary guestfish commands "
21278 "which are then parsed by guestfish."
21282 #: ../fish/guestfish.pod:767
21284 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
21285 "through C</foo.100>) using guestfish commands alone. However this is simple "
21286 "if we use a shell script to create the guestfish commands for us:"
21290 #: ../fish/guestfish.pod:772
21293 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
21298 #: ../fish/guestfish.pod:774
21299 msgid "or with names like C</foo.001>:"
21303 #: ../fish/guestfish.pod:776
21306 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
21311 #: ../fish/guestfish.pod:778
21313 "When using guestfish interactively it can be helpful to just run the shell "
21314 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21315 "ordinary I<!> local command), see what guestfish commands it would run, and "
21316 "when you are happy with those prepend the C<E<lt>> character to run the "
21317 "guestfish commands for real."
21321 #: ../fish/guestfish.pod:784
21326 #: ../fish/guestfish.pod:786
21328 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21329 "command (a guestfish command) to the second command (any host command). For "
21334 #: ../fish/guestfish.pod:790
21337 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21342 #: ../fish/guestfish.pod:792
21344 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21345 "program). The above command would list all accounts in the guest filesystem "
21346 "which have UID 0, ie. root accounts including backdoors. Other examples:"
21350 #: ../fish/guestfish.pod:797
21353 " hexdump /bin/ls | head\n"
21354 " list-devices | tail -1\n"
21355 " tgz-out / - | tar ztf -\n"
21360 #: ../fish/guestfish.pod:801
21362 "The space before the pipe symbol is required, any space after the pipe "
21363 "symbol is optional. Everything after the pipe symbol is just passed "
21364 "straight to the host shell, so it can contain redirections, globs and "
21365 "anything else that makes sense on the host side."
21369 #: ../fish/guestfish.pod:806
21371 "To use a literal argument which begins with a pipe symbol, you have to quote "
21376 #: ../fish/guestfish.pod:809
21384 #: ../fish/guestfish.pod:811
21385 msgid "HOME DIRECTORIES"
21389 #: ../fish/guestfish.pod:813
21391 "If a parameter starts with the character C<~> then the tilde may be expanded "
21392 "as a home directory path (either C<~> for the current user's home directory, "
21393 "or C<~user> for another user)."
21397 #: ../fish/guestfish.pod:817
21399 "Note that home directory expansion happens for users known I<on the host>, "
21400 "not in the guest filesystem."
21404 #: ../fish/guestfish.pod:820
21406 "To use a literal argument which begins with a tilde, you have to quote it, "
21411 #: ../fish/guestfish.pod:823
21419 #: ../fish/guestfish.pod:827
21421 "Libguestfs has some support for Linux guests encrypted according to the "
21422 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
21423 "disk encryption systems used by modern Linux guests. Currently only "
21424 "LVM-on-LUKS is supported."
21428 #: ../fish/guestfish.pod:832
21429 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
21433 #: ../fish/guestfish.pod:834
21436 " ><fs> vfs-type /dev/sda2\n"
21442 #: ../fish/guestfish.pod:837
21444 "Then open those devices using L</luks-open>. This creates a device-mapper "
21445 "device called C</dev/mapper/luksdev>."
21449 #: ../fish/guestfish.pod:840
21452 " ><fs> luks-open /dev/sda2 luksdev\n"
21453 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
21458 #: ../fish/guestfish.pod:843
21460 "Finally you have to tell LVM to scan for volume groups on the newly created "
21465 #: ../fish/guestfish.pod:846
21469 " vg-activate-all true\n"
21474 #: ../fish/guestfish.pod:849
21475 msgid "The logical volume(s) can now be mounted in the usual way."
21479 #: ../fish/guestfish.pod:851
21481 "Before closing a LUKS device you must unmount any logical volumes on it and "
21482 "deactivate the volume groups by calling C<vg-activate false VG> on each "
21483 "one. Then you can close the mapper device:"
21487 #: ../fish/guestfish.pod:855
21490 " vg-activate false /dev/VG\n"
21491 " luks-close /dev/mapper/luksdev\n"
21496 #: ../fish/guestfish.pod:858
21497 msgid "WINDOWS PATHS"
21501 #: ../fish/guestfish.pod:860
21503 "If a path is prefixed with C<win:> then you can use Windows-style drive "
21504 "letters and paths (with some limitations). The following commands are "
21509 #: ../fish/guestfish.pod:864
21512 " file /WINDOWS/system32/config/system.LOG\n"
21517 #: ../fish/guestfish.pod:866
21520 " file win:\\windows\\system32\\config\\system.log\n"
21525 #: ../fish/guestfish.pod:868
21528 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
21533 #: ../fish/guestfish.pod:870
21535 "The parameter is rewritten \"behind the scenes\" by looking up the position "
21536 "where the drive is mounted, prepending that to the path, changing all "
21537 "backslash characters to forward slash, then resolving the result using "
21538 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
21539 "then the parameter might be rewritten like this:"
21543 #: ../fish/guestfish.pod:876
21546 " win:e:\\foo\\bar => /e/FOO/bar\n"
21551 #: ../fish/guestfish.pod:878
21552 msgid "This only works in argument positions that expect a path."
21556 #: ../fish/guestfish.pod:880
21557 msgid "UPLOADING AND DOWNLOADING FILES"
21561 #: ../fish/guestfish.pod:882
21563 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
21564 "others which upload from or download to a local file, you can use the "
21565 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
21569 #: ../fish/guestfish.pod:886
21577 #: ../fish/guestfish.pod:888
21578 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
21582 #: ../fish/guestfish.pod:891
21585 " tar-out /etc - | tar tf -\n"
21590 #: ../fish/guestfish.pod:893
21592 "writes the tarball to stdout and then pipes that into the external \"tar\" "
21593 "command (see L</PIPES>)."
21597 #: ../fish/guestfish.pod:896
21599 "When using C<-> to read from stdin, the input is read up to the end of "
21600 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
21601 "some arbitrary end marker:"
21605 #: ../fish/guestfish.pod:900
21608 " upload -<<END /foo\n"
21617 #: ../fish/guestfish.pod:906
21619 "Any string of characters can be used instead of C<END>. The end marker must "
21620 "appear on a line of its own, without any preceeding or following characters "
21621 "(not even spaces)."
21625 #: ../fish/guestfish.pod:910
21627 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
21628 "upload local files (so-called \"FileIn\" parameters in the generator)."
21632 #: ../fish/guestfish.pod:913
21633 msgid "EXIT ON ERROR BEHAVIOUR"
21637 #: ../fish/guestfish.pod:915
21639 "By default, guestfish will ignore any errors when in interactive mode "
21640 "(ie. taking commands from a human over a tty), and will exit on the first "
21641 "error in non-interactive mode (scripts, commands given on the command line)."
21645 #: ../fish/guestfish.pod:920
21647 "If you prefix a command with a I<-> character, then that command will not "
21648 "cause guestfish to exit, even if that (one) command returns an error."
21652 #: ../fish/guestfish.pod:924
21653 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21657 #: ../fish/guestfish.pod:926
21659 "Guestfish can be remote-controlled over a socket. This is useful "
21660 "particularly in shell scripts where you want to make several different "
21661 "changes to a filesystem, but you don't want the overhead of starting up a "
21662 "guestfish process each time."
21666 #: ../fish/guestfish.pod:931
21667 msgid "Start a guestfish server process using:"
21671 #: ../fish/guestfish.pod:933
21674 " eval \"`guestfish --listen`\"\n"
21679 #: ../fish/guestfish.pod:935
21680 msgid "and then send it commands by doing:"
21684 #: ../fish/guestfish.pod:937
21687 " guestfish --remote cmd [...]\n"
21692 #: ../fish/guestfish.pod:939
21693 msgid "To cause the server to exit, send it the exit command:"
21697 #: ../fish/guestfish.pod:941
21700 " guestfish --remote exit\n"
21705 #: ../fish/guestfish.pod:943
21707 "Note that the server will normally exit if there is an error in a command. "
21708 "You can change this in the usual way. See section L</EXIT ON ERROR "
21713 #: ../fish/guestfish.pod:947
21714 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21718 #: ../fish/guestfish.pod:949
21720 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21721 "is how the I<--remote> option knows where to send the commands. You can "
21722 "have several guestfish listener processes running using:"
21726 #: ../fish/guestfish.pod:953
21729 " eval \"`guestfish --listen`\"\n"
21730 " pid1=$GUESTFISH_PID\n"
21731 " eval \"`guestfish --listen`\"\n"
21732 " pid2=$GUESTFISH_PID\n"
21734 " guestfish --remote=$pid1 cmd\n"
21735 " guestfish --remote=$pid2 cmd\n"
21740 #: ../fish/guestfish.pod:961
21741 msgid "REMOTE CONTROL AND CSH"
21745 #: ../fish/guestfish.pod:963
21747 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21752 #: ../fish/guestfish.pod:966
21755 " eval \"`guestfish --listen --csh`\"\n"
21760 #: ../fish/guestfish.pod:968
21761 msgid "REMOTE CONTROL DETAILS"
21765 #: ../fish/guestfish.pod:970
21767 "Remote control happens over a Unix domain socket called "
21768 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
21769 "of the process, and C<$PID> is the process ID of the server."
21773 #: ../fish/guestfish.pod:974
21774 msgid "Guestfish client and server versions must match exactly."
21778 #: ../fish/guestfish.pod:976
21779 msgid "PREPARED DISK IMAGES"
21783 #: ../fish/guestfish.pod:978
21785 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21786 "preformatted disk images that guestfish can make for you to save typing. "
21787 "This is particularly useful for testing purposes. This option is used "
21788 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21789 "can be mixed with I<-a>)."
21793 #: ../fish/guestfish.pod:984
21795 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21796 "the second and so on. Existing files in the current directory are "
21801 #: ../fish/guestfish.pod:988
21803 "The type briefly describes how the disk should be sized, partitioned, how "
21804 "filesystem(s) should be created, and how content should be added. "
21805 "Optionally the type can be followed by extra parameters, separated by C<:> "
21806 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
21807 "sparsely-allocated disk, containing a single partition, with the partition "
21808 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
21809 "on a 1GB disk instead."
21813 #: ../fish/guestfish.pod:996
21814 msgid "To list the available types and any extra parameters they take, run:"
21818 #: ../fish/guestfish.pod:1000
21820 "Note that the prepared filesystem is not mounted. You would usually have to "
21821 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21825 #: ../fish/guestfish.pod:1004
21827 "If any I<-N> or I<--new> options are given, the guest is automatically "
21832 #: ../fish/guestfish.pod:1009
21833 msgid "Create a 100MB disk with an ext4-formatted partition:"
21837 #: ../fish/guestfish.pod:1011
21840 " guestfish -N fs:ext4\n"
21845 #: ../fish/guestfish.pod:1013
21846 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21850 #: ../fish/guestfish.pod:1015
21853 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21858 #: ../fish/guestfish.pod:1017
21859 msgid "Create a blank 200MB disk:"
21863 #: ../fish/guestfish.pod:1019
21866 " guestfish -N disk:200M\n"
21871 #: ../fish/guestfish.pod:1021
21872 msgid "PROGRESS BARS"
21876 #: ../fish/guestfish.pod:1023
21878 "Some (not all) long-running commands send progress notification messages as "
21879 "they are running. Guestfish turns these messages into progress bars."
21883 #: ../fish/guestfish.pod:1027
21885 "When a command that supports progress bars takes longer than two seconds to "
21886 "run, and if progress bars are enabled, then you will see one appearing below "
21891 #: ../fish/guestfish.pod:1031
21894 " ><fs> copy-size /large-file /another-file 2048M\n"
21895 " / 10% [#####-----------------------------------------] 00:30\n"
21900 #: ../fish/guestfish.pod:1034
21902 "The spinner on the left hand side moves round once for every progress "
21903 "notification received from the backend. This is a (reasonably) golden "
21904 "assurance that the command is \"doing something\" even if the progress bar "
21905 "is not moving, because the command is able to send the progress "
21906 "notifications. When the bar reaches 100% and the command finishes, the "
21907 "spinner disappears."
21911 #: ../fish/guestfish.pod:1041
21913 "Progress bars are enabled by default when guestfish is used interactively. "
21914 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21915 "and you can disable them completely using I<--no-progress-bars>."
21919 #: ../fish/guestfish.pod:1046
21920 msgid "GUESTFISH COMMANDS"
21924 #: ../fish/guestfish.pod:1048
21926 "The commands in this section are guestfish convenience commands, in other "
21927 "words, they are not part of the L<guestfs(3)> API."
21931 #: ../fish/guestfish.pod:1051
21936 #: ../fish/guestfish.pod:1053
21945 #: ../fish/guestfish.pod:1056
21946 msgid "Without any parameter, this provides general help."
21950 #: ../fish/guestfish.pod:1058
21951 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21955 #: ../fish/guestfish.pod:1060
21956 msgid "quit | exit"
21960 #: ../fish/guestfish.pod:1062
21961 msgid "This exits guestfish. You can also use C<^D> key."
21965 #: ../fish/guestfish.pod:1064
21966 msgid "@FISH_COMMANDS@"
21970 #: ../fish/guestfish.pod:1066
21975 #: ../fish/guestfish.pod:1070 ../test-tool/libguestfs-test-tool.pod:77
21980 #: ../fish/guestfish.pod:1072
21982 "guestfish returns 0 if the commands completed without error, or 1 if there "
21987 #: ../fish/guestfish.pod:1079
21992 #: ../fish/guestfish.pod:1081
21994 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21999 #: ../fish/guestfish.pod:1084
22000 msgid "GUESTFISH_DISPLAY_IMAGE"
22004 #: ../fish/guestfish.pod:1086
22006 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
22007 "If not set, it uses L<display(1)>."
22011 #: ../fish/guestfish.pod:1089
22012 msgid "GUESTFISH_PID"
22016 #: ../fish/guestfish.pod:1091
22018 "Used with the I<--remote> option to specify the remote guestfish process to "
22019 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22023 #: ../fish/guestfish.pod:1095
22028 #: ../fish/guestfish.pod:1097
22030 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22031 "not specified, the external L<hexedit(1)> program is used."
22035 #: ../fish/guestfish.pod:1101
22040 #: ../fish/guestfish.pod:1103
22042 "If compiled with GNU readline support, various files in the home directory "
22043 "can be used. See L</FILES>."
22047 #: ../fish/guestfish.pod:1112
22049 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22050 "effect as using the B<-v> option."
22054 #: ../fish/guestfish.pod:1124
22056 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22057 "the discussion of paths in L<guestfs(3)>."
22061 #: ../fish/guestfish.pod:1135
22062 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22066 #: ../fish/guestfish.pod:1137
22071 #: ../fish/guestfish.pod:1139
22073 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22078 #: ../fish/guestfish.pod:1155 ../fuse/guestmount.pod:264
22083 #: ../fish/guestfish.pod:1159 ../fuse/guestmount.pod:268
22084 msgid "$HOME/.libguestfs-tools.rc"
22088 #: ../fish/guestfish.pod:1161 ../fuse/guestmount.pod:270
22089 msgid "/etc/libguestfs-tools.conf"
22093 #: ../fish/guestfish.pod:1163 ../fuse/guestmount.pod:272
22095 "This configuration file controls the default read-only or read-write mode "
22096 "(I<--ro> or I<--rw>)."
22100 #: ../fish/guestfish.pod:1166
22101 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
22105 #: ../fish/guestfish.pod:1168
22106 msgid "$HOME/.guestfish"
22110 #: ../fish/guestfish.pod:1170
22112 "If compiled with GNU readline support, then the command history is saved in "
22117 #: ../fish/guestfish.pod:1173
22118 msgid "$HOME/.inputrc"
22122 #: ../fish/guestfish.pod:1175
22123 msgid "/etc/inputrc"
22127 #: ../fish/guestfish.pod:1177
22129 "If compiled with GNU readline support, then these files can be used to "
22130 "configure readline. For further information, please see "
22131 "L<readline(3)/INITIALIZATION FILE>."
22135 #: ../fish/guestfish.pod:1181
22136 msgid "To write rules which only apply to guestfish, use:"
22140 #: ../fish/guestfish.pod:1183
22150 #: ../fish/guestfish.pod:1187
22152 "Variables that you can set in inputrc that change the behaviour of guestfish "
22153 "in useful ways include:"
22157 #: ../fish/guestfish.pod:1192
22158 msgid "completion-ignore-case (default: on)"
22162 #: ../fish/guestfish.pod:1194
22164 "By default, guestfish will ignore case when tab-completing paths on the "
22169 #: ../fish/guestfish.pod:1197
22172 " set completion-ignore-case off\n"
22177 #: ../fish/guestfish.pod:1199
22178 msgid "to make guestfish case sensitive."
22182 #: ../fish/guestfish.pod:1203
22187 #: ../fish/guestfish.pod:1205
22188 msgid "test2.img (etc)"
22192 #: ../fish/guestfish.pod:1207
22194 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
22195 "will be created in the file C<test1.img> in the current directory. The "
22196 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
22197 "the same name will be overwritten."
22201 #: ../fish/guestfish.pod:1216
22203 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
22204 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
22205 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
22206 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
22207 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
22208 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>."
22212 #: ../fish/guestfish.pod:1247 ../test-tool/libguestfs-test-tool.pod:102 ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
22214 "This program is free software; you can redistribute it and/or modify it "
22215 "under the terms of the GNU General Public License as published by the Free "
22216 "Software Foundation; either version 2 of the License, or (at your option) "
22217 "any later version."
22221 #: ../fish/guestfish.pod:1252 ../test-tool/libguestfs-test-tool.pod:107 ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
22223 "This program is distributed in the hope that it will be useful, but WITHOUT "
22224 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
22225 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
22230 #: ../fish/guestfish.pod:1257 ../test-tool/libguestfs-test-tool.pod:112 ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319 ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
22232 "You should have received a copy of the GNU General Public License along with "
22233 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
22234 "Ave, Cambridge, MA 02139, USA."
22238 #: ../fish/guestfish-actions.pod:1
22243 #: ../fish/guestfish-actions.pod:3
22246 " add-cdrom filename\n"
22251 #: ../fish/guestfish-actions.pod:15
22253 "This call checks for the existence of C<filename>. This stops you from "
22254 "specifying other types of drive which are supported by qemu such as C<nbd:> "
22255 "and C<http:> URLs. To specify those, use the general L</config> call "
22260 #: ../fish/guestfish-actions.pod:22
22262 "If you just want to add an ISO file (often you use this as an efficient way "
22263 "to transfer large files into the guest), then you should probably use "
22264 "L</add-drive-ro> instead."
22268 #: ../fish/guestfish-actions.pod:35
22273 #: ../fish/guestfish-actions.pod:37
22278 #: ../fish/guestfish-actions.pod:39
22281 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
22287 #: ../fish/guestfish-actions.pod:41
22289 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
22290 "It works by connecting to libvirt, requesting the domain and domain XML from "
22291 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
22295 #: ../fish/guestfish-actions.pod:76
22297 "The other optional parameters are passed directly through to "
22298 "L</add-drive-opts>."
22302 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1968 ../fish/guestfish-actions.pod:3134 ../fish/guestfish-actions.pod:3307 ../fish/guestfish-actions.pod:3442
22304 "This command has one or more optional arguments. See L</OPTIONAL "
22309 #: ../fish/guestfish-actions.pod:81
22314 #: ../fish/guestfish-actions.pod:83
22317 " add-drive filename\n"
22322 #: ../fish/guestfish-actions.pod:85
22324 "This function is the equivalent of calling L</add-drive-opts> with no "
22325 "optional parameters, so the disk is added writable, with the format being "
22326 "detected automatically."
22330 #: ../fish/guestfish-actions.pod:89
22332 "Automatic detection of the format opens you up to a potential security hole "
22333 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22334 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22335 "you should think about replacing calls to this function with calls to "
22336 "L</add-drive-opts>, and specifying the format."
22340 #: ../fish/guestfish-actions.pod:96
22341 msgid "add-drive-opts"
22345 #: ../fish/guestfish-actions.pod:98
22350 #: ../fish/guestfish-actions.pod:100
22353 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22358 #: ../fish/guestfish-actions.pod:127
22360 "This forces the image format. If you omit this (or use L</add-drive> or "
22361 "L</add-drive-ro>) then the format is automatically detected. Possible "
22362 "formats include C<raw> and C<qcow2>."
22366 #: ../fish/guestfish-actions.pod:138
22368 "This rarely-used option lets you emulate the behaviour of the deprecated "
22369 "L</add-drive-with-if> call (q.v.)"
22373 #: ../fish/guestfish-actions.pod:145
22374 msgid "add-drive-ro"
22378 #: ../fish/guestfish-actions.pod:147
22383 #: ../fish/guestfish-actions.pod:149
22386 " add-drive-ro filename\n"
22391 #: ../fish/guestfish-actions.pod:151
22393 "This function is the equivalent of calling L</add-drive-opts> with the "
22394 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22395 "is added read-only, with the format being detected automatically."
22399 #: ../fish/guestfish-actions.pod:156
22400 msgid "add-drive-ro-with-if"
22404 #: ../fish/guestfish-actions.pod:158
22407 " add-drive-ro-with-if filename iface\n"
22412 #: ../fish/guestfish-actions.pod:160
22414 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
22415 "interface emulation to use at run time."
22419 #: ../fish/guestfish-actions.pod:170
22420 msgid "add-drive-with-if"
22424 #: ../fish/guestfish-actions.pod:172
22427 " add-drive-with-if filename iface\n"
22432 #: ../fish/guestfish-actions.pod:174
22434 "This is the same as L</add-drive> but it allows you to specify the QEMU "
22435 "interface emulation to use at run time."
22439 #: ../fish/guestfish-actions.pod:184
22444 #: ../fish/guestfish-actions.pod:186
22447 " aug-clear augpath\n"
22452 #: ../fish/guestfish-actions.pod:191
22457 #: ../fish/guestfish-actions.pod:193
22465 #: ../fish/guestfish-actions.pod:195
22467 "Close the current Augeas handle and free up any resources used by it. After "
22468 "calling this, you have to call L</aug-init> again before you can use any "
22469 "other Augeas functions."
22473 #: ../fish/guestfish-actions.pod:200
22474 msgid "aug-defnode"
22478 #: ../fish/guestfish-actions.pod:202
22481 " aug-defnode name expr val\n"
22486 #: ../fish/guestfish-actions.pod:207
22488 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22489 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
22490 "containing that single node."
22494 #: ../fish/guestfish-actions.pod:215
22499 #: ../fish/guestfish-actions.pod:217
22502 " aug-defvar name expr\n"
22507 #: ../fish/guestfish-actions.pod:226
22512 #: ../fish/guestfish-actions.pod:228
22515 " aug-get augpath\n"
22520 #: ../fish/guestfish-actions.pod:233
22525 #: ../fish/guestfish-actions.pod:235
22528 " aug-init root flags\n"
22533 #: ../fish/guestfish-actions.pod:241
22534 msgid "You must call this before using any other L</aug-*> commands."
22538 #: ../fish/guestfish-actions.pod:276
22539 msgid "Do not load the tree in L</aug-init>."
22543 #: ../fish/guestfish-actions.pod:280
22544 msgid "To close the handle, you can call L</aug-close>."
22548 #: ../fish/guestfish-actions.pod:284
22553 #: ../fish/guestfish-actions.pod:286
22556 " aug-insert augpath label true|false\n"
22561 #: ../fish/guestfish-actions.pod:296
22566 #: ../fish/guestfish-actions.pod:298
22574 #: ../fish/guestfish-actions.pod:305
22579 #: ../fish/guestfish-actions.pod:307
22582 " aug-ls augpath\n"
22587 #: ../fish/guestfish-actions.pod:309
22589 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
22590 "resulting nodes into alphabetical order."
22594 #: ../fish/guestfish-actions.pod:312
22599 #: ../fish/guestfish-actions.pod:314
22602 " aug-match augpath\n"
22607 #: ../fish/guestfish-actions.pod:320
22612 #: ../fish/guestfish-actions.pod:322
22615 " aug-mv src dest\n"
22620 #: ../fish/guestfish-actions.pod:327
22625 #: ../fish/guestfish-actions.pod:329
22628 " aug-rm augpath\n"
22633 #: ../fish/guestfish-actions.pod:335
22638 #: ../fish/guestfish-actions.pod:337
22646 #: ../fish/guestfish-actions.pod:341
22648 "The flags which were passed to L</aug-init> affect exactly how files are "
22653 #: ../fish/guestfish-actions.pod:344
22658 #: ../fish/guestfish-actions.pod:346
22661 " aug-set augpath val\n"
22666 #: ../fish/guestfish-actions.pod:350
22668 "In the Augeas API, it is possible to clear a node by setting the value to "
22669 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22670 "this call. Instead you must use the L</aug-clear> call."
22674 #: ../fish/guestfish-actions.pod:355
22679 #: ../fish/guestfish-actions.pod:357
22682 " available 'groups ...'\n"
22687 #: ../fish/guestfish-actions.pod:363
22689 "The libguestfs groups, and the functions that those groups correspond to, "
22690 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22691 "runtime by calling L</available-all-groups>."
22695 #: ../fish/guestfish-actions.pod:387
22696 msgid "You must call L</launch> before calling this function."
22700 #: ../fish/guestfish-actions.pod:409
22702 "This call was added in version C<1.0.80>. In previous versions of "
22703 "libguestfs all you could do would be to speculatively execute a command to "
22704 "find out if the daemon implemented it. See also L</version>."
22708 #: ../fish/guestfish-actions.pod:416
22709 msgid "available-all-groups"
22713 #: ../fish/guestfish-actions.pod:418
22716 " available-all-groups\n"
22721 #: ../fish/guestfish-actions.pod:420
22723 "This command returns a list of all optional groups that this daemon knows "
22724 "about. Note this returns both supported and unsupported groups. To find "
22725 "out which ones the daemon can actually support you have to call "
22726 "L</available> on each member of the returned list."
22730 #: ../fish/guestfish-actions.pod:426
22731 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22735 #: ../fish/guestfish-actions.pod:428
22740 #: ../fish/guestfish-actions.pod:430
22743 " base64-in (base64file|-) filename\n"
22748 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444 ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862 ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255 ../fish/guestfish-actions.pod:4652 ../fish/guestfish-actions.pod:4664 ../fish/guestfish-actions.pod:4675 ../fish/guestfish-actions.pod:4686 ../fish/guestfish-actions.pod:4738 ../fish/guestfish-actions.pod:4747 ../fish/guestfish-actions.pod:4801 ../fish/guestfish-actions.pod:4824
22749 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22753 #: ../fish/guestfish-actions.pod:437
22758 #: ../fish/guestfish-actions.pod:439
22761 " base64-out filename (base64file|-)\n"
22766 #: ../fish/guestfish-actions.pod:446
22767 msgid "blockdev-flushbufs"
22771 #: ../fish/guestfish-actions.pod:448
22774 " blockdev-flushbufs device\n"
22779 #: ../fish/guestfish-actions.pod:455
22780 msgid "blockdev-getbsz"
22784 #: ../fish/guestfish-actions.pod:457
22787 " blockdev-getbsz device\n"
22792 #: ../fish/guestfish-actions.pod:466
22793 msgid "blockdev-getro"
22797 #: ../fish/guestfish-actions.pod:468
22800 " blockdev-getro device\n"
22805 #: ../fish/guestfish-actions.pod:475
22806 msgid "blockdev-getsize64"
22810 #: ../fish/guestfish-actions.pod:477
22813 " blockdev-getsize64 device\n"
22818 #: ../fish/guestfish-actions.pod:481
22819 msgid "See also L</blockdev-getsz>."
22823 #: ../fish/guestfish-actions.pod:485
22824 msgid "blockdev-getss"
22828 #: ../fish/guestfish-actions.pod:487
22831 " blockdev-getss device\n"
22836 #: ../fish/guestfish-actions.pod:492
22837 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22841 #: ../fish/guestfish-actions.pod:497
22842 msgid "blockdev-getsz"
22846 #: ../fish/guestfish-actions.pod:499
22849 " blockdev-getsz device\n"
22854 #: ../fish/guestfish-actions.pod:504
22856 "See also L</blockdev-getss> for the real sector size of the device, and "
22857 "L</blockdev-getsize64> for the more useful I<size in bytes>."
22861 #: ../fish/guestfish-actions.pod:510
22862 msgid "blockdev-rereadpt"
22866 #: ../fish/guestfish-actions.pod:512
22869 " blockdev-rereadpt device\n"
22874 #: ../fish/guestfish-actions.pod:518
22875 msgid "blockdev-setbsz"
22879 #: ../fish/guestfish-actions.pod:520
22882 " blockdev-setbsz device blocksize\n"
22887 #: ../fish/guestfish-actions.pod:529
22888 msgid "blockdev-setro"
22892 #: ../fish/guestfish-actions.pod:531
22895 " blockdev-setro device\n"
22900 #: ../fish/guestfish-actions.pod:537
22901 msgid "blockdev-setrw"
22905 #: ../fish/guestfish-actions.pod:539
22908 " blockdev-setrw device\n"
22913 #: ../fish/guestfish-actions.pod:545
22914 msgid "btrfs-filesystem-resize"
22918 #: ../fish/guestfish-actions.pod:547
22921 " btrfs-filesystem-resize mountpoint [size:..]\n"
22926 #: ../fish/guestfish-actions.pod:570
22927 msgid "case-sensitive-path"
22931 #: ../fish/guestfish-actions.pod:572
22934 " case-sensitive-path path\n"
22939 #: ../fish/guestfish-actions.pod:596
22941 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
22942 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22943 "how the directories were originally created under Windows)."
22947 #: ../fish/guestfish-actions.pod:604
22948 msgid "See also L</realpath>."
22952 #: ../fish/guestfish-actions.pod:606
22957 #: ../fish/guestfish-actions.pod:608
22965 #: ../fish/guestfish-actions.pod:612
22967 "Note that this function cannot correctly handle binary files (specifically, "
22968 "files containing C<\\0> character which is treated as end of string). For "
22969 "those you need to use the L</read-file> or L</download> functions which have "
22970 "a more complex interface."
22974 #: ../fish/guestfish-actions.pod:620
22979 #: ../fish/guestfish-actions.pod:622
22982 " checksum csumtype path\n"
22987 #: ../fish/guestfish-actions.pod:665
22988 msgid "To get the checksum for a device, use L</checksum-device>."
22992 #: ../fish/guestfish-actions.pod:667
22993 msgid "To get the checksums for many files, use L</checksums-out>."
22997 #: ../fish/guestfish-actions.pod:669
22998 msgid "checksum-device"
23002 #: ../fish/guestfish-actions.pod:671
23005 " checksum-device csumtype device\n"
23010 #: ../fish/guestfish-actions.pod:673
23012 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23013 "device named C<device>. For the types of checksums supported see the "
23014 "L</checksum> command."
23018 #: ../fish/guestfish-actions.pod:677
23019 msgid "checksums-out"
23023 #: ../fish/guestfish-actions.pod:679
23026 " checksums-out csumtype directory (sumsfile|-)\n"
23031 #: ../fish/guestfish-actions.pod:695
23036 #: ../fish/guestfish-actions.pod:697
23039 " chmod mode path\n"
23044 #: ../fish/guestfish-actions.pod:708
23049 #: ../fish/guestfish-actions.pod:710
23052 " chown owner group path\n"
23057 #: ../fish/guestfish-actions.pod:718
23062 #: ../fish/guestfish-actions.pod:720
23065 " command 'arguments ...'\n"
23070 #: ../fish/guestfish-actions.pod:727
23072 "The single parameter is an argv-style list of arguments. The first element "
23073 "is the name of the program to run. Subsequent elements are parameters. The "
23074 "list must be non-empty (ie. must contain a program name). Note that the "
23075 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
23079 #: ../fish/guestfish-actions.pod:755
23080 msgid "command-lines"
23084 #: ../fish/guestfish-actions.pod:757
23087 " command-lines 'arguments ...'\n"
23092 #: ../fish/guestfish-actions.pod:759
23093 msgid "This is the same as L</command>, but splits the result into a list of lines."
23097 #: ../fish/guestfish-actions.pod:762
23098 msgid "See also: L</sh-lines>"
23102 #: ../fish/guestfish-actions.pod:767
23107 #: ../fish/guestfish-actions.pod:769
23110 " config qemuparam qemuvalue\n"
23115 #: ../fish/guestfish-actions.pod:780
23120 #: ../fish/guestfish-actions.pod:782
23123 " copy-size src dest size\n"
23128 #: ../fish/guestfish-actions.pod:790
23133 #: ../fish/guestfish-actions.pod:792
23141 #: ../fish/guestfish-actions.pod:797
23146 #: ../fish/guestfish-actions.pod:799
23154 #: ../fish/guestfish-actions.pod:804
23159 #: ../fish/guestfish-actions.pod:806
23167 #: ../fish/guestfish-actions.pod:813
23169 "If the destination is a device, it must be as large or larger than the "
23170 "source file or device, otherwise the copy will fail. This command cannot do "
23171 "partial copies (see L</copy-size>)."
23175 #: ../fish/guestfish-actions.pod:817
23180 #: ../fish/guestfish-actions.pod:819
23188 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
23190 "This command is mostly useful for interactive sessions. It is I<not> "
23191 "intended that you try to parse the output string. Use L</statvfs> from "
23196 #: ../fish/guestfish-actions.pod:827
23201 #: ../fish/guestfish-actions.pod:829
23209 #: ../fish/guestfish-actions.pod:838
23214 #: ../fish/guestfish-actions.pod:840
23222 #: ../fish/guestfish-actions.pod:846
23224 "Another way to get the same information is to enable verbose messages with "
23225 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
23226 "before running the program."
23230 #: ../fish/guestfish-actions.pod:851
23235 #: ../fish/guestfish-actions.pod:853
23238 " download remotefilename (filename|-)\n"
23243 #: ../fish/guestfish-actions.pod:860
23244 msgid "See also L</upload>, L</cat>."
23248 #: ../fish/guestfish-actions.pod:864
23249 msgid "download-offset"
23253 #: ../fish/guestfish-actions.pod:866
23256 " download-offset remotefilename (filename|-) offset size\n"
23261 #: ../fish/guestfish-actions.pod:874
23263 "Note that there is no limit on the amount of data that can be downloaded "
23264 "with this call, unlike with L</pread>, and this call always reads the full "
23265 "amount unless an error occurs."
23269 #: ../fish/guestfish-actions.pod:879
23270 msgid "See also L</download>, L</pread>."
23274 #: ../fish/guestfish-actions.pod:883
23275 msgid "drop-caches"
23279 #: ../fish/guestfish-actions.pod:885
23282 " drop-caches whattodrop\n"
23287 #: ../fish/guestfish-actions.pod:897
23292 #: ../fish/guestfish-actions.pod:899
23300 #: ../fish/guestfish-actions.pod:911
23305 #: ../fish/guestfish-actions.pod:913
23308 " e2fsck-f device\n"
23313 #: ../fish/guestfish-actions.pod:919
23315 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23316 "should use L</fsck>."
23320 #: ../fish/guestfish-actions.pod:922
23321 msgid "echo-daemon"
23325 #: ../fish/guestfish-actions.pod:924
23328 " echo-daemon 'words ...'\n"
23333 #: ../fish/guestfish-actions.pod:931
23334 msgid "See also L</ping-daemon>."
23338 #: ../fish/guestfish-actions.pod:933
23343 #: ../fish/guestfish-actions.pod:935
23346 " egrep regex path\n"
23351 #: ../fish/guestfish-actions.pod:943
23356 #: ../fish/guestfish-actions.pod:945
23359 " egrepi regex path\n"
23364 #: ../fish/guestfish-actions.pod:953
23369 #: ../fish/guestfish-actions.pod:955
23372 " equal file1 file2\n"
23377 #: ../fish/guestfish-actions.pod:962
23382 #: ../fish/guestfish-actions.pod:964
23390 #: ../fish/guestfish-actions.pod:969
23391 msgid "See also L</is-file>, L</is-dir>, L</stat>."
23395 #: ../fish/guestfish-actions.pod:971
23400 #: ../fish/guestfish-actions.pod:973
23403 " fallocate path len\n"
23408 #: ../fish/guestfish-actions.pod:990
23409 msgid "fallocate64"
23413 #: ../fish/guestfish-actions.pod:992
23416 " fallocate64 path len\n"
23421 #: ../fish/guestfish-actions.pod:998
23423 "Note that this call allocates disk blocks for the file. To create a sparse "
23424 "file use L</truncate-size> instead."
23428 #: ../fish/guestfish-actions.pod:1001
23430 "The deprecated call L</fallocate> does the same, but owing to an oversight "
23431 "it only allowed 30 bit lengths to be specified, effectively limiting the "
23432 "maximum size of files created through that call to 1GB."
23436 #: ../fish/guestfish-actions.pod:1010
23441 #: ../fish/guestfish-actions.pod:1012
23444 " fgrep pattern path\n"
23449 #: ../fish/guestfish-actions.pod:1020
23454 #: ../fish/guestfish-actions.pod:1022
23457 " fgrepi pattern path\n"
23462 #: ../fish/guestfish-actions.pod:1030
23467 #: ../fish/guestfish-actions.pod:1032
23475 #: ../fish/guestfish-actions.pod:1048
23477 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
23478 "(etc), L</is-zero>."
23482 #: ../fish/guestfish-actions.pod:1051
23483 msgid "file-architecture"
23487 #: ../fish/guestfish-actions.pod:1053
23490 " file-architecture filename\n"
23495 #: ../fish/guestfish-actions.pod:1156
23500 #: ../fish/guestfish-actions.pod:1158
23508 #: ../fish/guestfish-actions.pod:1162
23510 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
23511 "L</is-file> etc. To get the size of block devices, use "
23512 "L</blockdev-getsize64>."
23516 #: ../fish/guestfish-actions.pod:1166
23521 #: ../fish/guestfish-actions.pod:1168
23524 " fill c len path\n"
23529 #: ../fish/guestfish-actions.pod:1174
23531 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23532 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
23533 "L</fill-pattern>."
23537 #: ../fish/guestfish-actions.pod:1179
23538 msgid "fill-pattern"
23542 #: ../fish/guestfish-actions.pod:1181
23545 " fill-pattern pattern len path\n"
23550 #: ../fish/guestfish-actions.pod:1183
23552 "This function is like L</fill> except that it creates a new file of length "
23553 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
23554 "is truncated if necessary to ensure the length of the file is exactly C<len> "
23559 #: ../fish/guestfish-actions.pod:1188
23564 #: ../fish/guestfish-actions.pod:1190
23567 " find directory\n"
23572 #: ../fish/guestfish-actions.pod:1204
23573 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
23577 #: ../fish/guestfish-actions.pod:1217
23578 msgid "See also L</find0>."
23582 #: ../fish/guestfish-actions.pod:1222
23587 #: ../fish/guestfish-actions.pod:1224
23590 " find0 directory (files|-)\n"
23595 #: ../fish/guestfish-actions.pod:1230
23596 msgid "This command works the same way as L</find> with the following exceptions:"
23600 #: ../fish/guestfish-actions.pod:1257
23601 msgid "findfs-label"
23605 #: ../fish/guestfish-actions.pod:1259
23608 " findfs-label label\n"
23613 #: ../fish/guestfish-actions.pod:1265
23614 msgid "To find the label of a filesystem, use L</vfs-label>."
23618 #: ../fish/guestfish-actions.pod:1267
23619 msgid "findfs-uuid"
23623 #: ../fish/guestfish-actions.pod:1269
23626 " findfs-uuid uuid\n"
23631 #: ../fish/guestfish-actions.pod:1275
23632 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
23636 #: ../fish/guestfish-actions.pod:1277
23641 #: ../fish/guestfish-actions.pod:1279
23644 " fsck fstype device\n"
23649 #: ../fish/guestfish-actions.pod:1309
23654 #: ../fish/guestfish-actions.pod:1311
23662 #: ../fish/guestfish-actions.pod:1318
23663 msgid "get-attach-method"
23667 #: ../fish/guestfish-actions.pod:1320
23670 " get-attach-method\n"
23675 #: ../fish/guestfish-actions.pod:1322
23676 msgid "Return the current attach method. See L</set-attach-method>."
23680 #: ../fish/guestfish-actions.pod:1324
23681 msgid "get-autosync"
23685 #: ../fish/guestfish-actions.pod:1326
23693 #: ../fish/guestfish-actions.pod:1330
23698 #: ../fish/guestfish-actions.pod:1332
23706 #: ../fish/guestfish-actions.pod:1336
23707 msgid "get-e2label"
23711 #: ../fish/guestfish-actions.pod:1338
23714 " get-e2label device\n"
23719 #: ../fish/guestfish-actions.pod:1350
23724 #: ../fish/guestfish-actions.pod:1352
23727 " get-e2uuid device\n"
23732 #: ../fish/guestfish-actions.pod:1364
23733 msgid "get-memsize"
23737 #: ../fish/guestfish-actions.pod:1366
23745 #: ../fish/guestfish-actions.pod:1371
23747 "If L</set-memsize> was not called on this handle, and if "
23748 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23749 "value for memsize."
23753 #: ../fish/guestfish-actions.pod:1378
23754 msgid "get-network"
23758 #: ../fish/guestfish-actions.pod:1380
23766 #: ../fish/guestfish-actions.pod:1384
23771 #: ../fish/guestfish-actions.pod:1386
23779 #: ../fish/guestfish-actions.pod:1393
23784 #: ../fish/guestfish-actions.pod:1395
23792 #: ../fish/guestfish-actions.pod:1399
23797 #: ../fish/guestfish-actions.pod:1401
23802 #: ../fish/guestfish-actions.pod:1403
23810 #: ../fish/guestfish-actions.pod:1410
23815 #: ../fish/guestfish-actions.pod:1412
23823 #: ../fish/guestfish-actions.pod:1419
23824 msgid "get-recovery-proc"
23828 #: ../fish/guestfish-actions.pod:1421
23831 " get-recovery-proc\n"
23836 #: ../fish/guestfish-actions.pod:1425
23837 msgid "get-selinux"
23841 #: ../fish/guestfish-actions.pod:1427
23849 #: ../fish/guestfish-actions.pod:1429
23851 "This returns the current setting of the selinux flag which is passed to the "
23852 "appliance at boot time. See L</set-selinux>."
23856 #: ../fish/guestfish-actions.pod:1435
23861 #: ../fish/guestfish-actions.pod:1437
23869 #: ../fish/guestfish-actions.pod:1444
23874 #: ../fish/guestfish-actions.pod:1446
23882 #: ../fish/guestfish-actions.pod:1450
23887 #: ../fish/guestfish-actions.pod:1452
23895 #: ../fish/guestfish-actions.pod:1454
23897 "Return the current umask. By default the umask is C<022> unless it has been "
23898 "set by calling L</umask>."
23902 #: ../fish/guestfish-actions.pod:1457
23903 msgid "get-verbose"
23907 #: ../fish/guestfish-actions.pod:1459
23915 #: ../fish/guestfish-actions.pod:1463
23920 #: ../fish/guestfish-actions.pod:1465
23928 #: ../fish/guestfish-actions.pod:1469
23929 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23933 #: ../fish/guestfish-actions.pod:1472
23938 #: ../fish/guestfish-actions.pod:1474
23941 " getxattr path name\n"
23946 #: ../fish/guestfish-actions.pod:1476
23948 "Get a single extended attribute from file C<path> named C<name>. This call "
23949 "follows symlinks. If you want to lookup an extended attribute for the "
23950 "symlink itself, use L</lgetxattr>."
23954 #: ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:2507
23956 "Normally it is better to get all extended attributes from a file in one go "
23957 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23958 "buggy and do not provide a way to list out attributes. For these "
23959 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23960 "attributes you want in advance and call this function."
23964 #: ../fish/guestfish-actions.pod:1490
23965 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23969 #: ../fish/guestfish-actions.pod:1492
23974 #: ../fish/guestfish-actions.pod:1494
23977 " getxattrs path\n"
23982 #: ../fish/guestfish-actions.pod:1502
23983 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23987 #: ../fish/guestfish-actions.pod:1504
23988 msgid "glob-expand"
23992 #: ../fish/guestfish-actions.pod:1506
23995 " glob-expand pattern\n"
24000 #: ../fish/guestfish-actions.pod:1519
24005 #: ../fish/guestfish-actions.pod:1521
24008 " grep regex path\n"
24013 #: ../fish/guestfish-actions.pod:1529
24018 #: ../fish/guestfish-actions.pod:1531
24021 " grepi regex path\n"
24026 #: ../fish/guestfish-actions.pod:1539
24027 msgid "grub-install"
24031 #: ../fish/guestfish-actions.pod:1541
24034 " grub-install root device\n"
24039 #: ../fish/guestfish-actions.pod:1557
24044 #: ../fish/guestfish-actions.pod:1559
24052 #: ../fish/guestfish-actions.pod:1567
24057 #: ../fish/guestfish-actions.pod:1569
24060 " head-n nrlines path\n"
24065 #: ../fish/guestfish-actions.pod:1582
24070 #: ../fish/guestfish-actions.pod:1584
24078 #: ../fish/guestfish-actions.pod:1592
24083 #: ../fish/guestfish-actions.pod:1594
24086 " initrd-cat initrdpath filename\n"
24091 #: ../fish/guestfish-actions.pod:1606
24092 msgid "See also L</initrd-list>."
24096 #: ../fish/guestfish-actions.pod:1611
24097 msgid "initrd-list"
24101 #: ../fish/guestfish-actions.pod:1613
24104 " initrd-list path\n"
24109 #: ../fish/guestfish-actions.pod:1625
24110 msgid "inotify-add-watch"
24114 #: ../fish/guestfish-actions.pod:1627
24117 " inotify-add-watch path mask\n"
24122 #: ../fish/guestfish-actions.pod:1639
24123 msgid "inotify-close"
24127 #: ../fish/guestfish-actions.pod:1641
24135 #: ../fish/guestfish-actions.pod:1647
24136 msgid "inotify-files"
24140 #: ../fish/guestfish-actions.pod:1649
24148 #: ../fish/guestfish-actions.pod:1651
24150 "This function is a helpful wrapper around L</inotify-read> which just "
24151 "returns a list of pathnames of objects that were touched. The returned "
24152 "pathnames are sorted and deduplicated."
24156 #: ../fish/guestfish-actions.pod:1655
24157 msgid "inotify-init"
24161 #: ../fish/guestfish-actions.pod:1657
24164 " inotify-init maxevents\n"
24169 #: ../fish/guestfish-actions.pod:1663
24171 "C<maxevents> is the maximum number of events which will be queued up between "
24172 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
24173 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
24174 "default was 16384 events. Beyond this limit, the kernel throws away events, "
24175 "but records the fact that it threw them away by setting a flag "
24176 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
24180 #: ../fish/guestfish-actions.pod:1673
24182 "Before any events are generated, you have to add some watches to the "
24183 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
24184 "L</inotify-watch-all>."
24188 #: ../fish/guestfish-actions.pod:1679
24190 "Queued up events should be read periodically by calling L</inotify-read> (or "
24191 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
24192 "If you don't read the events out often enough then you risk the internal "
24193 "queue overflowing."
24197 #: ../fish/guestfish-actions.pod:1686
24199 "The handle should be closed after use by calling L</inotify-close>. This "
24200 "also removes any watches automatically."
24204 #: ../fish/guestfish-actions.pod:1695
24205 msgid "inotify-read"
24209 #: ../fish/guestfish-actions.pod:1697
24217 #: ../fish/guestfish-actions.pod:1710
24218 msgid "inotify-rm-watch"
24222 #: ../fish/guestfish-actions.pod:1712
24225 " inotify-rm-watch wd\n"
24230 #: ../fish/guestfish-actions.pod:1714
24231 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
24235 #: ../fish/guestfish-actions.pod:1717
24236 msgid "inspect-get-arch"
24240 #: ../fish/guestfish-actions.pod:1719
24243 " inspect-get-arch root\n"
24248 #: ../fish/guestfish-actions.pod:1721
24250 "This returns the architecture of the inspected operating system. The "
24251 "possible return values are listed under L</file-architecture>."
24255 #: ../fish/guestfish-actions.pod:1730
24256 msgid "inspect-get-distro"
24260 #: ../fish/guestfish-actions.pod:1732
24263 " inspect-get-distro root\n"
24268 #: ../fish/guestfish-actions.pod:1813
24269 msgid "inspect-get-drive-mappings"
24273 #: ../fish/guestfish-actions.pod:1815
24276 " inspect-get-drive-mappings root\n"
24281 #: ../fish/guestfish-actions.pod:1842
24283 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24284 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
24288 #: ../fish/guestfish-actions.pod:1846
24289 msgid "inspect-get-filesystems"
24293 #: ../fish/guestfish-actions.pod:1848
24296 " inspect-get-filesystems root\n"
24301 #: ../fish/guestfish-actions.pod:1858
24303 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24304 "L</inspect-get-mountpoints>."
24308 #: ../fish/guestfish-actions.pod:1861
24309 msgid "inspect-get-format"
24313 #: ../fish/guestfish-actions.pod:1863
24316 " inspect-get-format root\n"
24321 #: ../fish/guestfish-actions.pod:1892
24322 msgid "inspect-get-hostname"
24326 #: ../fish/guestfish-actions.pod:1894
24329 " inspect-get-hostname root\n"
24334 #: ../fish/guestfish-actions.pod:1904
24335 msgid "inspect-get-icon"
24339 #: ../fish/guestfish-actions.pod:1906
24342 " inspect-get-icon root [favicon:..] [highquality:..]\n"
24347 #: ../fish/guestfish-actions.pod:1970
24348 msgid "inspect-get-major-version"
24352 #: ../fish/guestfish-actions.pod:1972
24355 " inspect-get-major-version root\n"
24360 #: ../fish/guestfish-actions.pod:1988
24361 msgid "inspect-get-minor-version"
24365 #: ../fish/guestfish-actions.pod:1990
24368 " inspect-get-minor-version root\n"
24373 #: ../fish/guestfish-actions.pod:1997
24375 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24376 "L</inspect-get-major-version>."
24380 #: ../fish/guestfish-actions.pod:2000
24381 msgid "inspect-get-mountpoints"
24385 #: ../fish/guestfish-actions.pod:2002
24388 " inspect-get-mountpoints root\n"
24393 #: ../fish/guestfish-actions.pod:2021
24395 "For operating systems like Windows which still use drive letters, this call "
24396 "will only return an entry for the first drive \"mounted on\" C</>. For "
24397 "information about the mapping of drive letters to partitions, see "
24398 "L</inspect-get-drive-mappings>."
24402 #: ../fish/guestfish-actions.pod:2027
24404 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24405 "L</inspect-get-filesystems>."
24409 #: ../fish/guestfish-actions.pod:2030
24410 msgid "inspect-get-package-format"
24414 #: ../fish/guestfish-actions.pod:2032
24417 " inspect-get-package-format root\n"
24422 #: ../fish/guestfish-actions.pod:2034
24424 "This function and L</inspect-get-package-management> return the package "
24425 "format and package management tool used by the inspected operating system. "
24426 "For example for Fedora these functions would return C<rpm> (package format) "
24427 "and C<yum> (package management)."
24431 #: ../fish/guestfish-actions.pod:2049
24432 msgid "inspect-get-package-management"
24436 #: ../fish/guestfish-actions.pod:2051
24439 " inspect-get-package-management root\n"
24444 #: ../fish/guestfish-actions.pod:2053
24446 "L</inspect-get-package-format> and this function return the package format "
24447 "and package management tool used by the inspected operating system. For "
24448 "example for Fedora these functions would return C<rpm> (package format) and "
24449 "C<yum> (package management)."
24453 #: ../fish/guestfish-actions.pod:2070
24454 msgid "inspect-get-product-name"
24458 #: ../fish/guestfish-actions.pod:2072
24461 " inspect-get-product-name root\n"
24466 #: ../fish/guestfish-actions.pod:2084
24467 msgid "inspect-get-product-variant"
24471 #: ../fish/guestfish-actions.pod:2086
24474 " inspect-get-product-variant root\n"
24479 #: ../fish/guestfish-actions.pod:2107
24481 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24482 "L</inspect-get-product-name>, L</inspect-get-major-version>."
24486 #: ../fish/guestfish-actions.pod:2111
24487 msgid "inspect-get-roots"
24491 #: ../fish/guestfish-actions.pod:2113
24494 " inspect-get-roots\n"
24499 #: ../fish/guestfish-actions.pod:2115
24501 "This function is a convenient way to get the list of root devices, as "
24502 "returned from a previous call to L</inspect-os>, but without redoing the "
24503 "whole inspection process."
24507 #: ../fish/guestfish-actions.pod:2119
24509 "This returns an empty list if either no root devices were found or the "
24510 "caller has not called L</inspect-os>."
24514 #: ../fish/guestfish-actions.pod:2124
24515 msgid "inspect-get-type"
24519 #: ../fish/guestfish-actions.pod:2126
24522 " inspect-get-type root\n"
24527 #: ../fish/guestfish-actions.pod:2156
24528 msgid "inspect-get-windows-current-control-set"
24532 #: ../fish/guestfish-actions.pod:2158
24535 " inspect-get-windows-current-control-set root\n"
24540 #: ../fish/guestfish-actions.pod:2169
24541 msgid "inspect-get-windows-systemroot"
24545 #: ../fish/guestfish-actions.pod:2171
24548 " inspect-get-windows-systemroot root\n"
24553 #: ../fish/guestfish-actions.pod:2182
24554 msgid "inspect-is-live"
24558 #: ../fish/guestfish-actions.pod:2184
24561 " inspect-is-live root\n"
24566 #: ../fish/guestfish-actions.pod:2186
24568 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24569 "then this returns true if a live image was detected on the disk."
24573 #: ../fish/guestfish-actions.pod:2192
24574 msgid "inspect-is-multipart"
24578 #: ../fish/guestfish-actions.pod:2194
24581 " inspect-is-multipart root\n"
24586 #: ../fish/guestfish-actions.pod:2196
24588 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24589 "then this returns true if the disk is part of a set."
24593 #: ../fish/guestfish-actions.pod:2202
24594 msgid "inspect-is-netinst"
24598 #: ../fish/guestfish-actions.pod:2204
24601 " inspect-is-netinst root\n"
24606 #: ../fish/guestfish-actions.pod:2206
24608 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
24609 "then this returns true if the disk is a network installer, ie. not a "
24610 "self-contained install CD but one which is likely to require network access "
24611 "to complete the install."
24615 #: ../fish/guestfish-actions.pod:2214
24616 msgid "inspect-list-applications"
24620 #: ../fish/guestfish-actions.pod:2216
24623 " inspect-list-applications root\n"
24628 #: ../fish/guestfish-actions.pod:2220
24630 "I<Note:> This call works differently from other parts of the inspection "
24631 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
24632 "then mount up the disks, before calling this. Listing applications is a "
24633 "significantly more difficult operation which requires access to the full "
24634 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
24635 "are just returning data cached in the libguestfs handle, this call actually "
24636 "reads parts of the mounted filesystems during the call."
24640 #: ../fish/guestfish-actions.pod:2310
24645 #: ../fish/guestfish-actions.pod:2312
24653 #: ../fish/guestfish-actions.pod:2327
24655 "You can pass the root string(s) returned to other L</inspect-get-*> "
24656 "functions in order to query further information about each operating system, "
24657 "such as the name and version."
24661 #: ../fish/guestfish-actions.pod:2332
24663 "This function uses other libguestfs features such as L</mount-ro> and "
24664 "L</umount-all> in order to mount and unmount filesystems and look at the "
24665 "contents. This should be called with no disks currently mounted. The "
24666 "function may also use Augeas, so any existing Augeas handle will be closed."
24670 #: ../fish/guestfish-actions.pod:2344 ../fish/guestfish-actions.pod:2542 ../fish/guestfish-actions.pod:2601
24671 msgid "See also L</list-filesystems>."
24675 #: ../fish/guestfish-actions.pod:2346
24676 msgid "is-blockdev"
24680 #: ../fish/guestfish-actions.pod:2348
24683 " is-blockdev path\n"
24688 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2390 ../fish/guestfish-actions.pod:2399 ../fish/guestfish-actions.pod:2409 ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2452
24689 msgid "See also L</stat>."
24693 #: ../fish/guestfish-actions.pod:2355
24698 #: ../fish/guestfish-actions.pod:2357
24706 #: ../fish/guestfish-actions.pod:2364
24711 #: ../fish/guestfish-actions.pod:2366
24714 " is-chardev path\n"
24719 #: ../fish/guestfish-actions.pod:2373
24724 #: ../fish/guestfish-actions.pod:2375
24732 #: ../fish/guestfish-actions.pod:2382
24737 #: ../fish/guestfish-actions.pod:2384
24745 #: ../fish/guestfish-actions.pod:2392
24750 #: ../fish/guestfish-actions.pod:2394
24758 #: ../fish/guestfish-actions.pod:2401
24763 #: ../fish/guestfish-actions.pod:2403
24771 #: ../fish/guestfish-actions.pod:2411
24772 msgid "is-launching"
24776 #: ../fish/guestfish-actions.pod:2413
24784 #: ../fish/guestfish-actions.pod:2420
24789 #: ../fish/guestfish-actions.pod:2422
24797 #: ../fish/guestfish-actions.pod:2427
24802 #: ../fish/guestfish-actions.pod:2429
24810 #: ../fish/guestfish-actions.pod:2436
24815 #: ../fish/guestfish-actions.pod:2438
24818 " is-socket path\n"
24823 #: ../fish/guestfish-actions.pod:2445
24828 #: ../fish/guestfish-actions.pod:2447
24831 " is-symlink path\n"
24836 #: ../fish/guestfish-actions.pod:2454
24841 #: ../fish/guestfish-actions.pod:2456
24849 #: ../fish/guestfish-actions.pod:2461
24850 msgid "is-zero-device"
24854 #: ../fish/guestfish-actions.pod:2463
24857 " is-zero-device device\n"
24862 #: ../fish/guestfish-actions.pod:2469
24863 msgid "kill-subprocess"
24867 #: ../fish/guestfish-actions.pod:2471
24870 " kill-subprocess\n"
24875 #: ../fish/guestfish-actions.pod:2475
24880 #: ../fish/guestfish-actions.pod:2477
24885 #: ../fish/guestfish-actions.pod:2479
24893 #: ../fish/guestfish-actions.pod:2487
24898 #: ../fish/guestfish-actions.pod:2489
24901 " lchown owner group path\n"
24906 #: ../fish/guestfish-actions.pod:2491
24908 "Change the file owner to C<owner> and group to C<group>. This is like "
24909 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
24914 #: ../fish/guestfish-actions.pod:2499
24919 #: ../fish/guestfish-actions.pod:2501
24922 " lgetxattr path name\n"
24927 #: ../fish/guestfish-actions.pod:2517
24928 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24932 #: ../fish/guestfish-actions.pod:2519
24937 #: ../fish/guestfish-actions.pod:2521
24940 " lgetxattrs path\n"
24945 #: ../fish/guestfish-actions.pod:2523
24947 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24948 "it returns the extended attributes of the link itself."
24952 #: ../fish/guestfish-actions.pod:2527
24957 #: ../fish/guestfish-actions.pod:2529
24965 #: ../fish/guestfish-actions.pod:2534
24966 msgid "list-devices"
24970 #: ../fish/guestfish-actions.pod:2536
24978 #: ../fish/guestfish-actions.pod:2544
24979 msgid "list-dm-devices"
24983 #: ../fish/guestfish-actions.pod:2546
24986 " list-dm-devices\n"
24991 #: ../fish/guestfish-actions.pod:2550
24993 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
24994 "previous call to L</luks-open>."
24998 #: ../fish/guestfish-actions.pod:2553
25000 "Device mapper devices which correspond to logical volumes are I<not> "
25001 "returned in this list. Call L</lvs> if you want to list logical volumes."
25005 #: ../fish/guestfish-actions.pod:2557
25006 msgid "list-filesystems"
25010 #: ../fish/guestfish-actions.pod:2559
25013 " list-filesystems\n"
25018 #: ../fish/guestfish-actions.pod:2578
25020 "This command runs other libguestfs commands, which might include L</mount> "
25021 "and L</umount>, and therefore you should use this soon after launch and only "
25022 "when nothing is mounted."
25026 #: ../fish/guestfish-actions.pod:2582
25028 "Not all of the filesystems returned will be mountable. In particular, swap "
25029 "partitions are returned in the list. Also this command does not check that "
25030 "each filesystem found is valid and mountable, and some filesystems might be "
25031 "mountable but require special options. Filesystems may not all belong to a "
25032 "single logical operating system (use L</inspect-os> to look for OSes)."
25036 #: ../fish/guestfish-actions.pod:2590
25037 msgid "list-partitions"
25041 #: ../fish/guestfish-actions.pod:2592
25044 " list-partitions\n"
25049 #: ../fish/guestfish-actions.pod:2598
25051 "This does not return logical volumes. For that you will need to call "
25056 #: ../fish/guestfish-actions.pod:2603
25061 #: ../fish/guestfish-actions.pod:2605
25069 #: ../fish/guestfish-actions.pod:2613
25074 #: ../fish/guestfish-actions.pod:2615
25077 " ln target linkname\n"
25082 #: ../fish/guestfish-actions.pod:2619
25087 #: ../fish/guestfish-actions.pod:2621
25090 " ln-f target linkname\n"
25095 #: ../fish/guestfish-actions.pod:2626
25100 #: ../fish/guestfish-actions.pod:2628
25103 " ln-s target linkname\n"
25108 #: ../fish/guestfish-actions.pod:2632
25113 #: ../fish/guestfish-actions.pod:2634
25116 " ln-sf target linkname\n"
25121 #: ../fish/guestfish-actions.pod:2639
25122 msgid "lremovexattr"
25126 #: ../fish/guestfish-actions.pod:2641
25129 " lremovexattr xattr path\n"
25134 #: ../fish/guestfish-actions.pod:2643
25136 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
25137 "it removes an extended attribute of the link itself."
25141 #: ../fish/guestfish-actions.pod:2647
25146 #: ../fish/guestfish-actions.pod:2649
25154 #: ../fish/guestfish-actions.pod:2655
25156 "This command is mostly useful for interactive sessions. Programs should "
25157 "probably use L</readdir> instead."
25161 #: ../fish/guestfish-actions.pod:2658
25166 #: ../fish/guestfish-actions.pod:2660
25169 " lsetxattr xattr val vallen path\n"
25174 #: ../fish/guestfish-actions.pod:2662
25176 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
25177 "sets an extended attribute of the link itself."
25181 #: ../fish/guestfish-actions.pod:2666
25186 #: ../fish/guestfish-actions.pod:2668
25194 #: ../fish/guestfish-actions.pod:2672
25196 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
25197 "the link is stat-ed, not the file it refers to."
25201 #: ../fish/guestfish-actions.pod:2678
25206 #: ../fish/guestfish-actions.pod:2680
25209 " lstatlist path 'names ...'\n"
25214 #: ../fish/guestfish-actions.pod:2682
25216 "This call allows you to perform the L</lstat> operation on multiple files, "
25217 "where all files are in the directory C<path>. C<names> is the list of files "
25218 "from this directory."
25222 #: ../fish/guestfish-actions.pod:2691
25224 "This call is intended for programs that want to efficiently list a directory "
25225 "contents without making many round-trips. See also L</lxattrlist> for a "
25226 "similarly efficient call for getting extended attributes. Very long "
25227 "directory listings might cause the protocol message size to be exceeded, "
25228 "causing this call to fail. The caller must split up such requests into "
25229 "smaller groups of names."
25233 #: ../fish/guestfish-actions.pod:2699
25234 msgid "luks-add-key"
25238 #: ../fish/guestfish-actions.pod:2701
25241 " luks-add-key device keyslot\n"
25246 #: ../fish/guestfish-actions.pod:2708
25248 "Note that if C<keyslot> already contains a key, then this command will "
25249 "fail. You have to use L</luks-kill-slot> first to remove that key."
25253 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2734 ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2761 ../fish/guestfish-actions.pod:2787 ../fish/guestfish-actions.pod:2797
25255 "This command has one or more key or passphrase parameters. Guestfish will "
25256 "prompt for these separately."
25260 #: ../fish/guestfish-actions.pod:2715
25265 #: ../fish/guestfish-actions.pod:2717
25268 " luks-close device\n"
25273 #: ../fish/guestfish-actions.pod:2719
25275 "This closes a LUKS device that was created earlier by L</luks-open> or "
25276 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
25277 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25278 "underlying block device."
25282 #: ../fish/guestfish-actions.pod:2725
25283 msgid "luks-format"
25287 #: ../fish/guestfish-actions.pod:2727
25290 " luks-format device keyslot\n"
25295 #: ../fish/guestfish-actions.pod:2740
25296 msgid "luks-format-cipher"
25300 #: ../fish/guestfish-actions.pod:2742
25303 " luks-format-cipher device keyslot cipher\n"
25308 #: ../fish/guestfish-actions.pod:2744
25310 "This command is the same as L</luks-format> but it also allows you to set "
25311 "the C<cipher> used."
25315 #: ../fish/guestfish-actions.pod:2753
25316 msgid "luks-kill-slot"
25320 #: ../fish/guestfish-actions.pod:2755
25323 " luks-kill-slot device keyslot\n"
25328 #: ../fish/guestfish-actions.pod:2764
25333 #: ../fish/guestfish-actions.pod:2766
25336 " luks-open device mapname\n"
25341 #: ../fish/guestfish-actions.pod:2780
25343 "If this block device contains LVM volume groups, then calling L</vgscan> "
25344 "followed by L</vg-activate-all> will make them visible."
25348 #: ../fish/guestfish-actions.pod:2784
25349 msgid "Use L</list-dm-devices> to list all device mapper devices."
25353 #: ../fish/guestfish-actions.pod:2790
25354 msgid "luks-open-ro"
25358 #: ../fish/guestfish-actions.pod:2792
25361 " luks-open-ro device mapname\n"
25366 #: ../fish/guestfish-actions.pod:2794
25368 "This is the same as L</luks-open> except that a read-only mapping is "
25373 #: ../fish/guestfish-actions.pod:2800
25378 #: ../fish/guestfish-actions.pod:2802
25381 " lvcreate logvol volgroup mbytes\n"
25386 #: ../fish/guestfish-actions.pod:2807
25387 msgid "lvm-canonical-lv-name"
25391 #: ../fish/guestfish-actions.pod:2809
25394 " lvm-canonical-lv-name lvname\n"
25399 #: ../fish/guestfish-actions.pod:2818
25400 msgid "See also L</is-lv>."
25404 #: ../fish/guestfish-actions.pod:2820
25405 msgid "lvm-clear-filter"
25409 #: ../fish/guestfish-actions.pod:2822
25412 " lvm-clear-filter\n"
25417 #: ../fish/guestfish-actions.pod:2824
25419 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
25424 #: ../fish/guestfish-actions.pod:2830
25425 msgid "lvm-remove-all"
25429 #: ../fish/guestfish-actions.pod:2832
25432 " lvm-remove-all\n"
25437 #: ../fish/guestfish-actions.pod:2840
25438 msgid "lvm-set-filter"
25442 #: ../fish/guestfish-actions.pod:2842
25445 " lvm-set-filter 'devices ...'\n"
25450 #: ../fish/guestfish-actions.pod:2867
25455 #: ../fish/guestfish-actions.pod:2869
25458 " lvremove device\n"
25463 #: ../fish/guestfish-actions.pod:2877
25468 #: ../fish/guestfish-actions.pod:2879
25471 " lvrename logvol newlogvol\n"
25476 #: ../fish/guestfish-actions.pod:2883
25481 #: ../fish/guestfish-actions.pod:2885
25484 " lvresize device mbytes\n"
25489 #: ../fish/guestfish-actions.pod:2891
25490 msgid "lvresize-free"
25494 #: ../fish/guestfish-actions.pod:2893
25497 " lvresize-free lv percent\n"
25502 #: ../fish/guestfish-actions.pod:2901
25507 #: ../fish/guestfish-actions.pod:2903
25515 #: ../fish/guestfish-actions.pod:2911
25516 msgid "See also L</lvs-full>, L</list-filesystems>."
25520 #: ../fish/guestfish-actions.pod:2913
25525 #: ../fish/guestfish-actions.pod:2915
25533 #: ../fish/guestfish-actions.pod:2920
25538 #: ../fish/guestfish-actions.pod:2922
25546 #: ../fish/guestfish-actions.pod:2926
25551 #: ../fish/guestfish-actions.pod:2928
25554 " lxattrlist path 'names ...'\n"
25559 #: ../fish/guestfish-actions.pod:2944
25561 "This call is intended for programs that want to efficiently list a directory "
25562 "contents without making many round-trips. See also L</lstatlist> for a "
25563 "similarly efficient call for getting standard stats. Very long directory "
25564 "listings might cause the protocol message size to be exceeded, causing this "
25565 "call to fail. The caller must split up such requests into smaller groups of "
25570 #: ../fish/guestfish-actions.pod:2952
25575 #: ../fish/guestfish-actions.pod:2954
25583 #: ../fish/guestfish-actions.pod:2958
25588 #: ../fish/guestfish-actions.pod:2960
25591 " mkdir-mode path mode\n"
25596 #: ../fish/guestfish-actions.pod:2969
25597 msgid "See also L</mkdir>, L</umask>"
25601 #: ../fish/guestfish-actions.pod:2971
25606 #: ../fish/guestfish-actions.pod:2973
25614 #: ../fish/guestfish-actions.pod:2978
25619 #: ../fish/guestfish-actions.pod:2980
25622 " mkdtemp template\n"
25627 #: ../fish/guestfish-actions.pod:3001
25632 #: ../fish/guestfish-actions.pod:3003
25635 " mke2fs-J fstype blocksize device journal\n"
25640 #: ../fish/guestfish-actions.pod:3011
25641 msgid "See also L</mke2journal>."
25645 #: ../fish/guestfish-actions.pod:3013
25650 #: ../fish/guestfish-actions.pod:3015
25653 " mke2fs-JL fstype blocksize device label\n"
25658 #: ../fish/guestfish-actions.pod:3020
25659 msgid "See also L</mke2journal-L>."
25663 #: ../fish/guestfish-actions.pod:3022
25668 #: ../fish/guestfish-actions.pod:3024
25671 " mke2fs-JU fstype blocksize device uuid\n"
25676 #: ../fish/guestfish-actions.pod:3029
25677 msgid "See also L</mke2journal-U>."
25681 #: ../fish/guestfish-actions.pod:3031
25682 msgid "mke2journal"
25686 #: ../fish/guestfish-actions.pod:3033
25689 " mke2journal blocksize device\n"
25694 #: ../fish/guestfish-actions.pod:3040
25695 msgid "mke2journal-L"
25699 #: ../fish/guestfish-actions.pod:3042
25702 " mke2journal-L blocksize label device\n"
25707 #: ../fish/guestfish-actions.pod:3046
25708 msgid "mke2journal-U"
25712 #: ../fish/guestfish-actions.pod:3048
25715 " mke2journal-U blocksize uuid device\n"
25720 #: ../fish/guestfish-actions.pod:3052
25725 #: ../fish/guestfish-actions.pod:3054
25728 " mkfifo mode path\n"
25733 #: ../fish/guestfish-actions.pod:3056
25735 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25736 "is just a convenient wrapper around L</mknod>."
25740 #: ../fish/guestfish-actions.pod:3062
25745 #: ../fish/guestfish-actions.pod:3064
25748 " mkfs fstype device\n"
25753 #: ../fish/guestfish-actions.pod:3070
25758 #: ../fish/guestfish-actions.pod:3072
25761 " mkfs-b fstype blocksize device\n"
25766 #: ../fish/guestfish-actions.pod:3074
25768 "This call is similar to L</mkfs>, but it allows you to control the block "
25769 "size of the resulting filesystem. Supported block sizes depend on the "
25770 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25774 #: ../fish/guestfish-actions.pod:3089
25779 #: ../fish/guestfish-actions.pod:3091
25782 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
25783 "[sectorsize:..]\n"
25788 #: ../fish/guestfish-actions.pod:3136
25789 msgid "mkmountpoint"
25793 #: ../fish/guestfish-actions.pod:3138
25796 " mkmountpoint exemptpath\n"
25801 #: ../fish/guestfish-actions.pod:3140
25803 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25804 "to create extra mountpoints before mounting the first filesystem."
25808 #: ../fish/guestfish-actions.pod:3164
25810 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25811 "unexpected errors if you try to mix these calls. It is safest to manually "
25812 "unmount filesystems and remove mountpoints after use."
25816 #: ../fish/guestfish-actions.pod:3168
25818 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25819 "for this to work for manual mountpoints, you must ensure that the innermost "
25820 "mountpoints have the longest pathnames, as in the example code above."
25824 #: ../fish/guestfish-actions.pod:3175
25826 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25827 "L</umount-all> to be called when the handle is closed which can also trigger "
25832 #: ../fish/guestfish-actions.pod:3179
25837 #: ../fish/guestfish-actions.pod:3181
25840 " mknod mode devmajor devminor path\n"
25845 #: ../fish/guestfish-actions.pod:3191
25847 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25848 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25849 "regular file). These constants are available in the standard Linux header "
25850 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25851 "wrappers around this command which bitwise OR in the appropriate constant "
25856 #: ../fish/guestfish-actions.pod:3201
25861 #: ../fish/guestfish-actions.pod:3203
25864 " mknod-b mode devmajor devminor path\n"
25869 #: ../fish/guestfish-actions.pod:3205
25871 "This call creates a block device node called C<path> with mode C<mode> and "
25872 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25873 "wrapper around L</mknod>."
25877 #: ../fish/guestfish-actions.pod:3211
25882 #: ../fish/guestfish-actions.pod:3213
25885 " mknod-c mode devmajor devminor path\n"
25890 #: ../fish/guestfish-actions.pod:3215
25892 "This call creates a char device node called C<path> with mode C<mode> and "
25893 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25894 "wrapper around L</mknod>."
25898 #: ../fish/guestfish-actions.pod:3221
25903 #: ../fish/guestfish-actions.pod:3223
25911 #: ../fish/guestfish-actions.pod:3227
25916 #: ../fish/guestfish-actions.pod:3229
25919 " mkswap-L label device\n"
25924 #: ../fish/guestfish-actions.pod:3237
25929 #: ../fish/guestfish-actions.pod:3239
25932 " mkswap-U uuid device\n"
25937 #: ../fish/guestfish-actions.pod:3243
25938 msgid "mkswap-file"
25942 #: ../fish/guestfish-actions.pod:3245
25945 " mkswap-file path\n"
25950 #: ../fish/guestfish-actions.pod:3249
25952 "This command just writes a swap file signature to an existing file. To "
25953 "create the file itself, use something like L</fallocate>."
25957 #: ../fish/guestfish-actions.pod:3252
25962 #: ../fish/guestfish-actions.pod:3254
25965 " modprobe modulename\n"
25970 #: ../fish/guestfish-actions.pod:3261
25975 #: ../fish/guestfish-actions.pod:3263
25978 " mount device mountpoint\n"
25983 #: ../fish/guestfish-actions.pod:3279
25985 "B<Important note:> When you use this call, the filesystem options C<sync> "
25986 "and C<noatime> are set implicitly. This was originally done because we "
25987 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25988 "very large negative performance impact and negligible effect on "
25989 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25990 "code that needs performance, and instead use L</mount-options> (use an empty "
25991 "string for the first parameter if you don't want any options)."
25995 #: ../fish/guestfish-actions.pod:3296
26000 #: ../fish/guestfish-actions.pod:3298
26003 " mount-9p mounttag mountpoint [options:..]\n"
26008 #: ../fish/guestfish-actions.pod:3309
26013 #: ../fish/guestfish-actions.pod:3311
26016 " mount-loop file mountpoint\n"
26021 #: ../fish/guestfish-actions.pod:3317
26022 msgid "mount-options"
26026 #: ../fish/guestfish-actions.pod:3319
26029 " mount-options options device mountpoint\n"
26034 #: ../fish/guestfish-actions.pod:3321
26036 "This is the same as the L</mount> command, but it allows you to set the "
26037 "mount options as for the L<mount(8)> I<-o> flag."
26041 #: ../fish/guestfish-actions.pod:3329
26046 #: ../fish/guestfish-actions.pod:3331
26049 " mount-ro device mountpoint\n"
26054 #: ../fish/guestfish-actions.pod:3333
26056 "This is the same as the L</mount> command, but it mounts the filesystem with "
26057 "the read-only (I<-o ro>) flag."
26061 #: ../fish/guestfish-actions.pod:3336
26066 #: ../fish/guestfish-actions.pod:3338
26069 " mount-vfs options vfstype device mountpoint\n"
26074 #: ../fish/guestfish-actions.pod:3340
26076 "This is the same as the L</mount> command, but it allows you to set both the "
26077 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
26081 #: ../fish/guestfish-actions.pod:3344
26082 msgid "mountpoints"
26086 #: ../fish/guestfish-actions.pod:3346
26094 #: ../fish/guestfish-actions.pod:3348
26096 "This call is similar to L</mounts>. That call returns a list of devices. "
26097 "This one returns a hash table (map) of device name to directory where the "
26098 "device is mounted."
26102 #: ../fish/guestfish-actions.pod:3352
26107 #: ../fish/guestfish-actions.pod:3354
26115 #: ../fish/guestfish-actions.pod:3361
26116 msgid "See also: L</mountpoints>"
26120 #: ../fish/guestfish-actions.pod:3363
26125 #: ../fish/guestfish-actions.pod:3365
26133 #: ../fish/guestfish-actions.pod:3370
26134 msgid "ntfs-3g-probe"
26138 #: ../fish/guestfish-actions.pod:3372
26141 " ntfs-3g-probe true|false device\n"
26146 #: ../fish/guestfish-actions.pod:3386
26151 #: ../fish/guestfish-actions.pod:3388
26154 " ntfsresize device\n"
26159 #: ../fish/guestfish-actions.pod:3410
26160 msgid "ntfsresize-opts"
26164 #: ../fish/guestfish-actions.pod:3412
26167 " ntfsresize-opts device [size:..] [force:..]\n"
26172 #: ../fish/guestfish-actions.pod:3431
26174 "After the resize operation, the filesystem is always marked as requiring a "
26175 "consistency check (for safety). You have to boot into Windows to perform "
26176 "this check and clear this condition. If you I<don't> set the C<force> "
26177 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
26178 "a single filesystem without booting into Windows between each resize."
26182 #: ../fish/guestfish-actions.pod:3444
26183 msgid "ntfsresize-size"
26187 #: ../fish/guestfish-actions.pod:3446
26190 " ntfsresize-size device size\n"
26195 #: ../fish/guestfish-actions.pod:3448
26197 "This command is the same as L</ntfsresize> except that it allows you to "
26198 "specify the new size (in bytes) explicitly."
26202 #: ../fish/guestfish-actions.pod:3458
26207 #: ../fish/guestfish-actions.pod:3460
26210 " part-add device prlogex startsect endsect\n"
26215 #: ../fish/guestfish-actions.pod:3462
26217 "This command adds a partition to C<device>. If there is no partition table "
26218 "on the device, call L</part-init> first."
26222 #: ../fish/guestfish-actions.pod:3474
26224 "Creating a partition which covers the whole disk is not so easy. Use "
26225 "L</part-disk> to do that."
26229 #: ../fish/guestfish-actions.pod:3477
26234 #: ../fish/guestfish-actions.pod:3479
26237 " part-del device partnum\n"
26242 #: ../fish/guestfish-actions.pod:3487
26247 #: ../fish/guestfish-actions.pod:3489
26250 " part-disk device parttype\n"
26255 #: ../fish/guestfish-actions.pod:3491
26257 "This command is simply a combination of L</part-init> followed by "
26258 "L</part-add> to create a single primary partition covering the whole disk."
26262 #: ../fish/guestfish-actions.pod:3495
26264 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26265 "possible values are described in L</part-init>."
26269 #: ../fish/guestfish-actions.pod:3501
26270 msgid "part-get-bootable"
26274 #: ../fish/guestfish-actions.pod:3503
26277 " part-get-bootable device partnum\n"
26282 #: ../fish/guestfish-actions.pod:3508
26283 msgid "See also L</part-set-bootable>."
26287 #: ../fish/guestfish-actions.pod:3510
26288 msgid "part-get-mbr-id"
26292 #: ../fish/guestfish-actions.pod:3512
26295 " part-get-mbr-id device partnum\n"
26300 #: ../fish/guestfish-actions.pod:3517 ../fish/guestfish-actions.pod:3655
26302 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26303 "undefined results for other partition table types (see "
26304 "L</part-get-parttype>)."
26308 #: ../fish/guestfish-actions.pod:3521
26309 msgid "part-get-parttype"
26313 #: ../fish/guestfish-actions.pod:3523
26316 " part-get-parttype device\n"
26321 #: ../fish/guestfish-actions.pod:3528
26323 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26324 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26325 "possible, although unusual. See L</part-init> for a full list."
26329 #: ../fish/guestfish-actions.pod:3533
26334 #: ../fish/guestfish-actions.pod:3535
26337 " part-init device parttype\n"
26342 #: ../fish/guestfish-actions.pod:3541
26344 "Initially there are no partitions. Following this, you should call "
26345 "L</part-add> for each partition required."
26349 #: ../fish/guestfish-actions.pod:3604
26354 #: ../fish/guestfish-actions.pod:3606
26357 " part-list device\n"
26362 #: ../fish/guestfish-actions.pod:3621
26364 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26365 "the device's sector size, see L</blockdev-getss>."
26369 #: ../fish/guestfish-actions.pod:3634
26370 msgid "part-set-bootable"
26374 #: ../fish/guestfish-actions.pod:3636
26377 " part-set-bootable device partnum true|false\n"
26382 #: ../fish/guestfish-actions.pod:3645
26383 msgid "part-set-mbr-id"
26387 #: ../fish/guestfish-actions.pod:3647
26390 " part-set-mbr-id device partnum idbyte\n"
26395 #: ../fish/guestfish-actions.pod:3659
26396 msgid "part-set-name"
26400 #: ../fish/guestfish-actions.pod:3661
26403 " part-set-name device partnum name\n"
26408 #: ../fish/guestfish-actions.pod:3669
26409 msgid "part-to-dev"
26413 #: ../fish/guestfish-actions.pod:3671
26416 " part-to-dev partition\n"
26421 #: ../fish/guestfish-actions.pod:3677
26423 "The named partition must exist, for example as a string returned from "
26424 "L</list-partitions>."
26428 #: ../fish/guestfish-actions.pod:3680
26429 msgid "ping-daemon"
26433 #: ../fish/guestfish-actions.pod:3682
26441 #: ../fish/guestfish-actions.pod:3689
26446 #: ../fish/guestfish-actions.pod:3691
26449 " pread path count offset\n"
26454 #: ../fish/guestfish-actions.pod:3699
26455 msgid "See also L</pwrite>, L</pread-device>."
26459 #: ../fish/guestfish-actions.pod:3704
26460 msgid "pread-device"
26464 #: ../fish/guestfish-actions.pod:3706
26467 " pread-device device count offset\n"
26472 #: ../fish/guestfish-actions.pod:3714
26473 msgid "See also L</pread>."
26477 #: ../fish/guestfish-actions.pod:3719
26482 #: ../fish/guestfish-actions.pod:3721
26485 " pvcreate device\n"
26490 #: ../fish/guestfish-actions.pod:3727
26495 #: ../fish/guestfish-actions.pod:3729
26498 " pvremove device\n"
26503 #: ../fish/guestfish-actions.pod:3738
26508 #: ../fish/guestfish-actions.pod:3740
26511 " pvresize device\n"
26516 #: ../fish/guestfish-actions.pod:3745
26517 msgid "pvresize-size"
26521 #: ../fish/guestfish-actions.pod:3747
26524 " pvresize-size device size\n"
26529 #: ../fish/guestfish-actions.pod:3749
26531 "This command is the same as L</pvresize> except that it allows you to "
26532 "specify the new size (in bytes) explicitly."
26536 #: ../fish/guestfish-actions.pod:3752
26541 #: ../fish/guestfish-actions.pod:3754
26549 #: ../fish/guestfish-actions.pod:3762
26550 msgid "See also L</pvs-full>."
26554 #: ../fish/guestfish-actions.pod:3764
26559 #: ../fish/guestfish-actions.pod:3766
26567 #: ../fish/guestfish-actions.pod:3771
26572 #: ../fish/guestfish-actions.pod:3773
26580 #: ../fish/guestfish-actions.pod:3777
26585 #: ../fish/guestfish-actions.pod:3779
26588 " pwrite path content offset\n"
26593 #: ../fish/guestfish-actions.pod:3790
26594 msgid "See also L</pread>, L</pwrite-device>."
26598 #: ../fish/guestfish-actions.pod:3795
26599 msgid "pwrite-device"
26603 #: ../fish/guestfish-actions.pod:3797
26606 " pwrite-device device content offset\n"
26611 #: ../fish/guestfish-actions.pod:3807
26612 msgid "See also L</pwrite>."
26616 #: ../fish/guestfish-actions.pod:3812
26621 #: ../fish/guestfish-actions.pod:3814
26624 " read-file path\n"
26629 #: ../fish/guestfish-actions.pod:3819
26631 "Unlike L</cat>, this function can correctly handle files that contain "
26632 "embedded ASCII NUL characters. However unlike L</download>, this function "
26633 "is limited in the total size of file that can be handled."
26637 #: ../fish/guestfish-actions.pod:3827
26642 #: ../fish/guestfish-actions.pod:3829
26645 " read-lines path\n"
26650 #: ../fish/guestfish-actions.pod:3836
26652 "Note that this function cannot correctly handle binary files (specifically, "
26653 "files containing C<\\0> character which is treated as end of line). For "
26654 "those you need to use the L</read-file> function which has a more complex "
26659 #: ../fish/guestfish-actions.pod:3841
26664 #: ../fish/guestfish-actions.pod:3843
26672 #: ../fish/guestfish-actions.pod:3895
26674 "This function is primarily intended for use by programs. To get a simple "
26675 "list of names, use L</ls>. To get a printable directory for human "
26676 "consumption, use L</ll>."
26680 #: ../fish/guestfish-actions.pod:3899
26685 #: ../fish/guestfish-actions.pod:3901
26693 #: ../fish/guestfish-actions.pod:3905
26694 msgid "readlinklist"
26698 #: ../fish/guestfish-actions.pod:3907
26701 " readlinklist path 'names ...'\n"
26706 #: ../fish/guestfish-actions.pod:3931
26711 #: ../fish/guestfish-actions.pod:3933
26719 #: ../fish/guestfish-actions.pod:3938
26720 msgid "removexattr"
26724 #: ../fish/guestfish-actions.pod:3940
26727 " removexattr xattr path\n"
26732 #: ../fish/guestfish-actions.pod:3945
26733 msgid "See also: L</lremovexattr>, L<attr(5)>."
26737 #: ../fish/guestfish-actions.pod:3947
26742 #: ../fish/guestfish-actions.pod:3949
26745 " resize2fs device\n"
26750 #: ../fish/guestfish-actions.pod:3954
26752 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26753 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26754 "gives an error about this and sometimes not. In any case, it is always safe "
26755 "to call L</e2fsck-f> before calling this function."
26759 #: ../fish/guestfish-actions.pod:3960
26760 msgid "resize2fs-M"
26764 #: ../fish/guestfish-actions.pod:3962
26767 " resize2fs-M device\n"
26772 #: ../fish/guestfish-actions.pod:3964
26774 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26775 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26780 #: ../fish/guestfish-actions.pod:3968
26782 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26783 "and read the C<Block size> and C<Block count> values. These two numbers, "
26784 "multiplied together, give the resulting size of the minimal filesystem in "
26789 #: ../fish/guestfish-actions.pod:3973
26790 msgid "resize2fs-size"
26794 #: ../fish/guestfish-actions.pod:3975
26797 " resize2fs-size device size\n"
26802 #: ../fish/guestfish-actions.pod:3977
26804 "This command is the same as L</resize2fs> except that it allows you to "
26805 "specify the new size (in bytes) explicitly."
26809 #: ../fish/guestfish-actions.pod:3980
26814 #: ../fish/guestfish-actions.pod:3982
26822 #: ../fish/guestfish-actions.pod:3986
26827 #: ../fish/guestfish-actions.pod:3988
26835 #: ../fish/guestfish-actions.pod:3994
26840 #: ../fish/guestfish-actions.pod:3996
26848 #: ../fish/guestfish-actions.pod:4000
26849 msgid "rmmountpoint"
26853 #: ../fish/guestfish-actions.pod:4002
26856 " rmmountpoint exemptpath\n"
26861 #: ../fish/guestfish-actions.pod:4004
26863 "This calls removes a mountpoint that was previously created with "
26864 "L</mkmountpoint>. See L</mkmountpoint> for full details."
26868 #: ../fish/guestfish-actions.pod:4008
26869 msgid "scrub-device"
26873 #: ../fish/guestfish-actions.pod:4010
26876 " scrub-device device\n"
26881 #: ../fish/guestfish-actions.pod:4021
26886 #: ../fish/guestfish-actions.pod:4023
26889 " scrub-file file\n"
26894 #: ../fish/guestfish-actions.pod:4033
26895 msgid "scrub-freespace"
26899 #: ../fish/guestfish-actions.pod:4035
26902 " scrub-freespace dir\n"
26907 #: ../fish/guestfish-actions.pod:4037
26909 "This command creates the directory C<dir> and then fills it with files until "
26910 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26911 "deletes them. The intention is to scrub any free space on the partition "
26912 "containing C<dir>."
26916 #: ../fish/guestfish-actions.pod:4046
26921 #: ../fish/guestfish-actions.pod:4048
26926 #: ../fish/guestfish-actions.pod:4050
26929 " set-append append\n"
26934 #: ../fish/guestfish-actions.pod:4061
26935 msgid "set-attach-method"
26939 #: ../fish/guestfish-actions.pod:4063
26940 msgid "attach-method"
26944 #: ../fish/guestfish-actions.pod:4065
26947 " set-attach-method attachmethod\n"
26952 #: ../fish/guestfish-actions.pod:4087
26953 msgid "set-autosync"
26957 #: ../fish/guestfish-actions.pod:4089
26962 #: ../fish/guestfish-actions.pod:4091
26965 " set-autosync true|false\n"
26970 #: ../fish/guestfish-actions.pod:4101
26975 #: ../fish/guestfish-actions.pod:4103
26980 #: ../fish/guestfish-actions.pod:4105
26983 " set-direct true|false\n"
26988 #: ../fish/guestfish-actions.pod:4111
26990 "One consequence of this is that log messages aren't caught by the library "
26991 "and handled by L</set-log-message-callback>, but go straight to stdout."
26995 #: ../fish/guestfish-actions.pod:4120
26996 msgid "set-e2label"
27000 #: ../fish/guestfish-actions.pod:4122
27003 " set-e2label device label\n"
27008 #: ../fish/guestfish-actions.pod:4128
27010 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
27011 "label on a filesystem."
27015 #: ../fish/guestfish-actions.pod:4131
27020 #: ../fish/guestfish-actions.pod:4133
27023 " set-e2uuid device uuid\n"
27028 #: ../fish/guestfish-actions.pod:4140
27030 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
27031 "UUID of a filesystem."
27035 #: ../fish/guestfish-actions.pod:4143
27036 msgid "set-memsize"
27040 #: ../fish/guestfish-actions.pod:4145
27045 #: ../fish/guestfish-actions.pod:4147
27048 " set-memsize memsize\n"
27053 #: ../fish/guestfish-actions.pod:4149
27055 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27056 "This only has any effect if called before L</launch>."
27060 #: ../fish/guestfish-actions.pod:4160
27061 msgid "set-network"
27065 #: ../fish/guestfish-actions.pod:4162
27070 #: ../fish/guestfish-actions.pod:4164
27073 " set-network true|false\n"
27078 #: ../fish/guestfish-actions.pod:4172
27079 msgid "You must call this before calling L</launch>, otherwise it has no effect."
27083 #: ../fish/guestfish-actions.pod:4175
27088 #: ../fish/guestfish-actions.pod:4177
27093 #: ../fish/guestfish-actions.pod:4179
27096 " set-path searchpath\n"
27101 #: ../fish/guestfish-actions.pod:4188
27106 #: ../fish/guestfish-actions.pod:4190
27111 #: ../fish/guestfish-actions.pod:4192
27114 " set-pgroup true|false\n"
27119 #: ../fish/guestfish-actions.pod:4203
27124 #: ../fish/guestfish-actions.pod:4205
27129 #: ../fish/guestfish-actions.pod:4207
27137 #: ../fish/guestfish-actions.pod:4227
27138 msgid "set-recovery-proc"
27142 #: ../fish/guestfish-actions.pod:4229
27143 msgid "recovery-proc"
27147 #: ../fish/guestfish-actions.pod:4231
27150 " set-recovery-proc true|false\n"
27155 #: ../fish/guestfish-actions.pod:4233
27157 "If this is called with the parameter C<false> then L</launch> does not "
27158 "create a recovery process. The purpose of the recovery process is to stop "
27159 "runaway qemu processes in the case where the main program aborts abruptly."
27163 #: ../fish/guestfish-actions.pod:4238
27165 "This only has any effect if called before L</launch>, and the default is "
27170 #: ../fish/guestfish-actions.pod:4247
27171 msgid "set-selinux"
27175 #: ../fish/guestfish-actions.pod:4249
27180 #: ../fish/guestfish-actions.pod:4251
27183 " set-selinux true|false\n"
27188 #: ../fish/guestfish-actions.pod:4262
27193 #: ../fish/guestfish-actions.pod:4264
27198 #: ../fish/guestfish-actions.pod:4266
27201 " set-trace true|false\n"
27206 #: ../fish/guestfish-actions.pod:4278
27208 "Trace messages are normally sent to C<stderr>, unless you register a "
27209 "callback to send them somewhere else (see L</set-event-callback>)."
27213 #: ../fish/guestfish-actions.pod:4282
27214 msgid "set-verbose"
27218 #: ../fish/guestfish-actions.pod:4284
27223 #: ../fish/guestfish-actions.pod:4286
27226 " set-verbose true|false\n"
27231 #: ../fish/guestfish-actions.pod:4293
27233 "Verbose messages are normally sent to C<stderr>, unless you register a "
27234 "callback to send them somewhere else (see L</set-event-callback>)."
27238 #: ../fish/guestfish-actions.pod:4297
27243 #: ../fish/guestfish-actions.pod:4299
27246 " setcon context\n"
27251 #: ../fish/guestfish-actions.pod:4306
27256 #: ../fish/guestfish-actions.pod:4308
27259 " setxattr xattr val vallen path\n"
27264 #: ../fish/guestfish-actions.pod:4314
27265 msgid "See also: L</lsetxattr>, L<attr(5)>."
27269 #: ../fish/guestfish-actions.pod:4316
27274 #: ../fish/guestfish-actions.pod:4318
27277 " sfdisk device cyls heads sectors 'lines ...'\n"
27282 #: ../fish/guestfish-actions.pod:4340
27283 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
27287 #: ../fish/guestfish-actions.pod:4353
27292 #: ../fish/guestfish-actions.pod:4355
27295 " sfdiskM device 'lines ...'\n"
27300 #: ../fish/guestfish-actions.pod:4357
27302 "This is a simplified interface to the L</sfdisk> command, where partition "
27303 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
27304 "you don't need to specify the cyls, heads and sectors parameters which were "
27305 "rarely if ever used anyway."
27309 #: ../fish/guestfish-actions.pod:4363
27310 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
27314 #: ../fish/guestfish-actions.pod:4376
27319 #: ../fish/guestfish-actions.pod:4378
27322 " sfdisk-N device partnum cyls heads sectors line\n"
27327 #: ../fish/guestfish-actions.pod:4383
27329 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
27330 "cyls/heads/sectors parameters."
27334 #: ../fish/guestfish-actions.pod:4386
27335 msgid "See also: L</part-add>"
27339 #: ../fish/guestfish-actions.pod:4398
27340 msgid "sfdisk-disk-geometry"
27344 #: ../fish/guestfish-actions.pod:4400
27347 " sfdisk-disk-geometry device\n"
27352 #: ../fish/guestfish-actions.pod:4402
27354 "This displays the disk geometry of C<device> read from the partition table. "
27355 "Especially in the case where the underlying block device has been resized, "
27356 "this can be different from the kernel's idea of the geometry (see "
27357 "L</sfdisk-kernel-geometry>)."
27361 #: ../fish/guestfish-actions.pod:4410
27362 msgid "sfdisk-kernel-geometry"
27366 #: ../fish/guestfish-actions.pod:4412
27369 " sfdisk-kernel-geometry device\n"
27374 #: ../fish/guestfish-actions.pod:4419
27379 #: ../fish/guestfish-actions.pod:4421
27382 " sfdisk-l device\n"
27387 #: ../fish/guestfish-actions.pod:4427
27388 msgid "See also: L</part-list>"
27392 #: ../fish/guestfish-actions.pod:4436
27397 #: ../fish/guestfish-actions.pod:4438
27405 #: ../fish/guestfish-actions.pod:4443
27406 msgid "This is like L</command>, but passes the command to:"
27410 #: ../fish/guestfish-actions.pod:4451
27411 msgid "All the provisos about L</command> apply to this call."
27415 #: ../fish/guestfish-actions.pod:4453
27420 #: ../fish/guestfish-actions.pod:4455
27423 " sh-lines command\n"
27428 #: ../fish/guestfish-actions.pod:4457
27429 msgid "This is the same as L</sh>, but splits the result into a list of lines."
27433 #: ../fish/guestfish-actions.pod:4460
27434 msgid "See also: L</command-lines>"
27438 #: ../fish/guestfish-actions.pod:4462
27443 #: ../fish/guestfish-actions.pod:4464
27451 #: ../fish/guestfish-actions.pod:4468
27456 #: ../fish/guestfish-actions.pod:4470
27464 #: ../fish/guestfish-actions.pod:4476
27469 #: ../fish/guestfish-actions.pod:4478
27477 #: ../fish/guestfish-actions.pod:4486
27482 #: ../fish/guestfish-actions.pod:4488
27490 #: ../fish/guestfish-actions.pod:4496
27495 #: ../fish/guestfish-actions.pod:4498
27498 " strings-e encoding path\n"
27503 #: ../fish/guestfish-actions.pod:4500
27505 "This is like the L</strings> command, but allows you to specify the encoding "
27506 "of strings that are looked for in the source file C<path>."
27510 #: ../fish/guestfish-actions.pod:4510
27512 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
27513 "ISO-8859-X (this is what L</strings> uses)."
27517 #: ../fish/guestfish-actions.pod:4542
27518 msgid "swapoff-device"
27522 #: ../fish/guestfish-actions.pod:4544
27525 " swapoff-device device\n"
27530 #: ../fish/guestfish-actions.pod:4546
27532 "This command disables the libguestfs appliance swap device or partition "
27533 "named C<device>. See L</swapon-device>."
27537 #: ../fish/guestfish-actions.pod:4550
27538 msgid "swapoff-file"
27542 #: ../fish/guestfish-actions.pod:4552
27545 " swapoff-file file\n"
27550 #: ../fish/guestfish-actions.pod:4556
27551 msgid "swapoff-label"
27555 #: ../fish/guestfish-actions.pod:4558
27558 " swapoff-label label\n"
27563 #: ../fish/guestfish-actions.pod:4563
27564 msgid "swapoff-uuid"
27568 #: ../fish/guestfish-actions.pod:4565
27571 " swapoff-uuid uuid\n"
27576 #: ../fish/guestfish-actions.pod:4570
27577 msgid "swapon-device"
27581 #: ../fish/guestfish-actions.pod:4572
27584 " swapon-device device\n"
27589 #: ../fish/guestfish-actions.pod:4574
27591 "This command enables the libguestfs appliance to use the swap device or "
27592 "partition named C<device>. The increased memory is made available for all "
27593 "commands, for example those run using L</command> or L</sh>."
27597 #: ../fish/guestfish-actions.pod:4586
27598 msgid "swapon-file"
27602 #: ../fish/guestfish-actions.pod:4588
27605 " swapon-file file\n"
27610 #: ../fish/guestfish-actions.pod:4590
27611 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
27615 #: ../fish/guestfish-actions.pod:4593
27616 msgid "swapon-label"
27620 #: ../fish/guestfish-actions.pod:4595
27623 " swapon-label label\n"
27628 #: ../fish/guestfish-actions.pod:4597
27630 "This command enables swap to a labeled swap partition. See "
27631 "L</swapon-device> for other notes."
27635 #: ../fish/guestfish-actions.pod:4600
27636 msgid "swapon-uuid"
27640 #: ../fish/guestfish-actions.pod:4602
27643 " swapon-uuid uuid\n"
27648 #: ../fish/guestfish-actions.pod:4604
27650 "This command enables swap to a swap partition with the given UUID. See "
27651 "L</swapon-device> for other notes."
27655 #: ../fish/guestfish-actions.pod:4607
27660 #: ../fish/guestfish-actions.pod:4609
27668 #: ../fish/guestfish-actions.pod:4617
27673 #: ../fish/guestfish-actions.pod:4619
27681 #: ../fish/guestfish-actions.pod:4627
27686 #: ../fish/guestfish-actions.pod:4629
27689 " tail-n nrlines path\n"
27694 #: ../fish/guestfish-actions.pod:4642
27699 #: ../fish/guestfish-actions.pod:4644
27702 " tar-in (tarfile|-) directory\n"
27707 #: ../fish/guestfish-actions.pod:4649
27708 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
27712 #: ../fish/guestfish-actions.pod:4654
27717 #: ../fish/guestfish-actions.pod:4656
27720 " tar-out directory (tarfile|-)\n"
27725 #: ../fish/guestfish-actions.pod:4661
27726 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
27730 #: ../fish/guestfish-actions.pod:4666
27735 #: ../fish/guestfish-actions.pod:4668
27738 " tgz-in (tarball|-) directory\n"
27743 #: ../fish/guestfish-actions.pod:4673
27744 msgid "To upload an uncompressed tarball, use L</tar-in>."
27748 #: ../fish/guestfish-actions.pod:4677
27753 #: ../fish/guestfish-actions.pod:4679
27756 " tgz-out directory (tarball|-)\n"
27761 #: ../fish/guestfish-actions.pod:4684
27762 msgid "To download an uncompressed tarball, use L</tar-out>."
27766 #: ../fish/guestfish-actions.pod:4688
27771 #: ../fish/guestfish-actions.pod:4690
27779 #: ../fish/guestfish-actions.pod:4699
27784 #: ../fish/guestfish-actions.pod:4701
27792 #: ../fish/guestfish-actions.pod:4706
27793 msgid "truncate-size"
27797 #: ../fish/guestfish-actions.pod:4708
27800 " truncate-size path size\n"
27805 #: ../fish/guestfish-actions.pod:4713
27807 "If the current file size is less than C<size> then the file is extended to "
27808 "the required size with zero bytes. This creates a sparse file (ie. disk "
27809 "blocks are not allocated for the file until you write to it). To create a "
27810 "non-sparse file of zeroes, use L</fallocate64> instead."
27814 #: ../fish/guestfish-actions.pod:4719
27819 #: ../fish/guestfish-actions.pod:4721
27822 " tune2fs-l device\n"
27827 #: ../fish/guestfish-actions.pod:4731
27832 #: ../fish/guestfish-actions.pod:4733
27835 " txz-in (tarball|-) directory\n"
27840 #: ../fish/guestfish-actions.pod:4740
27845 #: ../fish/guestfish-actions.pod:4742
27848 " txz-out directory (tarball|-)\n"
27853 #: ../fish/guestfish-actions.pod:4749
27858 #: ../fish/guestfish-actions.pod:4751
27866 #: ../fish/guestfish-actions.pod:4765
27867 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27871 #: ../fish/guestfish-actions.pod:4770
27876 #: ../fish/guestfish-actions.pod:4772
27881 #: ../fish/guestfish-actions.pod:4774
27884 " umount pathordevice\n"
27889 #: ../fish/guestfish-actions.pod:4780
27894 #: ../fish/guestfish-actions.pod:4782
27895 msgid "unmount-all"
27899 #: ../fish/guestfish-actions.pod:4784
27907 #: ../fish/guestfish-actions.pod:4790
27912 #: ../fish/guestfish-actions.pod:4792
27915 " upload (filename|-) remotefilename\n"
27920 #: ../fish/guestfish-actions.pod:4799
27921 msgid "See also L</download>."
27925 #: ../fish/guestfish-actions.pod:4803
27926 msgid "upload-offset"
27930 #: ../fish/guestfish-actions.pod:4805
27933 " upload-offset (filename|-) remotefilename offset\n"
27938 #: ../fish/guestfish-actions.pod:4817
27940 "Note that there is no limit on the amount of data that can be uploaded with "
27941 "this call, unlike with L</pwrite>, and this call always writes the full "
27942 "amount unless an error occurs."
27946 #: ../fish/guestfish-actions.pod:4822
27947 msgid "See also L</upload>, L</pwrite>."
27951 #: ../fish/guestfish-actions.pod:4826
27956 #: ../fish/guestfish-actions.pod:4828
27959 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27964 #: ../fish/guestfish-actions.pod:4847
27969 #: ../fish/guestfish-actions.pod:4849
27977 #: ../fish/guestfish-actions.pod:4876
27979 "I<Note:> Don't use this call to test for availability of features. In "
27980 "enterprise distributions we backport features from later versions into "
27981 "earlier versions, making this an unreliable way to test for features. Use "
27982 "L</available> instead."
27986 #: ../fish/guestfish-actions.pod:4882
27991 #: ../fish/guestfish-actions.pod:4884
27994 " vfs-label device\n"
27999 #: ../fish/guestfish-actions.pod:4891
28000 msgid "To find a filesystem from the label, use L</findfs-label>."
28004 #: ../fish/guestfish-actions.pod:4893
28009 #: ../fish/guestfish-actions.pod:4895
28012 " vfs-type device\n"
28017 #: ../fish/guestfish-actions.pod:4905
28022 #: ../fish/guestfish-actions.pod:4907
28025 " vfs-uuid device\n"
28030 #: ../fish/guestfish-actions.pod:4914
28031 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
28035 #: ../fish/guestfish-actions.pod:4916
28036 msgid "vg-activate"
28040 #: ../fish/guestfish-actions.pod:4918
28043 " vg-activate true|false 'volgroups ...'\n"
28048 #: ../fish/guestfish-actions.pod:4928
28049 msgid "vg-activate-all"
28053 #: ../fish/guestfish-actions.pod:4930
28056 " vg-activate-all true|false\n"
28061 #: ../fish/guestfish-actions.pod:4937
28066 #: ../fish/guestfish-actions.pod:4939
28069 " vgcreate volgroup 'physvols ...'\n"
28074 #: ../fish/guestfish-actions.pod:4944
28079 #: ../fish/guestfish-actions.pod:4946
28082 " vglvuuids vgname\n"
28087 #: ../fish/guestfish-actions.pod:4951
28089 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
28090 "logical volumes and volume groups."
28094 #: ../fish/guestfish-actions.pod:4954
28095 msgid "See also L</vgpvuuids>."
28099 #: ../fish/guestfish-actions.pod:4956
28104 #: ../fish/guestfish-actions.pod:4958
28107 " vgpvuuids vgname\n"
28112 #: ../fish/guestfish-actions.pod:4963
28114 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
28115 "physical volumes and volume groups."
28119 #: ../fish/guestfish-actions.pod:4966
28120 msgid "See also L</vglvuuids>."
28124 #: ../fish/guestfish-actions.pod:4968
28129 #: ../fish/guestfish-actions.pod:4970
28132 " vgremove vgname\n"
28137 #: ../fish/guestfish-actions.pod:4977
28142 #: ../fish/guestfish-actions.pod:4979
28145 " vgrename volgroup newvolgroup\n"
28150 #: ../fish/guestfish-actions.pod:4983
28155 #: ../fish/guestfish-actions.pod:4985
28163 #: ../fish/guestfish-actions.pod:4993
28164 msgid "See also L</vgs-full>."
28168 #: ../fish/guestfish-actions.pod:4995
28173 #: ../fish/guestfish-actions.pod:4997
28181 #: ../fish/guestfish-actions.pod:5002
28186 #: ../fish/guestfish-actions.pod:5004
28194 #: ../fish/guestfish-actions.pod:5009
28199 #: ../fish/guestfish-actions.pod:5011
28207 #: ../fish/guestfish-actions.pod:5015
28212 #: ../fish/guestfish-actions.pod:5017
28220 #: ../fish/guestfish-actions.pod:5022
28225 #: ../fish/guestfish-actions.pod:5024
28233 #: ../fish/guestfish-actions.pod:5029
28238 #: ../fish/guestfish-actions.pod:5031
28246 #: ../fish/guestfish-actions.pod:5036
28251 #: ../fish/guestfish-actions.pod:5038
28254 " write path content\n"
28259 #: ../fish/guestfish-actions.pod:5043
28260 msgid "See also L</write-append>."
28264 #: ../fish/guestfish-actions.pod:5048
28265 msgid "write-append"
28269 #: ../fish/guestfish-actions.pod:5050
28272 " write-append path content\n"
28277 #: ../fish/guestfish-actions.pod:5055
28278 msgid "See also L</write>."
28282 #: ../fish/guestfish-actions.pod:5060
28287 #: ../fish/guestfish-actions.pod:5062
28290 " write-file path content size\n"
28295 #: ../fish/guestfish-actions.pod:5085
28300 #: ../fish/guestfish-actions.pod:5087
28303 " zegrep regex path\n"
28308 #: ../fish/guestfish-actions.pod:5095
28313 #: ../fish/guestfish-actions.pod:5097
28316 " zegrepi regex path\n"
28321 #: ../fish/guestfish-actions.pod:5105
28326 #: ../fish/guestfish-actions.pod:5107
28334 #: ../fish/guestfish-actions.pod:5115
28335 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
28339 #: ../fish/guestfish-actions.pod:5118
28340 msgid "zero-device"
28344 #: ../fish/guestfish-actions.pod:5120
28347 " zero-device device\n"
28352 #: ../fish/guestfish-actions.pod:5122
28354 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
28355 "which just zeroes the first few blocks of a device."
28359 #: ../fish/guestfish-actions.pod:5129
28364 #: ../fish/guestfish-actions.pod:5131
28367 " zerofree device\n"
28372 #: ../fish/guestfish-actions.pod:5144
28377 #: ../fish/guestfish-actions.pod:5146
28380 " zfgrep pattern path\n"
28385 #: ../fish/guestfish-actions.pod:5154
28390 #: ../fish/guestfish-actions.pod:5156
28393 " zfgrepi pattern path\n"
28398 #: ../fish/guestfish-actions.pod:5164
28403 #: ../fish/guestfish-actions.pod:5166
28406 " zfile meth path\n"
28411 #: ../fish/guestfish-actions.pod:5173
28412 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
28416 #: ../fish/guestfish-actions.pod:5183
28421 #: ../fish/guestfish-actions.pod:5185
28424 " zgrep regex path\n"
28429 #: ../fish/guestfish-actions.pod:5193
28434 #: ../fish/guestfish-actions.pod:5195
28437 " zgrepi regex path\n"
28442 #: ../fish/guestfish-commands.pod:1
28447 #: ../fish/guestfish-commands.pod:3
28452 #: ../fish/guestfish-commands.pod:5
28455 " alloc filename size\n"
28460 #: ../fish/guestfish-commands.pod:7
28462 "This creates an empty (zeroed) file of the given size, and then adds so it "
28463 "can be further examined."
28467 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
28468 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
28472 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
28473 msgid "Size can be specified using standard suffixes, eg. C<1M>."
28477 #: ../fish/guestfish-commands.pod:14
28479 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
28480 "image, see L</PREPARED DISK IMAGES>."
28484 #: ../fish/guestfish-commands.pod:17
28489 #: ../fish/guestfish-commands.pod:19
28492 " copy-in local [local ...] /remotedir\n"
28497 #: ../fish/guestfish-commands.pod:21
28499 "C<copy-in> copies local files or directories recursively into the disk "
28500 "image, placing them in the directory called C</remotedir> (which must "
28501 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
28502 "other commands as necessary."
28506 #: ../fish/guestfish-commands.pod:26
28508 "Multiple local files and directories can be specified, but the last "
28509 "parameter must always be a remote directory. Wildcards cannot be used."
28513 #: ../fish/guestfish-commands.pod:30
28518 #: ../fish/guestfish-commands.pod:32
28521 " copy-out remote [remote ...] localdir\n"
28526 #: ../fish/guestfish-commands.pod:34
28528 "C<copy-out> copies remote files or directories recursively out of the disk "
28529 "image, placing them on the host disk in a local directory called C<localdir> "
28530 "(which must exist). This guestfish meta-command turns into a sequence of "
28531 "L</download>, L</tar-out> and other commands as necessary."
28535 #: ../fish/guestfish-commands.pod:40
28537 "Multiple remote files and directories can be specified, but the last "
28538 "parameter must always be a local directory. To download to the current "
28539 "directory, use C<.> as in:"
28543 #: ../fish/guestfish-commands.pod:44
28546 " copy-out /home .\n"
28551 #: ../fish/guestfish-commands.pod:46
28553 "Wildcards cannot be used in the ordinary command, but you can use them with "
28554 "the help of L</glob> like this:"
28558 #: ../fish/guestfish-commands.pod:49
28561 " glob copy-out /home/* .\n"
28566 #: ../fish/guestfish-commands.pod:51
28571 #: ../fish/guestfish-commands.pod:53
28574 " display filename\n"
28579 #: ../fish/guestfish-commands.pod:55
28581 "Use C<display> (a graphical display program) to display an image file. It "
28582 "downloads the file, and runs C<display> on it."
28586 #: ../fish/guestfish-commands.pod:58
28588 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
28589 "environment variable. For example to use the GNOME display program:"
28593 #: ../fish/guestfish-commands.pod:61
28596 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
28601 #: ../fish/guestfish-commands.pod:63
28602 msgid "See also L<display(1)>."
28606 #: ../fish/guestfish-commands.pod:65
28611 #: ../fish/guestfish-commands.pod:67
28614 " echo [params ...]\n"
28619 #: ../fish/guestfish-commands.pod:69
28620 msgid "This echos the parameters to the terminal."
28624 #: ../fish/guestfish-commands.pod:71
28629 #: ../fish/guestfish-commands.pod:73
28634 #: ../fish/guestfish-commands.pod:75
28639 #: ../fish/guestfish-commands.pod:77
28647 #: ../fish/guestfish-commands.pod:79
28649 "This is used to edit a file. It downloads the file, edits it locally using "
28650 "your editor, then uploads the result."
28654 #: ../fish/guestfish-commands.pod:82
28656 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
28657 "or C<emacs> you will get those corresponding editors."
28661 #: ../fish/guestfish-commands.pod:86
28666 #: ../fish/guestfish-commands.pod:88
28669 " glob command args...\n"
28674 #: ../fish/guestfish-commands.pod:90
28676 "Expand wildcards in any paths in the args list, and run C<command> "
28677 "repeatedly on each matching path."
28681 #: ../fish/guestfish-commands.pod:93
28682 msgid "See L</WILDCARDS AND GLOBBING>."
28686 #: ../fish/guestfish-commands.pod:95
28691 #: ../fish/guestfish-commands.pod:97
28694 " hexedit <filename|device>\n"
28695 " hexedit <filename|device> <max>\n"
28696 " hexedit <filename|device> <start> <max>\n"
28701 #: ../fish/guestfish-commands.pod:101
28703 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
28708 #: ../fish/guestfish-commands.pod:104
28710 "This command works by downloading potentially the whole file or device, "
28711 "editing it locally, then uploading it. If the file or device is large, you "
28712 "have to specify which part you wish to edit by using C<max> and/or C<start> "
28713 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
28714 "usual modifiers allowed such as C<1M> (1 megabyte)."
28718 #: ../fish/guestfish-commands.pod:111
28719 msgid "For example to edit the first few sectors of a disk you might do:"
28723 #: ../fish/guestfish-commands.pod:114
28726 " hexedit /dev/sda 1M\n"
28731 #: ../fish/guestfish-commands.pod:116
28733 "which would allow you to edit anywhere within the first megabyte of the "
28738 #: ../fish/guestfish-commands.pod:119
28739 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
28743 #: ../fish/guestfish-commands.pod:121
28746 " hexedit /dev/sda1 0x400 0x400\n"
28751 #: ../fish/guestfish-commands.pod:123
28752 msgid "(assuming the superblock is in the standard location)."
28756 #: ../fish/guestfish-commands.pod:125
28758 "This command requires the external L<hexedit(1)> program. You can specify "
28759 "another program to use by setting the C<HEXEDITOR> environment variable."
28763 #: ../fish/guestfish-commands.pod:129
28764 msgid "See also L</hexdump>."
28768 #: ../fish/guestfish-commands.pod:131
28773 #: ../fish/guestfish-commands.pod:133
28781 #: ../fish/guestfish-commands.pod:135
28782 msgid "Change the local directory, ie. the current directory of guestfish itself."
28786 #: ../fish/guestfish-commands.pod:138
28787 msgid "Note that C<!cd> won't do what you might expect."
28791 #: ../fish/guestfish-commands.pod:140
28796 #: ../fish/guestfish-commands.pod:142
28801 #: ../fish/guestfish-commands.pod:144
28809 #: ../fish/guestfish-commands.pod:146
28810 msgid "Opens the manual page for guestfish."
28814 #: ../fish/guestfish-commands.pod:148
28819 #: ../fish/guestfish-commands.pod:150
28824 #: ../fish/guestfish-commands.pod:152
28832 #: ../fish/guestfish-commands.pod:154
28840 #: ../fish/guestfish-commands.pod:156
28841 msgid "This is used to view a file."
28845 #: ../fish/guestfish-commands.pod:158
28847 "The default viewer is C<$PAGER>. However if you use the alternate command "
28848 "C<less> you will get the C<less> command specifically."
28852 #: ../fish/guestfish-commands.pod:161
28857 #: ../fish/guestfish-commands.pod:163
28865 #: ../fish/guestfish-commands.pod:165
28867 "Close and reopen the libguestfs handle. It is not necessary to use this "
28868 "normally, because the handle is closed properly when guestfish exits. "
28869 "However this is occasionally useful for testing."
28873 #: ../fish/guestfish-commands.pod:169
28878 #: ../fish/guestfish-commands.pod:171
28881 " sparse filename size\n"
28886 #: ../fish/guestfish-commands.pod:173
28888 "This creates an empty sparse file of the given size, and then adds so it can "
28889 "be further examined."
28893 #: ../fish/guestfish-commands.pod:176
28895 "In all respects it works the same as the L</alloc> command, except that the "
28896 "image file is allocated sparsely, which means that disk blocks are not "
28897 "assigned to the file until they are needed. Sparse disk files only use "
28898 "space when written to, but they are slower and there is a danger you could "
28899 "run out of real disk space during a write operation."
28903 #: ../fish/guestfish-commands.pod:186
28908 #: ../fish/guestfish-commands.pod:188
28916 #: ../fish/guestfish-commands.pod:190
28918 "This command returns a list of the optional groups known to the daemon, and "
28919 "indicates which ones are supported by this build of the libguestfs "
28924 #: ../fish/guestfish-commands.pod:194
28925 msgid "See also L<guestfs(3)/AVAILABILITY>."
28929 #: ../fish/guestfish-commands.pod:196
28934 #: ../fish/guestfish-commands.pod:198
28937 " time command args...\n"
28942 #: ../fish/guestfish-commands.pod:200
28944 "Run the command as usual, but print the elapsed time afterwards. This can "
28945 "be useful for benchmarking operations."
28949 #: ../test-tool/libguestfs-test-tool.pod:5
28950 msgid "libguestfs-test-tool - End user tests for libguestfs"
28954 #: ../test-tool/libguestfs-test-tool.pod:9
28957 " libguestfs-test-tool [--options]\n"
28962 #: ../test-tool/libguestfs-test-tool.pod:13
28964 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28965 "and developers, to allow them to check basic libguestfs functionality is "
28966 "working. This is needed because libguestfs occasionally breaks for reasons "
28967 "beyond our control: usually because of changes in the underlying qemu or "
28968 "kernel packages, or the host environment."
28972 #: ../test-tool/libguestfs-test-tool.pod:20
28973 msgid "If you suspect a problem in libguestfs, then just run:"
28977 #: ../test-tool/libguestfs-test-tool.pod:22
28980 " libguestfs-test-tool\n"
28985 #: ../test-tool/libguestfs-test-tool.pod:24
28986 msgid "It will print lots of diagnostic messages."
28990 #: ../test-tool/libguestfs-test-tool.pod:26
28991 msgid "If it runs to completion successfully, you will see this near the end:"
28995 #: ../test-tool/libguestfs-test-tool.pod:28
28998 " ===== TEST FINISHED OK =====\n"
29003 #: ../test-tool/libguestfs-test-tool.pod:30
29004 msgid "and the test tool will exit with code 0."
29008 #: ../test-tool/libguestfs-test-tool.pod:32
29010 "If it fails (and/or exits with non-zero error code), please paste the "
29011 "B<complete, unedited> output of the test tool into a bug report. More "
29012 "information about reporting bugs can be found on the "
29013 "L<http://libguestfs.org/> website."
29017 #: ../test-tool/libguestfs-test-tool.pod:41
29022 #: ../test-tool/libguestfs-test-tool.pod:43
29023 msgid "Display short usage information and exit."
29027 #: ../test-tool/libguestfs-test-tool.pod:45
29028 msgid "I<--qemu qemu_binary>"
29032 #: ../test-tool/libguestfs-test-tool.pod:47
29034 "If you have downloaded another qemu binary, point this option at the full "
29035 "path of the binary to try it."
29039 #: ../test-tool/libguestfs-test-tool.pod:50
29040 msgid "I<--qemudir qemu_source_dir>"
29044 #: ../test-tool/libguestfs-test-tool.pod:52
29046 "If you have compiled qemu from source, point this option at the source "
29047 "directory to try it."
29051 #: ../test-tool/libguestfs-test-tool.pod:55
29052 msgid "I<--timeout N>"
29056 #: ../test-tool/libguestfs-test-tool.pod:57
29058 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
29059 "does not usually need to be adjusted unless your machine is very slow."
29063 #: ../test-tool/libguestfs-test-tool.pod:63
29064 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
29068 #: ../test-tool/libguestfs-test-tool.pod:65
29070 "If you have compiled another version of qemu from source and would like to "
29071 "try that, then you can use the I<--qemudir> option to point to the qemu "
29072 "source directory."
29076 #: ../test-tool/libguestfs-test-tool.pod:69
29078 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
29079 "option to point to the binary."
29083 #: ../test-tool/libguestfs-test-tool.pod:72
29085 "When using an alternate qemu with libguestfs, usually you would need to "
29086 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
29087 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
29088 "when you use either of the I<--qemudir> or I<--qemu> options."
29092 #: ../test-tool/libguestfs-test-tool.pod:79
29094 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
29095 "I<1> if there was an error."
29099 #: ../test-tool/libguestfs-test-tool.pod:84
29101 "For the full list of environment variables which may affect libguestfs, "
29102 "please see the L<guestfs(3)> manual page."
29106 #: ../test-tool/libguestfs-test-tool.pod:89
29107 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
29111 #: ../fuse/guestmount.pod:5
29112 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
29116 #: ../fuse/guestmount.pod:9
29119 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
29124 #: ../fuse/guestmount.pod:11
29127 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
29132 #: ../fuse/guestmount.pod:13
29135 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
29140 #: ../fuse/guestmount.pod:17
29142 "You must I<not> use C<guestmount> in read-write mode on live virtual "
29143 "machines. If you do this, you risk disk corruption in the VM."
29147 #: ../fuse/guestmount.pod:22
29149 "The guestmount program can be used to mount virtual machine filesystems and "
29150 "other disk images on the host. It uses libguestfs for access to the guest "
29151 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
29152 "a mountable device."
29156 #: ../fuse/guestmount.pod:27
29158 "Along with other options, you have to give at least one device (I<-a> "
29159 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
29160 "option) or use the I<-i> inspection option. How this works is better "
29161 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
29166 #: ../fuse/guestmount.pod:33
29168 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
29169 "by you, and the filesystem will not be visible to any other users unless you "
29170 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
29171 "the filesystem, use the C<fusermount -u> command."
29175 #: ../fuse/guestmount.pod:41
29177 "For a typical Windows guest which has its main filesystem on the first "
29182 #: ../fuse/guestmount.pod:44
29185 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
29190 #: ../fuse/guestmount.pod:46
29192 "For a typical Linux guest which has a /boot filesystem on the first "
29193 "partition, and the root filesystem on a logical volume:"
29197 #: ../fuse/guestmount.pod:49
29200 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
29205 #: ../fuse/guestmount.pod:51
29206 msgid "To get libguestfs to detect guest mountpoints for you:"
29210 #: ../fuse/guestmount.pod:53
29213 " guestmount -a guest.img -i --ro /mnt\n"
29218 #: ../fuse/guestmount.pod:55
29219 msgid "For a libvirt guest called \"Guest\" you could do:"
29223 #: ../fuse/guestmount.pod:57
29226 " guestmount -d Guest -i --ro /mnt\n"
29231 #: ../fuse/guestmount.pod:59
29233 "If you don't know what filesystems are contained in a guest or disk image, "
29234 "use L<virt-filesystems(1)> first:"
29238 #: ../fuse/guestmount.pod:62
29241 " virt-filesystems MyGuest\n"
29246 #: ../fuse/guestmount.pod:64
29248 "If you want to trace the libguestfs calls but without excessive debugging "
29249 "information, we recommend:"
29253 #: ../fuse/guestmount.pod:67
29256 " guestmount [...] --trace /mnt\n"
29261 #: ../fuse/guestmount.pod:69
29262 msgid "If you want to debug the program, we recommend:"
29266 #: ../fuse/guestmount.pod:71
29269 " guestmount [...] --trace --verbose /mnt\n"
29274 #: ../fuse/guestmount.pod:73
29279 #: ../fuse/guestmount.pod:75
29280 msgid "Other users cannot see the filesystem by default"
29284 #: ../fuse/guestmount.pod:77
29286 "If you mount a filesystem as one user (eg. root), then other users will not "
29287 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
29288 "option when mounting:"
29292 #: ../fuse/guestmount.pod:81
29295 " sudo guestmount [...] -o allow_other /mnt\n"
29300 #: ../fuse/guestmount.pod:87
29301 msgid "B<-a image> | B<--add image>"
29305 #: ../fuse/guestmount.pod:89
29306 msgid "Add a block device or virtual machine image."
29310 #: ../fuse/guestmount.pod:94
29311 msgid "B<-c URI> | B<--connect URI>"
29315 #: ../fuse/guestmount.pod:100
29316 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
29320 #: ../fuse/guestmount.pod:108
29321 msgid "B<--dir-cache-timeout N>"
29325 #: ../fuse/guestmount.pod:110
29327 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
29328 "seconds. The readdir cache [actually, there are several semi-independent "
29329 "caches] is populated after a readdir(2) call with the stat and extended "
29330 "attributes of the files in the directory, in anticipation that they will be "
29331 "requested soon after."
29335 #: ../fuse/guestmount.pod:116
29337 "There is also a different attribute cache implemented by FUSE (see the FUSE "
29338 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
29339 "requests, only cache existing ones."
29343 #: ../fuse/guestmount.pod:127
29344 msgid "B<--format=raw|qcow2|..> | B<--format>"
29348 #: ../fuse/guestmount.pod:134
29350 "If you have untrusted raw-format guest disk images, you should use this "
29351 "option to specify the disk format. This avoids a possible security problem "
29352 "with malicious guests (CVE-2010-3851). See also "
29353 "L<guestfs(3)/guestfs_add_drive_opts>."
29357 #: ../fuse/guestmount.pod:139
29358 msgid "B<--fuse-help>"
29362 #: ../fuse/guestmount.pod:141
29363 msgid "Display help on special FUSE options (see I<-o> below)."
29367 #: ../fuse/guestmount.pod:145
29368 msgid "Display brief help and exit."
29372 #: ../fuse/guestmount.pod:147
29373 msgid "B<-i> | B<--inspector>"
29377 #: ../fuse/guestmount.pod:167
29379 "Mount the named partition or logical volume on the given mountpoint B<in the "
29380 "guest> (this has nothing to do with mountpoints in the host)."
29384 #: ../fuse/guestmount.pod:170
29386 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
29387 "something on C</>."
29391 #: ../fuse/guestmount.pod:183
29392 msgid "B<-n> | B<--no-sync>"
29396 #: ../fuse/guestmount.pod:185
29398 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
29399 "unmounted. If you specify this option, then we don't attempt to sync the "
29400 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
29404 #: ../fuse/guestmount.pod:190
29405 msgid "B<-o option> | B<--option option>"
29409 #: ../fuse/guestmount.pod:192
29410 msgid "Pass extra options to FUSE."
29414 #: ../fuse/guestmount.pod:194
29416 "To get a list of all the extra options supported by FUSE, use the command "
29417 "below. Note that only the FUSE I<-o> options can be passed, and only some "
29418 "of them are a good idea."
29422 #: ../fuse/guestmount.pod:198
29425 " guestmount --fuse-help\n"
29430 #: ../fuse/guestmount.pod:200
29431 msgid "Some potentially useful FUSE options:"
29435 #: ../fuse/guestmount.pod:204
29436 msgid "B<-o allow_other>"
29440 #: ../fuse/guestmount.pod:206
29441 msgid "Allow other users to see the filesystem."
29445 #: ../fuse/guestmount.pod:208
29446 msgid "B<-o attr_timeout=N>"
29450 #: ../fuse/guestmount.pod:210
29451 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
29455 #: ../fuse/guestmount.pod:212
29456 msgid "B<-o kernel_cache>"
29460 #: ../fuse/guestmount.pod:214
29462 "Allow the kernel to cache files (reduces the number of reads that have to go "
29463 "through the L<guestfs(3)> API). This is generally a good idea if you can "
29464 "afford the extra memory usage."
29468 #: ../fuse/guestmount.pod:218
29469 msgid "B<-o uid=N> B<-o gid=N>"
29473 #: ../fuse/guestmount.pod:220
29475 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
29476 "the chosen values."
29480 #: ../fuse/guestmount.pod:225
29481 msgid "B<-r> | B<--ro>"
29485 #: ../fuse/guestmount.pod:227
29487 "Add devices and mount everything read-only. Also disallow writes and make "
29488 "the disk appear read-only to FUSE."
29492 #: ../fuse/guestmount.pod:230
29494 "This is highly recommended if you are not going to edit the guest disk. If "
29495 "the guest is running and this option is I<not> supplied, then there is a "
29496 "strong risk of disk corruption in the guest. We try to prevent this from "
29497 "happening, but it is not always possible."
29501 #: ../fuse/guestmount.pod:235
29502 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29506 #: ../fuse/guestmount.pod:239
29507 msgid "Enable SELinux support for the guest."
29511 #: ../fuse/guestmount.pod:241
29512 msgid "B<-v> | B<--verbose>"
29516 #: ../fuse/guestmount.pod:243
29517 msgid "Enable verbose messages from underlying libguestfs."
29521 #: ../fuse/guestmount.pod:245
29522 msgid "B<-V> | B<--version>"
29526 #: ../fuse/guestmount.pod:247
29527 msgid "Display the program version and exit."
29531 #: ../fuse/guestmount.pod:249
29532 msgid "B<-w> | B<--rw>"
29536 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
29537 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
29541 #: ../fuse/guestmount.pod:256
29542 msgid "B<-x> | B<--trace>"
29546 #: ../fuse/guestmount.pod:258
29547 msgid "Trace libguestfs calls and entry into each FUSE function."
29551 #: ../fuse/guestmount.pod:260
29552 msgid "This also stops the daemon from forking into the background."
29556 #: ../fuse/guestmount.pod:281
29558 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29559 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
29560 "L<http://fuse.sf.net/>."
29564 #: ../fuse/guestmount.pod:296
29565 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
29569 #: ../tools/virt-win-reg.pl:37
29571 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
29576 #: ../tools/virt-win-reg.pl:41
29579 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
29584 #: ../tools/virt-win-reg.pl:43
29587 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
29592 #: ../tools/virt-win-reg.pl:45
29595 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
29600 #: ../tools/virt-win-reg.pl:47
29603 " virt-win-reg --merge domname [input.reg ...]\n"
29608 #: ../tools/virt-win-reg.pl:49
29611 " virt-win-reg [--options] disk.img ... # instead of domname\n"
29616 #: ../tools/virt-win-reg.pl:53
29618 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
29619 "virtual machines. If you do this, you I<will> get irreversible disk "
29620 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
29621 "but doesn't catch all cases."
29625 #: ../tools/virt-win-reg.pl:58
29627 "Modifying the Windows Registry is an inherently risky operation. The format "
29628 "is deliberately obscure and undocumented, and Registry changes can leave the "
29629 "system unbootable. Therefore when using the I<--merge> option, make sure "
29630 "you have a reliable backup first."
29634 #: ../tools/virt-win-reg.pl:65
29636 "This program can export and merge Windows Registry entries from a Windows "
29641 #: ../tools/virt-win-reg.pl:68
29643 "The first parameter is the libvirt guest name or the raw disk image of a "
29648 #: ../tools/virt-win-reg.pl:71
29650 "If I<--merge> is I<not> specified, then the chosen registry key is "
29651 "displayed/exported (recursively). For example:"
29655 #: ../tools/virt-win-reg.pl:74
29658 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
29663 #: ../tools/virt-win-reg.pl:76
29664 msgid "You can also display single values from within registry keys, for example:"
29668 #: ../tools/virt-win-reg.pl:79
29671 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
29672 " $ virt-win-reg Windows7 $cvkey ProductName\n"
29673 " Windows 7 Enterprise\n"
29678 #: ../tools/virt-win-reg.pl:83
29680 "With I<--merge>, you can merge a textual regedit file into the Windows "
29685 #: ../tools/virt-win-reg.pl:86
29688 " $ virt-win-reg --merge Windows7 changes.reg\n"
29693 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
29698 #: ../tools/virt-win-reg.pl:90
29700 "This program is only meant for simple access to the registry. If you want "
29701 "to do complicated things with the registry, we suggest you download the "
29702 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
29703 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
29704 "L<hivexregedit(1)>."
29708 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
29709 msgid "Display brief help."
29713 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
29714 msgid "Display version number and exit."
29718 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
29723 #: ../tools/virt-win-reg.pl:122
29724 msgid "Enable debugging messages."
29728 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
29729 msgid "B<--connect URI> | B<-c URI>"
29733 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
29735 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
29736 "to the default libvirt hypervisor."
29740 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
29742 "If you specify guest block devices directly, then libvirt is not used at "
29747 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
29748 msgid "B<--format> raw"
29752 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
29754 "Specify the format of disk images given on the command line. If this is "
29755 "omitted then the format is autodetected from the content of the disk image."
29759 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
29761 "If disk images are requested from libvirt, then this program asks libvirt "
29762 "for this information. In this case, the value of the format parameter is "
29767 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
29769 "If working with untrusted raw-format guest disk images, you should ensure "
29770 "the format is always specified."
29774 #: ../tools/virt-win-reg.pl:157
29779 #: ../tools/virt-win-reg.pl:159
29781 "In merge mode, this merges a textual regedit file into the Windows Registry "
29782 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29783 "displays or exports Registry entries instead."
29787 #: ../tools/virt-win-reg.pl:163
29789 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29790 "result in disk corruption. However exporting (without this flag) is always "
29795 #: ../tools/virt-win-reg.pl:171
29796 msgid "B<--encoding> UTF-16LE|ASCII"
29800 #: ../tools/virt-win-reg.pl:173
29802 "When merging (only), you may need to specify the encoding for strings to be "
29803 "used in the hive file. This is explained in detail in "
29804 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
29808 #: ../tools/virt-win-reg.pl:177
29810 "The default is to use UTF-16LE, which should work with recent versions of "
29815 #: ../tools/virt-win-reg.pl:184
29816 msgid "B<--unsafe-printable-strings>"
29820 #: ../tools/virt-win-reg.pl:186
29822 "When exporting (only), assume strings are UTF-16LE and print them as strings "
29823 "instead of hex sequences. Remove the final zero codepoint from strings if "
29828 #: ../tools/virt-win-reg.pl:190
29830 "This is unsafe and does not preserve the fidelity of strings in the original "
29831 "Registry for various reasons:"
29835 #: ../tools/virt-win-reg.pl:197
29837 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
29838 "other encodings will be corrupted by this transformation."
29842 #: ../tools/virt-win-reg.pl:202
29844 "Assumes that everything which has type 1 or 2 is really a string and that "
29845 "everything else is not a string, but the type field in real Registries is "
29850 #: ../tools/virt-win-reg.pl:208
29852 "Loses information about whether a zero codepoint followed the string in the "
29857 #: ../tools/virt-win-reg.pl:213
29859 "This all happens because the Registry itself contains no information about "
29860 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
29864 #: ../tools/virt-win-reg.pl:217
29866 "You should only use this option for quick hacking and debugging of the "
29867 "Registry contents, and I<never> use it if the output is going to be passed "
29868 "into another program or stored in another Registry."
29872 #: ../tools/virt-win-reg.pl:554
29873 msgid "SUPPORTED SYSTEMS"
29877 #: ../tools/virt-win-reg.pl:556
29879 "The program currently supports Windows NT-derived guests starting with "
29880 "Windows XP through to at least Windows 7."
29884 #: ../tools/virt-win-reg.pl:559
29885 msgid "The following Registry keys are supported:"
29889 #: ../tools/virt-win-reg.pl:563
29890 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
29894 #: ../tools/virt-win-reg.pl:565
29895 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
29899 #: ../tools/virt-win-reg.pl:567
29900 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
29904 #: ../tools/virt-win-reg.pl:569
29905 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
29909 #: ../tools/virt-win-reg.pl:571
29910 msgid "C<HKEY_USERS\\.DEFAULT>"
29914 #: ../tools/virt-win-reg.pl:573
29915 msgid "C<HKEY_USERS\\I<SID>>"
29919 #: ../tools/virt-win-reg.pl:575
29920 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
29924 #: ../tools/virt-win-reg.pl:577
29925 msgid "C<HKEY_USERS\\I<username>>"
29929 #: ../tools/virt-win-reg.pl:579
29930 msgid "where I<username> is a local user name (this is a libguestfs extension)."
29934 #: ../tools/virt-win-reg.pl:583
29936 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29941 #: ../tools/virt-win-reg.pl:586
29943 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
29944 "supported (there is no \"current user\")."
29948 #: ../tools/virt-win-reg.pl:589
29953 #: ../tools/virt-win-reg.pl:591
29955 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29956 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
29957 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
29958 "with Windows-style line endings, you may need to reencode the whole file "
29959 "before or after processing."
29963 #: ../tools/virt-win-reg.pl:597
29965 "To reencode a file from Windows format to Linux (before processing it with "
29966 "the I<--merge> option), you would do something like this:"
29970 #: ../tools/virt-win-reg.pl:600
29973 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29978 #: ../tools/virt-win-reg.pl:602
29980 "To go in the opposite direction, after exporting and before sending the file "
29981 "to a Windows user, do something like this:"
29985 #: ../tools/virt-win-reg.pl:605
29988 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29993 #: ../tools/virt-win-reg.pl:607
29994 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29998 #: ../tools/virt-win-reg.pl:609
30000 "If you are unsure about the current encoding, use the L<file(1)> command. "
30001 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
30002 "Windows-style (CRLF) line endings, like this:"
30006 #: ../tools/virt-win-reg.pl:613
30009 " $ file software.reg\n"
30010 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
30011 " with CRLF line terminators\n"
30016 #: ../tools/virt-win-reg.pl:617
30017 msgid "This file would need conversion before you could I<--merge> it."
30021 #: ../tools/virt-win-reg.pl:619
30022 msgid "CurrentControlSet etc."
30026 #: ../tools/virt-win-reg.pl:621
30028 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
30029 "Registry at the level of the hive file, and therefore you cannot modify "
30034 #: ../tools/virt-win-reg.pl:625
30036 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
30037 "circumstances it might refer to another control set. The way to find out is "
30038 "to look at the C<HKLM\\SYSTEM\\Select> key:"
30042 #: ../tools/virt-win-reg.pl:629
30045 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
30046 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
30047 " \"Current\"=dword:00000001\n"
30048 " \"Default\"=dword:00000001\n"
30049 " \"Failed\"=dword:00000000\n"
30050 " \"LastKnownGood\"=dword:00000002\n"
30055 #: ../tools/virt-win-reg.pl:636
30056 msgid "\"Current\" is the one which Windows will choose when it boots."
30060 #: ../tools/virt-win-reg.pl:638
30061 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
30065 #: ../tools/virt-win-reg.pl:641
30066 msgid "WINDOWS TIPS"
30070 #: ../tools/virt-win-reg.pl:643
30072 "Note that some of these tips modify the guest disk image. The guest I<must> "
30073 "be shut off, else you will get disk corruption."
30077 #: ../tools/virt-win-reg.pl:646
30078 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30082 #: ../tools/virt-win-reg.pl:648
30084 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30085 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30086 "is uploaded into C<C:\\>:"
30090 #: ../tools/virt-win-reg.pl:652
30093 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30098 #: ../tools/virt-win-reg.pl:654
30099 msgid "Prepare a regedit file containing the registry change:"
30103 #: ../tools/virt-win-reg.pl:656
30106 " cat > test.reg <<'EOF'\n"
30107 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30108 " \"Test\"=\"c:\\\\test.bat\"\n"
30114 #: ../tools/virt-win-reg.pl:661
30116 "In this example we use the key C<RunOnce> which means that the script will "
30117 "run precisely once when the first user logs in. If you want it to run every "
30118 "time a user logs in, replace C<RunOnce> with C<Run>."
30122 #: ../tools/virt-win-reg.pl:665
30123 msgid "Now update the registry:"
30127 #: ../tools/virt-win-reg.pl:667
30130 " virt-win-reg --merge WindowsGuest test.reg\n"
30135 #: ../tools/virt-win-reg.pl:669
30136 msgid "INSTALLING A SERVICE"
30140 #: ../tools/virt-win-reg.pl:671
30142 "This section assumes you are familiar with Windows services, and you either "
30143 "have a program which handles the Windows Service Control Protocol directly "
30144 "or you want to run any program using a service wrapper like SrvAny or the "
30149 #: ../tools/virt-win-reg.pl:676
30151 "First upload the program and optionally the service wrapper. In this case "
30152 "the test program is called C<test.exe> and we are using the RHSrvAny "
30157 #: ../tools/virt-win-reg.pl:680
30160 " guestfish -i -d WindowsGuest <<EOF\n"
30161 " upload rhsrvany.exe /rhsrvany.exe\n"
30162 " upload test.exe /test.exe\n"
30168 #: ../tools/virt-win-reg.pl:685
30170 "Prepare a regedit file containing the registry changes. In this example, "
30171 "the first registry change is needed for the service itself or the service "
30172 "wrapper (if used). The second registry change is only needed because I am "
30173 "using the RHSrvAny service wrapper."
30177 #: ../tools/virt-win-reg.pl:690
30180 " cat > service.reg <<'EOF'\n"
30181 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30182 " \"Type\"=dword:00000010\n"
30183 " \"Start\"=dword:00000002\n"
30184 " \"ErrorControl\"=dword:00000001\n"
30185 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30186 " \"DisplayName\"=\"RHSrvAny\"\n"
30187 " \"ObjectName\"=\"NetworkService\"\n"
30192 #: ../tools/virt-win-reg.pl:699
30195 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30196 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30197 " \"PWD\"=\"c:\\\\Temp\"\n"
30203 #: ../tools/virt-win-reg.pl:710
30205 "For use of C<ControlSet001> see the section above in this manual page. You "
30206 "may need to adjust this according to the control set that is in use by the "
30211 #: ../tools/virt-win-reg.pl:716
30213 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30214 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30215 "privileged account."
30219 #: ../tools/virt-win-reg.pl:722
30221 "For the meaning of the magic numbers, see this Microsoft KB article: "
30222 "L<http://support.microsoft.com/kb/103000>."
30226 #: ../tools/virt-win-reg.pl:727
30227 msgid "Update the registry:"
30231 #: ../tools/virt-win-reg.pl:729
30234 " virt-win-reg --merge WindowsGuest service.reg\n"
30239 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532 ../tools/virt-list-partitions.pl:250
30240 msgid "SHELL QUOTING"
30244 #: ../tools/virt-win-reg.pl:733
30246 "Be careful when passing parameters containing C<\\> (backslash) in the "
30247 "shell. Usually you will have to use 'single quotes' or double backslashes "
30248 "(but not both) to protect them from the shell."
30252 #: ../tools/virt-win-reg.pl:737
30253 msgid "Paths and value names are case-insensitive."
30257 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:252
30259 "Libvirt guest names can contain arbitrary characters, some of which have "
30260 "meaning to the shell such as C<#> and space. You may need to quote or "
30261 "escape these characters on the command line. See the shell manual page "
30262 "L<sh(1)> for details."
30266 #: ../tools/virt-win-reg.pl:746
30268 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
30269 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
30270 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
30271 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30275 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
30277 "When reporting bugs, please enable debugging and capture the I<complete> "
30282 #: ../tools/virt-win-reg.pl:764
30285 " export LIBGUESTFS_DEBUG=1\n"
30286 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30291 #: ../tools/virt-win-reg.pl:767
30293 "Attach /tmp/virt-win-reg.log to a new bug report at "
30294 "L<https://bugzilla.redhat.com/>"
30298 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564 ../tools/virt-list-partitions.pl:269
30303 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566 ../tools/virt-list-partitions.pl:271
30304 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
30308 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
30309 msgid "Copyright (C) 2010 Red Hat Inc."
30313 #: ../tools/virt-list-filesystems.pl:32
30314 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30318 #: ../tools/virt-list-filesystems.pl:36
30321 " virt-list-filesystems [--options] domname\n"
30326 #: ../tools/virt-list-filesystems.pl:38
30329 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30334 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30336 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30341 #: ../tools/virt-list-filesystems.pl:45
30343 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
30344 "are contained in a virtual machine or disk image."
30348 #: ../tools/virt-list-filesystems.pl:49
30350 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30351 "functionality. For more complex cases you should look at the "
30352 "L<guestfish(1)> tool."
30356 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
30357 msgid "B<-l> | B<--long>"
30361 #: ../tools/virt-list-filesystems.pl:108
30363 "With this option, C<virt-list-filesystems> displays the type of each "
30364 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
30368 #: ../tools/virt-list-filesystems.pl:115
30369 msgid "B<-a> | B<--all>"
30373 #: ../tools/virt-list-filesystems.pl:117
30375 "Normally we only show mountable filesystems. If this option is given then "
30376 "swap devices are shown too."
30380 #: ../tools/virt-list-filesystems.pl:191
30382 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
30383 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
30384 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30388 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
30389 msgid "Copyright (C) 2009 Red Hat Inc."
30393 #: ../tools/virt-tar.pl:33
30394 msgid "virt-tar - Extract or upload files to a virtual machine"
30398 #: ../tools/virt-tar.pl:37
30401 " virt-tar [--options] -x domname directory tarball\n"
30406 #: ../tools/virt-tar.pl:39
30409 " virt-tar [--options] -u domname tarball directory\n"
30414 #: ../tools/virt-tar.pl:41
30417 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
30422 #: ../tools/virt-tar.pl:43
30425 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
30430 #: ../tools/virt-tar.pl:47
30432 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
30433 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
30437 #: ../tools/virt-tar.pl:52
30438 msgid "Download C</home> from the VM into a local tarball:"
30442 #: ../tools/virt-tar.pl:54
30445 " virt-tar -x domname /home home.tar\n"
30450 #: ../tools/virt-tar.pl:56
30453 " virt-tar -zx domname /home home.tar.gz\n"
30458 #: ../tools/virt-tar.pl:58
30459 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
30463 #: ../tools/virt-tar.pl:60
30466 " virt-tar -u domname uploadstuff.tar /tmp\n"
30471 #: ../tools/virt-tar.pl:62
30474 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
30479 #: ../tools/virt-tar.pl:66
30481 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
30482 "virtual machines. If you do this, you risk disk corruption in the VM. "
30483 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
30487 #: ../tools/virt-tar.pl:71
30489 "You can use I<-x> (extract) on live virtual machines, but you might get "
30490 "inconsistent results or errors if there is filesystem activity inside the "
30491 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
30492 "work, but the only way to guarantee consistent results is if the virtual "
30493 "machine is shut down."
30497 #: ../tools/virt-tar.pl:79
30499 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
30500 "parts of a guest filesystem. There are many possibilities: making backups, "
30501 "uploading data files, snooping on guest activity, fixing or customizing "
30506 #: ../tools/virt-tar.pl:84
30508 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
30509 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
30510 "should look at the L<guestfish(1)> tool."
30514 #: ../tools/virt-tar.pl:88
30516 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
30517 "its contents (recursively) from the virtual machine into a local tarball. "
30518 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
30519 "virtual machine. You cannot use these two options together."
30523 #: ../tools/virt-tar.pl:94
30525 "In addition, you may need to use the I<-z> (gZip) option to enable "
30526 "compression. When uploading, you have to specify I<-z> if the upload file "
30527 "is compressed because virt-tar won't detect this on its own."
30531 #: ../tools/virt-tar.pl:98
30533 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
30534 "example it cannot do PKZip files or bzip2 compression. If you want that "
30535 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
30536 "the L<libguestfs(3)> API)."
30540 #: ../tools/virt-tar.pl:156
30541 msgid "B<-x> | B<--extract> | B<--download>"
30545 #: ../tools/virt-tar.pl:158
30546 msgid "B<-u> | B<--upload>"
30550 #: ../tools/virt-tar.pl:160
30552 "Use I<-x> to extract (download) a directory from a virtual machine to a "
30557 #: ../tools/virt-tar.pl:163
30559 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
30560 "Please read the L</WARNING> section above before using this option."
30564 #: ../tools/virt-tar.pl:167
30565 msgid "You must specify exactly one of these options."
30569 #: ../tools/virt-tar.pl:173
30570 msgid "B<-z> | B<--gzip>"
30574 #: ../tools/virt-tar.pl:175
30575 msgid "Specify that the input or output tarball is gzip-compressed."
30579 #: ../tools/virt-tar.pl:288
30581 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
30582 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
30583 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
30584 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30588 #: ../tools/virt-make-fs.pl:37
30589 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
30593 #: ../tools/virt-make-fs.pl:41
30596 " virt-make-fs [--options] input.tar output.img\n"
30601 #: ../tools/virt-make-fs.pl:43
30604 " virt-make-fs [--options] input.tar.gz output.img\n"
30609 #: ../tools/virt-make-fs.pl:45
30612 " virt-make-fs [--options] directory output.img\n"
30617 #: ../tools/virt-make-fs.pl:49
30619 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
30620 "archive or some files in a directory. It is similar to tools like "
30621 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
30622 "it can create common filesystem types like ext2/3 or NTFS, which can be "
30623 "useful if you want to attach these filesystems to existing virtual machines "
30624 "(eg. to import large amounts of read-only data to a VM)."
30628 #: ../tools/virt-make-fs.pl:57
30629 msgid "Basic usage is:"
30633 #: ../tools/virt-make-fs.pl:59
30636 " virt-make-fs input output\n"
30641 #: ../tools/virt-make-fs.pl:61
30643 "where C<input> is either a directory containing files that you want to add, "
30644 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
30645 "C<output> is a disk image. The input type is detected automatically. The "
30646 "output disk image defaults to a raw ext2 image unless you specify extra "
30647 "flags (see L</OPTIONS> below)."
30651 #: ../tools/virt-make-fs.pl:67
30652 msgid "EXTRA SPACE"
30656 #: ../tools/virt-make-fs.pl:69
30658 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
30659 "the files that it contains, but might have extra space. Depending on how "
30660 "you are going to use the output, you might think this extra space is wasted "
30661 "and want to minimize it, or you might want to leave space so that more files "
30662 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
30663 "but you can use the I<--size> flag to leave space in the filesystem if you "
30668 #: ../tools/virt-make-fs.pl:77
30670 "An alternative way to leave extra space but not make the output image any "
30671 "bigger is to use an alternative disk image format (instead of the default "
30672 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
30673 "image format (check your hypervisor supports this before using it). This "
30674 "allows you to choose a large I<--size> but the extra space won't actually be "
30675 "allocated in the image until you try to store something in it."
30679 #: ../tools/virt-make-fs.pl:85
30681 "Don't forget that you can also use local commands including L<resize2fs(8)> "
30682 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
30683 "to build another image from scratch."
30687 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
30692 #: ../tools/virt-make-fs.pl:91
30695 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
30700 #: ../tools/virt-make-fs.pl:93
30701 msgid "FILESYSTEM TYPE"
30705 #: ../tools/virt-make-fs.pl:95
30707 "The default filesystem type is C<ext2>. Just about any filesystem type that "
30708 "libguestfs supports can be used (but I<not> read-only formats like "
30709 "ISO9660). Here are some of the more common choices:"
30713 #: ../tools/virt-make-fs.pl:101
30718 #: ../tools/virt-make-fs.pl:103
30720 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
30721 "you are not going to use the filesystem in a way that requires the journal, "
30722 "then this is just wasted overhead."
30726 #: ../tools/virt-make-fs.pl:107
30727 msgid "I<ntfs> or I<vfat>"
30731 #: ../tools/virt-make-fs.pl:109
30732 msgid "Useful if exporting data to a Windows guest."
30736 #: ../tools/virt-make-fs.pl:111
30738 "I<Note for vfat>: The tar archive or local directory must only contain files "
30739 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
30740 "program running within libguestfs is unable to change the ownership of "
30741 "non-root files, since vfat itself does not support this."
30745 #: ../tools/virt-make-fs.pl:116
30750 #: ../tools/virt-make-fs.pl:118
30752 "Lower overhead than C<ext2>, but certain limitations on filename length and "
30753 "total filesystem size."
30757 #: ../tools/virt-make-fs.pl:125
30760 " virt-make-fs --type=minix input minixfs.img\n"
30765 #: ../tools/virt-make-fs.pl:127
30766 msgid "TO PARTITION OR NOT TO PARTITION"
30770 #: ../tools/virt-make-fs.pl:129
30771 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30775 #: ../tools/virt-make-fs.pl:131
30777 "Adding a partition can make the disk image more compatible with certain "
30778 "virtualized operating systems which don't expect to see a filesystem "
30779 "directly located on a block device (Linux doesn't care and will happily "
30780 "handle both types)."
30784 #: ../tools/virt-make-fs.pl:136
30786 "On the other hand, if you have a partition table then the output image is no "
30787 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30788 "directly on a partitioned disk image. (However libguestfs tools such as "
30789 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30793 #: ../tools/virt-make-fs.pl:144
30794 msgid "Add an MBR partition:"
30798 #: ../tools/virt-make-fs.pl:146
30801 " virt-make-fs --partition -- input disk.img\n"
30806 #: ../tools/virt-make-fs.pl:148
30808 "If the output disk image could be terabyte-sized or larger, it's better to "
30809 "use an EFI/GPT-compatible partition table:"
30813 #: ../tools/virt-make-fs.pl:151
30816 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30821 #: ../tools/virt-make-fs.pl:179
30822 msgid "Enable debugging information."
30826 #: ../tools/virt-make-fs.pl:185
30827 msgid "B<--size=E<lt>NE<gt>>"
30831 #: ../tools/virt-make-fs.pl:187
30832 msgid "B<--size=+E<lt>NE<gt>>"
30836 #: ../tools/virt-make-fs.pl:189
30837 msgid "B<-s E<lt>NE<gt>>"
30841 #: ../tools/virt-make-fs.pl:191
30842 msgid "B<-s +E<lt>NE<gt>>"
30846 #: ../tools/virt-make-fs.pl:193
30847 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30851 #: ../tools/virt-make-fs.pl:196
30853 "If this option is I<not> given, then the output image will be just large "
30854 "enough to contain all the files, with not much wasted space."
30858 #: ../tools/virt-make-fs.pl:199
30860 "To choose a fixed size output disk, specify an absolute number followed by "
30861 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30862 "Petabytes or Exabytes. This must be large enough to contain all the input "
30863 "files, else you will get an error."
30867 #: ../tools/virt-make-fs.pl:204
30869 "To leave extra space, specify C<+> (plus sign) and a number followed by "
30870 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30871 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30872 "the input files, and (approximately) an extra 200 MB free space."
30876 #: ../tools/virt-make-fs.pl:210
30878 "Note that virt-make-fs estimates free space, and therefore will not produce "
30879 "filesystems containing precisely the free space requested. (It is much more "
30880 "expensive and time-consuming to produce a filesystem which has precisely the "
30881 "desired free space)."
30885 #: ../tools/virt-make-fs.pl:219
30886 msgid "B<--format=E<lt>fmtE<gt>>"
30890 #: ../tools/virt-make-fs.pl:221
30891 msgid "B<-F E<lt>fmtE<gt>>"
30895 #: ../tools/virt-make-fs.pl:223
30896 msgid "Choose the output disk image format."
30900 #: ../tools/virt-make-fs.pl:225
30901 msgid "The default is C<raw> (raw disk image)."
30905 #: ../tools/virt-make-fs.pl:227
30907 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30908 "that would really make sense here is C<qcow2>."
30912 #: ../tools/virt-make-fs.pl:234
30913 msgid "B<--type=E<lt>fsE<gt>>"
30917 #: ../tools/virt-make-fs.pl:236
30918 msgid "B<-t E<lt>fsE<gt>>"
30922 #: ../tools/virt-make-fs.pl:238
30923 msgid "Choose the output filesystem type."
30927 #: ../tools/virt-make-fs.pl:240
30928 msgid "The default is C<ext2>."
30932 #: ../tools/virt-make-fs.pl:242
30933 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30937 #: ../tools/virt-make-fs.pl:249
30938 msgid "B<--partition>"
30942 #: ../tools/virt-make-fs.pl:251
30943 msgid "B<--partition=E<lt>parttypeE<gt>>"
30947 #: ../tools/virt-make-fs.pl:253
30949 "If specified, this flag adds an MBR partition table to the output disk "
30954 #: ../tools/virt-make-fs.pl:256
30956 "You can change the partition table type, eg. I<--partition=gpt> for large "
30961 #: ../tools/virt-make-fs.pl:259
30963 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30964 "might consider the next parameter to be the partition type. For example:"
30968 #: ../tools/virt-make-fs.pl:263
30971 " virt-make-fs --partition input.tar ...\n"
30976 #: ../tools/virt-make-fs.pl:265
30978 "would cause virt-make-fs to think you wanted to use a partition type of "
30979 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30980 "dash) between options and the input file argument:"
30984 #: ../tools/virt-make-fs.pl:269
30987 " virt-make-fs --partition -- input.tar ...\n"
30992 #: ../tools/virt-make-fs.pl:541
30994 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30995 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30996 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
31000 #: ../tools/virt-make-fs.pl:558
31003 " export LIBGUESTFS_DEBUG=1\n"
31004 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
31009 #: ../tools/virt-make-fs.pl:561
31011 "Attach /tmp/virt-make-fs.log to a new bug report at "
31012 "L<https://bugzilla.redhat.com/>"
31016 #: ../tools/virt-list-partitions.pl:32
31017 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
31021 #: ../tools/virt-list-partitions.pl:36
31024 " virt-list-partitions [--options] domname\n"
31029 #: ../tools/virt-list-partitions.pl:38
31032 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31037 #: ../tools/virt-list-partitions.pl:45
31039 "C<virt-list-partitions> is a command line tool to list the partitions that "
31040 "are contained in a virtual machine or disk image. It is mainly useful as a "
31041 "first step to using L<virt-resize(1)>."
31045 #: ../tools/virt-list-partitions.pl:50
31047 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31048 "functionality. For more complex cases you should look at the "
31049 "L<guestfish(1)> tool."
31053 #: ../tools/virt-list-partitions.pl:107
31054 msgid "B<-h> | B<--human-readable>"
31058 #: ../tools/virt-list-partitions.pl:109
31059 msgid "Show sizes in human-readable form (eg. \"1G\")."
31063 #: ../tools/virt-list-partitions.pl:117
31065 "With this option, C<virt-list-partitions> displays the type and size of each "
31066 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31070 #: ../tools/virt-list-partitions.pl:124
31071 msgid "B<-t> | B<--total>"
31075 #: ../tools/virt-list-partitions.pl:126
31076 msgid "Display the total size of each block device (as a separate row or rows)."
31080 #: ../tools/virt-list-partitions.pl:259
31082 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
31083 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
31084 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31088 #: ../tools/virt-list-partitions.pl:275
31089 msgid "Copyright (C) 2009-2010 Red Hat Inc."