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.12\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-06-28 19:35+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:2008 ../src/guestfs.pod:2013 ../src/guestfs.pod:2019 ../src/guestfs.pod:2027 ../src/guestfs.pod:2381 ../src/guestfs.pod:2387 ../src/guestfs.pod:2392 ../src/guestfs.pod:2398 ../src/guestfs.pod:2967 ../src/guestfs.pod:2971 ../src/guestfs.pod:2975 ../src/guestfs.pod:2979 ../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:1603 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1623 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1641 ../src/guestfs-actions.pod:1645 ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:1796 ../src/guestfs-actions.pod:1801 ../src/guestfs-actions.pod:1862 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1871 ../src/guestfs-actions.pod:2783 ../src/guestfs-actions.pod:2789 ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2804 ../src/guestfs-actions.pod:2811 ../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:1074 ../fish/guestfish-actions.pod:1078 ../fish/guestfish-actions.pod:1082 ../fish/guestfish-actions.pod:1086 ../fish/guestfish-actions.pod:1094 ../fish/guestfish-actions.pod:1098 ../fish/guestfish-actions.pod:1102 ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116 ../fish/guestfish-actions.pod:1120 ../fish/guestfish-actions.pod:1210 ../fish/guestfish-actions.pod:1214 ../fish/guestfish-actions.pod:1219 ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1266 ../fish/guestfish-actions.pod:1270 ../fish/guestfish-actions.pod:1275 ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:1916 ../fish/guestfish-actions.pod:1923 ../fish/guestfish-actions.pod:1930 ../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:2426
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:2451
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:767
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:1010
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:1858 ../src/guestfs-actions.pod:2779 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1262 ../fish/guestfish-actions.pod:1898 ../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 "PRIVATE DATA AREA"
3761 #: ../src/guestfs.pod:1954
3763 "You can attach named pieces of private data to the libguestfs handle, fetch "
3764 "them by name, and walk over them, for the lifetime of the handle. This is "
3765 "called the private data area and is only available from the C API."
3769 #: ../src/guestfs.pod:1959
3770 msgid "To attach a named piece of data, use the following call:"
3774 #: ../src/guestfs.pod:1961
3777 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3782 #: ../src/guestfs.pod:1963
3784 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3785 "pointer (which can be C<NULL>). Any previous item with the same key is "
3790 #: ../src/guestfs.pod:1967
3792 "You can use any C<key> you want, but your key should I<not> start with an "
3793 "underscore character. Keys beginning with an underscore character are "
3794 "reserved for internal libguestfs purposes (eg. for implementing language "
3795 "bindings). It is recommended that you prefix the key with some unique "
3796 "string to avoid collisions with other users."
3800 #: ../src/guestfs.pod:1973
3801 msgid "To retrieve the pointer, use:"
3805 #: ../src/guestfs.pod:1975
3808 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3813 #: ../src/guestfs.pod:1977
3815 "This function returns C<NULL> if either no data is found associated with "
3816 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3821 #: ../src/guestfs.pod:1981
3823 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3824 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3825 "all. In particular, libguestfs does I<not> try to free the data when the "
3826 "handle is closed. If the data must be freed, then the caller must either "
3827 "free it before calling L</guestfs_close> or must set up a close callback to "
3828 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3832 #: ../src/guestfs.pod:1988
3833 msgid "To walk over all entries, use these two functions:"
3837 #: ../src/guestfs.pod:1990
3840 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
3845 #: ../src/guestfs.pod:1992
3848 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
3853 #: ../src/guestfs.pod:1994
3855 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
3856 "not have any particular meaning -- keys are not returned in any defined "
3857 "order). A pointer to the key is returned in C<*key_rtn> and the "
3858 "corresponding data pointer is returned from the function. C<NULL> is "
3859 "returned if there are no keys stored in the handle."
3863 #: ../src/guestfs.pod:2000
3865 "C<guestfs_next_private> returns the next key, pointer pair. The return "
3866 "value of this function is also C<NULL> is there are no further entries to "
3871 #: ../src/guestfs.pod:2004
3872 msgid "Notes about walking over entries:"
3876 #: ../src/guestfs.pod:2010
3877 msgid "You must not call C<guestfs_set_private> while walking over the entries."
3881 #: ../src/guestfs.pod:2015
3883 "The handle maintains an internal iterator which is reset when you call "
3884 "C<guestfs_first_private>. This internal iterator is invalidated when you "
3885 "call C<guestfs_set_private>."
3889 #: ../src/guestfs.pod:2021
3890 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
3894 #: ../src/guestfs.pod:2023
3897 " guestfs_set_private (g, key, NULL);\n"
3902 #: ../src/guestfs.pod:2025
3903 msgid "then that C<key> is not returned when walking."
3907 #: ../src/guestfs.pod:2029
3909 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
3910 "C<guestfs_next_private> or C<guestfs_set_private>."
3914 #: ../src/guestfs.pod:2035
3916 "The following example code shows how to print all keys and data pointers "
3917 "that are associated with the handle C<g>:"
3921 #: ../src/guestfs.pod:2038
3924 " const char *key;\n"
3925 " void *data = guestfs_first_private (g, &key);\n"
3926 " while (data != NULL)\n"
3928 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3929 " data = guestfs_next_private (g, &key);\n"
3935 #: ../src/guestfs.pod:2046
3937 "More commonly you are only interested in keys that begin with an "
3938 "application-specific prefix C<foo_>. Modify the loop like so:"
3942 #: ../src/guestfs.pod:2049
3945 " const char *key;\n"
3946 " void *data = guestfs_first_private (g, &key);\n"
3947 " while (data != NULL)\n"
3949 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3950 " printf (\"key = %s, data = %p\\n\", key, data);\n"
3951 " data = guestfs_next_private (g, &key);\n"
3957 #: ../src/guestfs.pod:2058
3959 "If you need to modify keys while walking, then you have to jump back to the "
3960 "beginning of the loop. For example, to delete all keys prefixed with "
3965 #: ../src/guestfs.pod:2062
3968 " const char *key;\n"
3971 " data = guestfs_first_private (g, &key);\n"
3972 " while (data != NULL)\n"
3974 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
3976 " guestfs_set_private (g, key, NULL);\n"
3977 " /* note that 'key' pointer is now invalid, and so is\n"
3978 " the internal iterator */\n"
3981 " data = guestfs_next_private (g, &key);\n"
3987 #: ../src/guestfs.pod:2078
3989 "Note that the above loop is guaranteed to terminate because the keys are "
3990 "being deleted, but other manipulations of keys within the loop might not "
3991 "terminate unless you also maintain an indication of which keys have been "
3996 #: ../src/guestfs.pod:2083 ../src/guestfs.pod:2088
4001 #: ../src/guestfs.pod:2085
4003 "<!-- old anchor for the next section --> <a "
4004 "name=\"state_machine_and_low_level_event_api\"/>"
4008 #: ../src/guestfs.pod:2090
4009 msgid "ARCHITECTURE"
4013 #: ../src/guestfs.pod:2092
4015 "Internally, libguestfs is implemented by running an appliance (a special "
4016 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4017 "process of the main program."
4021 #: ../src/guestfs.pod:2096
4024 " ___________________\n"
4026 " | main program |\n"
4028 " | | child process / appliance\n"
4029 " | | __________________________\n"
4031 " +-------------------+ RPC | +-----------------+ |\n"
4032 " | libguestfs <--------------------> guestfsd | |\n"
4033 " | | | +-----------------+ |\n"
4034 " \\___________________/ | | Linux kernel | |\n"
4035 " | +--^--------------+ |\n"
4036 " \\_________|________________/\n"
4042 " \\______________/\n"
4047 #: ../src/guestfs.pod:2116
4049 "The library, linked to the main program, creates the child process and hence "
4050 "the appliance in the L</guestfs_launch> function."
4054 #: ../src/guestfs.pod:2119
4056 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4057 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4058 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4059 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4060 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4061 "attached to the qemu process which translates device access by the "
4062 "appliance's Linux kernel into accesses to the image."
4066 #: ../src/guestfs.pod:2128
4068 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4069 "Although the disk image you are attached to might also be used by some "
4070 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4071 "care if both libguestfs's qemu process and your virtual machine are trying "
4072 "to update the disk image at the same time, since these usually results in "
4073 "massive disk corruption)."
4077 #: ../src/guestfs.pod:2135
4078 msgid "STATE MACHINE"
4082 #: ../src/guestfs.pod:2137
4083 msgid "libguestfs uses a state machine to model the child process:"
4087 #: ../src/guestfs.pod:2139
4099 " / | \\ \\ guestfs_launch\n"
4100 " / | _\\__V______\n"
4102 " / | | LAUNCHING |\n"
4103 " / | \\___________/\n"
4105 " / | guestfs_launch\n"
4107 " ______ / __|____V\n"
4108 " / \\ ------> / \\\n"
4109 " | BUSY | | READY |\n"
4110 " \\______/ <------ \\________/\n"
4115 #: ../src/guestfs.pod:2161
4117 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4118 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4119 "(3) alternating between READY and BUSY as commands are issued to, and "
4120 "carried out by, the child process."
4124 #: ../src/guestfs.pod:2166
4126 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4127 "asynchronously at any time (eg. due to some internal error), and that causes "
4128 "the state to transition back to CONFIG."
4132 #: ../src/guestfs.pod:2170
4134 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4135 "issued when in the CONFIG state."
4139 #: ../src/guestfs.pod:2173
4141 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4142 "L</guestfs_launch> blocks until the child process is READY to accept "
4143 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4144 "moves the state from CONFIG to LAUNCHING while it is running."
4148 #: ../src/guestfs.pod:2179
4150 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4151 "state. These API calls block waiting for the command to be carried out "
4152 "(ie. the state to transition to BUSY and then back to READY). There are no "
4153 "non-blocking versions, and no way to issue more than one command per handle "
4158 #: ../src/guestfs.pod:2185
4160 "Finally, the child process sends asynchronous messages back to the main "
4161 "program, such as kernel log messages. You can register a callback to "
4162 "receive these messages."
4166 #: ../src/guestfs.pod:2189
4171 #: ../src/guestfs.pod:2191
4172 msgid "COMMUNICATION PROTOCOL"
4176 #: ../src/guestfs.pod:2193
4178 "Don't rely on using this protocol directly. This section documents how it "
4179 "currently works, but it may change at any time."
4183 #: ../src/guestfs.pod:2196
4185 "The protocol used to talk between the library and the daemon running inside "
4186 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4187 "1014, RFC 1832, RFC 4506)."
4191 #: ../src/guestfs.pod:2200
4193 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4194 "this file is automatically generated)."
4198 #: ../src/guestfs.pod:2203
4200 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4201 "and C<FileOut> parameters, which are handled with very simple request/reply "
4202 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4203 "parameters, which use the same request and reply messages, but they may also "
4204 "be followed by files sent using a chunked encoding."
4208 #: ../src/guestfs.pod:2210
4209 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4213 #: ../src/guestfs.pod:2212
4214 msgid "For ordinary functions, the request message is:"
4218 #: ../src/guestfs.pod:2214
4221 " total length (header + arguments,\n"
4222 " but not including the length word itself)\n"
4223 " struct guestfs_message_header (encoded as XDR)\n"
4224 " struct guestfs_<foo>_args (encoded as XDR)\n"
4229 #: ../src/guestfs.pod:2219
4231 "The total length field allows the daemon to allocate a fixed size buffer "
4232 "into which it slurps the rest of the message. As a result, the total length "
4233 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4234 "effective size of any request is limited to somewhere under this size."
4238 #: ../src/guestfs.pod:2225
4240 "Note also that many functions don't take any arguments, in which case the "
4241 "C<guestfs_I<foo>_args> is completely omitted."
4245 #: ../src/guestfs.pod:2228
4247 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4248 "receiver knows what type of args structure to expect, or none at all."
4252 #: ../src/guestfs.pod:2232
4254 "For functions that take optional arguments, the optional arguments are "
4255 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4256 "arguments. A bitmask in the header indicates which optional arguments are "
4257 "meaningful. The bitmask is also checked to see if it contains bits set "
4258 "which the daemon does not know about (eg. if more optional arguments were "
4259 "added in a later version of the library), and this causes the call to be "
4264 #: ../src/guestfs.pod:2240
4265 msgid "The reply message for ordinary functions is:"
4269 #: ../src/guestfs.pod:2242
4272 " total length (header + ret,\n"
4273 " but not including the length word itself)\n"
4274 " struct guestfs_message_header (encoded as XDR)\n"
4275 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4280 #: ../src/guestfs.pod:2247
4282 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4283 "functions that return no formal return values."
4287 #: ../src/guestfs.pod:2250
4288 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4292 #: ../src/guestfs.pod:2253
4294 "In the case of an error, a flag is set in the header, and the reply message "
4295 "is slightly changed:"
4299 #: ../src/guestfs.pod:2256
4302 " total length (header + error,\n"
4303 " but not including the length word itself)\n"
4304 " struct guestfs_message_header (encoded as XDR)\n"
4305 " struct guestfs_message_error (encoded as XDR)\n"
4310 #: ../src/guestfs.pod:2261
4312 "The C<guestfs_message_error> structure contains the error message as a "
4317 #: ../src/guestfs.pod:2264
4318 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4322 #: ../src/guestfs.pod:2266
4324 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4325 "The normal request message is sent (see above). However this is followed by "
4326 "a sequence of file chunks."
4330 #: ../src/guestfs.pod:2270
4333 " total length (header + arguments,\n"
4334 " but not including the length word itself,\n"
4335 " and not including the chunks)\n"
4336 " struct guestfs_message_header (encoded as XDR)\n"
4337 " struct guestfs_<foo>_args (encoded as XDR)\n"
4338 " sequence of chunks for FileIn param #0\n"
4339 " sequence of chunks for FileIn param #1 etc.\n"
4344 #: ../src/guestfs.pod:2278
4345 msgid "The \"sequence of chunks\" is:"
4349 #: ../src/guestfs.pod:2280
4352 " length of chunk (not including length word itself)\n"
4353 " struct guestfs_chunk (encoded as XDR)\n"
4354 " length of chunk\n"
4355 " struct guestfs_chunk (encoded as XDR)\n"
4357 " length of chunk\n"
4358 " struct guestfs_chunk (with data.data_len == 0)\n"
4363 #: ../src/guestfs.pod:2288
4365 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4366 "is set in the final chunk to indicate either successful completion or early "
4371 #: ../src/guestfs.pod:2292
4373 "At time of writing there are no functions that have more than one FileIn "
4374 "parameter. However this is (theoretically) supported, by sending the "
4375 "sequence of chunks for each FileIn parameter one after another (from left to "
4380 #: ../src/guestfs.pod:2297
4382 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4383 "transfer. The library does this by sending a chunk with a special flag set "
4384 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4385 "RPC, does I<not> send any reply, and goes back to reading the next request."
4389 #: ../src/guestfs.pod:2303
4391 "The daemon may also cancel. It does this by writing a special word "
4392 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4393 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4394 "cancel chunk). The special word is chosen so that even if cancellation "
4395 "happens right at the end of the transfer (after the library has finished "
4396 "writing and has started listening for the reply), the \"spurious\" cancel "
4397 "flag will not be confused with the reply message."
4401 #: ../src/guestfs.pod:2312
4403 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4404 "limit), and also files where the size is not known in advance (eg. from "
4405 "pipes or sockets). However the chunks are rather small "
4406 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4407 "to keep much in memory."
4411 #: ../src/guestfs.pod:2318
4412 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4416 #: ../src/guestfs.pod:2320
4418 "The protocol for FileOut parameters is exactly the same as for FileIn "
4419 "parameters, but with the roles of daemon and library reversed."
4423 #: ../src/guestfs.pod:2323
4426 " total length (header + ret,\n"
4427 " but not including the length word itself,\n"
4428 " and not including the chunks)\n"
4429 " struct guestfs_message_header (encoded as XDR)\n"
4430 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4431 " sequence of chunks for FileOut param #0\n"
4432 " sequence of chunks for FileOut param #1 etc.\n"
4437 #: ../src/guestfs.pod:2331
4438 msgid "INITIAL MESSAGE"
4442 #: ../src/guestfs.pod:2333
4444 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4445 "which indicates that the guest and daemon is alive. This is what "
4446 "L</guestfs_launch> waits for."
4450 #: ../src/guestfs.pod:2337
4451 msgid "PROGRESS NOTIFICATION MESSAGES"
4455 #: ../src/guestfs.pod:2339
4457 "The daemon may send progress notification messages at any time. These are "
4458 "distinguished by the normal length word being replaced by "
4459 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4463 #: ../src/guestfs.pod:2343
4465 "The library turns them into progress callbacks (see "
4466 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4471 #: ../src/guestfs.pod:2347
4473 "The daemon self-limits the frequency of progress messages it sends (see "
4474 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4479 #: ../src/guestfs.pod:2351
4480 msgid "LIBGUESTFS VERSION NUMBERS"
4484 #: ../src/guestfs.pod:2353
4486 "Since April 2010, libguestfs has started to make separate development and "
4487 "stable releases, along with corresponding branches in our git repository. "
4488 "These separate releases can be identified by version number:"
4492 #: ../src/guestfs.pod:2358
4495 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4496 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4502 " | `-------- sub-version\n"
4504 " `------ always '1' because we don't change the ABI\n"
4509 #: ../src/guestfs.pod:2369
4510 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4514 #: ../src/guestfs.pod:2371
4516 "As time passes we cherry pick fixes from the development branch and backport "
4517 "those into the stable branch, the effect being that the stable branch should "
4518 "get more stable and less buggy over time. So the stable releases are ideal "
4519 "for people who don't need new features but would just like the software to "
4524 #: ../src/guestfs.pod:2377
4525 msgid "Our criteria for backporting changes are:"
4529 #: ../src/guestfs.pod:2383
4531 "Documentation changes which don't affect any code are backported unless the "
4532 "documentation refers to a future feature which is not in stable."
4536 #: ../src/guestfs.pod:2389
4538 "Bug fixes which are not controversial, fix obvious problems, and have been "
4539 "well tested are backported."
4543 #: ../src/guestfs.pod:2394
4545 "Simple rearrangements of code which shouldn't affect how it works get "
4546 "backported. This is so that the code in the two branches doesn't get too "
4547 "far out of step, allowing us to backport future fixes more easily."
4551 #: ../src/guestfs.pod:2400
4553 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4554 "exceptional case: the new feature is required in order to implement an "
4555 "important bug fix."
4559 #: ../src/guestfs.pod:2406
4561 "A new stable branch starts when we think the new features in development are "
4562 "substantial and compelling enough over the current stable branch to warrant "
4563 "it. When that happens we create new stable and development versions 1.N.0 "
4564 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4565 "stable at this point, but by backporting fixes from development, that branch "
4566 "will stabilize over time."
4570 #: ../src/guestfs.pod:2414
4571 msgid "EXTENDING LIBGUESTFS"
4575 #: ../src/guestfs.pod:2416
4576 msgid "ADDING A NEW API ACTION"
4580 #: ../src/guestfs.pod:2418
4582 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4583 "documentation) are generated, and this makes it easy to extend the "
4588 #: ../src/guestfs.pod:2422
4589 msgid "To add a new API action there are two changes:"
4593 #: ../src/guestfs.pod:2428
4595 "You need to add a description of the call (name, parameters, return type, "
4596 "tests, documentation) to C<generator/generator_actions.ml>."
4600 #: ../src/guestfs.pod:2431
4602 "There are two sorts of API action, depending on whether the call goes "
4603 "through to the daemon in the appliance, or is serviced entirely by the "
4604 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4605 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4606 "an example of the latter, since a trace flag is maintained in the handle and "
4607 "all tracing is done on the library side."
4611 #: ../src/guestfs.pod:2439
4613 "Most new actions are of the first type, and get added to the "
4614 "C<daemon_functions> list. Each function has a unique procedure number used "
4615 "in the RPC protocol which is assigned to that action when we publish "
4616 "libguestfs and cannot be reused. Take the latest procedure number and "
4621 #: ../src/guestfs.pod:2445
4623 "For library-only actions of the second type, add to the "
4624 "C<non_daemon_functions> list. Since these functions are serviced by the "
4625 "library and do not travel over the RPC mechanism to the daemon, these "
4626 "functions do not need a procedure number, and so the procedure number is set "
4631 #: ../src/guestfs.pod:2453
4632 msgid "Implement the action (in C):"
4636 #: ../src/guestfs.pod:2455
4638 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4639 "C<daemon/> directory."
4643 #: ../src/guestfs.pod:2458
4645 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4646 "(note: double underscore) in the C<src/> directory."
4650 #: ../src/guestfs.pod:2461
4651 msgid "In either case, use another function as an example of what to do."
4655 #: ../src/guestfs.pod:2465
4656 msgid "After making these changes, use C<make> to compile."
4660 #: ../src/guestfs.pod:2467
4662 "Note that you don't need to implement the RPC, language bindings, manual "
4663 "pages or anything else. It's all automatically generated from the OCaml "
4668 #: ../src/guestfs.pod:2471
4669 msgid "ADDING TESTS FOR AN API ACTION"
4673 #: ../src/guestfs.pod:2473
4675 "You can supply zero or as many tests as you want per API call. The tests "
4676 "can either be added as part of the API description "
4677 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4678 "drop a script into C<regressions/>. Note that adding a script to "
4679 "C<regressions/> is slower, so if possible use the first method."
4683 #: ../src/guestfs.pod:2479
4685 "The following describes the test environment used when you add an API test "
4686 "in C<generator_actions.ml>."
4690 #: ../src/guestfs.pod:2482
4691 msgid "The test environment has 4 block devices:"
4695 #: ../src/guestfs.pod:2486
4696 msgid "C</dev/sda> 500MB"
4700 #: ../src/guestfs.pod:2488
4701 msgid "General block device for testing."
4705 #: ../src/guestfs.pod:2490
4706 msgid "C</dev/sdb> 50MB"
4710 #: ../src/guestfs.pod:2492
4712 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4717 #: ../src/guestfs.pod:2495
4718 msgid "C</dev/sdc> 10MB"
4722 #: ../src/guestfs.pod:2497
4723 msgid "Used in a few tests where two block devices are needed."
4727 #: ../src/guestfs.pod:2499
4732 #: ../src/guestfs.pod:2501
4733 msgid "ISO with fixed content (see C<images/test.iso>)."
4737 #: ../src/guestfs.pod:2505
4739 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4740 "appliance and block devices are reused between tests. So don't try testing "
4741 "L</guestfs_kill_subprocess> :-x"
4745 #: ../src/guestfs.pod:2509
4747 "Each test starts with an initial scenario, selected using one of the "
4748 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4749 "initialize the disks mentioned above in a particular way as documented in "
4750 "C<generator_types.ml>. You should not assume anything about the previous "
4751 "contents of other disks that are not initialized."
4755 #: ../src/guestfs.pod:2515
4757 "You can add a prerequisite clause to any individual test. This is a "
4758 "run-time check, which, if it fails, causes the test to be skipped. Useful "
4759 "if testing a command which might not work on all variations of libguestfs "
4760 "builds. A test that has prerequisite of C<Always> means to run "
4765 #: ../src/guestfs.pod:2521
4767 "In addition, packagers can skip individual tests by setting environment "
4768 "variables before running C<make check>."
4772 #: ../src/guestfs.pod:2524
4775 " SKIP_TEST_<CMD>_<NUM>=1\n"
4780 #: ../src/guestfs.pod:2526
4781 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4785 #: ../src/guestfs.pod:2528
4790 #: ../src/guestfs.pod:2530
4793 " SKIP_TEST_<CMD>=1\n"
4798 #: ../src/guestfs.pod:2532
4799 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4803 #: ../src/guestfs.pod:2534
4804 msgid "Packagers can run only certain tests by setting for example:"
4808 #: ../src/guestfs.pod:2536
4811 " TEST_ONLY=\"vfs_type zerofree\"\n"
4816 #: ../src/guestfs.pod:2538
4818 "See C<capitests/tests.c> for more details of how these environment variables "
4823 #: ../src/guestfs.pod:2541
4824 msgid "DEBUGGING NEW API ACTIONS"
4828 #: ../src/guestfs.pod:2543
4829 msgid "Test new actions work before submitting them."
4833 #: ../src/guestfs.pod:2545
4834 msgid "You can use guestfish to try out new commands."
4838 #: ../src/guestfs.pod:2547
4840 "Debugging the daemon is a problem because it runs inside a minimal "
4841 "environment. However you can fprintf messages in the daemon to stderr, and "
4842 "they will show up if you use C<guestfish -v>."
4846 #: ../src/guestfs.pod:2551
4847 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4851 #: ../src/guestfs.pod:2553
4853 "Our C source code generally adheres to some basic code-formatting "
4854 "conventions. The existing code base is not totally consistent on this "
4855 "front, but we do prefer that contributed code be formatted similarly. In "
4856 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4857 "indentation level, and other than that, follow the K&R style."
4861 #: ../src/guestfs.pod:2559
4863 "If you use Emacs, add the following to one of one of your start-up files "
4864 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
4868 #: ../src/guestfs.pod:2562
4871 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4872 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4873 " (add-hook 'find-file-hook\n"
4874 " '(lambda () (if (and buffer-file-name\n"
4875 " (string-match \"/libguestfs\\\\>\"\n"
4876 " (buffer-file-name))\n"
4877 " (not (string-equal mode-name \"Change Log\"))\n"
4878 " (not (string-equal mode-name \"Makefile\")))\n"
4879 " (setq indent-tabs-mode nil))))\n"
4884 #: ../src/guestfs.pod:2572
4887 " ;;; When editing C sources in libguestfs, use this style.\n"
4888 " (defun libguestfs-c-mode ()\n"
4889 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4891 " (c-set-style \"K&R\")\n"
4892 " (setq c-indent-level 2)\n"
4893 " (setq c-basic-offset 2))\n"
4894 " (add-hook 'c-mode-hook\n"
4895 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4896 " (buffer-file-name))\n"
4897 " (libguestfs-c-mode))))\n"
4902 #: ../src/guestfs.pod:2584
4903 msgid "Enable warnings when compiling (and fix any problems this finds):"
4907 #: ../src/guestfs.pod:2587
4910 " ./configure --enable-gcc-warnings\n"
4915 #: ../src/guestfs.pod:2589
4916 msgid "Useful targets are:"
4920 #: ../src/guestfs.pod:2591
4923 " make syntax-check # checks the syntax of the C code\n"
4924 " make check # runs the test suite\n"
4929 #: ../src/guestfs.pod:2594
4930 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4934 #: ../src/guestfs.pod:2596
4936 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4937 "which are used to do shell quoting."
4941 #: ../src/guestfs.pod:2601
4946 #: ../src/guestfs.pod:2603
4948 "Simple shell quoted string. Any spaces or other shell characters are "
4953 #: ../src/guestfs.pod:2606
4958 #: ../src/guestfs.pod:2608
4960 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4965 #: ../src/guestfs.pod:2613 ../fish/guestfish.pod:242 ../fish/guestfish.pod:615
4966 msgid "For example:"
4970 #: ../src/guestfs.pod:2615
4973 " asprintf (&cmd, \"cat %R\", path);\n"
4978 #: ../src/guestfs.pod:2617
4979 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
4983 #: ../src/guestfs.pod:2619
4985 "I<Note:> Do I<not> use these when you are passing parameters to the "
4986 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
4987 "because they are not passed via the shell (instead, straight to exec). You "
4988 "probably want to use the C<sysroot_path()> function however."
4992 #: ../src/guestfs.pod:2625
4993 msgid "SUBMITTING YOUR NEW API ACTIONS"
4997 #: ../src/guestfs.pod:2627
4999 "Submit patches to the mailing list: "
5000 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5001 "L<rjones@redhat.com>."
5005 #: ../src/guestfs.pod:2631
5006 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5010 #: ../src/guestfs.pod:2633
5011 msgid "We support i18n (gettext anyhow) in the library."
5015 #: ../src/guestfs.pod:2635
5017 "However many messages come from the daemon, and we don't translate those at "
5018 "the moment. One reason is that the appliance generally has all locale files "
5019 "removed from it, because they take up a lot of space. So we'd have to readd "
5020 "some of those, as well as copying our PO files into the appliance."
5024 #: ../src/guestfs.pod:2641
5026 "Debugging messages are never translated, since they are intended for the "
5031 #: ../src/guestfs.pod:2644
5032 msgid "SOURCE CODE SUBDIRECTORIES"
5036 #: ../src/guestfs.pod:2648 ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:3958
5037 msgid "C<appliance>"
5041 #: ../src/guestfs.pod:2650
5042 msgid "The libguestfs appliance, build scripts and so on."
5046 #: ../src/guestfs.pod:2652
5047 msgid "C<capitests>"
5051 #: ../src/guestfs.pod:2654
5052 msgid "Automated tests of the C API."
5056 #: ../src/guestfs.pod:2656
5061 #: ../src/guestfs.pod:2658
5063 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5068 #: ../src/guestfs.pod:2661
5073 #: ../src/guestfs.pod:2663
5074 msgid "Outside contributions, experimental parts."
5078 #: ../src/guestfs.pod:2665
5083 #: ../src/guestfs.pod:2667
5085 "The daemon that runs inside the libguestfs appliance and carries out "
5090 #: ../src/guestfs.pod:2670
5095 #: ../src/guestfs.pod:2672
5096 msgid "L<virt-df(1)> command and documentation."
5100 #: ../src/guestfs.pod:2674
5105 #: ../src/guestfs.pod:2676
5106 msgid "L<virt-edit(1)> command and documentation."
5110 #: ../src/guestfs.pod:2678
5115 #: ../src/guestfs.pod:2680
5116 msgid "C API example code."
5120 #: ../src/guestfs.pod:2682
5125 #: ../src/guestfs.pod:2684
5127 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5128 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
5129 "L<virt-tar-out(1)>."
5133 #: ../src/guestfs.pod:2688
5138 #: ../src/guestfs.pod:2690
5139 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5143 #: ../src/guestfs.pod:2692
5144 msgid "C<generator>"
5148 #: ../src/guestfs.pod:2694
5150 "The crucially important generator, used to automatically generate large "
5151 "amounts of boilerplate C code for things like RPC and bindings."
5155 #: ../src/guestfs.pod:2697
5160 #: ../src/guestfs.pod:2699
5161 msgid "Files used by the test suite."
5165 #: ../src/guestfs.pod:2701
5166 msgid "Some \"phony\" guest images which we test against."
5170 #: ../src/guestfs.pod:2703
5171 msgid "C<inspector>"
5175 #: ../src/guestfs.pod:2705
5176 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5180 #: ../src/guestfs.pod:2707
5185 #: ../src/guestfs.pod:2709
5186 msgid "Logo used on the website. The fish is called Arthur by the way."
5190 #: ../src/guestfs.pod:2711
5195 #: ../src/guestfs.pod:2713
5196 msgid "M4 macros used by autoconf."
5200 #: ../src/guestfs.pod:2715
5205 #: ../src/guestfs.pod:2717
5206 msgid "Translations of simple gettext strings."
5210 #: ../src/guestfs.pod:2719
5215 #: ../src/guestfs.pod:2721
5217 "The build infrastructure and PO files for translations of manpages and POD "
5218 "files. Eventually this will be combined with the C<po> directory, but that "
5219 "is rather complicated."
5223 #: ../src/guestfs.pod:2725
5224 msgid "C<regressions>"
5228 #: ../src/guestfs.pod:2727
5229 msgid "Regression tests."
5233 #: ../src/guestfs.pod:2729
5238 #: ../src/guestfs.pod:2731
5239 msgid "L<virt-rescue(1)> command and documentation."
5243 #: ../src/guestfs.pod:2733
5248 #: ../src/guestfs.pod:2735
5249 msgid "Source code to the C library."
5253 #: ../src/guestfs.pod:2737
5258 #: ../src/guestfs.pod:2739
5259 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5263 #: ../src/guestfs.pod:2741
5264 msgid "C<test-tool>"
5268 #: ../src/guestfs.pod:2743
5270 "Test tool for end users to test if their qemu/kernel combination will work "
5275 #: ../src/guestfs.pod:2746
5280 #: ../src/guestfs.pod:2748
5285 #: ../src/guestfs.pod:2750
5290 #: ../src/guestfs.pod:2752
5295 #: ../src/guestfs.pod:2754
5300 #: ../src/guestfs.pod:2756
5305 #: ../src/guestfs.pod:2758
5310 #: ../src/guestfs.pod:2760
5315 #: ../src/guestfs.pod:2762
5316 msgid "Language bindings."
5320 #: ../src/guestfs.pod:2766
5325 #: ../src/guestfs.pod:2768
5326 msgid "PROTOCOL LIMITS"
5330 #: ../src/guestfs.pod:2770
5332 "Internally libguestfs uses a message-based protocol to pass API calls and "
5333 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5334 "plenty more detail about this). The maximum message size used by the "
5335 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5336 "aware of this limit. The API calls which may be affected are individually "
5337 "documented, with a link back to this section of the documentation."
5341 #: ../src/guestfs.pod:2778
5343 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5344 "a simple string. Because this string is at some point internally encoded as "
5345 "a message, the maximum size that it can return is slightly under 4 MB. If "
5346 "the requested file is larger than this then you will get an error."
5350 #: ../src/guestfs.pod:2784
5352 "In order to transfer large files into and out of the guest filesystem, you "
5353 "need to use particular calls that support this. The sections L</UPLOADING> "
5354 "and L</DOWNLOADING> document how to do this."
5358 #: ../src/guestfs.pod:2788
5360 "You might also consider mounting the disk image using our FUSE filesystem "
5361 "support (L<guestmount(1)>)."
5365 #: ../src/guestfs.pod:2791
5366 msgid "MAXIMUM NUMBER OF DISKS"
5370 #: ../src/guestfs.pod:2793
5371 msgid "When using virtio disks (the default) the current limit is B<25> disks."
5375 #: ../src/guestfs.pod:2796
5377 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
5378 "slots. However febootstrap only understands disks with names C</dev/vda> "
5379 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5384 #: ../src/guestfs.pod:2801
5386 "We are working to substantially raise this limit in future versions but it "
5387 "requires complex changes to qemu."
5391 #: ../src/guestfs.pod:2804
5393 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5394 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5395 "requires changes to qemu."
5399 #: ../src/guestfs.pod:2808
5400 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5404 #: ../src/guestfs.pod:2810
5405 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5409 #: ../src/guestfs.pod:2812
5411 "This is because it reserves 4 bits for the minor device number (thus "
5412 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5416 #: ../src/guestfs.pod:2815
5418 "If you attach a disk with more than 15 partitions, the extra partitions are "
5419 "ignored by libguestfs."
5423 #: ../src/guestfs.pod:2818
5424 msgid "MAXIMUM SIZE OF A DISK"
5428 #: ../src/guestfs.pod:2820
5429 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5433 #: ../src/guestfs.pod:2822
5435 "We have tested block devices up to 1 exabyte (2**60 or "
5436 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5441 #: ../src/guestfs.pod:2826
5443 "Although libguestfs probably does not impose any limit, the underlying host "
5444 "storage will. If you store disk images on a host ext4 filesystem, then the "
5445 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5446 "TB). If you store disk images as host logical volumes then you are limited "
5447 "by the maximum size of an LV."
5451 #: ../src/guestfs.pod:2832
5453 "For the hugest disk image files, we recommend using XFS on the host for "
5458 #: ../src/guestfs.pod:2835
5459 msgid "MAXIMUM SIZE OF A PARTITION"
5463 #: ../src/guestfs.pod:2837
5465 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
5466 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
5467 "address a partition located beyond 2 TB on the disk."
5471 #: ../src/guestfs.pod:2841
5473 "It is recommended that you use GPT partitions on disks which are larger than "
5474 "this size. GPT uses 64 bit sector numbers and so can address partitions "
5475 "which are theoretically larger than the largest disk we could support."
5479 #: ../src/guestfs.pod:2846
5480 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5484 #: ../src/guestfs.pod:2848
5486 "This depends on the filesystem type. libguestfs itself does not impose any "
5487 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5488 "what these limits are."
5492 #: ../src/guestfs.pod:2852
5493 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5497 #: ../src/guestfs.pod:2854
5499 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5500 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5501 "uploads and downloads."
5505 #: ../src/guestfs.pod:2858
5506 msgid "INSPECTION LIMITS"
5510 #: ../src/guestfs.pod:2860
5512 "The inspection code has several arbitrary limits on things like the size of "
5513 "Windows Registry hive it will read, and the length of product name. These "
5514 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5515 "memory and disk space on the host, and should not be reached in practice. "
5516 "See the source code for more information."
5520 #: ../src/guestfs.pod:2866 ../fish/guestfish.pod:1017 ../test-tool/libguestfs-test-tool.pod:82
5521 msgid "ENVIRONMENT VARIABLES"
5525 #: ../src/guestfs.pod:2870 ../fish/guestfish.pod:1048
5526 msgid "LIBGUESTFS_APPEND"
5530 #: ../src/guestfs.pod:2872 ../fish/guestfish.pod:1050
5531 msgid "Pass additional options to the guest kernel."
5535 #: ../src/guestfs.pod:2874 ../fish/guestfish.pod:1052
5536 msgid "LIBGUESTFS_DEBUG"
5540 #: ../src/guestfs.pod:2876
5542 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5543 "effect as calling C<guestfs_set_verbose (g, 1)>."
5547 #: ../src/guestfs.pod:2879 ../fish/guestfish.pod:1057
5548 msgid "LIBGUESTFS_MEMSIZE"
5552 #: ../src/guestfs.pod:2881 ../fish/guestfish.pod:1059
5553 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
5557 #: ../src/guestfs.pod:2884 ../fish/guestfish.pod:1062
5560 " LIBGUESTFS_MEMSIZE=700\n"
5565 #: ../src/guestfs.pod:2886 ../fish/guestfish.pod:1064
5566 msgid "LIBGUESTFS_PATH"
5570 #: ../src/guestfs.pod:2888
5572 "Set the path that libguestfs uses to search for a supermin appliance. See "
5573 "the discussion of paths in section L</PATH> above."
5577 #: ../src/guestfs.pod:2891 ../fish/guestfish.pod:1069
5578 msgid "LIBGUESTFS_QEMU"
5582 #: ../src/guestfs.pod:2893 ../fish/guestfish.pod:1071
5584 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5585 "which was found at compile time by the configure script is used."
5589 #: ../src/guestfs.pod:2897
5590 msgid "See also L</QEMU WRAPPERS> above."
5594 #: ../src/guestfs.pod:2899 ../fish/guestfish.pod:1075
5595 msgid "LIBGUESTFS_TRACE"
5599 #: ../src/guestfs.pod:2901
5601 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5602 "effect as calling C<guestfs_set_trace (g, 1)>."
5606 #: ../src/guestfs.pod:2904 ../fish/guestfish.pod:1084
5611 #: ../src/guestfs.pod:2906 ../fish/guestfish.pod:1086
5613 "Location of temporary directory, defaults to C</tmp> except for the cached "
5614 "supermin appliance which defaults to C</var/tmp>."
5618 #: ../src/guestfs.pod:2909 ../fish/guestfish.pod:1089
5620 "If libguestfs was compiled to use the supermin appliance then the real "
5621 "appliance is cached in this directory, shared between all handles belonging "
5622 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5623 "use in case C</var/tmp> is not large enough."
5627 #: ../src/guestfs.pod:2917 ../fish/guestfish.pod:1156 ../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
5632 #: ../src/guestfs.pod:2919
5634 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
5635 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
5636 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
5637 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
5638 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
5639 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
5640 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5641 "L<http://libguestfs.org/>."
5645 #: ../src/guestfs.pod:2946
5647 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5648 "L<lvm(8)>, L<disktype(1)>."
5652 #: ../src/guestfs.pod:2953 ../tools/virt-win-reg.pl:759 ../tools/virt-make-fs.pl:553
5657 #: ../src/guestfs.pod:2955
5658 msgid "To get a list of bugs against libguestfs use this link:"
5662 #: ../src/guestfs.pod:2957
5663 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5667 #: ../src/guestfs.pod:2959
5668 msgid "To report a new bug against libguestfs use this link:"
5672 #: ../src/guestfs.pod:2961
5673 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5677 #: ../src/guestfs.pod:2963
5678 msgid "When reporting a bug, please check:"
5682 #: ../src/guestfs.pod:2969
5683 msgid "That the bug hasn't been reported already."
5687 #: ../src/guestfs.pod:2973
5688 msgid "That you are testing a recent version."
5692 #: ../src/guestfs.pod:2977
5693 msgid "Describe the bug accurately, and give a way to reproduce it."
5697 #: ../src/guestfs.pod:2981
5699 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5704 #: ../src/guestfs.pod:2986 ../fish/guestfish.pod:1180 ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5709 #: ../src/guestfs.pod:2988 ../fish/guestfish.pod:1182 ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5710 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5714 #: ../src/guestfs.pod:2990 ../fish/guestfish.pod:1184 ../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
5719 #: ../src/guestfs.pod:2992 ../fish/guestfish.pod:1186 ../test-tool/libguestfs-test-tool.pod:99
5720 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5724 #: ../src/guestfs.pod:2995
5726 "This library is free software; you can redistribute it and/or modify it "
5727 "under the terms of the GNU Lesser General Public License as published by the "
5728 "Free Software Foundation; either version 2 of the License, or (at your "
5729 "option) any later version."
5733 #: ../src/guestfs.pod:3000
5735 "This library is distributed in the hope that it will be useful, but WITHOUT "
5736 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5737 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5742 #: ../src/guestfs.pod:3005
5744 "You should have received a copy of the GNU Lesser General Public License "
5745 "along with this library; if not, write to the Free Software Foundation, "
5746 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5750 #: ../src/guestfs-actions.pod:1
5751 msgid "guestfs_add_cdrom"
5755 #: ../src/guestfs-actions.pod:3
5759 " guestfs_add_cdrom (guestfs_h *g,\n"
5760 " const char *filename);\n"
5765 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5766 msgid "This function adds a virtual CD-ROM disk image to the guest."
5770 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5771 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5775 #: ../src/guestfs-actions.pod:17
5777 "This call checks for the existence of C<filename>. This stops you from "
5778 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5779 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5784 #: ../src/guestfs-actions.pod:24
5786 "If you just want to add an ISO file (often you use this as an efficient way "
5787 "to transfer large files into the guest), then you should probably use "
5788 "C<guestfs_add_drive_ro> instead."
5792 #: ../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:982 ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:1020 ../src/guestfs-actions.pod:1104 ../src/guestfs-actions.pod:1122 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1155 ../src/guestfs-actions.pod:1175 ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1276 ../src/guestfs-actions.pod:1301 ../src/guestfs-actions.pod:1343 ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1483 ../src/guestfs-actions.pod:1698 ../src/guestfs-actions.pod:1720 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:2269 ../src/guestfs-actions.pod:2413 ../src/guestfs-actions.pod:2474 ../src/guestfs-actions.pod:2509 ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3544 ../src/guestfs-actions.pod:3569 ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3750 ../src/guestfs-actions.pod:3763 ../src/guestfs-actions.pod:3777 ../src/guestfs-actions.pod:3792 ../src/guestfs-actions.pod:3828 ../src/guestfs-actions.pod:3900 ../src/guestfs-actions.pod:3920 ../src/guestfs-actions.pod:3937 ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:4015 ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4100 ../src/guestfs-actions.pod:4136 ../src/guestfs-actions.pod:4152 ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4197 ../src/guestfs-actions.pod:4290 ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4323 ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4392 ../src/guestfs-actions.pod:4410 ../src/guestfs-actions.pod:4426 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4454 ../src/guestfs-actions.pod:4471 ../src/guestfs-actions.pod:4486 ../src/guestfs-actions.pod:4506 ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4668 ../src/guestfs-actions.pod:4687 ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:4735 ../src/guestfs-actions.pod:4748 ../src/guestfs-actions.pod:4763 ../src/guestfs-actions.pod:4778 ../src/guestfs-actions.pod:4813 ../src/guestfs-actions.pod:4846 ../src/guestfs-actions.pod:4883 ../src/guestfs-actions.pod:4903 ../src/guestfs-actions.pod:4917 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4983 ../src/guestfs-actions.pod:5020 ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5079 ../src/guestfs-actions.pod:5097 ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:5288 ../src/guestfs-actions.pod:5310 ../src/guestfs-actions.pod:5328 ../src/guestfs-actions.pod:5360 ../src/guestfs-actions.pod:5426 ../src/guestfs-actions.pod:5443 ../src/guestfs-actions.pod:5456 ../src/guestfs-actions.pod:5470 ../src/guestfs-actions.pod:5759 ../src/guestfs-actions.pod:5778 ../src/guestfs-actions.pod:5797 ../src/guestfs-actions.pod:5809 ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:5835 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5877 ../src/guestfs-actions.pod:5898 ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:5936 ../src/guestfs-actions.pod:5966 ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6005 ../src/guestfs-actions.pod:6023 ../src/guestfs-actions.pod:6042 ../src/guestfs-actions.pod:6063 ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6099 ../src/guestfs-actions.pod:6127 ../src/guestfs-actions.pod:6151 ../src/guestfs-actions.pod:6170 ../src/guestfs-actions.pod:6194 ../src/guestfs-actions.pod:6213 ../src/guestfs-actions.pod:6228 ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6284 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6347 ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:6590 ../src/guestfs-actions.pod:6602 ../src/guestfs-actions.pod:6615 ../src/guestfs-actions.pod:6628 ../src/guestfs-actions.pod:6650 ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6689 ../src/guestfs-actions.pod:6704 ../src/guestfs-actions.pod:6763 ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6796 ../src/guestfs-actions.pod:6812 ../src/guestfs-actions.pod:6829 ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6862 ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6912 ../src/guestfs-actions.pod:6953 ../src/guestfs-actions.pod:6966 ../src/guestfs-actions.pod:6984 ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7173 ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7260 ../src/guestfs-actions.pod:7273 ../src/guestfs-actions.pod:7318 ../src/guestfs-actions.pod:7351 ../src/guestfs-actions.pod:7412 ../src/guestfs-actions.pod:7438 ../src/guestfs-actions.pod:7505 ../src/guestfs-actions.pod:7524 ../src/guestfs-actions.pod:7553
5793 msgid "This function returns 0 on success or -1 on error."
5797 #: ../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
5799 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5804 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:1947 ../src/guestfs-actions.pod:1968 ../src/guestfs-actions.pod:4511 ../src/guestfs-actions.pod:4818 ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6322 ../src/guestfs-actions.pod:6355 ../src/guestfs-actions.pod:6414 ../src/guestfs-actions.pod:7356 ../src/guestfs-actions.pod:7446 ../src/guestfs-actions.pod:7616 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:961 ../fish/guestfish-actions.pod:1321 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:3038 ../fish/guestfish-actions.pod:3235 ../fish/guestfish-actions.pod:4220 ../fish/guestfish-actions.pod:4243 ../fish/guestfish-actions.pod:4265 ../fish/guestfish-actions.pod:4303 ../fish/guestfish-actions.pod:4944 ../fish/guestfish-actions.pod:5042
5806 "Deprecated functions will not be removed from the API, but the fact that "
5807 "they are deprecated indicates that there are problems with correct use of "
5812 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1106 ../src/guestfs-actions.pod:1919 ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2120 ../src/guestfs-actions.pod:3531 ../src/guestfs-actions.pod:3551 ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:6101 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6706 ../src/guestfs-actions.pod:6831 ../src/guestfs-actions.pod:7360
5813 msgid "(Added in 0.3)"
5817 #: ../src/guestfs-actions.pod:41
5818 msgid "guestfs_add_domain"
5822 #: ../src/guestfs-actions.pod:43
5826 " guestfs_add_domain (guestfs_h *g,\n"
5827 " const char *dom,\n"
5833 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:2750 ../src/guestfs-actions.pod:4525 ../src/guestfs-actions.pod:4832
5835 "You may supply a list of optional arguments to this call. Use zero or more "
5836 "of the following pairs of parameters, and terminate the list with C<-1> on "
5837 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5841 #: ../src/guestfs-actions.pod:53
5844 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5845 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5846 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5847 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
5848 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
5853 #: ../src/guestfs-actions.pod:59
5855 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5856 "It works by connecting to libvirt, requesting the domain and domain XML from "
5857 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5862 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
5864 "The number of disks added is returned. This operation is atomic: if an "
5865 "error is returned, then no disks are added."
5869 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
5871 "This function does some minimal checks to make sure the libvirt domain is "
5872 "not running (unless C<readonly> is true). In a future version we will try "
5873 "to acquire the libvirt lock on each disk."
5877 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
5879 "Disks must be accessible locally. This often means that adding disks from a "
5880 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5881 "unless those disks are accessible via the same device path locally too."
5885 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
5887 "The optional C<libvirturi> parameter sets the libvirt URI (see "
5888 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
5889 "default libvirt URI (or one set through an environment variable, see the "
5890 "libvirt documentation for full details)."
5894 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
5896 "The optional C<live> flag controls whether this call will try to connect to "
5897 "a running virtual machine C<guestfsd> process if it sees a suitable "
5898 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5899 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5900 "DAEMONS> for more information."
5904 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
5906 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5907 "passed instead of the domain name. The C<dom> string is treated as a UUID "
5908 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
5913 #: ../src/guestfs-actions.pod:94
5915 "The other optional parameters are passed directly through to "
5916 "C<guestfs_add_drive_opts>."
5920 #: ../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:1321 ../src/guestfs-actions.pod:1677 ../src/guestfs-actions.pod:1880 ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2084 ../src/guestfs-actions.pod:2107 ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:2866 ../src/guestfs-actions.pod:2884 ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5134 ../src/guestfs-actions.pod:5540 ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:6939 ../src/guestfs-actions.pod:7371 ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7397
5921 msgid "On error this function returns -1."
5925 #: ../src/guestfs-actions.pod:99
5926 msgid "(Added in 1.7.4)"
5930 #: ../src/guestfs-actions.pod:101
5931 msgid "guestfs_add_domain_va"
5935 #: ../src/guestfs-actions.pod:103
5939 " guestfs_add_domain_va (guestfs_h *g,\n"
5940 " const char *dom,\n"
5946 #: ../src/guestfs-actions.pod:108
5947 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5951 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:2844 ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:4590 ../src/guestfs-actions.pod:4858 ../src/guestfs-actions.pod:4870
5952 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5956 #: ../src/guestfs-actions.pod:112
5957 msgid "guestfs_add_domain_argv"
5961 #: ../src/guestfs-actions.pod:114
5965 " guestfs_add_domain_argv (guestfs_h *g,\n"
5966 " const char *dom,\n"
5967 " const struct guestfs_add_domain_argv *optargs);\n"
5972 #: ../src/guestfs-actions.pod:119
5973 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5977 #: ../src/guestfs-actions.pod:123
5978 msgid "guestfs_add_drive"
5982 #: ../src/guestfs-actions.pod:125
5986 " guestfs_add_drive (guestfs_h *g,\n"
5987 " const char *filename);\n"
5992 #: ../src/guestfs-actions.pod:129
5994 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5995 "optional parameters, so the disk is added writable, with the format being "
5996 "detected automatically."
6000 #: ../src/guestfs-actions.pod:133
6002 "Automatic detection of the format opens you up to a potential security hole "
6003 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6004 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6005 "you should think about replacing calls to this function with calls to "
6006 "C<guestfs_add_drive_opts>, and specifying the format."
6010 #: ../src/guestfs-actions.pod:144
6011 msgid "guestfs_add_drive_opts"
6015 #: ../src/guestfs-actions.pod:146
6019 " guestfs_add_drive_opts (guestfs_h *g,\n"
6020 " const char *filename,\n"
6026 #: ../src/guestfs-actions.pod:156
6029 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6030 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6031 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6036 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6038 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6039 "The first time you call this function, the disk appears as C</dev/sda>, the "
6040 "second time as C</dev/sdb>, and so on."
6044 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6046 "You don't necessarily need to be root when using libguestfs. However you "
6047 "obviously do need sufficient permissions to access the filename for whatever "
6048 "operations you want to perform (ie. read access if you just want to read the "
6049 "image or write access if you want to modify the image)."
6053 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6054 msgid "This call checks that C<filename> exists."
6058 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3049
6059 msgid "The optional arguments are:"
6063 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6068 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6070 "If true then the image is treated as read-only. Writes are still allowed, "
6071 "but they are stored in a temporary snapshot overlay which is discarded at "
6072 "the end. The disk that you add is not modified."
6076 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6081 #: ../src/guestfs-actions.pod:185
6083 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6084 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6085 "Possible formats include C<raw> and C<qcow2>."
6089 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6091 "Automatic detection of the format opens you up to a potential security hole "
6092 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6093 "RHBZ#642934. Specifying the format closes this security hole."
6097 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6102 #: ../src/guestfs-actions.pod:196
6104 "This rarely-used option lets you emulate the behaviour of the deprecated "
6105 "C<guestfs_add_drive_with_if> call (q.v.)"
6109 #: ../src/guestfs-actions.pod:203
6110 msgid "(Added in 1.5.23)"
6114 #: ../src/guestfs-actions.pod:205
6115 msgid "guestfs_add_drive_opts_va"
6119 #: ../src/guestfs-actions.pod:207
6123 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6124 " const char *filename,\n"
6130 #: ../src/guestfs-actions.pod:212
6131 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6135 #: ../src/guestfs-actions.pod:216
6136 msgid "guestfs_add_drive_opts_argv"
6140 #: ../src/guestfs-actions.pod:218
6144 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6145 " const char *filename,\n"
6146 " const struct guestfs_add_drive_opts_argv "
6152 #: ../src/guestfs-actions.pod:223
6153 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6157 #: ../src/guestfs-actions.pod:227
6158 msgid "guestfs_add_drive_ro"
6162 #: ../src/guestfs-actions.pod:229
6166 " guestfs_add_drive_ro (guestfs_h *g,\n"
6167 " const char *filename);\n"
6172 #: ../src/guestfs-actions.pod:233
6174 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6175 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6176 "disk is added read-only, with the format being detected automatically."
6180 #: ../src/guestfs-actions.pod:240
6181 msgid "(Added in 1.0.38)"
6185 #: ../src/guestfs-actions.pod:242
6186 msgid "guestfs_add_drive_ro_with_if"
6190 #: ../src/guestfs-actions.pod:244
6194 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6195 " const char *filename,\n"
6196 " const char *iface);\n"
6201 #: ../src/guestfs-actions.pod:249
6203 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6204 "QEMU interface emulation to use at run time."
6208 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2359
6209 msgid "(Added in 1.0.84)"
6213 #: ../src/guestfs-actions.pod:263
6214 msgid "guestfs_add_drive_with_if"
6218 #: ../src/guestfs-actions.pod:265
6222 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6223 " const char *filename,\n"
6224 " const char *iface);\n"
6229 #: ../src/guestfs-actions.pod:270
6231 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6232 "QEMU interface emulation to use at run time."
6236 #: ../src/guestfs-actions.pod:284
6237 msgid "guestfs_aug_clear"
6241 #: ../src/guestfs-actions.pod:286
6245 " guestfs_aug_clear (guestfs_h *g,\n"
6246 " const char *augpath);\n"
6251 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6253 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6254 "L<augtool(1)> C<clear> command."
6258 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2109
6259 msgid "(Added in 1.3.4)"
6263 #: ../src/guestfs-actions.pod:297
6264 msgid "guestfs_aug_close"
6268 #: ../src/guestfs-actions.pod:299
6272 " guestfs_aug_close (guestfs_h *g);\n"
6277 #: ../src/guestfs-actions.pod:302
6279 "Close the current Augeas handle and free up any resources used by it. After "
6280 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6281 "any other Augeas functions."
6285 #: ../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:5617
6286 msgid "(Added in 0.7)"
6290 #: ../src/guestfs-actions.pod:311
6291 msgid "guestfs_aug_defnode"
6295 #: ../src/guestfs-actions.pod:313
6298 " struct guestfs_int_bool *\n"
6299 " guestfs_aug_defnode (guestfs_h *g,\n"
6300 " const char *name,\n"
6301 " const char *expr,\n"
6302 " const char *val);\n"
6307 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6308 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6312 #: ../src/guestfs-actions.pod:322
6314 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6315 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6316 "containing that single node."
6320 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6322 "On success this returns a pair containing the number of nodes in the "
6323 "nodeset, and a boolean flag if a node was created."
6327 #: ../src/guestfs-actions.pod:330
6329 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6330 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6334 #: ../src/guestfs-actions.pod:336
6335 msgid "guestfs_aug_defvar"
6339 #: ../src/guestfs-actions.pod:338
6343 " guestfs_aug_defvar (guestfs_h *g,\n"
6344 " const char *name,\n"
6345 " const char *expr);\n"
6350 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6352 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6353 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6357 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6359 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6360 "evaluates to something which is not a nodeset."
6364 #: ../src/guestfs-actions.pod:354
6365 msgid "guestfs_aug_get"
6369 #: ../src/guestfs-actions.pod:356
6373 " guestfs_aug_get (guestfs_h *g,\n"
6374 " const char *augpath);\n"
6379 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6381 "Look up the value associated with C<path>. If C<path> matches exactly one "
6382 "node, the C<value> is returned."
6386 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:881 ../src/guestfs-actions.pod:941 ../src/guestfs-actions.pod:957 ../src/guestfs-actions.pod:1060 ../src/guestfs-actions.pod:1190 ../src/guestfs-actions.pod:1207 ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1548 ../src/guestfs-actions.pod:1660 ../src/guestfs-actions.pod:1823 ../src/guestfs-actions.pod:1840 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:2324 ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2618 ../src/guestfs-actions.pod:2720 ../src/guestfs-actions.pod:2737 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:2977 ../src/guestfs-actions.pod:2998 ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3089 ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3722 ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5345 ../src/guestfs-actions.pod:5515 ../src/guestfs-actions.pod:5693 ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:6375 ../src/guestfs-actions.pod:6391 ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6439 ../src/guestfs-actions.pod:7113 ../src/guestfs-actions.pod:7132 ../src/guestfs-actions.pod:7150 ../src/guestfs-actions.pod:7330 ../src/guestfs-actions.pod:7610
6388 "This function returns a string, or NULL on error. I<The caller must free "
6389 "the returned string after use>."
6393 #: ../src/guestfs-actions.pod:368
6394 msgid "guestfs_aug_init"
6398 #: ../src/guestfs-actions.pod:370
6402 " guestfs_aug_init (guestfs_h *g,\n"
6403 " const char *root,\n"
6409 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6411 "Create a new Augeas handle for editing configuration files. If there was "
6412 "any previous Augeas handle associated with this guestfs session, then it is "
6417 #: ../src/guestfs-actions.pod:379
6418 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6422 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6423 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6427 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6429 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6430 "logical I<or> of the following integers:"
6434 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6435 msgid "C<AUG_SAVE_BACKUP> = 1"
6439 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6440 msgid "Keep the original file with a C<.augsave> extension."
6444 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6445 msgid "C<AUG_SAVE_NEWFILE> = 2"
6449 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6451 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6452 "original. Overrides C<AUG_SAVE_BACKUP>."
6456 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6457 msgid "C<AUG_TYPE_CHECK> = 4"
6461 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6462 msgid "Typecheck lenses (can be expensive)."
6466 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6467 msgid "C<AUG_NO_STDINC> = 8"
6471 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6472 msgid "Do not use standard load path for modules."
6476 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6477 msgid "C<AUG_SAVE_NOOP> = 16"
6481 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6482 msgid "Make save a no-op, just record what would have been changed."
6486 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6487 msgid "C<AUG_NO_LOAD> = 32"
6491 #: ../src/guestfs-actions.pod:414
6492 msgid "Do not load the tree in C<guestfs_aug_init>."
6496 #: ../src/guestfs-actions.pod:418
6497 msgid "To close the handle, you can call C<guestfs_aug_close>."
6501 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6502 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6506 #: ../src/guestfs-actions.pod:426
6507 msgid "guestfs_aug_insert"
6511 #: ../src/guestfs-actions.pod:428
6515 " guestfs_aug_insert (guestfs_h *g,\n"
6516 " const char *augpath,\n"
6517 " const char *label,\n"
6523 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6525 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6526 "or after C<path> (depending on the boolean flag C<before>)."
6530 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6532 "C<path> must match exactly one existing node in the tree, and C<label> must "
6533 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6537 #: ../src/guestfs-actions.pod:446
6538 msgid "guestfs_aug_load"
6542 #: ../src/guestfs-actions.pod:448
6546 " guestfs_aug_load (guestfs_h *g);\n"
6551 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6552 msgid "Load files into the tree."
6556 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6557 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6561 #: ../src/guestfs-actions.pod:460
6562 msgid "guestfs_aug_ls"
6566 #: ../src/guestfs-actions.pod:462
6570 " guestfs_aug_ls (guestfs_h *g,\n"
6571 " const char *augpath);\n"
6576 #: ../src/guestfs-actions.pod:466
6578 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6579 "sorting the resulting nodes into alphabetical order."
6583 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485 ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1079 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1394 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1516 ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:2204 ../src/guestfs-actions.pod:2220 ../src/guestfs-actions.pod:2239 ../src/guestfs-actions.pod:2282 ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:2377 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2681 ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3317 ../src/guestfs-actions.pod:3627 ../src/guestfs-actions.pod:3642 ../src/guestfs-actions.pod:3704 ../src/guestfs-actions.pod:3809 ../src/guestfs-actions.pod:4214 ../src/guestfs-actions.pod:4967 ../src/guestfs-actions.pod:5487 ../src/guestfs-actions.pod:5613 ../src/guestfs-actions.pod:5727 ../src/guestfs-actions.pod:6455 ../src/guestfs-actions.pod:6516 ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6717 ../src/guestfs-actions.pod:6741 ../src/guestfs-actions.pod:7223 ../src/guestfs-actions.pod:7243 ../src/guestfs-actions.pod:7290 ../src/guestfs-actions.pod:7462 ../src/guestfs-actions.pod:7481 ../src/guestfs-actions.pod:7567 ../src/guestfs-actions.pod:7586 ../src/guestfs-actions.pod:7632 ../src/guestfs-actions.pod:7651
6585 "This function returns a NULL-terminated array of strings (like "
6586 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6587 "strings and the array after use>."
6591 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:1022 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3426 ../src/guestfs-actions.pod:4055 ../src/guestfs-actions.pod:4105 ../src/guestfs-actions.pod:4292 ../src/guestfs-actions.pod:4325 ../src/guestfs-actions.pod:4488 ../src/guestfs-actions.pod:4971 ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5823 ../src/guestfs-actions.pod:5837 ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:6296 ../src/guestfs-actions.pod:6955 ../src/guestfs-actions.pod:6968 ../src/guestfs-actions.pod:7207 ../src/guestfs-actions.pod:7450
6592 msgid "(Added in 0.8)"
6596 #: ../src/guestfs-actions.pod:475
6597 msgid "guestfs_aug_match"
6601 #: ../src/guestfs-actions.pod:477
6605 " guestfs_aug_match (guestfs_h *g,\n"
6606 " const char *augpath);\n"
6611 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
6613 "Returns a list of paths which match the path expression C<path>. The "
6614 "returned paths are sufficiently qualified so that they match exactly one "
6615 "node in the current tree."
6619 #: ../src/guestfs-actions.pod:491
6620 msgid "guestfs_aug_mv"
6624 #: ../src/guestfs-actions.pod:493
6628 " guestfs_aug_mv (guestfs_h *g,\n"
6629 " const char *src,\n"
6630 " const char *dest);\n"
6635 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
6637 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6638 "C<dest> is overwritten if it exists."
6642 #: ../src/guestfs-actions.pod:505
6643 msgid "guestfs_aug_rm"
6647 #: ../src/guestfs-actions.pod:507
6651 " guestfs_aug_rm (guestfs_h *g,\n"
6652 " const char *augpath);\n"
6657 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
6658 msgid "Remove C<path> and all of its children."
6662 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
6663 msgid "On success this returns the number of entries which were removed."
6667 #: ../src/guestfs-actions.pod:519
6668 msgid "guestfs_aug_save"
6672 #: ../src/guestfs-actions.pod:521
6676 " guestfs_aug_save (guestfs_h *g);\n"
6681 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
6682 msgid "This writes all pending changes to disk."
6686 #: ../src/guestfs-actions.pod:526
6688 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6693 #: ../src/guestfs-actions.pod:533
6694 msgid "guestfs_aug_set"
6698 #: ../src/guestfs-actions.pod:535
6702 " guestfs_aug_set (guestfs_h *g,\n"
6703 " const char *augpath,\n"
6704 " const char *val);\n"
6709 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
6710 msgid "Set the value associated with C<path> to C<val>."
6714 #: ../src/guestfs-actions.pod:542
6716 "In the Augeas API, it is possible to clear a node by setting the value to "
6717 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6718 "this call. Instead you must use the C<guestfs_aug_clear> call."
6722 #: ../src/guestfs-actions.pod:551
6723 msgid "guestfs_available"
6727 #: ../src/guestfs-actions.pod:553
6731 " guestfs_available (guestfs_h *g,\n"
6732 " char *const *groups);\n"
6737 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
6739 "This command is used to check the availability of some groups of "
6740 "functionality in the appliance, which not all builds of the libguestfs "
6741 "appliance will be able to provide."
6745 #: ../src/guestfs-actions.pod:561
6747 "The libguestfs groups, and the functions that those groups correspond to, "
6748 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6749 "runtime by calling C<guestfs_available_all_groups>."
6753 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
6755 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
6756 "\"augeas\"]> would check for the availability of the Linux inotify functions "
6757 "and Augeas (configuration file editing) functions."
6761 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
6762 msgid "The command returns no error if I<all> requested groups are available."
6766 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
6768 "It fails with an error if one or more of the requested groups is unavailable "
6773 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
6775 "If an unknown group name is included in the list of groups then an error is "
6780 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
6785 #: ../src/guestfs-actions.pod:585
6786 msgid "You must call C<guestfs_launch> before calling this function."
6790 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
6792 "The reason is because we don't know what groups are supported by the "
6793 "appliance/daemon until it is running and can be queried."
6797 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
6799 "If a group of functions is available, this does not necessarily mean that "
6800 "they will work. You still have to check for errors when calling individual "
6801 "API functions even if they are available."
6805 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
6807 "It is usually the job of distro packagers to build complete functionality "
6808 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6809 "with all requirements satisfied, will support everything."
6813 #: ../src/guestfs-actions.pod:607
6815 "This call was added in version C<1.0.80>. In previous versions of "
6816 "libguestfs all you could do would be to speculatively execute a command to "
6817 "find out if the daemon implemented it. See also C<guestfs_version>."
6821 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1177
6822 msgid "(Added in 1.0.80)"
6826 #: ../src/guestfs-actions.pod:618
6827 msgid "guestfs_available_all_groups"
6831 #: ../src/guestfs-actions.pod:620
6835 " guestfs_available_all_groups (guestfs_h *g);\n"
6840 #: ../src/guestfs-actions.pod:623
6842 "This command returns a list of all optional groups that this daemon knows "
6843 "about. Note this returns both supported and unsupported groups. To find "
6844 "out which ones the daemon can actually support you have to call "
6845 "C<guestfs_available> on each member of the returned list."
6849 #: ../src/guestfs-actions.pod:629
6850 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
6854 #: ../src/guestfs-actions.pod:635
6855 msgid "(Added in 1.3.15)"
6859 #: ../src/guestfs-actions.pod:637
6860 msgid "guestfs_base64_in"
6864 #: ../src/guestfs-actions.pod:639
6868 " guestfs_base64_in (guestfs_h *g,\n"
6869 " const char *base64file,\n"
6870 " const char *filename);\n"
6875 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
6876 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
6880 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
6881 msgid "(Added in 1.3.5)"
6885 #: ../src/guestfs-actions.pod:651
6886 msgid "guestfs_base64_out"
6890 #: ../src/guestfs-actions.pod:653
6894 " guestfs_base64_out (guestfs_h *g,\n"
6895 " const char *filename,\n"
6896 " const char *base64file);\n"
6901 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
6903 "This command downloads the contents of C<filename>, writing it out to local "
6904 "file C<base64file> encoded as base64."
6908 #: ../src/guestfs-actions.pod:665
6909 msgid "guestfs_blockdev_flushbufs"
6913 #: ../src/guestfs-actions.pod:667
6917 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
6918 " const char *device);\n"
6923 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
6924 msgid "This tells the kernel to flush internal buffers associated with C<device>."
6928 #: ../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
6929 msgid "This uses the L<blockdev(8)> command."
6933 #: ../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
6934 msgid "(Added in 0.9.3)"
6938 #: ../src/guestfs-actions.pod:680
6939 msgid "guestfs_blockdev_getbsz"
6943 #: ../src/guestfs-actions.pod:682
6947 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
6948 " const char *device);\n"
6953 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
6954 msgid "This returns the block size of a device."
6958 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788 ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
6960 "(Note this is different from both I<size in blocks> and I<filesystem block "
6965 #: ../src/guestfs-actions.pod:697
6966 msgid "guestfs_blockdev_getro"
6970 #: ../src/guestfs-actions.pod:699
6974 " guestfs_blockdev_getro (guestfs_h *g,\n"
6975 " const char *device);\n"
6980 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
6982 "Returns a boolean indicating if the block device is read-only (true if "
6983 "read-only, false if not)."
6987 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1415 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1928 ../src/guestfs-actions.pod:2000 ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2070 ../src/guestfs-actions.pod:2095 ../src/guestfs-actions.pod:2118 ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3158 ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3348 ../src/guestfs-actions.pod:3363 ../src/guestfs-actions.pod:3377 ../src/guestfs-actions.pod:3393 ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3438 ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3495 ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3520 ../src/guestfs-actions.pod:5116
6988 msgid "This function returns a C truth value on success or -1 on error."
6992 #: ../src/guestfs-actions.pod:712
6993 msgid "guestfs_blockdev_getsize64"
6997 #: ../src/guestfs-actions.pod:714
7001 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7002 " const char *device);\n"
7007 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7008 msgid "This returns the size of the device in bytes."
7012 #: ../src/guestfs-actions.pod:720
7013 msgid "See also C<guestfs_blockdev_getsz>."
7017 #: ../src/guestfs-actions.pod:728
7018 msgid "guestfs_blockdev_getss"
7022 #: ../src/guestfs-actions.pod:730
7026 " guestfs_blockdev_getss (guestfs_h *g,\n"
7027 " const char *device);\n"
7032 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7034 "This returns the size of sectors on a block device. Usually 512, but can be "
7035 "larger for modern devices."
7039 #: ../src/guestfs-actions.pod:737
7041 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7046 #: ../src/guestfs-actions.pod:746
7047 msgid "guestfs_blockdev_getsz"
7051 #: ../src/guestfs-actions.pod:748
7055 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7056 " const char *device);\n"
7061 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7063 "This returns the size of the device in units of 512-byte sectors (even if "
7064 "the sectorsize isn't 512 bytes ... weird)."
7068 #: ../src/guestfs-actions.pod:755
7070 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7071 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7075 #: ../src/guestfs-actions.pod:765
7076 msgid "guestfs_blockdev_rereadpt"
7080 #: ../src/guestfs-actions.pod:767
7084 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7085 " const char *device);\n"
7090 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7091 msgid "Reread the partition table on C<device>."
7095 #: ../src/guestfs-actions.pod:779
7096 msgid "guestfs_blockdev_setbsz"
7100 #: ../src/guestfs-actions.pod:781
7104 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7105 " const char *device,\n"
7106 " int blocksize);\n"
7111 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7112 msgid "This sets the block size of a device."
7116 #: ../src/guestfs-actions.pod:797
7117 msgid "guestfs_blockdev_setro"
7121 #: ../src/guestfs-actions.pod:799
7125 " guestfs_blockdev_setro (guestfs_h *g,\n"
7126 " const char *device);\n"
7131 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7132 msgid "Sets the block device named C<device> to read-only."
7136 #: ../src/guestfs-actions.pod:811
7137 msgid "guestfs_blockdev_setrw"
7141 #: ../src/guestfs-actions.pod:813
7145 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7146 " const char *device);\n"
7151 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7152 msgid "Sets the block device named C<device> to read-write."
7156 #: ../src/guestfs-actions.pod:825
7157 msgid "guestfs_case_sensitive_path"
7161 #: ../src/guestfs-actions.pod:827
7165 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7166 " const char *path);\n"
7171 #: ../src/guestfs-actions.pod:831 ../fish/guestfish-actions.pod:549
7173 "This can be used to resolve case insensitive paths on a filesystem which is "
7174 "case sensitive. The use case is to resolve paths which you have read from "
7175 "Windows configuration files or the Windows Registry, to the true path."
7179 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:554
7181 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7182 "(and probably others), which is that although the underlying filesystem is "
7183 "case-insensitive, the driver exports the filesystem to Linux as "
7188 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:559
7190 "One consequence of this is that special directories such as C<c:\\windows> "
7191 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7192 "precise details of how they were created. In Windows itself this would not "
7197 #: ../src/guestfs-actions.pod:847 ../fish/guestfish-actions.pod:565
7199 "Bug or feature? You decide: "
7200 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
7204 #: ../src/guestfs-actions.pod:850 ../fish/guestfish-actions.pod:568
7206 "This function resolves the true case of each element in the path and returns "
7207 "the case-sensitive path."
7211 #: ../src/guestfs-actions.pod:853
7213 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7214 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7215 "how the directories were originally created under Windows)."
7219 #: ../src/guestfs-actions.pod:858 ../fish/guestfish-actions.pod:576
7220 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7224 #: ../src/guestfs-actions.pod:861
7225 msgid "See also C<guestfs_realpath>."
7229 #: ../src/guestfs-actions.pod:866 ../src/guestfs-actions.pod:7135
7230 msgid "(Added in 1.0.75)"
7234 #: ../src/guestfs-actions.pod:868
7239 #: ../src/guestfs-actions.pod:870
7243 " guestfs_cat (guestfs_h *g,\n"
7244 " const char *path);\n"
7249 #: ../src/guestfs-actions.pod:874 ../src/guestfs-actions.pod:5603 ../fish/guestfish-actions.pod:585 ../fish/guestfish-actions.pod:3717
7250 msgid "Return the contents of the file named C<path>."
7254 #: ../src/guestfs-actions.pod:876
7256 "Note that this function cannot correctly handle binary files (specifically, "
7257 "files containing C<\\0> character which is treated as end of string). For "
7258 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7259 "functions which have a more complex interface."
7263 #: ../src/guestfs-actions.pod:884 ../src/guestfs-actions.pod:1063 ../src/guestfs-actions.pod:1083 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1520 ../src/guestfs-actions.pod:1766 ../src/guestfs-actions.pod:2224 ../src/guestfs-actions.pod:2243 ../src/guestfs-actions.pod:2286 ../src/guestfs-actions.pod:2310 ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:5385 ../src/guestfs-actions.pod:5411 ../src/guestfs-actions.pod:5542 ../src/guestfs-actions.pod:5568 ../src/guestfs-actions.pod:5592 ../src/guestfs-actions.pod:6520 ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6721 ../src/guestfs-actions.pod:6745 ../src/guestfs-actions.pod:7414 ../src/guestfs-actions.pod:7440 ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7485 ../src/guestfs-actions.pod:7571 ../src/guestfs-actions.pod:7590 ../src/guestfs-actions.pod:7636 ../src/guestfs-actions.pod:7655 ../fish/guestfish-actions.pod:592 ../fish/guestfish-actions.pod:727 ../fish/guestfish-actions.pod:739 ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:925 ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1002 ../fish/guestfish-actions.pod:1194 ../fish/guestfish-actions.pod:1495 ../fish/guestfish-actions.pod:1505 ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:1548 ../fish/guestfish-actions.pod:1558 ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:3587 ../fish/guestfish-actions.pod:3602 ../fish/guestfish-actions.pod:3678 ../fish/guestfish-actions.pod:3695 ../fish/guestfish-actions.pod:3710 ../fish/guestfish-actions.pod:4364 ../fish/guestfish-actions.pod:4410 ../fish/guestfish-actions.pod:4495 ../fish/guestfish-actions.pod:4510 ../fish/guestfish-actions.pod:4920 ../fish/guestfish-actions.pod:4938 ../fish/guestfish-actions.pod:4955 ../fish/guestfish-actions.pod:4965 ../fish/guestfish-actions.pod:5014 ../fish/guestfish-actions.pod:5024 ../fish/guestfish-actions.pod:5053 ../fish/guestfish-actions.pod:5063
7265 "Because of the message protocol, there is a transfer limit of somewhere "
7266 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7270 #: ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:3725 ../src/guestfs-actions.pod:3813 ../src/guestfs-actions.pod:4218 ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:5491 ../src/guestfs-actions.pod:5505 ../src/guestfs-actions.pod:7294 ../src/guestfs-actions.pod:7308
7271 msgid "(Added in 0.4)"
7275 #: ../src/guestfs-actions.pod:889
7276 msgid "guestfs_checksum"
7280 #: ../src/guestfs-actions.pod:891
7284 " guestfs_checksum (guestfs_h *g,\n"
7285 " const char *csumtype,\n"
7286 " const char *path);\n"
7291 #: ../src/guestfs-actions.pod:896 ../fish/guestfish-actions.pod:599
7292 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7296 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:602
7298 "The type of checksum to compute is given by the C<csumtype> parameter which "
7299 "must have one of the following values:"
7303 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:607
7308 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:609
7310 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7315 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:612
7320 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:614
7321 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7325 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:616
7330 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:618
7331 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7335 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:620
7340 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:622
7341 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7345 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:624
7350 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:626
7351 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7355 #: ../src/guestfs-actions.pod:925 ../fish/guestfish-actions.pod:628
7360 #: ../src/guestfs-actions.pod:927 ../fish/guestfish-actions.pod:630
7361 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7365 #: ../src/guestfs-actions.pod:929 ../fish/guestfish-actions.pod:632
7370 #: ../src/guestfs-actions.pod:931 ../fish/guestfish-actions.pod:634
7371 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7375 #: ../src/guestfs-actions.pod:935 ../fish/guestfish-actions.pod:638
7376 msgid "The checksum is returned as a printable string."
7380 #: ../src/guestfs-actions.pod:937
7381 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7385 #: ../src/guestfs-actions.pod:939
7386 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7390 #: ../src/guestfs-actions.pod:944 ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:2086 ../src/guestfs-actions.pod:3350 ../src/guestfs-actions.pod:3379 ../src/guestfs-actions.pod:3440 ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:6991
7391 msgid "(Added in 1.0.2)"
7395 #: ../src/guestfs-actions.pod:946
7396 msgid "guestfs_checksum_device"
7400 #: ../src/guestfs-actions.pod:948
7404 " guestfs_checksum_device (guestfs_h *g,\n"
7405 " const char *csumtype,\n"
7406 " const char *device);\n"
7411 #: ../src/guestfs-actions.pod:953
7413 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7414 "device named C<device>. For the types of checksums supported see the "
7415 "C<guestfs_checksum> command."
7419 #: ../src/guestfs-actions.pod:960 ../src/guestfs-actions.pod:5022 ../src/guestfs-actions.pod:5081 ../src/guestfs-actions.pod:5118 ../src/guestfs-actions.pod:5136 ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6914 ../src/guestfs-actions.pod:7320
7420 msgid "(Added in 1.3.2)"
7424 #: ../src/guestfs-actions.pod:962
7425 msgid "guestfs_checksums_out"
7429 #: ../src/guestfs-actions.pod:964
7433 " guestfs_checksums_out (guestfs_h *g,\n"
7434 " const char *csumtype,\n"
7435 " const char *directory,\n"
7436 " const char *sumsfile);\n"
7441 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:656
7443 "This command computes the checksums of all regular files in C<directory> and "
7444 "then emits a list of those checksums to the local output file C<sumsfile>."
7448 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:660
7450 "This can be used for verifying the integrity of a virtual machine. However "
7451 "to be properly secure you should pay attention to the output of the checksum "
7452 "command (it uses the ones from GNU coreutils). In particular when the "
7453 "filename is not printable, coreutils uses a special backslash syntax. For "
7454 "more information, see the GNU coreutils info file."
7458 #: ../src/guestfs-actions.pod:984
7459 msgid "(Added in 1.3.7)"
7463 #: ../src/guestfs-actions.pod:986
7464 msgid "guestfs_chmod"
7468 #: ../src/guestfs-actions.pod:988
7472 " guestfs_chmod (guestfs_h *g,\n"
7474 " const char *path);\n"
7479 #: ../src/guestfs-actions.pod:993 ../fish/guestfish-actions.pod:674
7481 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7486 #: ../src/guestfs-actions.pod:996 ../fish/guestfish-actions.pod:677
7488 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7489 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7494 #: ../src/guestfs-actions.pod:1000 ../src/guestfs-actions.pod:4469 ../src/guestfs-actions.pod:4666 ../src/guestfs-actions.pod:4685 ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:681 ../fish/guestfish-actions.pod:3013 ../fish/guestfish-actions.pod:3142 ../fish/guestfish-actions.pod:3152 ../fish/guestfish-actions.pod:3162
7495 msgid "The mode actually set is affected by the umask."
7499 #: ../src/guestfs-actions.pod:1006
7500 msgid "guestfs_chown"
7504 #: ../src/guestfs-actions.pod:1008
7508 " guestfs_chown (guestfs_h *g,\n"
7511 " const char *path);\n"
7516 #: ../src/guestfs-actions.pod:1014 ../fish/guestfish-actions.pod:687
7517 msgid "Change the file owner to C<owner> and group to C<group>."
7521 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:3565 ../fish/guestfish-actions.pod:689 ../fish/guestfish-actions.pod:2464
7523 "Only numeric uid and gid are supported. If you want to use names, you will "
7524 "need to locate and parse the password file yourself (Augeas support makes "
7525 "this relatively easy)."
7529 #: ../src/guestfs-actions.pod:1024
7530 msgid "guestfs_command"
7534 #: ../src/guestfs-actions.pod:1026
7538 " guestfs_command (guestfs_h *g,\n"
7539 " char *const *arguments);\n"
7544 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:697
7546 "This call runs a command from the guest filesystem. The filesystem must be "
7547 "mounted, and must contain a compatible operating system (ie. something "
7548 "Linux, with the same or compatible processor architecture)."
7552 #: ../src/guestfs-actions.pod:1035
7554 "The single parameter is an argv-style list of arguments. The first element "
7555 "is the name of the program to run. Subsequent elements are parameters. The "
7556 "list must be non-empty (ie. must contain a program name). Note that the "
7557 "command runs directly, and is I<not> invoked via the shell (see "
7562 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:709
7563 msgid "The return value is anything printed to I<stdout> by the command."
7567 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:712
7569 "If the command returns a non-zero exit status, then this function returns an "
7570 "error message. The error message string is the content of I<stderr> from "
7575 #: ../src/guestfs-actions.pod:1049 ../fish/guestfish-actions.pod:716
7577 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
7578 "C</bin>. If you require a program from another location, you should provide "
7579 "the full path in the first parameter."
7583 #: ../src/guestfs-actions.pod:1054 ../fish/guestfish-actions.pod:721
7585 "Shared libraries and data files required by the program must be available on "
7586 "filesystems which are mounted in the correct places. It is the caller's "
7587 "responsibility to ensure all filesystems that are needed are mounted at the "
7592 #: ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1551
7593 msgid "(Added in 0.9.1)"
7597 #: ../src/guestfs-actions.pod:1068
7598 msgid "guestfs_command_lines"
7602 #: ../src/guestfs-actions.pod:1070
7606 " guestfs_command_lines (guestfs_h *g,\n"
7607 " char *const *arguments);\n"
7612 #: ../src/guestfs-actions.pod:1074
7614 "This is the same as C<guestfs_command>, but splits the result into a list of "
7619 #: ../src/guestfs-actions.pod:1077
7620 msgid "See also: C<guestfs_sh_lines>"
7624 #: ../src/guestfs-actions.pod:1088
7625 msgid "guestfs_config"
7629 #: ../src/guestfs-actions.pod:1090
7633 " guestfs_config (guestfs_h *g,\n"
7634 " const char *qemuparam,\n"
7635 " const char *qemuvalue);\n"
7640 #: ../src/guestfs-actions.pod:1095 ../fish/guestfish-actions.pod:746
7642 "This can be used to add arbitrary qemu command line parameters of the form "
7643 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7644 "setting some parameters which would interfere with parameters that we use."
7648 #: ../src/guestfs-actions.pod:1100 ../fish/guestfish-actions.pod:751
7649 msgid "The first character of C<param> string must be a C<-> (dash)."
7653 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:753
7654 msgid "C<value> can be NULL."
7658 #: ../src/guestfs-actions.pod:1108
7659 msgid "guestfs_copy_size"
7663 #: ../src/guestfs-actions.pod:1110
7667 " guestfs_copy_size (guestfs_h *g,\n"
7668 " const char *src,\n"
7669 " const char *dest,\n"
7675 #: ../src/guestfs-actions.pod:1116 ../fish/guestfish-actions.pod:759
7677 "This command copies exactly C<size> bytes from one source device or file "
7678 "C<src> to another destination device or file C<dest>."
7682 #: ../src/guestfs-actions.pod:1119 ../fish/guestfish-actions.pod:762
7684 "Note this will fail if the source is too short or if the destination is not "
7689 #: ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1247 ../src/guestfs-actions.pod:1278 ../src/guestfs-actions.pod:1323 ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:3546 ../src/guestfs-actions.pod:6986 ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7507 ../src/guestfs-actions.pod:7526
7691 "This long-running command can generate progress notification messages so "
7692 "that the caller can display a progress bar or indicator. To receive these "
7693 "messages, the caller must register a progress event callback. See "
7694 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
7698 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:4245 ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:7227 ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7333
7699 msgid "(Added in 1.0.87)"
7703 #: ../src/guestfs-actions.pod:1131
7708 #: ../src/guestfs-actions.pod:1133
7712 " guestfs_cp (guestfs_h *g,\n"
7713 " const char *src,\n"
7714 " const char *dest);\n"
7719 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:769
7721 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7722 "destination filename or destination directory."
7726 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1157 ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1303 ../src/guestfs-actions.pod:1417 ../src/guestfs-actions.pod:4985 ../src/guestfs-actions.pod:5362
7727 msgid "(Added in 1.0.18)"
7731 #: ../src/guestfs-actions.pod:1145
7732 msgid "guestfs_cp_a"
7736 #: ../src/guestfs-actions.pod:1147
7740 " guestfs_cp_a (guestfs_h *g,\n"
7741 " const char *src,\n"
7742 " const char *dest);\n"
7747 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:776
7749 "This copies a file or directory from C<src> to C<dest> recursively using the "
7754 #: ../src/guestfs-actions.pod:1159
7759 #: ../src/guestfs-actions.pod:1161
7763 " guestfs_dd (guestfs_h *g,\n"
7764 " const char *src,\n"
7765 " const char *dest);\n"
7770 #: ../src/guestfs-actions.pod:1166 ../fish/guestfish-actions.pod:783
7772 "This command copies from one source device or file C<src> to another "
7773 "destination device or file C<dest>. Normally you would use this to copy to "
7774 "or from a device or partition, for example to duplicate a filesystem."
7778 #: ../src/guestfs-actions.pod:1171
7780 "If the destination is a device, it must be as large or larger than the "
7781 "source file or device, otherwise the copy will fail. This command cannot do "
7782 "partial copies (see C<guestfs_copy_size>)."
7786 #: ../src/guestfs-actions.pod:1179
7791 #: ../src/guestfs-actions.pod:1181
7795 " guestfs_df (guestfs_h *g);\n"
7800 #: ../src/guestfs-actions.pod:1184 ../fish/guestfish-actions.pod:796
7801 msgid "This command runs the C<df> command to report disk space used."
7805 #: ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1203
7807 "This command is mostly useful for interactive sessions. It is I<not> "
7808 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
7813 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1210 ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:2289 ../src/guestfs-actions.pod:2313 ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:4355 ../src/guestfs-actions.pod:4885 ../src/guestfs-actions.pod:6724 ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7386 ../src/guestfs-actions.pod:7399
7814 msgid "(Added in 1.0.54)"
7818 #: ../src/guestfs-actions.pod:1195
7819 msgid "guestfs_df_h"
7823 #: ../src/guestfs-actions.pod:1197
7827 " guestfs_df_h (guestfs_h *g);\n"
7832 #: ../src/guestfs-actions.pod:1200 ../fish/guestfish-actions.pod:806
7834 "This command runs the C<df -h> command to report disk space used in "
7835 "human-readable format."
7839 #: ../src/guestfs-actions.pod:1212
7840 msgid "guestfs_dmesg"
7844 #: ../src/guestfs-actions.pod:1214
7848 " guestfs_dmesg (guestfs_h *g);\n"
7853 #: ../src/guestfs-actions.pod:1217 ../fish/guestfish-actions.pod:817
7855 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7856 "This is sometimes useful for extended debugging of problems."
7860 #: ../src/guestfs-actions.pod:1221
7862 "Another way to get the same information is to enable verbose messages with "
7863 "C<guestfs_set_verbose> or by setting the environment variable "
7864 "C<LIBGUESTFS_DEBUG=1> before running the program."
7868 #: ../src/guestfs-actions.pod:1231
7869 msgid "guestfs_download"
7873 #: ../src/guestfs-actions.pod:1233
7877 " guestfs_download (guestfs_h *g,\n"
7878 " const char *remotefilename,\n"
7879 " const char *filename);\n"
7884 #: ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:1263 ../fish/guestfish-actions.pod:830 ../fish/guestfish-actions.pod:843
7886 "Download file C<remotefilename> and save it as C<filename> on the local "
7891 #: ../src/guestfs-actions.pod:1241 ../src/guestfs-actions.pod:6980 ../fish/guestfish-actions.pod:833 ../fish/guestfish-actions.pod:4668
7892 msgid "C<filename> can also be a named pipe."
7896 #: ../src/guestfs-actions.pod:1243
7897 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
7901 #: ../src/guestfs-actions.pod:1254
7902 msgid "guestfs_download_offset"
7906 #: ../src/guestfs-actions.pod:1256
7910 " guestfs_download_offset (guestfs_h *g,\n"
7911 " const char *remotefilename,\n"
7912 " const char *filename,\n"
7913 " int64_t offset,\n"
7919 #: ../src/guestfs-actions.pod:1266 ../fish/guestfish-actions.pod:846
7921 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7922 "region must be within the file or device)."
7926 #: ../src/guestfs-actions.pod:1269
7928 "Note that there is no limit on the amount of data that can be downloaded "
7929 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
7930 "full amount unless an error occurs."
7934 #: ../src/guestfs-actions.pod:1274
7935 msgid "See also C<guestfs_download>, C<guestfs_pread>."
7939 #: ../src/guestfs-actions.pod:1283 ../src/guestfs-actions.pod:7025
7940 msgid "(Added in 1.5.17)"
7944 #: ../src/guestfs-actions.pod:1285
7945 msgid "guestfs_drop_caches"
7949 #: ../src/guestfs-actions.pod:1287
7953 " guestfs_drop_caches (guestfs_h *g,\n"
7954 " int whattodrop);\n"
7959 #: ../src/guestfs-actions.pod:1291 ../fish/guestfish-actions.pod:862
7961 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7962 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7963 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7967 #: ../src/guestfs-actions.pod:1296 ../fish/guestfish-actions.pod:867
7968 msgid "Setting C<whattodrop> to 3 should drop everything."
7972 #: ../src/guestfs-actions.pod:1298 ../fish/guestfish-actions.pod:869
7974 "This automatically calls L<sync(2)> before the operation, so that the "
7975 "maximum guest memory is freed."
7979 #: ../src/guestfs-actions.pod:1305
7984 #: ../src/guestfs-actions.pod:1307
7988 " guestfs_du (guestfs_h *g,\n"
7989 " const char *path);\n"
7994 #: ../src/guestfs-actions.pod:1311 ../fish/guestfish-actions.pod:876
7996 "This command runs the C<du -s> command to estimate file space usage for "
8001 #: ../src/guestfs-actions.pod:1314 ../fish/guestfish-actions.pod:879
8003 "C<path> can be a file or a directory. If C<path> is a directory then the "
8004 "estimate includes the contents of the directory and all subdirectories "
8009 #: ../src/guestfs-actions.pod:1318 ../fish/guestfish-actions.pod:883
8010 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8014 #: ../src/guestfs-actions.pod:1330
8015 msgid "guestfs_e2fsck_f"
8019 #: ../src/guestfs-actions.pod:1332
8023 " guestfs_e2fsck_f (guestfs_h *g,\n"
8024 " const char *device);\n"
8029 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:890
8031 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8032 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
8037 #: ../src/guestfs-actions.pod:1340
8039 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8040 "Normally you should use C<guestfs_fsck>."
8044 #: ../src/guestfs-actions.pod:1345
8045 msgid "(Added in 1.0.29)"
8049 #: ../src/guestfs-actions.pod:1347
8050 msgid "guestfs_echo_daemon"
8054 #: ../src/guestfs-actions.pod:1349
8058 " guestfs_echo_daemon (guestfs_h *g,\n"
8059 " char *const *words);\n"
8064 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:901
8066 "This command concatenates the list of C<words> passed with single spaces "
8067 "between them and returns the resulting string."
8071 #: ../src/guestfs-actions.pod:1356 ../fish/guestfish-actions.pod:904
8072 msgid "You can use this command to test the connection through to the daemon."
8076 #: ../src/guestfs-actions.pod:1358
8077 msgid "See also C<guestfs_ping_daemon>."
8081 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:2097 ../src/guestfs-actions.pod:6196
8082 msgid "(Added in 1.0.69)"
8086 #: ../src/guestfs-actions.pod:1365
8087 msgid "guestfs_egrep"
8091 #: ../src/guestfs-actions.pod:1367
8095 " guestfs_egrep (guestfs_h *g,\n"
8096 " const char *regex,\n"
8097 " const char *path);\n"
8102 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
8103 msgid "This calls the external C<egrep> program and returns the matching lines."
8107 #: ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1401 ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:1523 ../src/guestfs-actions.pod:2227 ../src/guestfs-actions.pod:2246 ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:2415 ../src/guestfs-actions.pod:2430 ../src/guestfs-actions.pod:2476 ../src/guestfs-actions.pod:2498 ../src/guestfs-actions.pod:2511 ../src/guestfs-actions.pod:3738 ../src/guestfs-actions.pod:3752 ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:3779 ../src/guestfs-actions.pod:4765 ../src/guestfs-actions.pod:5696 ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:6592 ../src/guestfs-actions.pod:6604 ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:6630 ../src/guestfs-actions.pod:6652 ../src/guestfs-actions.pod:6665 ../src/guestfs-actions.pod:6678 ../src/guestfs-actions.pod:6691 ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:7488 ../src/guestfs-actions.pod:7574 ../src/guestfs-actions.pod:7593 ../src/guestfs-actions.pod:7639 ../src/guestfs-actions.pod:7658
8108 msgid "(Added in 1.0.66)"
8112 #: ../src/guestfs-actions.pod:1384
8113 msgid "guestfs_egrepi"
8117 #: ../src/guestfs-actions.pod:1386
8121 " guestfs_egrepi (guestfs_h *g,\n"
8122 " const char *regex,\n"
8123 " const char *path);\n"
8128 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
8129 msgid "This calls the external C<egrep -i> program and returns the matching lines."
8133 #: ../src/guestfs-actions.pod:1403
8134 msgid "guestfs_equal"
8138 #: ../src/guestfs-actions.pod:1405
8142 " guestfs_equal (guestfs_h *g,\n"
8143 " const char *file1,\n"
8144 " const char *file2);\n"
8149 #: ../src/guestfs-actions.pod:1410 ../fish/guestfish-actions.pod:932
8151 "This compares the two files C<file1> and C<file2> and returns true if their "
8152 "content is exactly equal, or false otherwise."
8156 #: ../src/guestfs-actions.pod:1413 ../fish/guestfish-actions.pod:935
8157 msgid "The external L<cmp(1)> program is used for the comparison."
8161 #: ../src/guestfs-actions.pod:1419
8162 msgid "guestfs_exists"
8166 #: ../src/guestfs-actions.pod:1421
8170 " guestfs_exists (guestfs_h *g,\n"
8171 " const char *path);\n"
8176 #: ../src/guestfs-actions.pod:1425 ../fish/guestfish-actions.pod:941
8178 "This returns C<true> if and only if there is a file, directory (or anything) "
8179 "with the given C<path> name."
8183 #: ../src/guestfs-actions.pod:1428
8184 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8188 #: ../src/guestfs-actions.pod:1434
8189 msgid "guestfs_fallocate"
8193 #: ../src/guestfs-actions.pod:1436
8197 " guestfs_fallocate (guestfs_h *g,\n"
8198 " const char *path,\n"
8204 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1467 ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:969
8206 "This command preallocates a file (containing zero bytes) named C<path> of "
8207 "size C<len> bytes. If the file exists already, it is overwritten."
8211 #: ../src/guestfs-actions.pod:1445 ../fish/guestfish-actions.pod:954
8213 "Do not confuse this with the guestfish-specific C<alloc> command which "
8214 "allocates a file in the host and attaches it as a device."
8218 #: ../src/guestfs-actions.pod:1451 ../fish/guestfish-actions.pod:958
8220 "This function is deprecated. In new code, use the C<fallocate64> call "
8225 #: ../src/guestfs-actions.pod:1460
8226 msgid "guestfs_fallocate64"
8230 #: ../src/guestfs-actions.pod:1462
8234 " guestfs_fallocate64 (guestfs_h *g,\n"
8235 " const char *path,\n"
8241 #: ../src/guestfs-actions.pod:1471
8243 "Note that this call allocates disk blocks for the file. To create a sparse "
8244 "file use C<guestfs_truncate_size> instead."
8248 #: ../src/guestfs-actions.pod:1474
8250 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8251 "oversight it only allowed 30 bit lengths to be specified, effectively "
8252 "limiting the maximum size of files created through that call to 1GB."
8256 #: ../src/guestfs-actions.pod:1479 ../fish/guestfish-actions.pod:981
8258 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8259 "commands which create a file in the host and attach it as a device."
8263 #: ../src/guestfs-actions.pod:1485
8264 msgid "(Added in 1.3.17)"
8268 #: ../src/guestfs-actions.pod:1487
8269 msgid "guestfs_fgrep"
8273 #: ../src/guestfs-actions.pod:1489
8277 " guestfs_fgrep (guestfs_h *g,\n"
8278 " const char *pattern,\n"
8279 " const char *path);\n"
8284 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
8285 msgid "This calls the external C<fgrep> program and returns the matching lines."
8289 #: ../src/guestfs-actions.pod:1506
8290 msgid "guestfs_fgrepi"
8294 #: ../src/guestfs-actions.pod:1508
8298 " guestfs_fgrepi (guestfs_h *g,\n"
8299 " const char *pattern,\n"
8300 " const char *path);\n"
8305 #: ../src/guestfs-actions.pod:1513 ../fish/guestfish-actions.pod:999
8306 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
8310 #: ../src/guestfs-actions.pod:1525
8311 msgid "guestfs_file"
8315 #: ../src/guestfs-actions.pod:1527
8319 " guestfs_file (guestfs_h *g,\n"
8320 " const char *path);\n"
8325 #: ../src/guestfs-actions.pod:1531 ../fish/guestfish-actions.pod:1009
8327 "This call uses the standard L<file(1)> command to determine the type or "
8328 "contents of the file."
8332 #: ../src/guestfs-actions.pod:1534 ../fish/guestfish-actions.pod:1012
8334 "This call will also transparently look inside various types of compressed "
8339 #: ../src/guestfs-actions.pod:1537 ../fish/guestfish-actions.pod:1015
8341 "The exact command which runs is C<file -zb path>. Note in particular that "
8342 "the filename is not prepended to the output (the I<-b> option)."
8346 #: ../src/guestfs-actions.pod:1541 ../fish/guestfish-actions.pod:1019
8348 "The output depends on the output of the underlying L<file(1)> command and it "
8349 "can change in future in ways beyond our control. In other words, the output "
8350 "is not guaranteed by the ABI."
8354 #: ../src/guestfs-actions.pod:1545
8356 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8357 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8361 #: ../src/guestfs-actions.pod:1553
8362 msgid "guestfs_file_architecture"
8366 #: ../src/guestfs-actions.pod:1555
8370 " guestfs_file_architecture (guestfs_h *g,\n"
8371 " const char *filename);\n"
8376 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1030
8378 "This detects the architecture of the binary C<filename>, and returns it if "
8383 #: ../src/guestfs-actions.pod:1562 ../fish/guestfish-actions.pod:1033
8384 msgid "Currently defined architectures are:"
8388 #: ../src/guestfs-actions.pod:1566 ../fish/guestfish-actions.pod:1037
8393 #: ../src/guestfs-actions.pod:1568 ../fish/guestfish-actions.pod:1039
8395 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8396 "irrespective of the precise processor requirements of the binary."
8400 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1042
8405 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1044
8406 msgid "64 bit x86-64."
8410 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1046
8415 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1048
8416 msgid "32 bit SPARC."
8420 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1050
8425 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1052
8426 msgid "64 bit SPARC V9 and above."
8430 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1054
8435 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1056
8436 msgid "Intel Itanium."
8440 #: ../src/guestfs-actions.pod:1587 ../fish/guestfish-actions.pod:1058
8445 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1060
8446 msgid "32 bit Power PC."
8450 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1062
8455 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1064
8456 msgid "64 bit Power PC."
8460 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1068
8461 msgid "Libguestfs may return other architecture strings in future."
8465 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1070
8466 msgid "The function works on at least the following types of files:"
8470 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1076
8471 msgid "many types of Un*x and Linux binary"
8475 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1080
8476 msgid "many types of Un*x and Linux shared library"
8480 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1084
8481 msgid "Windows Win32 and Win64 binaries"
8485 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1088
8486 msgid "Windows Win32 and Win64 DLLs"
8490 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1090
8491 msgid "Win32 binaries and DLLs return C<i386>."
8495 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1092
8496 msgid "Win64 binaries and DLLs return C<x86_64>."
8500 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1096
8501 msgid "Linux kernel modules"
8505 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1100
8506 msgid "Linux new-style initrd images"
8510 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1104
8511 msgid "some non-x86 Linux vmlinuz kernels"
8515 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1108
8516 msgid "What it can't do currently:"
8520 #: ../src/guestfs-actions.pod:1643 ../fish/guestfish-actions.pod:1114
8521 msgid "static libraries (libfoo.a)"
8525 #: ../src/guestfs-actions.pod:1647 ../fish/guestfish-actions.pod:1118
8526 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8530 #: ../src/guestfs-actions.pod:1651 ../fish/guestfish-actions.pod:1122
8531 msgid "x86 Linux vmlinuz kernels"
8535 #: ../src/guestfs-actions.pod:1653 ../fish/guestfish-actions.pod:1124
8537 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8538 "compressed code, and are horribly hard to unpack. If you want to find the "
8539 "architecture of a kernel, use the architecture of the associated initrd or "
8540 "kernel module(s) instead."
8544 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1843 ../src/guestfs-actions.pod:2531 ../src/guestfs-actions.pod:2621 ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:2868 ../src/guestfs-actions.pod:2886 ../src/guestfs-actions.pod:2926 ../src/guestfs-actions.pod:3001 ../src/guestfs-actions.pod:3092 ../src/guestfs-actions.pod:3321 ../src/guestfs-actions.pod:3453
8545 msgid "(Added in 1.5.3)"
8549 #: ../src/guestfs-actions.pod:1665
8550 msgid "guestfs_filesize"
8554 #: ../src/guestfs-actions.pod:1667
8558 " guestfs_filesize (guestfs_h *g,\n"
8559 " const char *file);\n"
8564 #: ../src/guestfs-actions.pod:1671 ../fish/guestfish-actions.pod:1135
8565 msgid "This command returns the size of C<file> in bytes."
8569 #: ../src/guestfs-actions.pod:1673
8571 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
8572 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
8573 "devices, use C<guestfs_blockdev_getsize64>."
8577 #: ../src/guestfs-actions.pod:1679
8578 msgid "(Added in 1.0.82)"
8582 #: ../src/guestfs-actions.pod:1681
8583 msgid "guestfs_fill"
8587 #: ../src/guestfs-actions.pod:1683
8591 " guestfs_fill (guestfs_h *g,\n"
8594 " const char *path);\n"
8599 #: ../src/guestfs-actions.pod:1689 ../fish/guestfish-actions.pod:1145
8601 "This command creates a new file called C<path>. The initial content of the "
8602 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
8607 #: ../src/guestfs-actions.pod:1693
8609 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8610 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
8611 "bytes use C<guestfs_fill_pattern>."
8615 #: ../src/guestfs-actions.pod:1705
8616 msgid "(Added in 1.0.79)"
8620 #: ../src/guestfs-actions.pod:1707
8621 msgid "guestfs_fill_pattern"
8625 #: ../src/guestfs-actions.pod:1709
8629 " guestfs_fill_pattern (guestfs_h *g,\n"
8630 " const char *pattern,\n"
8632 " const char *path);\n"
8637 #: ../src/guestfs-actions.pod:1715
8639 "This function is like C<guestfs_fill> except that it creates a new file of "
8640 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
8641 "pattern is truncated if necessary to ensure the length of the file is "
8642 "exactly C<len> bytes."
8646 #: ../src/guestfs-actions.pod:1727
8647 msgid "(Added in 1.3.12)"
8651 #: ../src/guestfs-actions.pod:1729
8652 msgid "guestfs_find"
8656 #: ../src/guestfs-actions.pod:1731
8660 " guestfs_find (guestfs_h *g,\n"
8661 " const char *directory);\n"
8666 #: ../src/guestfs-actions.pod:1735 ../fish/guestfish-actions.pod:1167
8668 "This command lists out all files and directories, recursively, starting at "
8669 "C<directory>. It is essentially equivalent to running the shell command "
8670 "C<find directory -print> but some post-processing happens on the output, "
8675 #: ../src/guestfs-actions.pod:1740 ../fish/guestfish-actions.pod:1172
8677 "This returns a list of strings I<without any prefix>. Thus if the directory "
8682 #: ../src/guestfs-actions.pod:1743 ../fish/guestfish-actions.pod:1175
8692 #: ../src/guestfs-actions.pod:1747
8693 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
8697 #: ../src/guestfs-actions.pod:1750 ../fish/guestfish-actions.pod:1182
8708 #: ../src/guestfs-actions.pod:1755 ../fish/guestfish-actions.pod:1187
8709 msgid "If C<directory> is not a directory, then this command returns an error."
8713 #: ../src/guestfs-actions.pod:1758 ../fish/guestfish-actions.pod:1190
8714 msgid "The returned list is sorted."
8718 #: ../src/guestfs-actions.pod:1760
8719 msgid "See also C<guestfs_find0>."
8723 #: ../src/guestfs-actions.pod:1769 ../src/guestfs-actions.pod:4182 ../src/guestfs-actions.pod:5780
8724 msgid "(Added in 1.0.27)"
8728 #: ../src/guestfs-actions.pod:1771
8729 msgid "guestfs_find0"
8733 #: ../src/guestfs-actions.pod:1773
8737 " guestfs_find0 (guestfs_h *g,\n"
8738 " const char *directory,\n"
8739 " const char *files);\n"
8744 #: ../src/guestfs-actions.pod:1778 ../fish/guestfish-actions.pod:1201
8746 "This command lists out all files and directories, recursively, starting at "
8747 "C<directory>, placing the resulting list in the external file called "
8752 #: ../src/guestfs-actions.pod:1782
8754 "This command works the same way as C<guestfs_find> with the following "
8759 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1212
8760 msgid "The resulting list is written to an external file."
8764 #: ../src/guestfs-actions.pod:1793 ../fish/guestfish-actions.pod:1216
8766 "Items (filenames) in the result are separated by C<\\0> characters. See "
8767 "L<find(1)> option I<-print0>."
8771 #: ../src/guestfs-actions.pod:1798 ../fish/guestfish-actions.pod:1221
8772 msgid "This command is not limited in the number of names that it can return."
8776 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1226
8777 msgid "The result list is not sorted."
8781 #: ../src/guestfs-actions.pod:1809
8782 msgid "(Added in 1.0.74)"
8786 #: ../src/guestfs-actions.pod:1811
8787 msgid "guestfs_findfs_label"
8791 #: ../src/guestfs-actions.pod:1813
8795 " guestfs_findfs_label (guestfs_h *g,\n"
8796 " const char *label);\n"
8801 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1236
8803 "This command searches the filesystems and returns the one which has the "
8804 "given label. An error is returned if no such filesystem can be found."
8808 #: ../src/guestfs-actions.pod:1821
8809 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
8813 #: ../src/guestfs-actions.pod:1828
8814 msgid "guestfs_findfs_uuid"
8818 #: ../src/guestfs-actions.pod:1830
8822 " guestfs_findfs_uuid (guestfs_h *g,\n"
8823 " const char *uuid);\n"
8828 #: ../src/guestfs-actions.pod:1834 ../fish/guestfish-actions.pod:1246
8830 "This command searches the filesystems and returns the one which has the "
8831 "given UUID. An error is returned if no such filesystem can be found."
8835 #: ../src/guestfs-actions.pod:1838
8836 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
8840 #: ../src/guestfs-actions.pod:1845
8841 msgid "guestfs_fsck"
8845 #: ../src/guestfs-actions.pod:1847
8849 " guestfs_fsck (guestfs_h *g,\n"
8850 " const char *fstype,\n"
8851 " const char *device);\n"
8856 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1256
8858 "This runs the filesystem checker (fsck) on C<device> which should have "
8859 "filesystem type C<fstype>."
8863 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish-actions.pod:1259
8865 "The returned integer is the status. See L<fsck(8)> for the list of status "
8866 "codes from C<fsck>."
8870 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1268
8871 msgid "Multiple status codes can be summed together."
8875 #: ../src/guestfs-actions.pod:1868 ../fish/guestfish-actions.pod:1272
8877 "A non-zero return code can mean \"success\", for example if errors have been "
8878 "corrected on the filesystem."
8882 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1277
8883 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8887 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1282
8888 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8892 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:7512
8893 msgid "(Added in 1.0.16)"
8897 #: ../src/guestfs-actions.pod:1884
8898 msgid "guestfs_get_append"
8902 #: ../src/guestfs-actions.pod:1886
8906 " guestfs_get_append (guestfs_h *g);\n"
8911 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1288
8913 "Return the additional kernel options which are added to the guest kernel "
8918 #: ../src/guestfs-actions.pod:1892 ../fish/guestfish-actions.pod:1291
8919 msgid "If C<NULL> then no options are added."
8923 #: ../src/guestfs-actions.pod:1894
8925 "This function returns a string which may be NULL. There is no way to return "
8926 "an error from this function. The string is owned by the guest handle and "
8927 "must I<not> be freed."
8931 #: ../src/guestfs-actions.pod:1898 ../src/guestfs-actions.pod:5458 ../src/guestfs-actions.pod:5938 ../src/guestfs-actions.pod:6359 ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6394 ../src/guestfs-actions.pod:6418 ../src/guestfs-actions.pod:7175 ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7555
8932 msgid "(Added in 1.0.26)"
8936 #: ../src/guestfs-actions.pod:1900
8937 msgid "guestfs_get_attach_method"
8941 #: ../src/guestfs-actions.pod:1902
8945 " guestfs_get_attach_method (guestfs_h *g);\n"
8950 #: ../src/guestfs-actions.pod:1905
8951 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
8955 #: ../src/guestfs-actions.pod:1910
8956 msgid "guestfs_get_autosync"
8960 #: ../src/guestfs-actions.pod:1912
8964 " guestfs_get_autosync (guestfs_h *g);\n"
8969 #: ../src/guestfs-actions.pod:1915 ../fish/guestfish-actions.pod:1303
8970 msgid "Get the autosync flag."
8974 #: ../src/guestfs-actions.pod:1921
8975 msgid "guestfs_get_direct"
8979 #: ../src/guestfs-actions.pod:1923
8983 " guestfs_get_direct (guestfs_h *g);\n"
8988 #: ../src/guestfs-actions.pod:1926 ../fish/guestfish-actions.pod:1309
8989 msgid "Return the direct appliance mode flag."
8993 #: ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:6007
8994 msgid "(Added in 1.0.72)"
8998 #: ../src/guestfs-actions.pod:1932
8999 msgid "guestfs_get_e2label"
9003 #: ../src/guestfs-actions.pod:1934
9007 " guestfs_get_e2label (guestfs_h *g,\n"
9008 " const char *device);\n"
9013 #: ../src/guestfs-actions.pod:1938 ../fish/guestfish-actions.pod:1315
9014 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9018 #: ../src/guestfs-actions.pod:1944 ../fish/guestfish-actions.pod:1318
9020 "This function is deprecated. In new code, use the C<vfs_label> call "
9025 #: ../src/guestfs-actions.pod:1951 ../src/guestfs-actions.pod:1972 ../src/guestfs-actions.pod:6025 ../src/guestfs-actions.pod:6044
9026 msgid "(Added in 1.0.15)"
9030 #: ../src/guestfs-actions.pod:1953
9031 msgid "guestfs_get_e2uuid"
9035 #: ../src/guestfs-actions.pod:1955
9039 " guestfs_get_e2uuid (guestfs_h *g,\n"
9040 " const char *device);\n"
9045 #: ../src/guestfs-actions.pod:1959 ../fish/guestfish-actions.pod:1329
9046 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9050 #: ../src/guestfs-actions.pod:1965 ../fish/guestfish-actions.pod:1332
9051 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9055 #: ../src/guestfs-actions.pod:1974
9056 msgid "guestfs_get_memsize"
9060 #: ../src/guestfs-actions.pod:1976
9064 " guestfs_get_memsize (guestfs_h *g);\n"
9069 #: ../src/guestfs-actions.pod:1979 ../fish/guestfish-actions.pod:1343
9070 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
9074 #: ../src/guestfs-actions.pod:1982
9076 "If C<guestfs_set_memsize> was not called on this handle, and if "
9077 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9078 "value for memsize."
9082 #: ../src/guestfs-actions.pod:1986 ../src/guestfs-actions.pod:2067 ../src/guestfs-actions.pod:6060 ../src/guestfs-actions.pod:6167 ../fish/guestfish-actions.pod:1350 ../fish/guestfish-actions.pod:1401 ../fish/guestfish-actions.pod:4043 ../fish/guestfish-actions.pod:4130
9083 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9087 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:4473 ../src/guestfs-actions.pod:4670 ../src/guestfs-actions.pod:4689 ../src/guestfs-actions.pod:4708 ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:4750 ../src/guestfs-actions.pod:5683 ../src/guestfs-actions.pod:6065 ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6941
9088 msgid "(Added in 1.0.55)"
9092 #: ../src/guestfs-actions.pod:1993
9093 msgid "guestfs_get_network"
9097 #: ../src/guestfs-actions.pod:1995
9101 " guestfs_get_network (guestfs_h *g);\n"
9106 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1357
9107 msgid "This returns the enable network flag."
9111 #: ../src/guestfs-actions.pod:2002 ../src/guestfs-actions.pod:6084
9112 msgid "(Added in 1.5.4)"
9116 #: ../src/guestfs-actions.pod:2004
9117 msgid "guestfs_get_path"
9121 #: ../src/guestfs-actions.pod:2006
9125 " guestfs_get_path (guestfs_h *g);\n"
9130 #: ../src/guestfs-actions.pod:2009 ../fish/guestfish-actions.pod:1363
9131 msgid "Return the current search path."
9135 #: ../src/guestfs-actions.pod:2011 ../fish/guestfish-actions.pod:1365
9137 "This is always non-NULL. If it wasn't set already, then this will return "
9142 #: ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2043
9144 "This function returns a string, or NULL on error. The string is owned by "
9145 "the guest handle and must I<not> be freed."
9149 #: ../src/guestfs-actions.pod:2019
9150 msgid "guestfs_get_pid"
9154 #: ../src/guestfs-actions.pod:2021
9158 " guestfs_get_pid (guestfs_h *g);\n"
9163 #: ../src/guestfs-actions.pod:2024 ../fish/guestfish-actions.pod:1374
9165 "Return the process ID of the qemu subprocess. If there is no qemu "
9166 "subprocess, then this will return an error."
9170 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1377
9171 msgid "This is an internal call used for debugging and testing."
9175 #: ../src/guestfs-actions.pod:2031
9176 msgid "(Added in 1.0.56)"
9180 #: ../src/guestfs-actions.pod:2033
9181 msgid "guestfs_get_qemu"
9185 #: ../src/guestfs-actions.pod:2035
9189 " guestfs_get_qemu (guestfs_h *g);\n"
9194 #: ../src/guestfs-actions.pod:2038 ../fish/guestfish-actions.pod:1383
9195 msgid "Return the current qemu binary."
9199 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1385
9201 "This is always non-NULL. If it wasn't set already, then this will return "
9202 "the default qemu binary name."
9206 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:6129
9207 msgid "(Added in 1.0.6)"
9211 #: ../src/guestfs-actions.pod:2048
9212 msgid "guestfs_get_recovery_proc"
9216 #: ../src/guestfs-actions.pod:2050
9220 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9225 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1392
9226 msgid "Return the recovery process enabled flag."
9230 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3880 ../src/guestfs-actions.pod:4280 ../src/guestfs-actions.pod:4312 ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5731 ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6864 ../src/guestfs-actions.pod:7056
9231 msgid "(Added in 1.0.77)"
9235 #: ../src/guestfs-actions.pod:2059
9236 msgid "guestfs_get_selinux"
9240 #: ../src/guestfs-actions.pod:2061
9244 " guestfs_get_selinux (guestfs_h *g);\n"
9249 #: ../src/guestfs-actions.pod:2064
9251 "This returns the current setting of the selinux flag which is passed to the "
9252 "appliance at boot time. See C<guestfs_set_selinux>."
9256 #: ../src/guestfs-actions.pod:2072 ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6230
9257 msgid "(Added in 1.0.67)"
9261 #: ../src/guestfs-actions.pod:2074
9262 msgid "guestfs_get_state"
9266 #: ../src/guestfs-actions.pod:2076
9270 " guestfs_get_state (guestfs_h *g);\n"
9275 #: ../src/guestfs-actions.pod:2079 ../fish/guestfish-actions.pod:1408
9277 "This returns the current state as an opaque integer. This is only useful "
9278 "for printing debug and internal error messages."
9282 #: ../src/guestfs-actions.pod:2082 ../src/guestfs-actions.pod:3346 ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:3463 ../fish/guestfish-actions.pod:1411 ../fish/guestfish-actions.pod:2331 ../fish/guestfish-actions.pod:2349 ../fish/guestfish-actions.pod:2387 ../fish/guestfish-actions.pod:2403
9283 msgid "For more information on states, see L<guestfs(3)>."
9287 #: ../src/guestfs-actions.pod:2088
9288 msgid "guestfs_get_trace"
9292 #: ../src/guestfs-actions.pod:2090
9296 " guestfs_get_trace (guestfs_h *g);\n"
9301 #: ../src/guestfs-actions.pod:2093 ../fish/guestfish-actions.pod:1417
9302 msgid "Return the command trace flag."
9306 #: ../src/guestfs-actions.pod:2099
9307 msgid "guestfs_get_umask"
9311 #: ../src/guestfs-actions.pod:2101
9315 " guestfs_get_umask (guestfs_h *g);\n"
9320 #: ../src/guestfs-actions.pod:2104
9322 "Return the current umask. By default the umask is C<022> unless it has been "
9323 "set by calling C<guestfs_umask>."
9327 #: ../src/guestfs-actions.pod:2111
9328 msgid "guestfs_get_verbose"
9332 #: ../src/guestfs-actions.pod:2113
9336 " guestfs_get_verbose (guestfs_h *g);\n"
9341 #: ../src/guestfs-actions.pod:2116 ../fish/guestfish-actions.pod:1430
9342 msgid "This returns the verbose messages flag."
9346 #: ../src/guestfs-actions.pod:2122
9347 msgid "guestfs_getcon"
9351 #: ../src/guestfs-actions.pod:2124
9355 " guestfs_getcon (guestfs_h *g);\n"
9360 #: ../src/guestfs-actions.pod:2127 ../fish/guestfish-actions.pod:1436
9361 msgid "This gets the SELinux security context of the daemon."
9365 #: ../src/guestfs-actions.pod:2129
9366 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
9370 #: ../src/guestfs-actions.pod:2137
9371 msgid "guestfs_getxattr"
9375 #: ../src/guestfs-actions.pod:2139
9379 " guestfs_getxattr (guestfs_h *g,\n"
9380 " const char *path,\n"
9381 " const char *name,\n"
9382 " size_t *size_r);\n"
9387 #: ../src/guestfs-actions.pod:2145
9389 "Get a single extended attribute from file C<path> named C<name>. This call "
9390 "follows symlinks. If you want to lookup an extended attribute for the "
9391 "symlink itself, use C<guestfs_lgetxattr>."
9395 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:3585
9397 "Normally it is better to get all extended attributes from a file in one go "
9398 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
9399 "implementations are buggy and do not provide a way to list out attributes. "
9400 "For these filesystems (notably ntfs-3g) you have to know the names of the "
9401 "extended attributes you want in advance and call this function."
9405 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3592 ../fish/guestfish-actions.pod:1456 ../fish/guestfish-actions.pod:2483
9407 "Extended attribute values are blobs of binary data. If there is no extended "
9408 "attribute named C<name>, this returns an error."
9412 #: ../src/guestfs-actions.pod:2159
9413 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
9417 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2352 ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:5588
9419 "This function returns a buffer, or NULL on error. The size of the returned "
9420 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
9425 #: ../src/guestfs-actions.pod:2165 ../src/guestfs-actions.pod:3601
9426 msgid "(Added in 1.7.24)"
9430 #: ../src/guestfs-actions.pod:2167
9431 msgid "guestfs_getxattrs"
9435 #: ../src/guestfs-actions.pod:2169
9438 " struct guestfs_xattr_list *\n"
9439 " guestfs_getxattrs (guestfs_h *g,\n"
9440 " const char *path);\n"
9445 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1465
9446 msgid "This call lists the extended attributes of the file or directory C<path>."
9450 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1468
9452 "At the system call level, this is a combination of the L<listxattr(2)> and "
9453 "L<getxattr(2)> calls."
9457 #: ../src/guestfs-actions.pod:2179
9458 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
9462 #: ../src/guestfs-actions.pod:2181 ../src/guestfs-actions.pod:3613 ../src/guestfs-actions.pod:4276
9464 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
9465 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
9469 #: ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:3617 ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:3830 ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:6249 ../src/guestfs-actions.pod:7620
9470 msgid "(Added in 1.0.59)"
9474 #: ../src/guestfs-actions.pod:2187
9475 msgid "guestfs_glob_expand"
9479 #: ../src/guestfs-actions.pod:2189
9483 " guestfs_glob_expand (guestfs_h *g,\n"
9484 " const char *pattern);\n"
9489 #: ../src/guestfs-actions.pod:2193 ../fish/guestfish-actions.pod:1477
9491 "This command searches for all the pathnames matching C<pattern> according to "
9492 "the wildcard expansion rules used by the shell."
9496 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1481
9497 msgid "If no paths match, then this returns an empty list (note: not an error)."
9501 #: ../src/guestfs-actions.pod:2200 ../fish/guestfish-actions.pod:1484
9503 "It is just a wrapper around the C L<glob(3)> function with flags "
9504 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
9508 #: ../src/guestfs-actions.pod:2208 ../src/guestfs-actions.pod:6442 ../src/guestfs-actions.pod:6459
9509 msgid "(Added in 1.0.50)"
9513 #: ../src/guestfs-actions.pod:2210
9514 msgid "guestfs_grep"
9518 #: ../src/guestfs-actions.pod:2212
9522 " guestfs_grep (guestfs_h *g,\n"
9523 " const char *regex,\n"
9524 " const char *path);\n"
9529 #: ../src/guestfs-actions.pod:2217 ../fish/guestfish-actions.pod:1492
9530 msgid "This calls the external C<grep> program and returns the matching lines."
9534 #: ../src/guestfs-actions.pod:2229
9535 msgid "guestfs_grepi"
9539 #: ../src/guestfs-actions.pod:2231
9543 " guestfs_grepi (guestfs_h *g,\n"
9544 " const char *regex,\n"
9545 " const char *path);\n"
9550 #: ../src/guestfs-actions.pod:2236 ../fish/guestfish-actions.pod:1502
9551 msgid "This calls the external C<grep -i> program and returns the matching lines."
9555 #: ../src/guestfs-actions.pod:2248
9556 msgid "guestfs_grub_install"
9560 #: ../src/guestfs-actions.pod:2250
9564 " guestfs_grub_install (guestfs_h *g,\n"
9565 " const char *root,\n"
9566 " const char *device);\n"
9571 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1512
9573 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9574 "the root directory being C<root>."
9578 #: ../src/guestfs-actions.pod:2258 ../fish/guestfish-actions.pod:1515
9580 "Note: If grub-install reports the error \"No suitable drive was found in the "
9581 "generated device map.\" it may be that you need to create a "
9582 "C</boot/grub/device.map> file first that contains the mapping between grub "
9583 "device names and Linux device names. It is usually sufficient to create a "
9588 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
9596 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1524
9597 msgid "replacing C</dev/vda> with the name of the installation device."
9601 #: ../src/guestfs-actions.pod:2271
9602 msgid "(Added in 1.0.17)"
9606 #: ../src/guestfs-actions.pod:2273
9607 msgid "guestfs_head"
9611 #: ../src/guestfs-actions.pod:2275
9615 " guestfs_head (guestfs_h *g,\n"
9616 " const char *path);\n"
9621 #: ../src/guestfs-actions.pod:2279 ../fish/guestfish-actions.pod:1530
9623 "This command returns up to the first 10 lines of a file as a list of "
9628 #: ../src/guestfs-actions.pod:2291
9629 msgid "guestfs_head_n"
9633 #: ../src/guestfs-actions.pod:2293
9637 " guestfs_head_n (guestfs_h *g,\n"
9639 " const char *path);\n"
9644 #: ../src/guestfs-actions.pod:2298 ../fish/guestfish-actions.pod:1540
9646 "If the parameter C<nrlines> is a positive number, this returns the first "
9647 "C<nrlines> lines of the file C<path>."
9651 #: ../src/guestfs-actions.pod:2301 ../fish/guestfish-actions.pod:1543
9653 "If the parameter C<nrlines> is a negative number, this returns lines from "
9654 "the file C<path>, excluding the last C<nrlines> lines."
9658 #: ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:6739 ../fish/guestfish-actions.pod:1546 ../fish/guestfish-actions.pod:4508
9659 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9663 #: ../src/guestfs-actions.pod:2315
9664 msgid "guestfs_hexdump"
9668 #: ../src/guestfs-actions.pod:2317
9672 " guestfs_hexdump (guestfs_h *g,\n"
9673 " const char *path);\n"
9678 #: ../src/guestfs-actions.pod:2321 ../fish/guestfish-actions.pod:1555
9680 "This runs C<hexdump -C> on the given C<path>. The result is the "
9681 "human-readable, canonical hex dump of the file."
9685 #: ../src/guestfs-actions.pod:2330 ../src/guestfs-actions.pod:6523 ../src/guestfs-actions.pod:6578
9686 msgid "(Added in 1.0.22)"
9690 #: ../src/guestfs-actions.pod:2332
9691 msgid "guestfs_initrd_cat"
9695 #: ../src/guestfs-actions.pod:2334
9699 " guestfs_initrd_cat (guestfs_h *g,\n"
9700 " const char *initrdpath,\n"
9701 " const char *filename,\n"
9702 " size_t *size_r);\n"
9707 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1565
9709 "This command unpacks the file C<filename> from the initrd file called "
9710 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9715 #: ../src/guestfs-actions.pod:2344 ../fish/guestfish-actions.pod:1569
9717 "For example, in guestfish you could use the following command to examine the "
9718 "boot script (usually called C</init>) contained in a Linux initrd or "
9723 #: ../src/guestfs-actions.pod:2348 ../fish/guestfish-actions.pod:1573
9726 " initrd-cat /boot/initrd-<version>.img init\n"
9731 #: ../src/guestfs-actions.pod:2350
9732 msgid "See also C<guestfs_initrd_list>."
9736 #: ../src/guestfs-actions.pod:2361
9737 msgid "guestfs_initrd_list"
9741 #: ../src/guestfs-actions.pod:2363
9745 " guestfs_initrd_list (guestfs_h *g,\n"
9746 " const char *path);\n"
9751 #: ../src/guestfs-actions.pod:2367 ../fish/guestfish-actions.pod:1584
9752 msgid "This command lists out files contained in an initrd."
9756 #: ../src/guestfs-actions.pod:2369 ../fish/guestfish-actions.pod:1586
9758 "The files are listed without any initial C</> character. The files are "
9759 "listed in the order they appear (not necessarily alphabetical). Directory "
9760 "names are listed as separate items."
9764 #: ../src/guestfs-actions.pod:2373 ../fish/guestfish-actions.pod:1590
9766 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9767 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9772 #: ../src/guestfs-actions.pod:2383
9773 msgid "guestfs_inotify_add_watch"
9777 #: ../src/guestfs-actions.pod:2385
9781 " guestfs_inotify_add_watch (guestfs_h *g,\n"
9782 " const char *path,\n"
9788 #: ../src/guestfs-actions.pod:2390 ../fish/guestfish-actions.pod:1598
9789 msgid "Watch C<path> for the events listed in C<mask>."
9793 #: ../src/guestfs-actions.pod:2392 ../fish/guestfish-actions.pod:1600
9795 "Note that if C<path> is a directory then events within that directory are "
9796 "watched, but this does I<not> happen recursively (in subdirectories)."
9800 #: ../src/guestfs-actions.pod:2396 ../fish/guestfish-actions.pod:1604
9802 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9803 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9807 #: ../src/guestfs-actions.pod:2404
9808 msgid "guestfs_inotify_close"
9812 #: ../src/guestfs-actions.pod:2406
9816 " guestfs_inotify_close (guestfs_h *g);\n"
9821 #: ../src/guestfs-actions.pod:2409 ../fish/guestfish-actions.pod:1612
9823 "This closes the inotify handle which was previously opened by inotify_init. "
9824 "It removes all watches, throws away any pending events, and deallocates all "
9829 #: ../src/guestfs-actions.pod:2417
9830 msgid "guestfs_inotify_files"
9834 #: ../src/guestfs-actions.pod:2419
9838 " guestfs_inotify_files (guestfs_h *g);\n"
9843 #: ../src/guestfs-actions.pod:2422
9845 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
9846 "returns a list of pathnames of objects that were touched. The returned "
9847 "pathnames are sorted and deduplicated."
9851 #: ../src/guestfs-actions.pod:2432
9852 msgid "guestfs_inotify_init"
9856 #: ../src/guestfs-actions.pod:2434
9860 " guestfs_inotify_init (guestfs_h *g,\n"
9861 " int maxevents);\n"
9866 #: ../src/guestfs-actions.pod:2438 ../fish/guestfish-actions.pod:1628
9868 "This command creates a new inotify handle. The inotify subsystem can be "
9869 "used to notify events which happen to objects in the guest filesystem."
9873 #: ../src/guestfs-actions.pod:2442
9875 "C<maxevents> is the maximum number of events which will be queued up between "
9876 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
9877 "passed as C<0>, then the kernel (or previously set) default is used. For "
9878 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
9879 "throws away events, but records the fact that it threw them away by setting "
9880 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
9881 "C<guestfs_inotify_read>)."
9885 #: ../src/guestfs-actions.pod:2452
9887 "Before any events are generated, you have to add some watches to the "
9888 "internal watch list. See: C<guestfs_inotify_add_watch>, "
9889 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
9893 #: ../src/guestfs-actions.pod:2458
9895 "Queued up events should be read periodically by calling "
9896 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
9897 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
9898 "often enough then you risk the internal queue overflowing."
9902 #: ../src/guestfs-actions.pod:2465
9904 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
9905 "This also removes any watches automatically."
9909 #: ../src/guestfs-actions.pod:2469 ../fish/guestfish-actions.pod:1659
9911 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9912 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9913 "that there is one global inotify handle per libguestfs instance."
9917 #: ../src/guestfs-actions.pod:2478
9918 msgid "guestfs_inotify_read"
9922 #: ../src/guestfs-actions.pod:2480
9925 " struct guestfs_inotify_event_list *\n"
9926 " guestfs_inotify_read (guestfs_h *g);\n"
9931 #: ../src/guestfs-actions.pod:2483 ../fish/guestfish-actions.pod:1668
9933 "Return the complete queue of events that have happened since the previous "
9938 #: ../src/guestfs-actions.pod:2486 ../fish/guestfish-actions.pod:1671
9939 msgid "If no events have happened, this returns an empty list."
9943 #: ../src/guestfs-actions.pod:2488 ../fish/guestfish-actions.pod:1673
9945 "I<Note>: In order to make sure that all events have been read, you must call "
9946 "this function repeatedly until it returns an empty list. The reason is that "
9947 "the call will read events up to the maximum appliance-to-host message size "
9948 "and leave remaining events in the queue."
9952 #: ../src/guestfs-actions.pod:2494
9954 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
9955 "there was an error. I<The caller must call "
9956 "C<guestfs_free_inotify_event_list> after use>."
9960 #: ../src/guestfs-actions.pod:2500
9961 msgid "guestfs_inotify_rm_watch"
9965 #: ../src/guestfs-actions.pod:2502
9969 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
9975 #: ../src/guestfs-actions.pod:2506
9977 "Remove a previously defined inotify watch. See "
9978 "C<guestfs_inotify_add_watch>."
9982 #: ../src/guestfs-actions.pod:2513
9983 msgid "guestfs_inspect_get_arch"
9987 #: ../src/guestfs-actions.pod:2515
9991 " guestfs_inspect_get_arch (guestfs_h *g,\n"
9992 " const char *root);\n"
9997 #: ../src/guestfs-actions.pod:2519
9999 "This returns the architecture of the inspected operating system. The "
10000 "possible return values are listed under C<guestfs_file_architecture>."
10004 #: ../src/guestfs-actions.pod:2523 ../fish/guestfish-actions.pod:1694
10006 "If the architecture could not be determined, then the string C<unknown> is "
10011 #: ../src/guestfs-actions.pod:2526 ../src/guestfs-actions.pod:2616 ../src/guestfs-actions.pod:2718 ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:2864 ../src/guestfs-actions.pod:2947 ../src/guestfs-actions.pod:2975 ../src/guestfs-actions.pod:2996 ../src/guestfs-actions.pod:3047 ../src/guestfs-actions.pod:3087 ../src/guestfs-actions.pod:3107 ../src/guestfs-actions.pod:3125 ../src/guestfs-actions.pod:3142 ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3272 ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:1697 ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1859 ../fish/guestfish-actions.pod:1871 ../fish/guestfish-actions.pod:1955 ../fish/guestfish-actions.pod:2016 ../fish/guestfish-actions.pod:2037 ../fish/guestfish-actions.pod:2051 ../fish/guestfish-actions.pod:2091 ../fish/guestfish-actions.pod:2123 ../fish/guestfish-actions.pod:2136 ../fish/guestfish-actions.pod:2149 ../fish/guestfish-actions.pod:2159 ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2181 ../fish/guestfish-actions.pod:2277 ../fish/guestfish-actions.pod:2311
10012 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10016 #: ../src/guestfs-actions.pod:2533
10017 msgid "guestfs_inspect_get_distro"
10021 #: ../src/guestfs-actions.pod:2535
10025 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10026 " const char *root);\n"
10031 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1703
10032 msgid "This returns the distro (distribution) of the inspected operating system."
10036 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1706
10037 msgid "Currently defined distros are:"
10041 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1710
10042 msgid "\"archlinux\""
10046 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1712
10047 msgid "Arch Linux."
10051 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1714
10056 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1716
10061 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1718
10066 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1720
10071 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1722
10076 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1724
10081 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1726
10086 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1728
10091 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1730
10092 msgid "\"linuxmint\""
10096 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1732
10097 msgid "Linux Mint."
10101 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1734
10102 msgid "\"mandriva\""
10106 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1736
10111 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1738
10116 #: ../src/guestfs-actions.pod:2576 ../fish/guestfish-actions.pod:1740
10121 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1742
10126 #: ../src/guestfs-actions.pod:2580 ../fish/guestfish-actions.pod:1744
10131 #: ../src/guestfs-actions.pod:2582 ../fish/guestfish-actions.pod:1746
10132 msgid "\"redhat-based\""
10136 #: ../src/guestfs-actions.pod:2584 ../fish/guestfish-actions.pod:1748
10137 msgid "Some Red Hat-derived distro."
10141 #: ../src/guestfs-actions.pod:2586 ../fish/guestfish-actions.pod:1750
10146 #: ../src/guestfs-actions.pod:2588 ../fish/guestfish-actions.pod:1752
10147 msgid "Red Hat Enterprise Linux."
10151 #: ../src/guestfs-actions.pod:2590 ../fish/guestfish-actions.pod:1754
10152 msgid "\"scientificlinux\""
10156 #: ../src/guestfs-actions.pod:2592 ../fish/guestfish-actions.pod:1756
10157 msgid "Scientific Linux."
10161 #: ../src/guestfs-actions.pod:2594 ../fish/guestfish-actions.pod:1758
10162 msgid "\"slackware\""
10166 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1760
10171 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1762
10176 #: ../src/guestfs-actions.pod:2600 ../fish/guestfish-actions.pod:1764
10181 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2709 ../src/guestfs-actions.pod:3078 ../fish/guestfish-actions.pod:1766 ../fish/guestfish-actions.pod:1850 ../fish/guestfish-actions.pod:2114
10182 msgid "\"unknown\""
10186 #: ../src/guestfs-actions.pod:2604 ../fish/guestfish-actions.pod:1768
10187 msgid "The distro could not be determined."
10191 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:3070 ../fish/guestfish-actions.pod:1770 ../fish/guestfish-actions.pod:2106
10192 msgid "\"windows\""
10196 #: ../src/guestfs-actions.pod:2608 ../fish/guestfish-actions.pod:1772
10198 "Windows does not have distributions. This string is returned if the OS type "
10203 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2715 ../src/guestfs-actions.pod:3084 ../fish/guestfish-actions.pod:1777 ../fish/guestfish-actions.pod:1856 ../fish/guestfish-actions.pod:2120
10205 "Future versions of libguestfs may return other strings here. The caller "
10206 "should be prepared to handle any string."
10210 #: ../src/guestfs-actions.pod:2623
10211 msgid "guestfs_inspect_get_drive_mappings"
10215 #: ../src/guestfs-actions.pod:2625
10219 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10220 " const char *root);\n"
10225 #: ../src/guestfs-actions.pod:2629 ../fish/guestfish-actions.pod:1786
10227 "This call is useful for Windows which uses a primitive system of assigning "
10228 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10229 "Windows Registry to find out how disks/partitions are mapped to drive "
10230 "letters, and returns a hash table as in the example below:"
10234 #: ../src/guestfs-actions.pod:2635 ../fish/guestfish-actions.pod:1792
10237 " C => /dev/vda2\n"
10238 " E => /dev/vdb1\n"
10239 " F => /dev/vdc1\n"
10244 #: ../src/guestfs-actions.pod:2639 ../fish/guestfish-actions.pod:1796
10246 "Note that keys are drive letters. For Windows, the key is case insensitive "
10247 "and just contains the drive letter, without the customary colon separator "
10252 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1800
10254 "In future we may support other operating systems that also used drive "
10255 "letters, but the keys for those might not be case insensitive and might be "
10256 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10261 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1805
10263 "For Windows guests, currently only hard drive mappings are returned. "
10264 "Removable disks (eg. DVD-ROMs) are ignored."
10268 #: ../src/guestfs-actions.pod:2651 ../fish/guestfish-actions.pod:1808
10270 "For guests that do not use drive mappings, or if the drive mappings could "
10271 "not be determined, this returns an empty hash table."
10275 #: ../src/guestfs-actions.pod:2654
10277 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10278 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10282 #: ../src/guestfs-actions.pod:2658 ../src/guestfs-actions.pod:2920 ../src/guestfs-actions.pod:3682 ../src/guestfs-actions.pod:4947 ../src/guestfs-actions.pod:6880
10284 "This function returns a NULL-terminated array of strings, or NULL if there "
10285 "was an error. The array of strings will always have length C<2n+1>, where "
10286 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
10287 "caller must free the strings and the array after use>."
10291 #: ../src/guestfs-actions.pod:2664
10292 msgid "guestfs_inspect_get_filesystems"
10296 #: ../src/guestfs-actions.pod:2666
10300 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
10301 " const char *root);\n"
10306 #: ../src/guestfs-actions.pod:2670 ../fish/guestfish-actions.pod:1819
10308 "This returns a list of all the filesystems that we think are associated with "
10309 "this operating system. This includes the root filesystem, other ordinary "
10310 "filesystems, and non-mounted devices like swap partitions."
10314 #: ../src/guestfs-actions.pod:2675 ../fish/guestfish-actions.pod:1824
10316 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10317 "to be shared between operating systems."
10321 #: ../src/guestfs-actions.pod:2678
10323 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10324 "C<guestfs_inspect_get_mountpoints>."
10328 #: ../src/guestfs-actions.pod:2687
10329 msgid "guestfs_inspect_get_format"
10333 #: ../src/guestfs-actions.pod:2689
10337 " guestfs_inspect_get_format (guestfs_h *g,\n"
10338 " const char *root);\n"
10343 #: ../src/guestfs-actions.pod:2693 ../fish/guestfish-actions.pod:1834
10345 "This returns the format of the inspected operating system. You can use it "
10346 "to detect install images, live CDs and similar."
10350 #: ../src/guestfs-actions.pod:2696 ../fish/guestfish-actions.pod:1837
10351 msgid "Currently defined formats are:"
10355 #: ../src/guestfs-actions.pod:2700 ../fish/guestfish-actions.pod:1841
10356 msgid "\"installed\""
10360 #: ../src/guestfs-actions.pod:2702 ../fish/guestfish-actions.pod:1843
10361 msgid "This is an installed operating system."
10365 #: ../src/guestfs-actions.pod:2704 ../fish/guestfish-actions.pod:1845
10366 msgid "\"installer\""
10370 #: ../src/guestfs-actions.pod:2706 ../fish/guestfish-actions.pod:1847
10372 "The disk image being inspected is not an installed operating system, but a "
10373 "I<bootable> install disk, live CD, or similar."
10377 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
10378 msgid "The format of this disk image is not known."
10382 #: ../src/guestfs-actions.pod:2723
10383 msgid "guestfs_inspect_get_hostname"
10387 #: ../src/guestfs-actions.pod:2725
10391 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
10392 " const char *root);\n"
10397 #: ../src/guestfs-actions.pod:2729 ../fish/guestfish-actions.pod:1865
10399 "This function returns the hostname of the operating system as found by "
10400 "inspection of the guest's configuration files."
10404 #: ../src/guestfs-actions.pod:2732 ../fish/guestfish-actions.pod:1868
10406 "If the hostname could not be determined, then the string C<unknown> is "
10411 #: ../src/guestfs-actions.pod:2740
10412 msgid "(Added in 1.7.9)"
10416 #: ../src/guestfs-actions.pod:2742
10417 msgid "guestfs_inspect_get_icon"
10421 #: ../src/guestfs-actions.pod:2744
10425 " guestfs_inspect_get_icon (guestfs_h *g,\n"
10426 " const char *root,\n"
10427 " size_t *size_r,\n"
10433 #: ../src/guestfs-actions.pod:2755
10436 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
10437 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
10442 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1877
10444 "This function returns an icon corresponding to the inspected operating "
10445 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
10446 "to PNG if necessary)."
10450 #: ../src/guestfs-actions.pod:2762 ../fish/guestfish-actions.pod:1881
10452 "If it was not possible to get an icon this function returns a zero-length "
10453 "(non-NULL) buffer. I<Callers must check for this case>."
10457 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1884
10459 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
10460 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
10461 "this file will be returned. You can disable favicons by passing the "
10462 "optional C<favicon> boolean as false (default is true)."
10466 #: ../src/guestfs-actions.pod:2771 ../fish/guestfish-actions.pod:1890
10468 "If finding the favicon fails, then we look in other places in the guest for "
10473 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1893
10475 "If the optional C<highquality> boolean is true then only high quality icons "
10476 "are returned, which means only icons of high resolution with an alpha "
10477 "channel. The default (false) is to return any icon we can, even if it is of "
10478 "substandard quality."
10482 #: ../src/guestfs-actions.pod:2785 ../fish/guestfish-actions.pod:1904
10484 "Unlike most other inspection API calls, the guest's disks must be mounted up "
10485 "before you call this, since it needs to read information from the guest "
10486 "filesystem during the call."
10490 #: ../src/guestfs-actions.pod:2791 ../fish/guestfish-actions.pod:1910
10492 "B<Security:> The icon data comes from the untrusted guest, and should be "
10493 "treated with caution. PNG files have been known to contain exploits. "
10494 "Ensure that libpng (or other relevant libraries) are fully up to date before "
10495 "trying to process or display the icon."
10499 #: ../src/guestfs-actions.pod:2799 ../fish/guestfish-actions.pod:1918
10501 "The PNG image returned can be any size. It might not be square. Libguestfs "
10502 "tries to return the largest, highest quality icon available. The "
10503 "application must scale the icon to the required size."
10507 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1925
10509 "Extracting icons from Windows guests requires the external C<wrestool> "
10510 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
10511 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
10512 "installed separately."
10516 #: ../src/guestfs-actions.pod:2813 ../fish/guestfish-actions.pod:1932
10518 "Operating system icons are usually trademarks. Seek legal advice before "
10519 "using trademarks in applications."
10523 #: ../src/guestfs-actions.pod:2822
10524 msgid "guestfs_inspect_get_icon_va"
10528 #: ../src/guestfs-actions.pod:2824
10532 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
10533 " const char *root,\n"
10534 " size_t *size_r,\n"
10535 " va_list args);\n"
10540 #: ../src/guestfs-actions.pod:2830
10541 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
10545 #: ../src/guestfs-actions.pod:2834
10546 msgid "guestfs_inspect_get_icon_argv"
10550 #: ../src/guestfs-actions.pod:2836
10554 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
10555 " const char *root,\n"
10556 " size_t *size_r,\n"
10557 " const struct guestfs_inspect_get_icon_argv "
10563 #: ../src/guestfs-actions.pod:2842
10564 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
10568 #: ../src/guestfs-actions.pod:2846
10569 msgid "guestfs_inspect_get_major_version"
10573 #: ../src/guestfs-actions.pod:2848
10577 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
10578 " const char *root);\n"
10583 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1943
10584 msgid "This returns the major version number of the inspected operating system."
10588 #: ../src/guestfs-actions.pod:2855 ../fish/guestfish-actions.pod:1946
10590 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10591 "popular public names used by the operating system. Notably the operating "
10592 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10593 "1). You can find out the real versions corresponding to releases of Windows "
10594 "by consulting Wikipedia or MSDN."
10598 #: ../src/guestfs-actions.pod:2862 ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:1964
10599 msgid "If the version could not be determined, then C<0> is returned."
10603 #: ../src/guestfs-actions.pod:2870
10604 msgid "guestfs_inspect_get_minor_version"
10608 #: ../src/guestfs-actions.pod:2872
10612 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
10613 " const char *root);\n"
10618 #: ../src/guestfs-actions.pod:2876 ../fish/guestfish-actions.pod:1961
10619 msgid "This returns the minor version number of the inspected operating system."
10623 #: ../src/guestfs-actions.pod:2881
10625 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10626 "C<guestfs_inspect_get_major_version>."
10630 #: ../src/guestfs-actions.pod:2888
10631 msgid "guestfs_inspect_get_mountpoints"
10635 #: ../src/guestfs-actions.pod:2890
10639 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
10640 " const char *root);\n"
10645 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1973
10647 "This returns a hash of where we think the filesystems associated with this "
10648 "operating system should be mounted. Callers should note that this is at "
10649 "best an educated guess made by reading configuration files such as "
10650 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
10651 "are non-existent or not mountable and callers should be prepared to handle "
10652 "or ignore failures if they try to mount them."
10656 #: ../src/guestfs-actions.pod:2903 ../fish/guestfish-actions.pod:1982
10658 "Each element in the returned hashtable has a key which is the path of the "
10659 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10660 "mounted there (eg. C</dev/sda1>)."
10664 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:1987
10665 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
10669 #: ../src/guestfs-actions.pod:2911
10671 "For operating systems like Windows which still use drive letters, this call "
10672 "will only return an entry for the first drive \"mounted on\" C</>. For "
10673 "information about the mapping of drive letters to partitions, see "
10674 "C<guestfs_inspect_get_drive_mappings>."
10678 #: ../src/guestfs-actions.pod:2917
10680 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10681 "C<guestfs_inspect_get_filesystems>."
10685 #: ../src/guestfs-actions.pod:2928
10686 msgid "guestfs_inspect_get_package_format"
10690 #: ../src/guestfs-actions.pod:2930
10694 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
10695 " const char *root);\n"
10700 #: ../src/guestfs-actions.pod:2934
10702 "This function and C<guestfs_inspect_get_package_management> return the "
10703 "package format and package management tool used by the inspected operating "
10704 "system. For example for Fedora these functions would return C<rpm> (package "
10705 "format) and C<yum> (package management)."
10709 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2009
10711 "This returns the string C<unknown> if we could not determine the package "
10712 "format I<or> if the operating system does not have a real packaging system "
10717 #: ../src/guestfs-actions.pod:2944 ../fish/guestfish-actions.pod:2013
10719 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
10720 "Future versions of libguestfs may return other strings."
10724 #: ../src/guestfs-actions.pod:2952 ../src/guestfs-actions.pod:2980
10725 msgid "(Added in 1.7.5)"
10729 #: ../src/guestfs-actions.pod:2954
10730 msgid "guestfs_inspect_get_package_management"
10734 #: ../src/guestfs-actions.pod:2956
10738 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
10739 " const char *root);\n"
10744 #: ../src/guestfs-actions.pod:2960
10746 "C<guestfs_inspect_get_package_format> and this function return the package "
10747 "format and package management tool used by the inspected operating system. "
10748 "For example for Fedora these functions would return C<rpm> (package format) "
10749 "and C<yum> (package management)."
10753 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2028
10755 "This returns the string C<unknown> if we could not determine the package "
10756 "management tool I<or> if the operating system does not have a real packaging "
10757 "system (eg. Windows)."
10761 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2032
10763 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
10764 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
10765 "libguestfs may return other strings."
10769 #: ../src/guestfs-actions.pod:2982
10770 msgid "guestfs_inspect_get_product_name"
10774 #: ../src/guestfs-actions.pod:2984
10778 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
10779 " const char *root);\n"
10784 #: ../src/guestfs-actions.pod:2988 ../fish/guestfish-actions.pod:2043
10786 "This returns the product name of the inspected operating system. The "
10787 "product name is generally some freeform string which can be displayed to the "
10788 "user, but should not be parsed by programs."
10792 #: ../src/guestfs-actions.pod:2993 ../fish/guestfish-actions.pod:2048
10794 "If the product name could not be determined, then the string C<unknown> is "
10799 #: ../src/guestfs-actions.pod:3003
10800 msgid "guestfs_inspect_get_product_variant"
10804 #: ../src/guestfs-actions.pod:3005
10808 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
10809 " const char *root);\n"
10814 #: ../src/guestfs-actions.pod:3009 ../fish/guestfish-actions.pod:2057
10815 msgid "This returns the product variant of the inspected operating system."
10819 #: ../src/guestfs-actions.pod:3012 ../fish/guestfish-actions.pod:2060
10821 "For Windows guests, this returns the contents of the Registry key "
10822 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
10823 "which is usually a string such as C<Client> or C<Server> (other values are "
10824 "possible). This can be used to distinguish consumer and enterprise versions "
10825 "of Windows that have the same version number (for example, Windows 7 and "
10826 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
10827 "the latter is C<Server>)."
10831 #: ../src/guestfs-actions.pod:3021 ../fish/guestfish-actions.pod:2069
10833 "For enterprise Linux guests, in future we intend this to return the product "
10834 "variant such as C<Desktop>, C<Server> and so on. But this is not "
10835 "implemented at present."
10839 #: ../src/guestfs-actions.pod:3025 ../fish/guestfish-actions.pod:2073
10841 "If the product variant could not be determined, then the string C<unknown> "
10846 #: ../src/guestfs-actions.pod:3028
10848 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10849 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
10853 #: ../src/guestfs-actions.pod:3035
10854 msgid "guestfs_inspect_get_roots"
10858 #: ../src/guestfs-actions.pod:3037
10862 " guestfs_inspect_get_roots (guestfs_h *g);\n"
10867 #: ../src/guestfs-actions.pod:3040
10869 "This function is a convenient way to get the list of root devices, as "
10870 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
10871 "the whole inspection process."
10875 #: ../src/guestfs-actions.pod:3044
10877 "This returns an empty list if either no root devices were found or the "
10878 "caller has not called C<guestfs_inspect_os>."
10882 #: ../src/guestfs-actions.pod:3053
10883 msgid "(Added in 1.7.3)"
10887 #: ../src/guestfs-actions.pod:3055
10888 msgid "guestfs_inspect_get_type"
10892 #: ../src/guestfs-actions.pod:3057
10896 " guestfs_inspect_get_type (guestfs_h *g,\n"
10897 " const char *root);\n"
10902 #: ../src/guestfs-actions.pod:3061 ../fish/guestfish-actions.pod:2097
10904 "This returns the type of the inspected operating system. Currently defined "
10909 #: ../src/guestfs-actions.pod:3066 ../fish/guestfish-actions.pod:2102
10914 #: ../src/guestfs-actions.pod:3068 ../fish/guestfish-actions.pod:2104
10915 msgid "Any Linux-based operating system."
10919 #: ../src/guestfs-actions.pod:3072 ../fish/guestfish-actions.pod:2108
10920 msgid "Any Microsoft Windows operating system."
10924 #: ../src/guestfs-actions.pod:3074 ../fish/guestfish-actions.pod:2110
10925 msgid "\"freebsd\""
10929 #: ../src/guestfs-actions.pod:3076 ../fish/guestfish-actions.pod:2112
10934 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2116
10935 msgid "The operating system type could not be determined."
10939 #: ../src/guestfs-actions.pod:3094
10940 msgid "guestfs_inspect_get_windows_current_control_set"
10944 #: ../src/guestfs-actions.pod:3096
10948 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
10949 " const char *root);\n"
10954 #: ../src/guestfs-actions.pod:3100 ../fish/guestfish-actions.pod:2129
10956 "This returns the Windows CurrentControlSet of the inspected guest. The "
10957 "CurrentControlSet is a registry key name such as C<ControlSet001>."
10961 #: ../src/guestfs-actions.pod:3103 ../fish/guestfish-actions.pod:2132
10963 "This call assumes that the guest is Windows and that the Registry could be "
10964 "examined by inspection. If this is not the case then an error is returned."
10968 #: ../src/guestfs-actions.pod:3112
10969 msgid "guestfs_inspect_get_windows_systemroot"
10973 #: ../src/guestfs-actions.pod:3114
10977 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
10978 " const char *root);\n"
10983 #: ../src/guestfs-actions.pod:3118 ../fish/guestfish-actions.pod:2142
10985 "This returns the Windows systemroot of the inspected guest. The systemroot "
10986 "is a directory path such as C</WINDOWS>."
10990 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2145
10992 "This call assumes that the guest is Windows and that the systemroot could be "
10993 "determined by inspection. If this is not the case then an error is "
10998 #: ../src/guestfs-actions.pod:3130
10999 msgid "(Added in 1.5.25)"
11003 #: ../src/guestfs-actions.pod:3132
11004 msgid "guestfs_inspect_is_live"
11008 #: ../src/guestfs-actions.pod:3134
11012 " guestfs_inspect_is_live (guestfs_h *g,\n"
11013 " const char *root);\n"
11018 #: ../src/guestfs-actions.pod:3138
11020 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11021 "disk), then this returns true if a live image was detected on the disk."
11025 #: ../src/guestfs-actions.pod:3146
11026 msgid "guestfs_inspect_is_multipart"
11030 #: ../src/guestfs-actions.pod:3148
11034 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11035 " const char *root);\n"
11040 #: ../src/guestfs-actions.pod:3152
11042 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11043 "disk), then this returns true if the disk is part of a set."
11047 #: ../src/guestfs-actions.pod:3160
11048 msgid "guestfs_inspect_is_netinst"
11052 #: ../src/guestfs-actions.pod:3162
11056 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11057 " const char *root);\n"
11062 #: ../src/guestfs-actions.pod:3166
11064 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11065 "disk), then this returns true if the disk is a network installer, ie. not a "
11066 "self-contained install CD but one which is likely to require network access "
11067 "to complete the install."
11071 #: ../src/guestfs-actions.pod:3176
11072 msgid "guestfs_inspect_list_applications"
11076 #: ../src/guestfs-actions.pod:3178
11079 " struct guestfs_application_list *\n"
11080 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11081 " const char *root);\n"
11086 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2187
11087 msgid "Return the list of applications installed in the operating system."
11091 #: ../src/guestfs-actions.pod:3184
11093 "I<Note:> This call works differently from other parts of the inspection "
11094 "API. You have to call C<guestfs_inspect_os>, then "
11095 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11096 "this. Listing applications is a significantly more difficult operation "
11097 "which requires access to the full filesystem. Also note that unlike the "
11098 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11099 "the libguestfs handle, this call actually reads parts of the mounted "
11100 "filesystems during the call."
11104 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2199
11106 "This returns an empty list if the inspection code was not able to determine "
11107 "the list of applications."
11111 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2202
11112 msgid "The application structure contains the following fields:"
11116 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2206
11117 msgid "C<app_name>"
11121 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2208
11123 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11124 "guests, this is the package name."
11128 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2211
11129 msgid "C<app_display_name>"
11133 #: ../src/guestfs-actions.pod:3208 ../fish/guestfish-actions.pod:2213
11135 "The display name of the application, sometimes localized to the install "
11136 "language of the guest operating system."
11140 #: ../src/guestfs-actions.pod:3211 ../fish/guestfish-actions.pod:2216
11142 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11143 "to display something can use C<app_name> instead."
11147 #: ../src/guestfs-actions.pod:3214 ../fish/guestfish-actions.pod:2219
11148 msgid "C<app_epoch>"
11152 #: ../src/guestfs-actions.pod:3216 ../fish/guestfish-actions.pod:2221
11154 "For package managers which use epochs, this contains the epoch of the "
11155 "package (an integer). If unavailable, this is returned as C<0>."
11159 #: ../src/guestfs-actions.pod:3219 ../fish/guestfish-actions.pod:2224
11160 msgid "C<app_version>"
11164 #: ../src/guestfs-actions.pod:3221 ../fish/guestfish-actions.pod:2226
11166 "The version string of the application or package. If unavailable this is "
11167 "returned as an empty string C<\"\">."
11171 #: ../src/guestfs-actions.pod:3224 ../fish/guestfish-actions.pod:2229
11172 msgid "C<app_release>"
11176 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2231
11178 "The release string of the application or package, for package managers that "
11179 "use this. If unavailable this is returned as an empty string C<\"\">."
11183 #: ../src/guestfs-actions.pod:3230 ../fish/guestfish-actions.pod:2235
11184 msgid "C<app_install_path>"
11188 #: ../src/guestfs-actions.pod:3232 ../fish/guestfish-actions.pod:2237
11190 "The installation path of the application (on operating systems such as "
11191 "Windows which use installation paths). This path is in the format used by "
11192 "the guest operating system, it is not a libguestfs path."
11196 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2242
11197 msgid "If unavailable this is returned as an empty string C<\"\">."
11201 #: ../src/guestfs-actions.pod:3239 ../fish/guestfish-actions.pod:2244
11202 msgid "C<app_trans_path>"
11206 #: ../src/guestfs-actions.pod:3241 ../fish/guestfish-actions.pod:2246
11208 "The install path translated into a libguestfs path. If unavailable this is "
11209 "returned as an empty string C<\"\">."
11213 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
11214 msgid "C<app_publisher>"
11218 #: ../src/guestfs-actions.pod:3246 ../fish/guestfish-actions.pod:2251
11220 "The name of the publisher of the application, for package managers that use "
11221 "this. If unavailable this is returned as an empty string C<\"\">."
11225 #: ../src/guestfs-actions.pod:3250 ../fish/guestfish-actions.pod:2255
11230 #: ../src/guestfs-actions.pod:3252 ../fish/guestfish-actions.pod:2257
11232 "The URL (eg. upstream URL) of the application. If unavailable this is "
11233 "returned as an empty string C<\"\">."
11237 #: ../src/guestfs-actions.pod:3255 ../fish/guestfish-actions.pod:2260
11238 msgid "C<app_source_package>"
11242 #: ../src/guestfs-actions.pod:3257 ../fish/guestfish-actions.pod:2262
11244 "For packaging systems which support this, the name of the source package. "
11245 "If unavailable this is returned as an empty string C<\"\">."
11249 #: ../src/guestfs-actions.pod:3260 ../fish/guestfish-actions.pod:2265
11250 msgid "C<app_summary>"
11254 #: ../src/guestfs-actions.pod:3262 ../fish/guestfish-actions.pod:2267
11256 "A short (usually one line) description of the application or package. If "
11257 "unavailable this is returned as an empty string C<\"\">."
11261 #: ../src/guestfs-actions.pod:3265 ../fish/guestfish-actions.pod:2270
11262 msgid "C<app_description>"
11266 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2272
11268 "A longer description of the application or package. If unavailable this is "
11269 "returned as an empty string C<\"\">."
11273 #: ../src/guestfs-actions.pod:3274
11275 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11276 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11281 #: ../src/guestfs-actions.pod:3278
11282 msgid "(Added in 1.7.8)"
11286 #: ../src/guestfs-actions.pod:3280
11287 msgid "guestfs_inspect_os"
11291 #: ../src/guestfs-actions.pod:3282
11295 " guestfs_inspect_os (guestfs_h *g);\n"
11300 #: ../src/guestfs-actions.pod:3285 ../fish/guestfish-actions.pod:2283
11302 "This function uses other libguestfs functions and certain heuristics to "
11303 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11304 "for operating systems."
11308 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2287
11309 msgid "The list returned is empty if no operating systems were found."
11313 #: ../src/guestfs-actions.pod:3291 ../fish/guestfish-actions.pod:2289
11315 "If one operating system was found, then this returns a list with a single "
11316 "element, which is the name of the root filesystem of this operating system. "
11317 "It is also possible for this function to return a list containing more than "
11318 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11319 "element being the root filesystem of one of the operating systems."
11323 #: ../src/guestfs-actions.pod:3298
11325 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11326 "functions in order to query further information about each operating system, "
11327 "such as the name and version."
11331 #: ../src/guestfs-actions.pod:3303
11333 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11334 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11335 "the contents. This should be called with no disks currently mounted. The "
11336 "function may also use Augeas, so any existing Augeas handle will be closed."
11340 #: ../src/guestfs-actions.pod:3309 ../fish/guestfish-actions.pod:2307
11342 "This function cannot decrypt encrypted disks. The caller must do that first "
11343 "(supplying the necessary keys) if the disk is encrypted."
11347 #: ../src/guestfs-actions.pod:3315 ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3702
11348 msgid "See also C<guestfs_list_filesystems>."
11352 #: ../src/guestfs-actions.pod:3323
11353 msgid "guestfs_is_blockdev"
11357 #: ../src/guestfs-actions.pod:3325
11361 " guestfs_is_blockdev (guestfs_h *g,\n"
11362 " const char *path);\n"
11367 #: ../src/guestfs-actions.pod:3329 ../fish/guestfish-actions.pod:2319
11369 "This returns C<true> if and only if there is a block device with the given "
11374 #: ../src/guestfs-actions.pod:3332 ../src/guestfs-actions.pod:3361 ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3406 ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3478 ../src/guestfs-actions.pod:3493
11375 msgid "See also C<guestfs_stat>."
11379 #: ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3482 ../src/guestfs-actions.pod:3497
11380 msgid "(Added in 1.5.10)"
11384 #: ../src/guestfs-actions.pod:3338
11385 msgid "guestfs_is_busy"
11389 #: ../src/guestfs-actions.pod:3340
11393 " guestfs_is_busy (guestfs_h *g);\n"
11398 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2328
11400 "This returns true iff this handle is busy processing a command (in the "
11405 #: ../src/guestfs-actions.pod:3352
11406 msgid "guestfs_is_chardev"
11410 #: ../src/guestfs-actions.pod:3354
11414 " guestfs_is_chardev (guestfs_h *g,\n"
11415 " const char *path);\n"
11420 #: ../src/guestfs-actions.pod:3358 ../fish/guestfish-actions.pod:2337
11422 "This returns C<true> if and only if there is a character device with the "
11423 "given C<path> name."
11427 #: ../src/guestfs-actions.pod:3367
11428 msgid "guestfs_is_config"
11432 #: ../src/guestfs-actions.pod:3369
11436 " guestfs_is_config (guestfs_h *g);\n"
11441 #: ../src/guestfs-actions.pod:3372 ../fish/guestfish-actions.pod:2346
11443 "This returns true iff this handle is being configured (in the C<CONFIG> "
11448 #: ../src/guestfs-actions.pod:3381
11449 msgid "guestfs_is_dir"
11453 #: ../src/guestfs-actions.pod:3383
11457 " guestfs_is_dir (guestfs_h *g,\n"
11458 " const char *path);\n"
11463 #: ../src/guestfs-actions.pod:3387 ../fish/guestfish-actions.pod:2355
11465 "This returns C<true> if and only if there is a directory with the given "
11466 "C<path> name. Note that it returns false for other objects like files."
11470 #: ../src/guestfs-actions.pod:3397
11471 msgid "guestfs_is_fifo"
11475 #: ../src/guestfs-actions.pod:3399
11479 " guestfs_is_fifo (guestfs_h *g,\n"
11480 " const char *path);\n"
11485 #: ../src/guestfs-actions.pod:3403 ../fish/guestfish-actions.pod:2365
11487 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11488 "given C<path> name."
11492 #: ../src/guestfs-actions.pod:3412
11493 msgid "guestfs_is_file"
11497 #: ../src/guestfs-actions.pod:3414
11501 " guestfs_is_file (guestfs_h *g,\n"
11502 " const char *path);\n"
11507 #: ../src/guestfs-actions.pod:3418 ../fish/guestfish-actions.pod:2374
11509 "This returns C<true> if and only if there is a regular file with the given "
11510 "C<path> name. Note that it returns false for other objects like "
11515 #: ../src/guestfs-actions.pod:3428
11516 msgid "guestfs_is_launching"
11520 #: ../src/guestfs-actions.pod:3430
11524 " guestfs_is_launching (guestfs_h *g);\n"
11529 #: ../src/guestfs-actions.pod:3433 ../fish/guestfish-actions.pod:2384
11531 "This returns true iff this handle is launching the subprocess (in the "
11532 "C<LAUNCHING> state)."
11536 #: ../src/guestfs-actions.pod:3442
11537 msgid "guestfs_is_lv"
11541 #: ../src/guestfs-actions.pod:3444
11545 " guestfs_is_lv (guestfs_h *g,\n"
11546 " const char *device);\n"
11551 #: ../src/guestfs-actions.pod:3448 ../fish/guestfish-actions.pod:2393
11553 "This command tests whether C<device> is a logical volume, and returns true "
11554 "iff this is the case."
11558 #: ../src/guestfs-actions.pod:3455
11559 msgid "guestfs_is_ready"
11563 #: ../src/guestfs-actions.pod:3457
11567 " guestfs_is_ready (guestfs_h *g);\n"
11572 #: ../src/guestfs-actions.pod:3460 ../fish/guestfish-actions.pod:2400
11574 "This returns true iff this handle is ready to accept commands (in the "
11579 #: ../src/guestfs-actions.pod:3469
11580 msgid "guestfs_is_socket"
11584 #: ../src/guestfs-actions.pod:3471
11588 " guestfs_is_socket (guestfs_h *g,\n"
11589 " const char *path);\n"
11594 #: ../src/guestfs-actions.pod:3475 ../fish/guestfish-actions.pod:2409
11596 "This returns C<true> if and only if there is a Unix domain socket with the "
11597 "given C<path> name."
11601 #: ../src/guestfs-actions.pod:3484
11602 msgid "guestfs_is_symlink"
11606 #: ../src/guestfs-actions.pod:3486
11610 " guestfs_is_symlink (guestfs_h *g,\n"
11611 " const char *path);\n"
11616 #: ../src/guestfs-actions.pod:3490 ../fish/guestfish-actions.pod:2418
11618 "This returns C<true> if and only if there is a symbolic link with the given "
11623 #: ../src/guestfs-actions.pod:3499
11624 msgid "guestfs_is_zero"
11628 #: ../src/guestfs-actions.pod:3501
11632 " guestfs_is_zero (guestfs_h *g,\n"
11633 " const char *path);\n"
11638 #: ../src/guestfs-actions.pod:3505 ../fish/guestfish-actions.pod:2427
11640 "This returns true iff the file exists and the file is empty or it contains "
11645 #: ../src/guestfs-actions.pod:3510
11646 msgid "guestfs_is_zero_device"
11650 #: ../src/guestfs-actions.pod:3512
11654 " guestfs_is_zero_device (guestfs_h *g,\n"
11655 " const char *device);\n"
11660 #: ../src/guestfs-actions.pod:3516 ../fish/guestfish-actions.pod:2434
11661 msgid "This returns true iff the device exists and contains all zero bytes."
11665 #: ../src/guestfs-actions.pod:3518 ../fish/guestfish-actions.pod:2436
11666 msgid "Note that for large devices this can take a long time to run."
11670 #: ../src/guestfs-actions.pod:3522
11671 msgid "guestfs_kill_subprocess"
11675 #: ../src/guestfs-actions.pod:3524
11679 " guestfs_kill_subprocess (guestfs_h *g);\n"
11684 #: ../src/guestfs-actions.pod:3527 ../fish/guestfish-actions.pod:2442
11685 msgid "This kills the qemu subprocess. You should never need to call this."
11689 #: ../src/guestfs-actions.pod:3533
11690 msgid "guestfs_launch"
11694 #: ../src/guestfs-actions.pod:3535
11698 " guestfs_launch (guestfs_h *g);\n"
11703 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2450
11705 "Internally libguestfs is implemented by running a virtual machine using "
11710 #: ../src/guestfs-actions.pod:3541 ../fish/guestfish-actions.pod:2453
11712 "You should call this after configuring the handle (eg. adding drives) but "
11713 "before performing any actions."
11717 #: ../src/guestfs-actions.pod:3553
11718 msgid "guestfs_lchown"
11722 #: ../src/guestfs-actions.pod:3555
11726 " guestfs_lchown (guestfs_h *g,\n"
11729 " const char *path);\n"
11734 #: ../src/guestfs-actions.pod:3561
11736 "Change the file owner to C<owner> and group to C<group>. This is like "
11737 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
11738 "changed, not the target."
11742 #: ../src/guestfs-actions.pod:3573
11743 msgid "guestfs_lgetxattr"
11747 #: ../src/guestfs-actions.pod:3575
11751 " guestfs_lgetxattr (guestfs_h *g,\n"
11752 " const char *path,\n"
11753 " const char *name,\n"
11754 " size_t *size_r);\n"
11759 #: ../src/guestfs-actions.pod:3581 ../fish/guestfish-actions.pod:2472
11761 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
11762 "is a symlink, then this call returns an extended attribute from the symlink."
11766 #: ../src/guestfs-actions.pod:3595
11767 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
11771 #: ../src/guestfs-actions.pod:3603
11772 msgid "guestfs_lgetxattrs"
11776 #: ../src/guestfs-actions.pod:3605
11779 " struct guestfs_xattr_list *\n"
11780 " guestfs_lgetxattrs (guestfs_h *g,\n"
11781 " const char *path);\n"
11786 #: ../src/guestfs-actions.pod:3609
11788 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
11789 "then it returns the extended attributes of the link itself."
11793 #: ../src/guestfs-actions.pod:3619
11794 msgid "guestfs_list_9p"
11798 #: ../src/guestfs-actions.pod:3621
11802 " guestfs_list_9p (guestfs_h *g);\n"
11807 #: ../src/guestfs-actions.pod:3624 ../fish/guestfish-actions.pod:2500
11809 "List all 9p filesystems attached to the guest. A list of mount tags is "
11814 #: ../src/guestfs-actions.pod:3631
11815 msgid "guestfs_list_devices"
11819 #: ../src/guestfs-actions.pod:3633
11823 " guestfs_list_devices (guestfs_h *g);\n"
11828 #: ../src/guestfs-actions.pod:3636 ../fish/guestfish-actions.pod:2507
11829 msgid "List all the block devices."
11833 #: ../src/guestfs-actions.pod:3638 ../fish/guestfish-actions.pod:2509
11834 msgid "The full block device names are returned, eg. C</dev/sda>."
11838 #: ../src/guestfs-actions.pod:3648
11839 msgid "guestfs_list_filesystems"
11843 #: ../src/guestfs-actions.pod:3650
11847 " guestfs_list_filesystems (guestfs_h *g);\n"
11852 #: ../src/guestfs-actions.pod:3653 ../fish/guestfish-actions.pod:2517
11854 "This inspection command looks for filesystems on partitions, block devices "
11855 "and logical volumes, returning a list of devices containing filesystems and "
11860 #: ../src/guestfs-actions.pod:3657 ../fish/guestfish-actions.pod:2521
11862 "The return value is a hash, where the keys are the devices containing "
11863 "filesystems, and the values are the filesystem types. For example:"
11867 #: ../src/guestfs-actions.pod:3661 ../fish/guestfish-actions.pod:2525
11870 " \"/dev/sda1\" => \"ntfs\"\n"
11871 " \"/dev/sda2\" => \"ext2\"\n"
11872 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
11873 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
11878 #: ../src/guestfs-actions.pod:3666 ../fish/guestfish-actions.pod:2530
11880 "The value can have the special value \"unknown\", meaning the content of the "
11881 "device is undetermined or empty. \"swap\" means a Linux swap partition."
11885 #: ../src/guestfs-actions.pod:3670
11887 "This command runs other libguestfs commands, which might include "
11888 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
11889 "soon after launch and only when nothing is mounted."
11893 #: ../src/guestfs-actions.pod:3674
11895 "Not all of the filesystems returned will be mountable. In particular, swap "
11896 "partitions are returned in the list. Also this command does not check that "
11897 "each filesystem found is valid and mountable, and some filesystems might be "
11898 "mountable but require special options. Filesystems may not all belong to a "
11899 "single logical operating system (use C<guestfs_inspect_os> to look for "
11904 #: ../src/guestfs-actions.pod:3688 ../src/guestfs-actions.pod:5348
11905 msgid "(Added in 1.5.15)"
11909 #: ../src/guestfs-actions.pod:3690
11910 msgid "guestfs_list_partitions"
11914 #: ../src/guestfs-actions.pod:3692
11918 " guestfs_list_partitions (guestfs_h *g);\n"
11923 #: ../src/guestfs-actions.pod:3695 ../fish/guestfish-actions.pod:2550
11924 msgid "List all the partitions detected on all block devices."
11928 #: ../src/guestfs-actions.pod:3697 ../fish/guestfish-actions.pod:2552
11929 msgid "The full partition device names are returned, eg. C</dev/sda1>"
11933 #: ../src/guestfs-actions.pod:3699
11935 "This does not return logical volumes. For that you will need to call "
11940 #: ../src/guestfs-actions.pod:3710
11945 #: ../src/guestfs-actions.pod:3712
11949 " guestfs_ll (guestfs_h *g,\n"
11950 " const char *directory);\n"
11955 #: ../src/guestfs-actions.pod:3716 ../fish/guestfish-actions.pod:2563
11957 "List the files in C<directory> (relative to the root directory, there is no "
11958 "cwd) in the format of 'ls -la'."
11962 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2566
11964 "This command is mostly useful for interactive sessions. It is I<not> "
11965 "intended that you try to parse the output string."
11969 #: ../src/guestfs-actions.pod:3727
11974 #: ../src/guestfs-actions.pod:3729
11978 " guestfs_ln (guestfs_h *g,\n"
11979 " const char *target,\n"
11980 " const char *linkname);\n"
11985 #: ../src/guestfs-actions.pod:3734 ../fish/guestfish-actions.pod:2573
11986 msgid "This command creates a hard link using the C<ln> command."
11990 #: ../src/guestfs-actions.pod:3740
11991 msgid "guestfs_ln_f"
11995 #: ../src/guestfs-actions.pod:3742
11999 " guestfs_ln_f (guestfs_h *g,\n"
12000 " const char *target,\n"
12001 " const char *linkname);\n"
12006 #: ../src/guestfs-actions.pod:3747 ../fish/guestfish-actions.pod:2579
12008 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12009 "option removes the link (C<linkname>) if it exists already."
12013 #: ../src/guestfs-actions.pod:3754
12014 msgid "guestfs_ln_s"
12018 #: ../src/guestfs-actions.pod:3756
12022 " guestfs_ln_s (guestfs_h *g,\n"
12023 " const char *target,\n"
12024 " const char *linkname);\n"
12029 #: ../src/guestfs-actions.pod:3761 ../fish/guestfish-actions.pod:2586
12030 msgid "This command creates a symbolic link using the C<ln -s> command."
12034 #: ../src/guestfs-actions.pod:3767
12035 msgid "guestfs_ln_sf"
12039 #: ../src/guestfs-actions.pod:3769
12043 " guestfs_ln_sf (guestfs_h *g,\n"
12044 " const char *target,\n"
12045 " const char *linkname);\n"
12050 #: ../src/guestfs-actions.pod:3774 ../fish/guestfish-actions.pod:2592
12052 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12053 "option removes the link (C<linkname>) if it exists already."
12057 #: ../src/guestfs-actions.pod:3781
12058 msgid "guestfs_lremovexattr"
12062 #: ../src/guestfs-actions.pod:3783
12066 " guestfs_lremovexattr (guestfs_h *g,\n"
12067 " const char *xattr,\n"
12068 " const char *path);\n"
12073 #: ../src/guestfs-actions.pod:3788
12075 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12076 "link, then it removes an extended attribute of the link itself."
12080 #: ../src/guestfs-actions.pod:3796
12085 #: ../src/guestfs-actions.pod:3798
12089 " guestfs_ls (guestfs_h *g,\n"
12090 " const char *directory);\n"
12095 #: ../src/guestfs-actions.pod:3802 ../fish/guestfish-actions.pod:2607
12097 "List the files in C<directory> (relative to the root directory, there is no "
12098 "cwd). The '.' and '..' entries are not returned, but hidden files are "
12103 #: ../src/guestfs-actions.pod:3806
12105 "This command is mostly useful for interactive sessions. Programs should "
12106 "probably use C<guestfs_readdir> instead."
12110 #: ../src/guestfs-actions.pod:3815
12111 msgid "guestfs_lsetxattr"
12115 #: ../src/guestfs-actions.pod:3817
12119 " guestfs_lsetxattr (guestfs_h *g,\n"
12120 " const char *xattr,\n"
12121 " const char *val,\n"
12123 " const char *path);\n"
12128 #: ../src/guestfs-actions.pod:3824
12130 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12131 "then it sets an extended attribute of the link itself."
12135 #: ../src/guestfs-actions.pod:3832
12136 msgid "guestfs_lstat"
12140 #: ../src/guestfs-actions.pod:3834
12143 " struct guestfs_stat *\n"
12144 " guestfs_lstat (guestfs_h *g,\n"
12145 " const char *path);\n"
12150 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:6479 ../fish/guestfish-actions.pod:2626 ../fish/guestfish-actions.pod:4343
12151 msgid "Returns file information for the given C<path>."
12155 #: ../src/guestfs-actions.pod:3840
12157 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12158 "link, then the link is stat-ed, not the file it refers to."
12162 #: ../src/guestfs-actions.pod:3844 ../fish/guestfish-actions.pod:2632
12163 msgid "This is the same as the C<lstat(2)> system call."
12167 #: ../src/guestfs-actions.pod:3846 ../src/guestfs-actions.pod:6483
12169 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12170 "error. I<The caller must call C<guestfs_free_stat> after use>."
12174 #: ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:6487 ../src/guestfs-actions.pod:6505 ../src/guestfs-actions.pod:6886
12175 msgid "(Added in 0.9.2)"
12179 #: ../src/guestfs-actions.pod:3852
12180 msgid "guestfs_lstatlist"
12184 #: ../src/guestfs-actions.pod:3854
12187 " struct guestfs_stat_list *\n"
12188 " guestfs_lstatlist (guestfs_h *g,\n"
12189 " const char *path,\n"
12190 " char *const *names);\n"
12195 #: ../src/guestfs-actions.pod:3859
12197 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12198 "files, where all files are in the directory C<path>. C<names> is the list "
12199 "of files from this directory."
12203 #: ../src/guestfs-actions.pod:3863 ../fish/guestfish-actions.pod:2642
12205 "On return you get a list of stat structs, with a one-to-one correspondence "
12206 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12207 "then the C<ino> field of that structure is set to C<-1>."
12211 #: ../src/guestfs-actions.pod:3868
12213 "This call is intended for programs that want to efficiently list a directory "
12214 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12215 "for a similarly efficient call for getting extended attributes. Very long "
12216 "directory listings might cause the protocol message size to be exceeded, "
12217 "causing this call to fail. The caller must split up such requests into "
12218 "smaller groups of names."
12222 #: ../src/guestfs-actions.pod:3876
12224 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12225 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12229 #: ../src/guestfs-actions.pod:3882
12230 msgid "guestfs_luks_add_key"
12234 #: ../src/guestfs-actions.pod:3884
12238 " guestfs_luks_add_key (guestfs_h *g,\n"
12239 " const char *device,\n"
12240 " const char *key,\n"
12241 " const char *newkey,\n"
12247 #: ../src/guestfs-actions.pod:3891 ../fish/guestfish-actions.pod:2659
12249 "This command adds a new key on LUKS device C<device>. C<key> is any "
12250 "existing key, and is used to access the device. C<newkey> is the new key to "
12251 "add. C<keyslot> is the key slot that will be replaced."
12255 #: ../src/guestfs-actions.pod:3896
12257 "Note that if C<keyslot> already contains a key, then this command will "
12258 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12262 #: ../src/guestfs-actions.pod:3902 ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:3985 ../src/guestfs-actions.pod:4017 ../src/guestfs-actions.pod:4036
12264 "This function takes a key or passphrase parameter which could contain "
12265 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12270 #: ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3946 ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:3989
12271 msgid "(Added in 1.5.2)"
12275 #: ../src/guestfs-actions.pod:3908
12276 msgid "guestfs_luks_close"
12280 #: ../src/guestfs-actions.pod:3910
12284 " guestfs_luks_close (guestfs_h *g,\n"
12285 " const char *device);\n"
12290 #: ../src/guestfs-actions.pod:3914
12292 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12293 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12294 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12295 "underlying block device."
12299 #: ../src/guestfs-actions.pod:3922 ../src/guestfs-actions.pod:4021 ../src/guestfs-actions.pod:4040 ../src/guestfs-actions.pod:4090 ../src/guestfs-actions.pod:4138
12300 msgid "(Added in 1.5.1)"
12304 #: ../src/guestfs-actions.pod:3924
12305 msgid "guestfs_luks_format"
12309 #: ../src/guestfs-actions.pod:3926
12313 " guestfs_luks_format (guestfs_h *g,\n"
12314 " const char *device,\n"
12315 " const char *key,\n"
12321 #: ../src/guestfs-actions.pod:3932 ../fish/guestfish-actions.pod:2685
12323 "This command erases existing data on C<device> and formats the device as a "
12324 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12325 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12329 #: ../src/guestfs-actions.pod:3939 ../src/guestfs-actions.pod:3962 ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:5099 ../src/guestfs-actions.pod:5879 ../src/guestfs-actions.pod:6286 ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6349 ../src/guestfs-actions.pod:7531 ../fish/guestfish-actions.pod:2693 ../fish/guestfish-actions.pod:2706 ../fish/guestfish-actions.pod:2790 ../fish/guestfish-actions.pod:3384 ../fish/guestfish-actions.pod:3904 ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4237 ../fish/guestfish-actions.pod:4259 ../fish/guestfish-actions.pod:4989
12331 "B<This command is dangerous. Without careful use you can easily destroy all "
12336 #: ../src/guestfs-actions.pod:3948
12337 msgid "guestfs_luks_format_cipher"
12341 #: ../src/guestfs-actions.pod:3950
12345 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12346 " const char *device,\n"
12347 " const char *key,\n"
12349 " const char *cipher);\n"
12354 #: ../src/guestfs-actions.pod:3957
12356 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12357 "set the C<cipher> used."
12361 #: ../src/guestfs-actions.pod:3971
12362 msgid "guestfs_luks_kill_slot"
12366 #: ../src/guestfs-actions.pod:3973
12370 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12371 " const char *device,\n"
12372 " const char *key,\n"
12378 #: ../src/guestfs-actions.pod:3979 ../fish/guestfish-actions.pod:2713
12380 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12381 "device C<device>. C<key> must be one of the I<other> keys."
12385 #: ../src/guestfs-actions.pod:3991
12386 msgid "guestfs_luks_open"
12390 #: ../src/guestfs-actions.pod:3993
12394 " guestfs_luks_open (guestfs_h *g,\n"
12395 " const char *device,\n"
12396 " const char *key,\n"
12397 " const char *mapname);\n"
12402 #: ../src/guestfs-actions.pod:3999 ../fish/guestfish-actions.pod:2724
12404 "This command opens a block device which has been encrypted according to the "
12405 "Linux Unified Key Setup (LUKS) standard."
12409 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2727
12410 msgid "C<device> is the encrypted block device or partition."
12414 #: ../src/guestfs-actions.pod:4004 ../fish/guestfish-actions.pod:2729
12416 "The caller must supply one of the keys associated with the LUKS block "
12417 "device, in the C<key> parameter."
12421 #: ../src/guestfs-actions.pod:4007 ../fish/guestfish-actions.pod:2732
12423 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
12424 "writes to this block device are decrypted from and encrypted to the "
12425 "underlying C<device> respectively."
12429 #: ../src/guestfs-actions.pod:4011
12431 "If this block device contains LVM volume groups, then calling "
12432 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
12437 #: ../src/guestfs-actions.pod:4023
12438 msgid "guestfs_luks_open_ro"
12442 #: ../src/guestfs-actions.pod:4025
12446 " guestfs_luks_open_ro (guestfs_h *g,\n"
12447 " const char *device,\n"
12448 " const char *key,\n"
12449 " const char *mapname);\n"
12454 #: ../src/guestfs-actions.pod:4031
12456 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
12461 #: ../src/guestfs-actions.pod:4042
12462 msgid "guestfs_lvcreate"
12466 #: ../src/guestfs-actions.pod:4044
12470 " guestfs_lvcreate (guestfs_h *g,\n"
12471 " const char *logvol,\n"
12472 " const char *volgroup,\n"
12478 #: ../src/guestfs-actions.pod:4050 ../fish/guestfish-actions.pod:2757
12480 "This creates an LVM logical volume called C<logvol> on the volume group "
12481 "C<volgroup>, with C<size> megabytes."
12485 #: ../src/guestfs-actions.pod:4057
12486 msgid "guestfs_lvm_canonical_lv_name"
12490 #: ../src/guestfs-actions.pod:4059
12494 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
12495 " const char *lvname);\n"
12500 #: ../src/guestfs-actions.pod:4063 ../fish/guestfish-actions.pod:2764
12502 "This converts alternative naming schemes for LVs that you might find to the "
12503 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
12508 #: ../src/guestfs-actions.pod:4067 ../fish/guestfish-actions.pod:2768
12510 "This command returns an error if the C<lvname> parameter does not refer to a "
12515 #: ../src/guestfs-actions.pod:4070
12516 msgid "See also C<guestfs_is_lv>."
12520 #: ../src/guestfs-actions.pod:4075
12521 msgid "(Added in 1.5.24)"
12525 #: ../src/guestfs-actions.pod:4077
12526 msgid "guestfs_lvm_clear_filter"
12530 #: ../src/guestfs-actions.pod:4079
12534 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
12539 #: ../src/guestfs-actions.pod:4082
12541 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
12542 "see every block device."
12546 #: ../src/guestfs-actions.pod:4085 ../src/guestfs-actions.pod:4127 ../fish/guestfish-actions.pod:2780 ../fish/guestfish-actions.pod:2811
12547 msgid "This command also clears the LVM cache and performs a volume group scan."
12551 #: ../src/guestfs-actions.pod:4092
12552 msgid "guestfs_lvm_remove_all"
12556 #: ../src/guestfs-actions.pod:4094
12560 " guestfs_lvm_remove_all (guestfs_h *g);\n"
12565 #: ../src/guestfs-actions.pod:4097 ../fish/guestfish-actions.pod:2787
12567 "This command removes all LVM logical volumes, volume groups and physical "
12572 #: ../src/guestfs-actions.pod:4107
12573 msgid "guestfs_lvm_set_filter"
12577 #: ../src/guestfs-actions.pod:4109
12581 " guestfs_lvm_set_filter (guestfs_h *g,\n"
12582 " char *const *devices);\n"
12587 #: ../src/guestfs-actions.pod:4113 ../fish/guestfish-actions.pod:2797
12589 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
12590 "block devices in the list C<devices>, and will ignore all other attached "
12595 #: ../src/guestfs-actions.pod:4117 ../fish/guestfish-actions.pod:2801
12597 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
12598 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
12599 "there are two types of duplication possible: either cloned PVs/VGs which "
12600 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
12601 "same name. In normal operation you cannot create this situation, but you "
12602 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
12603 "inside the LVM metadata."
12607 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2814
12608 msgid "You can filter whole block devices or individual partitions."
12612 #: ../src/guestfs-actions.pod:4132 ../fish/guestfish-actions.pod:2816
12614 "You cannot use this if any VG is currently in use (eg. contains a mounted "
12615 "filesystem), even if you are not filtering out that VG."
12619 #: ../src/guestfs-actions.pod:4140
12620 msgid "guestfs_lvremove"
12624 #: ../src/guestfs-actions.pod:4142
12628 " guestfs_lvremove (guestfs_h *g,\n"
12629 " const char *device);\n"
12634 #: ../src/guestfs-actions.pod:4146 ../fish/guestfish-actions.pod:2824
12636 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
12637 "LV, such as C</dev/VG/LV>."
12641 #: ../src/guestfs-actions.pod:4149 ../fish/guestfish-actions.pod:2827
12643 "You can also remove all LVs in a volume group by specifying the VG name, "
12648 #: ../src/guestfs-actions.pod:4154 ../src/guestfs-actions.pod:5445 ../src/guestfs-actions.pod:7262
12649 msgid "(Added in 1.0.13)"
12653 #: ../src/guestfs-actions.pod:4156
12654 msgid "guestfs_lvrename"
12658 #: ../src/guestfs-actions.pod:4158
12662 " guestfs_lvrename (guestfs_h *g,\n"
12663 " const char *logvol,\n"
12664 " const char *newlogvol);\n"
12669 #: ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:2834
12670 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
12674 #: ../src/guestfs-actions.pod:4167 ../src/guestfs-actions.pod:7275
12675 msgid "(Added in 1.0.83)"
12679 #: ../src/guestfs-actions.pod:4169
12680 msgid "guestfs_lvresize"
12684 #: ../src/guestfs-actions.pod:4171
12688 " guestfs_lvresize (guestfs_h *g,\n"
12689 " const char *device,\n"
12695 #: ../src/guestfs-actions.pod:4176 ../fish/guestfish-actions.pod:2840
12697 "This resizes (expands or shrinks) an existing LVM logical volume to "
12698 "C<mbytes>. When reducing, data in the reduced part is lost."
12702 #: ../src/guestfs-actions.pod:4184
12703 msgid "guestfs_lvresize_free"
12707 #: ../src/guestfs-actions.pod:4186
12711 " guestfs_lvresize_free (guestfs_h *g,\n"
12712 " const char *lv,\n"
12718 #: ../src/guestfs-actions.pod:4191 ../fish/guestfish-actions.pod:2848
12720 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
12721 "remaining free space in the volume group. Commonly you would call this with "
12722 "pc = 100 which expands the logical volume as much as possible, using all "
12723 "remaining free space in the volume group."
12727 #: ../src/guestfs-actions.pod:4199
12728 msgid "(Added in 1.3.3)"
12732 #: ../src/guestfs-actions.pod:4201
12733 msgid "guestfs_lvs"
12737 #: ../src/guestfs-actions.pod:4203
12741 " guestfs_lvs (guestfs_h *g);\n"
12746 #: ../src/guestfs-actions.pod:4206 ../fish/guestfish-actions.pod:2858
12748 "List all the logical volumes detected. This is the equivalent of the "
12749 "L<lvs(8)> command."
12753 #: ../src/guestfs-actions.pod:4209 ../fish/guestfish-actions.pod:2861
12755 "This returns a list of the logical volume device names "
12756 "(eg. C</dev/VolGroup00/LogVol00>)."
12760 #: ../src/guestfs-actions.pod:4212
12761 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
12765 #: ../src/guestfs-actions.pod:4220
12766 msgid "guestfs_lvs_full"
12770 #: ../src/guestfs-actions.pod:4222
12773 " struct guestfs_lvm_lv_list *\n"
12774 " guestfs_lvs_full (guestfs_h *g);\n"
12779 #: ../src/guestfs-actions.pod:4225 ../fish/guestfish-actions.pod:2870
12781 "List all the logical volumes detected. This is the equivalent of the "
12782 "L<lvs(8)> command. The \"full\" version includes all fields."
12786 #: ../src/guestfs-actions.pod:4228
12788 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
12789 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
12794 #: ../src/guestfs-actions.pod:4234
12795 msgid "guestfs_lvuuid"
12799 #: ../src/guestfs-actions.pod:4236
12803 " guestfs_lvuuid (guestfs_h *g,\n"
12804 " const char *device);\n"
12809 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2877
12810 msgid "This command returns the UUID of the LVM LV C<device>."
12814 #: ../src/guestfs-actions.pod:4247
12815 msgid "guestfs_lxattrlist"
12819 #: ../src/guestfs-actions.pod:4249
12822 " struct guestfs_xattr_list *\n"
12823 " guestfs_lxattrlist (guestfs_h *g,\n"
12824 " const char *path,\n"
12825 " char *const *names);\n"
12830 #: ../src/guestfs-actions.pod:4254 ../fish/guestfish-actions.pod:2883
12832 "This call allows you to get the extended attributes of multiple files, where "
12833 "all files are in the directory C<path>. C<names> is the list of files from "
12838 #: ../src/guestfs-actions.pod:4258 ../fish/guestfish-actions.pod:2887
12840 "On return you get a flat list of xattr structs which must be interpreted "
12841 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
12842 "C<attrval> in this struct is zero-length to indicate there was an error "
12843 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
12844 "number (the number of following attributes for this file, which could be "
12845 "C<\"0\">). Then after the first xattr struct are the zero or more "
12846 "attributes for the first named file. This repeats for the second and "
12847 "subsequent files."
12851 #: ../src/guestfs-actions.pod:4268
12853 "This call is intended for programs that want to efficiently list a directory "
12854 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
12855 "a similarly efficient call for getting standard stats. Very long directory "
12856 "listings might cause the protocol message size to be exceeded, causing this "
12857 "call to fail. The caller must split up such requests into smaller groups of "
12862 #: ../src/guestfs-actions.pod:4282
12863 msgid "guestfs_mkdir"
12867 #: ../src/guestfs-actions.pod:4284
12871 " guestfs_mkdir (guestfs_h *g,\n"
12872 " const char *path);\n"
12877 #: ../src/guestfs-actions.pod:4288 ../fish/guestfish-actions.pod:2909
12878 msgid "Create a directory named C<path>."
12882 #: ../src/guestfs-actions.pod:4294
12883 msgid "guestfs_mkdir_mode"
12887 #: ../src/guestfs-actions.pod:4296
12891 " guestfs_mkdir_mode (guestfs_h *g,\n"
12892 " const char *path,\n"
12898 #: ../src/guestfs-actions.pod:4301 ../fish/guestfish-actions.pod:2915
12900 "This command creates a directory, setting the initial permissions of the "
12901 "directory to C<mode>."
12905 #: ../src/guestfs-actions.pod:4304 ../fish/guestfish-actions.pod:2918
12907 "For common Linux filesystems, the actual mode which is set will be C<mode & "
12908 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
12913 #: ../src/guestfs-actions.pod:4308
12914 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
12918 #: ../src/guestfs-actions.pod:4314
12919 msgid "guestfs_mkdir_p"
12923 #: ../src/guestfs-actions.pod:4316
12927 " guestfs_mkdir_p (guestfs_h *g,\n"
12928 " const char *path);\n"
12933 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2928
12935 "Create a directory named C<path>, creating any parent directories as "
12936 "necessary. This is like the C<mkdir -p> shell command."
12940 #: ../src/guestfs-actions.pod:4327
12941 msgid "guestfs_mkdtemp"
12945 #: ../src/guestfs-actions.pod:4329
12949 " guestfs_mkdtemp (guestfs_h *g,\n"
12950 " const char *template);\n"
12955 #: ../src/guestfs-actions.pod:4333 ../fish/guestfish-actions.pod:2935
12957 "This command creates a temporary directory. The C<template> parameter "
12958 "should be a full pathname for the temporary directory name with the final "
12959 "six characters being \"XXXXXX\"."
12963 #: ../src/guestfs-actions.pod:4338 ../fish/guestfish-actions.pod:2940
12965 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
12966 "being suitable for Windows filesystems."
12970 #: ../src/guestfs-actions.pod:4341 ../fish/guestfish-actions.pod:2943
12971 msgid "The name of the temporary directory that was created is returned."
12975 #: ../src/guestfs-actions.pod:4344 ../fish/guestfish-actions.pod:2946
12976 msgid "The temporary directory is created with mode 0700 and is owned by root."
12980 #: ../src/guestfs-actions.pod:4347 ../fish/guestfish-actions.pod:2949
12982 "The caller is responsible for deleting the temporary directory and its "
12983 "contents after use."
12987 #: ../src/guestfs-actions.pod:4350 ../fish/guestfish-actions.pod:2952
12988 msgid "See also: L<mkdtemp(3)>"
12992 #: ../src/guestfs-actions.pod:4357
12993 msgid "guestfs_mke2fs_J"
12997 #: ../src/guestfs-actions.pod:4359
13001 " guestfs_mke2fs_J (guestfs_h *g,\n"
13002 " const char *fstype,\n"
13003 " int blocksize,\n"
13004 " const char *device,\n"
13005 " const char *journal);\n"
13010 #: ../src/guestfs-actions.pod:4366 ../fish/guestfish-actions.pod:2958
13012 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13013 "C<journal>. It is equivalent to the command:"
13017 #: ../src/guestfs-actions.pod:4370 ../fish/guestfish-actions.pod:2962
13020 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13025 #: ../src/guestfs-actions.pod:4372
13026 msgid "See also C<guestfs_mke2journal>."
13030 #: ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:4394 ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4428 ../src/guestfs-actions.pod:4442 ../src/guestfs-actions.pod:4456 ../src/guestfs-actions.pod:4515 ../src/guestfs-actions.pod:4780
13031 msgid "(Added in 1.0.68)"
13035 #: ../src/guestfs-actions.pod:4378
13036 msgid "guestfs_mke2fs_JL"
13040 #: ../src/guestfs-actions.pod:4380
13044 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13045 " const char *fstype,\n"
13046 " int blocksize,\n"
13047 " const char *device,\n"
13048 " const char *label);\n"
13053 #: ../src/guestfs-actions.pod:4387 ../fish/guestfish-actions.pod:2970
13055 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13056 "the journal labeled C<label>."
13060 #: ../src/guestfs-actions.pod:4390
13061 msgid "See also C<guestfs_mke2journal_L>."
13065 #: ../src/guestfs-actions.pod:4396
13066 msgid "guestfs_mke2fs_JU"
13070 #: ../src/guestfs-actions.pod:4398
13074 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13075 " const char *fstype,\n"
13076 " int blocksize,\n"
13077 " const char *device,\n"
13078 " const char *uuid);\n"
13083 #: ../src/guestfs-actions.pod:4405 ../fish/guestfish-actions.pod:2979
13085 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13086 "the journal with UUID C<uuid>."
13090 #: ../src/guestfs-actions.pod:4408
13091 msgid "See also C<guestfs_mke2journal_U>."
13095 #: ../src/guestfs-actions.pod:4414
13096 msgid "guestfs_mke2journal"
13100 #: ../src/guestfs-actions.pod:4416
13104 " guestfs_mke2journal (guestfs_h *g,\n"
13105 " int blocksize,\n"
13106 " const char *device);\n"
13111 #: ../src/guestfs-actions.pod:4421 ../fish/guestfish-actions.pod:2988
13113 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13118 #: ../src/guestfs-actions.pod:4424 ../fish/guestfish-actions.pod:2991
13121 " mke2fs -O journal_dev -b blocksize device\n"
13126 #: ../src/guestfs-actions.pod:4430
13127 msgid "guestfs_mke2journal_L"
13131 #: ../src/guestfs-actions.pod:4432
13135 " guestfs_mke2journal_L (guestfs_h *g,\n"
13136 " int blocksize,\n"
13137 " const char *label,\n"
13138 " const char *device);\n"
13143 #: ../src/guestfs-actions.pod:4438 ../fish/guestfish-actions.pod:2997
13144 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13148 #: ../src/guestfs-actions.pod:4444
13149 msgid "guestfs_mke2journal_U"
13153 #: ../src/guestfs-actions.pod:4446
13157 " guestfs_mke2journal_U (guestfs_h *g,\n"
13158 " int blocksize,\n"
13159 " const char *uuid,\n"
13160 " const char *device);\n"
13165 #: ../src/guestfs-actions.pod:4452 ../fish/guestfish-actions.pod:3003
13166 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13170 #: ../src/guestfs-actions.pod:4458
13171 msgid "guestfs_mkfifo"
13175 #: ../src/guestfs-actions.pod:4460
13179 " guestfs_mkfifo (guestfs_h *g,\n"
13181 " const char *path);\n"
13186 #: ../src/guestfs-actions.pod:4465
13188 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13189 "is just a convenient wrapper around C<guestfs_mknod>."
13193 #: ../src/guestfs-actions.pod:4475
13194 msgid "guestfs_mkfs"
13198 #: ../src/guestfs-actions.pod:4477
13202 " guestfs_mkfs (guestfs_h *g,\n"
13203 " const char *fstype,\n"
13204 " const char *device);\n"
13209 #: ../src/guestfs-actions.pod:4482 ../fish/guestfish-actions.pod:3019
13211 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13212 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13216 #: ../src/guestfs-actions.pod:4490
13217 msgid "guestfs_mkfs_b"
13221 #: ../src/guestfs-actions.pod:4492
13225 " guestfs_mkfs_b (guestfs_h *g,\n"
13226 " const char *fstype,\n"
13227 " int blocksize,\n"
13228 " const char *device);\n"
13233 #: ../src/guestfs-actions.pod:4498
13235 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13236 "block size of the resulting filesystem. Supported block sizes depend on the "
13237 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13241 #: ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4546 ../fish/guestfish-actions.pod:3032 ../fish/guestfish-actions.pod:3059
13243 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13248 #: ../src/guestfs-actions.pod:4508 ../fish/guestfish-actions.pod:3035
13250 "This function is deprecated. In new code, use the C<mkfs_opts> call "
13255 #: ../src/guestfs-actions.pod:4517
13256 msgid "guestfs_mkfs_opts"
13260 #: ../src/guestfs-actions.pod:4519
13264 " guestfs_mkfs_opts (guestfs_h *g,\n"
13265 " const char *fstype,\n"
13266 " const char *device,\n"
13272 #: ../src/guestfs-actions.pod:4530
13275 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13276 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
13281 #: ../src/guestfs-actions.pod:4533 ../fish/guestfish-actions.pod:3046
13283 "This function creates a filesystem on C<device>. The filesystem type is "
13284 "C<fstype>, for example C<ext3>."
13288 #: ../src/guestfs-actions.pod:4540 ../fish/guestfish-actions.pod:3053
13289 msgid "C<blocksize>"
13293 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3055
13295 "The filesystem block size. Supported block sizes depend on the filesystem "
13296 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
13301 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3062
13302 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
13306 #: ../src/guestfs-actions.pod:4551 ../fish/guestfish-actions.pod:3064
13307 msgid "C<features>"
13311 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3066
13312 msgid "This passes the I<-O> parameter to the external mkfs program."
13316 #: ../src/guestfs-actions.pod:4555 ../fish/guestfish-actions.pod:3068
13318 "For certain filesystem types, this allows extra filesystem features to be "
13319 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
13323 #: ../src/guestfs-actions.pod:4559 ../fish/guestfish-actions.pod:3072
13325 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
13330 #: ../src/guestfs-actions.pod:4566
13331 msgid "(Added in 1.7.19)"
13335 #: ../src/guestfs-actions.pod:4568
13336 msgid "guestfs_mkfs_opts_va"
13340 #: ../src/guestfs-actions.pod:4570
13344 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
13345 " const char *fstype,\n"
13346 " const char *device,\n"
13347 " va_list args);\n"
13352 #: ../src/guestfs-actions.pod:4576
13353 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
13357 #: ../src/guestfs-actions.pod:4580
13358 msgid "guestfs_mkfs_opts_argv"
13362 #: ../src/guestfs-actions.pod:4582
13366 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
13367 " const char *fstype,\n"
13368 " const char *device,\n"
13369 " const struct guestfs_mkfs_opts_argv *optargs);\n"
13374 #: ../src/guestfs-actions.pod:4588
13375 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
13379 #: ../src/guestfs-actions.pod:4592
13380 msgid "guestfs_mkmountpoint"
13384 #: ../src/guestfs-actions.pod:4594
13388 " guestfs_mkmountpoint (guestfs_h *g,\n"
13389 " const char *exemptpath);\n"
13394 #: ../src/guestfs-actions.pod:4598
13396 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
13397 "that can be used to create extra mountpoints before mounting the first "
13402 #: ../src/guestfs-actions.pod:4602 ../fish/guestfish-actions.pod:3087
13404 "These calls are I<only> necessary in some very limited circumstances, mainly "
13405 "the case where you want to mount a mix of unrelated and/or read-only "
13406 "filesystems together."
13410 #: ../src/guestfs-actions.pod:4606 ../fish/guestfish-actions.pod:3091
13412 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
13413 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
13414 "inside that. You can unpack this as follows in guestfish:"
13418 #: ../src/guestfs-actions.pod:4611 ../fish/guestfish-actions.pod:3096
13421 " add-ro Fedora-11-i686-Live.iso\n"
13423 " mkmountpoint /cd\n"
13424 " mkmountpoint /sqsh\n"
13425 " mkmountpoint /ext3fs\n"
13426 " mount /dev/sda /cd\n"
13427 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
13428 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
13433 #: ../src/guestfs-actions.pod:4620 ../fish/guestfish-actions.pod:3105
13434 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
13438 #: ../src/guestfs-actions.pod:4622
13440 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
13441 "may get unexpected errors if you try to mix these calls. It is safest to "
13442 "manually unmount filesystems and remove mountpoints after use."
13446 #: ../src/guestfs-actions.pod:4626
13448 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
13449 "first, so for this to work for manual mountpoints, you must ensure that the "
13450 "innermost mountpoints have the longest pathnames, as in the example code "
13455 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3116
13456 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
13460 #: ../src/guestfs-actions.pod:4633
13462 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
13463 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
13464 "can also trigger these issues."
13468 #: ../src/guestfs-actions.pod:4639 ../src/guestfs-actions.pod:4953 ../src/guestfs-actions.pod:5863
13469 msgid "(Added in 1.0.62)"
13473 #: ../src/guestfs-actions.pod:4641
13474 msgid "guestfs_mknod"
13478 #: ../src/guestfs-actions.pod:4643
13482 " guestfs_mknod (guestfs_h *g,\n"
13486 " const char *path);\n"
13491 #: ../src/guestfs-actions.pod:4650 ../fish/guestfish-actions.pod:3126
13493 "This call creates block or character special devices, or named pipes "
13498 #: ../src/guestfs-actions.pod:4653 ../fish/guestfish-actions.pod:3129
13500 "The C<mode> parameter should be the mode, using the standard constants. "
13501 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
13502 "used when creating block and character special devices."
13506 #: ../src/guestfs-actions.pod:4658
13508 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
13509 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
13510 "regular file). These constants are available in the standard Linux header "
13511 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
13512 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
13513 "the appropriate constant for you."
13517 #: ../src/guestfs-actions.pod:4672
13518 msgid "guestfs_mknod_b"
13522 #: ../src/guestfs-actions.pod:4674
13526 " guestfs_mknod_b (guestfs_h *g,\n"
13530 " const char *path);\n"
13535 #: ../src/guestfs-actions.pod:4681
13537 "This call creates a block device node called C<path> with mode C<mode> and "
13538 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13539 "wrapper around C<guestfs_mknod>."
13543 #: ../src/guestfs-actions.pod:4691
13544 msgid "guestfs_mknod_c"
13548 #: ../src/guestfs-actions.pod:4693
13552 " guestfs_mknod_c (guestfs_h *g,\n"
13556 " const char *path);\n"
13561 #: ../src/guestfs-actions.pod:4700
13563 "This call creates a char device node called C<path> with mode C<mode> and "
13564 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
13565 "wrapper around C<guestfs_mknod>."
13569 #: ../src/guestfs-actions.pod:4710
13570 msgid "guestfs_mkswap"
13574 #: ../src/guestfs-actions.pod:4712
13578 " guestfs_mkswap (guestfs_h *g,\n"
13579 " const char *device);\n"
13584 #: ../src/guestfs-actions.pod:4716 ../fish/guestfish-actions.pod:3168
13585 msgid "Create a swap partition on C<device>."
13589 #: ../src/guestfs-actions.pod:4722
13590 msgid "guestfs_mkswap_L"
13594 #: ../src/guestfs-actions.pod:4724
13598 " guestfs_mkswap_L (guestfs_h *g,\n"
13599 " const char *label,\n"
13600 " const char *device);\n"
13605 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3174
13606 msgid "Create a swap partition on C<device> with label C<label>."
13610 #: ../src/guestfs-actions.pod:4731 ../fish/guestfish-actions.pod:3176
13612 "Note that you cannot attach a swap label to a block device "
13613 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
13614 "the kernel or swap tools."
13618 #: ../src/guestfs-actions.pod:4739
13619 msgid "guestfs_mkswap_U"
13623 #: ../src/guestfs-actions.pod:4741
13627 " guestfs_mkswap_U (guestfs_h *g,\n"
13628 " const char *uuid,\n"
13629 " const char *device);\n"
13634 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3184
13635 msgid "Create a swap partition on C<device> with UUID C<uuid>."
13639 #: ../src/guestfs-actions.pod:4752
13640 msgid "guestfs_mkswap_file"
13644 #: ../src/guestfs-actions.pod:4754
13648 " guestfs_mkswap_file (guestfs_h *g,\n"
13649 " const char *path);\n"
13654 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3190
13655 msgid "Create a swap file."
13659 #: ../src/guestfs-actions.pod:4760
13661 "This command just writes a swap file signature to an existing file. To "
13662 "create the file itself, use something like C<guestfs_fallocate>."
13666 #: ../src/guestfs-actions.pod:4767
13667 msgid "guestfs_modprobe"
13671 #: ../src/guestfs-actions.pod:4769
13675 " guestfs_modprobe (guestfs_h *g,\n"
13676 " const char *modulename);\n"
13681 #: ../src/guestfs-actions.pod:4773 ../fish/guestfish-actions.pod:3199
13682 msgid "This loads a kernel module in the appliance."
13686 #: ../src/guestfs-actions.pod:4775 ../fish/guestfish-actions.pod:3201
13688 "The kernel module must have been whitelisted when libguestfs was built (see "
13689 "C<appliance/kmod.whitelist.in> in the source)."
13693 #: ../src/guestfs-actions.pod:4782
13694 msgid "guestfs_mount"
13698 #: ../src/guestfs-actions.pod:4784
13702 " guestfs_mount (guestfs_h *g,\n"
13703 " const char *device,\n"
13704 " const char *mountpoint);\n"
13709 #: ../src/guestfs-actions.pod:4789 ../fish/guestfish-actions.pod:3208
13711 "Mount a guest disk at a position in the filesystem. Block devices are named "
13712 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
13713 "those block devices contain partitions, they will have the usual names "
13714 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
13718 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3214
13720 "The rules are the same as for L<mount(2)>: A filesystem must first be "
13721 "mounted on C</> before others can be mounted. Other filesystems can only be "
13722 "mounted on directories which already exist."
13726 #: ../src/guestfs-actions.pod:4800 ../fish/guestfish-actions.pod:3219
13728 "The mounted filesystem is writable, if we have sufficient permissions on the "
13729 "underlying device."
13733 #: ../src/guestfs-actions.pod:4803
13735 "B<Important note:> When you use this call, the filesystem options C<sync> "
13736 "and C<noatime> are set implicitly. This was originally done because we "
13737 "thought it would improve reliability, but it turns out that I<-o sync> has a "
13738 "very large negative performance impact and negligible effect on "
13739 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
13740 "in any code that needs performance, and instead use C<guestfs_mount_options> "
13741 "(use an empty string for the first parameter if you don't want any options)."
13745 #: ../src/guestfs-actions.pod:4815 ../fish/guestfish-actions.pod:3232
13747 "This function is deprecated. In new code, use the C<mount_options> call "
13752 #: ../src/guestfs-actions.pod:4824
13753 msgid "guestfs_mount_9p"
13757 #: ../src/guestfs-actions.pod:4826
13761 " guestfs_mount_9p (guestfs_h *g,\n"
13762 " const char *mounttag,\n"
13763 " const char *mountpoint,\n"
13769 #: ../src/guestfs-actions.pod:4837
13772 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
13777 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3243
13779 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
13784 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3246
13786 "If required, C<trans=virtio> will be automatically added to the options. "
13787 "Any other options required can be passed in the optional C<options> "
13792 #: ../src/guestfs-actions.pod:4848
13793 msgid "guestfs_mount_9p_va"
13797 #: ../src/guestfs-actions.pod:4850
13801 " guestfs_mount_9p_va (guestfs_h *g,\n"
13802 " const char *mounttag,\n"
13803 " const char *mountpoint,\n"
13804 " va_list args);\n"
13809 #: ../src/guestfs-actions.pod:4856
13810 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
13814 #: ../src/guestfs-actions.pod:4860
13815 msgid "guestfs_mount_9p_argv"
13819 #: ../src/guestfs-actions.pod:4862
13823 " guestfs_mount_9p_argv (guestfs_h *g,\n"
13824 " const char *mounttag,\n"
13825 " const char *mountpoint,\n"
13826 " const struct guestfs_mount_9p_argv *optargs);\n"
13831 #: ../src/guestfs-actions.pod:4868
13832 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
13836 #: ../src/guestfs-actions.pod:4872
13837 msgid "guestfs_mount_loop"
13841 #: ../src/guestfs-actions.pod:4874
13845 " guestfs_mount_loop (guestfs_h *g,\n"
13846 " const char *file,\n"
13847 " const char *mountpoint);\n"
13852 #: ../src/guestfs-actions.pod:4879 ../fish/guestfish-actions.pod:3256
13854 "This command lets you mount C<file> (a filesystem image in a file) on a "
13855 "mount point. It is entirely equivalent to the command C<mount -o loop file "
13860 #: ../src/guestfs-actions.pod:4887
13861 msgid "guestfs_mount_options"
13865 #: ../src/guestfs-actions.pod:4889
13869 " guestfs_mount_options (guestfs_h *g,\n"
13870 " const char *options,\n"
13871 " const char *device,\n"
13872 " const char *mountpoint);\n"
13877 #: ../src/guestfs-actions.pod:4895
13879 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13880 "the mount options as for the L<mount(8)> I<-o> flag."
13884 #: ../src/guestfs-actions.pod:4899 ../fish/guestfish-actions.pod:3268
13886 "If the C<options> parameter is an empty string, then no options are passed "
13887 "(all options default to whatever the filesystem uses)."
13891 #: ../src/guestfs-actions.pod:4905 ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4936
13892 msgid "(Added in 1.0.10)"
13896 #: ../src/guestfs-actions.pod:4907
13897 msgid "guestfs_mount_ro"
13901 #: ../src/guestfs-actions.pod:4909
13905 " guestfs_mount_ro (guestfs_h *g,\n"
13906 " const char *device,\n"
13907 " const char *mountpoint);\n"
13912 #: ../src/guestfs-actions.pod:4914
13914 "This is the same as the C<guestfs_mount> command, but it mounts the "
13915 "filesystem with the read-only (I<-o ro>) flag."
13919 #: ../src/guestfs-actions.pod:4921
13920 msgid "guestfs_mount_vfs"
13924 #: ../src/guestfs-actions.pod:4923
13928 " guestfs_mount_vfs (guestfs_h *g,\n"
13929 " const char *options,\n"
13930 " const char *vfstype,\n"
13931 " const char *device,\n"
13932 " const char *mountpoint);\n"
13937 #: ../src/guestfs-actions.pod:4930
13939 "This is the same as the C<guestfs_mount> command, but it allows you to set "
13940 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
13945 #: ../src/guestfs-actions.pod:4938
13946 msgid "guestfs_mountpoints"
13950 #: ../src/guestfs-actions.pod:4940
13954 " guestfs_mountpoints (guestfs_h *g);\n"
13959 #: ../src/guestfs-actions.pod:4943
13961 "This call is similar to C<guestfs_mounts>. That call returns a list of "
13962 "devices. This one returns a hash table (map) of device name to directory "
13963 "where the device is mounted."
13967 #: ../src/guestfs-actions.pod:4955
13968 msgid "guestfs_mounts"
13972 #: ../src/guestfs-actions.pod:4957
13976 " guestfs_mounts (guestfs_h *g);\n"
13981 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3299
13983 "This returns the list of currently mounted filesystems. It returns the list "
13984 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
13988 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3302
13989 msgid "Some internal mounts are not shown."
13993 #: ../src/guestfs-actions.pod:4965
13994 msgid "See also: C<guestfs_mountpoints>"
13998 #: ../src/guestfs-actions.pod:4973
14003 #: ../src/guestfs-actions.pod:4975
14007 " guestfs_mv (guestfs_h *g,\n"
14008 " const char *src,\n"
14009 " const char *dest);\n"
14014 #: ../src/guestfs-actions.pod:4980 ../fish/guestfish-actions.pod:3310
14016 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14017 "destination filename or destination directory."
14021 #: ../src/guestfs-actions.pod:4987
14022 msgid "guestfs_ntfs_3g_probe"
14026 #: ../src/guestfs-actions.pod:4989
14030 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14032 " const char *device);\n"
14037 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3317
14039 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14040 "C<device> for mountability. (Not all NTFS volumes can be mounted "
14041 "read-write, and some cannot be mounted at all)."
14045 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3321
14047 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14048 "can be mounted read-write. Set it to false if you want to test if the "
14049 "volume can be mounted read-only."
14053 #: ../src/guestfs-actions.pod:5002 ../fish/guestfish-actions.pod:3325
14055 "The return value is an integer which C<0> if the operation would succeed, or "
14056 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14060 #: ../src/guestfs-actions.pod:5008
14061 msgid "(Added in 1.0.43)"
14065 #: ../src/guestfs-actions.pod:5010
14066 msgid "guestfs_ntfsresize"
14070 #: ../src/guestfs-actions.pod:5012
14074 " guestfs_ntfsresize (guestfs_h *g,\n"
14075 " const char *device);\n"
14080 #: ../src/guestfs-actions.pod:5016 ../fish/guestfish-actions.pod:3333
14082 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14083 "size of the underlying device. See also L<ntfsresize(8)>."
14087 #: ../src/guestfs-actions.pod:5024
14088 msgid "guestfs_ntfsresize_size"
14092 #: ../src/guestfs-actions.pod:5026
14096 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14097 " const char *device,\n"
14098 " int64_t size);\n"
14103 #: ../src/guestfs-actions.pod:5031
14105 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14106 "to specify the new size (in bytes) explicitly."
14110 #: ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5472 ../src/guestfs-actions.pod:5545 ../src/guestfs-actions.pod:5811 ../src/guestfs-actions.pod:7417
14111 msgid "(Added in 1.3.14)"
14115 #: ../src/guestfs-actions.pod:5038
14116 msgid "guestfs_part_add"
14120 #: ../src/guestfs-actions.pod:5040
14124 " guestfs_part_add (guestfs_h *g,\n"
14125 " const char *device,\n"
14126 " const char *prlogex,\n"
14127 " int64_t startsect,\n"
14128 " int64_t endsect);\n"
14133 #: ../src/guestfs-actions.pod:5047
14135 "This command adds a partition to C<device>. If there is no partition table "
14136 "on the device, call C<guestfs_part_init> first."
14140 #: ../src/guestfs-actions.pod:5050 ../fish/guestfish-actions.pod:3351
14142 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14143 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14144 "C<logical>) and C<e> (or C<extended>) partition types."
14148 #: ../src/guestfs-actions.pod:5055 ../fish/guestfish-actions.pod:3356
14150 "C<startsect> and C<endsect> are the start and end of the partition in "
14151 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14152 "from the end of the disk (C<-1> is the last sector)."
14156 #: ../src/guestfs-actions.pod:5059
14158 "Creating a partition which covers the whole disk is not so easy. Use "
14159 "C<guestfs_part_disk> to do that."
14163 #: ../src/guestfs-actions.pod:5064 ../src/guestfs-actions.pod:5102 ../src/guestfs-actions.pod:5155 ../src/guestfs-actions.pod:5233 ../src/guestfs-actions.pod:5271 ../src/guestfs-actions.pod:5290 ../src/guestfs-actions.pod:5330
14164 msgid "(Added in 1.0.78)"
14168 #: ../src/guestfs-actions.pod:5066
14169 msgid "guestfs_part_del"
14173 #: ../src/guestfs-actions.pod:5068
14177 " guestfs_part_del (guestfs_h *g,\n"
14178 " const char *device,\n"
14184 #: ../src/guestfs-actions.pod:5073 ../fish/guestfish-actions.pod:3367
14185 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14189 #: ../src/guestfs-actions.pod:5075 ../fish/guestfish-actions.pod:3369
14191 "Note that in the case of MBR partitioning, deleting an extended partition "
14192 "also deletes any logical partitions it contains."
14196 #: ../src/guestfs-actions.pod:5083
14197 msgid "guestfs_part_disk"
14201 #: ../src/guestfs-actions.pod:5085
14205 " guestfs_part_disk (guestfs_h *g,\n"
14206 " const char *device,\n"
14207 " const char *parttype);\n"
14212 #: ../src/guestfs-actions.pod:5090
14214 "This command is simply a combination of C<guestfs_part_init> followed by "
14215 "C<guestfs_part_add> to create a single primary partition covering the whole "
14220 #: ../src/guestfs-actions.pod:5094
14222 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14223 "possible values are described in C<guestfs_part_init>."
14227 #: ../src/guestfs-actions.pod:5104
14228 msgid "guestfs_part_get_bootable"
14232 #: ../src/guestfs-actions.pod:5106
14236 " guestfs_part_get_bootable (guestfs_h *g,\n"
14237 " const char *device,\n"
14243 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3391
14245 "This command returns true if the partition C<partnum> on C<device> has the "
14246 "bootable flag set."
14250 #: ../src/guestfs-actions.pod:5114
14251 msgid "See also C<guestfs_part_set_bootable>."
14255 #: ../src/guestfs-actions.pod:5120
14256 msgid "guestfs_part_get_mbr_id"
14260 #: ../src/guestfs-actions.pod:5122
14264 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14265 " const char *device,\n"
14271 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3400
14273 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14274 "partition C<partnum>."
14278 #: ../src/guestfs-actions.pod:5130 ../src/guestfs-actions.pod:5306
14280 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
14281 "undefined results for other partition table types (see "
14282 "C<guestfs_part_get_parttype>)."
14286 #: ../src/guestfs-actions.pod:5138
14287 msgid "guestfs_part_get_parttype"
14291 #: ../src/guestfs-actions.pod:5140
14295 " guestfs_part_get_parttype (guestfs_h *g,\n"
14296 " const char *device);\n"
14301 #: ../src/guestfs-actions.pod:5144 ../fish/guestfish-actions.pod:3411
14303 "This command examines the partition table on C<device> and returns the "
14304 "partition table type (format) being used."
14308 #: ../src/guestfs-actions.pod:5147
14310 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
14311 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
14312 "possible, although unusual. See C<guestfs_part_init> for a full list."
14316 #: ../src/guestfs-actions.pod:5157
14317 msgid "guestfs_part_init"
14321 #: ../src/guestfs-actions.pod:5159
14325 " guestfs_part_init (guestfs_h *g,\n"
14326 " const char *device,\n"
14327 " const char *parttype);\n"
14332 #: ../src/guestfs-actions.pod:5164 ../fish/guestfish-actions.pod:3423
14334 "This creates an empty partition table on C<device> of one of the partition "
14335 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
14336 "(for large disks)."
14340 #: ../src/guestfs-actions.pod:5168
14342 "Initially there are no partitions. Following this, you should call "
14343 "C<guestfs_part_add> for each partition required."
14347 #: ../src/guestfs-actions.pod:5171 ../fish/guestfish-actions.pod:3430
14348 msgid "Possible values for C<parttype> are:"
14352 #: ../src/guestfs-actions.pod:5175 ../fish/guestfish-actions.pod:3434
14353 msgid "B<efi> | B<gpt>"
14357 #: ../src/guestfs-actions.pod:5177 ../fish/guestfish-actions.pod:3436
14358 msgid "Intel EFI / GPT partition table."
14362 #: ../src/guestfs-actions.pod:5179 ../fish/guestfish-actions.pod:3438
14364 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
14365 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
14366 "the C<mbr> format."
14370 #: ../src/guestfs-actions.pod:5183 ../fish/guestfish-actions.pod:3442
14371 msgid "B<mbr> | B<msdos>"
14375 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3444
14377 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
14378 "Windows. This partition type will B<only> work for device sizes up to 2 "
14379 "TB. For large disks we recommend using C<gpt>."
14383 #: ../src/guestfs-actions.pod:5192 ../fish/guestfish-actions.pod:3451
14384 msgid "Other partition table types that may work but are not supported include:"
14388 #: ../src/guestfs-actions.pod:5197 ../fish/guestfish-actions.pod:3456
14393 #: ../src/guestfs-actions.pod:5199 ../fish/guestfish-actions.pod:3458
14394 msgid "AIX disk labels."
14398 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3460
14399 msgid "B<amiga> | B<rdb>"
14403 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3462
14404 msgid "Amiga \"Rigid Disk Block\" format."
14408 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3464
14413 #: ../src/guestfs-actions.pod:5207 ../fish/guestfish-actions.pod:3466
14414 msgid "BSD disk labels."
14418 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3468
14423 #: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:3470
14424 msgid "DASD, used on IBM mainframes."
14428 #: ../src/guestfs-actions.pod:5213 ../fish/guestfish-actions.pod:3472
14433 #: ../src/guestfs-actions.pod:5215 ../fish/guestfish-actions.pod:3474
14434 msgid "MIPS/SGI volumes."
14438 #: ../src/guestfs-actions.pod:5217 ../fish/guestfish-actions.pod:3476
14443 #: ../src/guestfs-actions.pod:5219 ../fish/guestfish-actions.pod:3478
14444 msgid "Old Mac partition format. Modern Macs use C<gpt>."
14448 #: ../src/guestfs-actions.pod:5221 ../fish/guestfish-actions.pod:3480
14453 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3482
14454 msgid "NEC PC-98 format, common in Japan apparently."
14458 #: ../src/guestfs-actions.pod:5225 ../fish/guestfish-actions.pod:3484
14463 #: ../src/guestfs-actions.pod:5227 ../fish/guestfish-actions.pod:3486
14464 msgid "Sun disk labels."
14468 #: ../src/guestfs-actions.pod:5235
14469 msgid "guestfs_part_list"
14473 #: ../src/guestfs-actions.pod:5237
14476 " struct guestfs_partition_list *\n"
14477 " guestfs_part_list (guestfs_h *g,\n"
14478 " const char *device);\n"
14483 #: ../src/guestfs-actions.pod:5241 ../fish/guestfish-actions.pod:3494
14485 "This command parses the partition table on C<device> and returns the list of "
14486 "partitions found."
14490 #: ../src/guestfs-actions.pod:5244 ../fish/guestfish-actions.pod:3497
14491 msgid "The fields in the returned structure are:"
14495 #: ../src/guestfs-actions.pod:5248 ../fish/guestfish-actions.pod:3501
14496 msgid "B<part_num>"
14500 #: ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3503
14501 msgid "Partition number, counting from 1."
14505 #: ../src/guestfs-actions.pod:5252 ../fish/guestfish-actions.pod:3505
14506 msgid "B<part_start>"
14510 #: ../src/guestfs-actions.pod:5254
14512 "Start of the partition I<in bytes>. To get sectors you have to divide by "
14513 "the device's sector size, see C<guestfs_blockdev_getss>."
14517 #: ../src/guestfs-actions.pod:5257 ../fish/guestfish-actions.pod:3510
14518 msgid "B<part_end>"
14522 #: ../src/guestfs-actions.pod:5259 ../fish/guestfish-actions.pod:3512
14523 msgid "End of the partition in bytes."
14527 #: ../src/guestfs-actions.pod:5261 ../fish/guestfish-actions.pod:3514
14528 msgid "B<part_size>"
14532 #: ../src/guestfs-actions.pod:5263 ../fish/guestfish-actions.pod:3516
14533 msgid "Size of the partition in bytes."
14537 #: ../src/guestfs-actions.pod:5267
14539 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
14540 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
14545 #: ../src/guestfs-actions.pod:5273
14546 msgid "guestfs_part_set_bootable"
14550 #: ../src/guestfs-actions.pod:5275
14554 " guestfs_part_set_bootable (guestfs_h *g,\n"
14555 " const char *device,\n"
14557 " int bootable);\n"
14562 #: ../src/guestfs-actions.pod:5281 ../fish/guestfish-actions.pod:3524
14564 "This sets the bootable flag on partition numbered C<partnum> on device "
14565 "C<device>. Note that partitions are numbered from 1."
14569 #: ../src/guestfs-actions.pod:5284 ../fish/guestfish-actions.pod:3527
14571 "The bootable flag is used by some operating systems (notably Windows) to "
14572 "determine which partition to boot from. It is by no means universally "
14577 #: ../src/guestfs-actions.pod:5292
14578 msgid "guestfs_part_set_mbr_id"
14582 #: ../src/guestfs-actions.pod:5294
14586 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
14587 " const char *device,\n"
14594 #: ../src/guestfs-actions.pod:5300 ../fish/guestfish-actions.pod:3535
14596 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
14597 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
14598 "documentation are in fact hexadecimal numbers, but usually documented "
14599 "without any leading \"0x\" which might be confusing."
14603 #: ../src/guestfs-actions.pod:5314
14604 msgid "guestfs_part_set_name"
14608 #: ../src/guestfs-actions.pod:5316
14612 " guestfs_part_set_name (guestfs_h *g,\n"
14613 " const char *device,\n"
14615 " const char *name);\n"
14620 #: ../src/guestfs-actions.pod:5322 ../fish/guestfish-actions.pod:3549
14622 "This sets the partition name on partition numbered C<partnum> on device "
14623 "C<device>. Note that partitions are numbered from 1."
14627 #: ../src/guestfs-actions.pod:5325 ../fish/guestfish-actions.pod:3552
14629 "The partition name can only be set on certain types of partition table. "
14630 "This works on C<gpt> but not on C<mbr> partitions."
14634 #: ../src/guestfs-actions.pod:5332
14635 msgid "guestfs_part_to_dev"
14639 #: ../src/guestfs-actions.pod:5334
14643 " guestfs_part_to_dev (guestfs_h *g,\n"
14644 " const char *partition);\n"
14649 #: ../src/guestfs-actions.pod:5338 ../fish/guestfish-actions.pod:3559
14651 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
14652 "partition number, returning the device name (eg. \"/dev/sdb\")."
14656 #: ../src/guestfs-actions.pod:5342
14658 "The named partition must exist, for example as a string returned from "
14659 "C<guestfs_list_partitions>."
14663 #: ../src/guestfs-actions.pod:5350
14664 msgid "guestfs_ping_daemon"
14668 #: ../src/guestfs-actions.pod:5352
14672 " guestfs_ping_daemon (guestfs_h *g);\n"
14677 #: ../src/guestfs-actions.pod:5355 ../fish/guestfish-actions.pod:3570
14679 "This is a test probe into the guestfs daemon running inside the qemu "
14680 "subprocess. Calling this function checks that the daemon responds to the "
14681 "ping message, without affecting the daemon or attached block device(s) in "
14686 #: ../src/guestfs-actions.pod:5364
14687 msgid "guestfs_pread"
14691 #: ../src/guestfs-actions.pod:5366
14695 " guestfs_pread (guestfs_h *g,\n"
14696 " const char *path,\n"
14698 " int64_t offset,\n"
14699 " size_t *size_r);\n"
14704 #: ../src/guestfs-actions.pod:5373 ../fish/guestfish-actions.pod:3579
14706 "This command lets you read part of a file. It reads C<count> bytes of the "
14707 "file, starting at C<offset>, from file C<path>."
14711 #: ../src/guestfs-actions.pod:5376 ../src/guestfs-actions.pod:5402 ../fish/guestfish-actions.pod:3582 ../fish/guestfish-actions.pod:3597
14713 "This may read fewer bytes than requested. For further details see the "
14714 "L<pread(2)> system call."
14718 #: ../src/guestfs-actions.pod:5379
14719 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
14723 #: ../src/guestfs-actions.pod:5390
14724 msgid "guestfs_pread_device"
14728 #: ../src/guestfs-actions.pod:5392
14732 " guestfs_pread_device (guestfs_h *g,\n"
14733 " const char *device,\n"
14735 " int64_t offset,\n"
14736 " size_t *size_r);\n"
14741 #: ../src/guestfs-actions.pod:5399 ../fish/guestfish-actions.pod:3594
14743 "This command lets you read part of a file. It reads C<count> bytes of "
14744 "C<device>, starting at C<offset>."
14748 #: ../src/guestfs-actions.pod:5405
14749 msgid "See also C<guestfs_pread>."
14753 #: ../src/guestfs-actions.pod:5414
14754 msgid "(Added in 1.5.21)"
14758 #: ../src/guestfs-actions.pod:5416
14759 msgid "guestfs_pvcreate"
14763 #: ../src/guestfs-actions.pod:5418
14767 " guestfs_pvcreate (guestfs_h *g,\n"
14768 " const char *device);\n"
14773 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3609
14775 "This creates an LVM physical volume on the named C<device>, where C<device> "
14776 "should usually be a partition name such as C</dev/sda1>."
14780 #: ../src/guestfs-actions.pod:5430
14781 msgid "guestfs_pvremove"
14785 #: ../src/guestfs-actions.pod:5432
14789 " guestfs_pvremove (guestfs_h *g,\n"
14790 " const char *device);\n"
14795 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3617
14797 "This wipes a physical volume C<device> so that LVM will no longer recognise "
14802 #: ../src/guestfs-actions.pod:5439 ../fish/guestfish-actions.pod:3620
14804 "The implementation uses the C<pvremove> command which refuses to wipe "
14805 "physical volumes that contain any volume groups, so you have to remove those "
14810 #: ../src/guestfs-actions.pod:5447
14811 msgid "guestfs_pvresize"
14815 #: ../src/guestfs-actions.pod:5449
14819 " guestfs_pvresize (guestfs_h *g,\n"
14820 " const char *device);\n"
14825 #: ../src/guestfs-actions.pod:5453 ../fish/guestfish-actions.pod:3628
14827 "This resizes (expands or shrinks) an existing LVM physical volume to match "
14828 "the new size of the underlying device."
14832 #: ../src/guestfs-actions.pod:5460
14833 msgid "guestfs_pvresize_size"
14837 #: ../src/guestfs-actions.pod:5462
14841 " guestfs_pvresize_size (guestfs_h *g,\n"
14842 " const char *device,\n"
14843 " int64_t size);\n"
14848 #: ../src/guestfs-actions.pod:5467
14850 "This command is the same as C<guestfs_pvresize> except that it allows you to "
14851 "specify the new size (in bytes) explicitly."
14855 #: ../src/guestfs-actions.pod:5474
14856 msgid "guestfs_pvs"
14860 #: ../src/guestfs-actions.pod:5476
14864 " guestfs_pvs (guestfs_h *g);\n"
14869 #: ../src/guestfs-actions.pod:5479 ../fish/guestfish-actions.pod:3642
14871 "List all the physical volumes detected. This is the equivalent of the "
14872 "L<pvs(8)> command."
14876 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3645
14878 "This returns a list of just the device names that contain PVs "
14879 "(eg. C</dev/sda2>)."
14883 #: ../src/guestfs-actions.pod:5485
14884 msgid "See also C<guestfs_pvs_full>."
14888 #: ../src/guestfs-actions.pod:5493
14889 msgid "guestfs_pvs_full"
14893 #: ../src/guestfs-actions.pod:5495
14896 " struct guestfs_lvm_pv_list *\n"
14897 " guestfs_pvs_full (guestfs_h *g);\n"
14902 #: ../src/guestfs-actions.pod:5498 ../fish/guestfish-actions.pod:3654
14904 "List all the physical volumes detected. This is the equivalent of the "
14905 "L<pvs(8)> command. The \"full\" version includes all fields."
14909 #: ../src/guestfs-actions.pod:5501
14911 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
14912 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
14917 #: ../src/guestfs-actions.pod:5507
14918 msgid "guestfs_pvuuid"
14922 #: ../src/guestfs-actions.pod:5509
14926 " guestfs_pvuuid (guestfs_h *g,\n"
14927 " const char *device);\n"
14932 #: ../src/guestfs-actions.pod:5513 ../fish/guestfish-actions.pod:3661
14933 msgid "This command returns the UUID of the LVM PV C<device>."
14937 #: ../src/guestfs-actions.pod:5520
14938 msgid "guestfs_pwrite"
14942 #: ../src/guestfs-actions.pod:5522
14946 " guestfs_pwrite (guestfs_h *g,\n"
14947 " const char *path,\n"
14948 " const char *content,\n"
14949 " size_t content_size,\n"
14950 " int64_t offset);\n"
14955 #: ../src/guestfs-actions.pod:5529 ../fish/guestfish-actions.pod:3667
14957 "This command writes to part of a file. It writes the data buffer C<content> "
14958 "to the file C<path> starting at offset C<offset>."
14962 #: ../src/guestfs-actions.pod:5532 ../fish/guestfish-actions.pod:3670
14964 "This command implements the L<pwrite(2)> system call, and like that system "
14965 "call it may not write the full data requested. The return value is the "
14966 "number of bytes that were actually written to the file. This could even be "
14967 "0, although short writes are unlikely for regular files in ordinary "
14972 #: ../src/guestfs-actions.pod:5538
14973 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
14977 #: ../src/guestfs-actions.pod:5547
14978 msgid "guestfs_pwrite_device"
14982 #: ../src/guestfs-actions.pod:5549
14986 " guestfs_pwrite_device (guestfs_h *g,\n"
14987 " const char *device,\n"
14988 " const char *content,\n"
14989 " size_t content_size,\n"
14990 " int64_t offset);\n"
14995 #: ../src/guestfs-actions.pod:5556 ../fish/guestfish-actions.pod:3685
14997 "This command writes to part of a device. It writes the data buffer "
14998 "C<content> to C<device> starting at offset C<offset>."
15002 #: ../src/guestfs-actions.pod:5559 ../fish/guestfish-actions.pod:3688
15004 "This command implements the L<pwrite(2)> system call, and like that system "
15005 "call it may not write the full data requested (although short writes to disk "
15006 "devices and partitions are probably impossible with standard Linux kernels)."
15010 #: ../src/guestfs-actions.pod:5564
15011 msgid "See also C<guestfs_pwrite>."
15015 #: ../src/guestfs-actions.pod:5571
15016 msgid "(Added in 1.5.20)"
15020 #: ../src/guestfs-actions.pod:5573
15021 msgid "guestfs_read_file"
15025 #: ../src/guestfs-actions.pod:5575
15029 " guestfs_read_file (guestfs_h *g,\n"
15030 " const char *path,\n"
15031 " size_t *size_r);\n"
15036 #: ../src/guestfs-actions.pod:5580 ../fish/guestfish-actions.pod:3702
15037 msgid "This calls returns the contents of the file C<path> as a buffer."
15041 #: ../src/guestfs-actions.pod:5583
15043 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15044 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15045 "function is limited in the total size of file that can be handled."
15049 #: ../src/guestfs-actions.pod:5595
15050 msgid "(Added in 1.0.63)"
15054 #: ../src/guestfs-actions.pod:5597
15055 msgid "guestfs_read_lines"
15059 #: ../src/guestfs-actions.pod:5599
15063 " guestfs_read_lines (guestfs_h *g,\n"
15064 " const char *path);\n"
15069 #: ../src/guestfs-actions.pod:5605 ../fish/guestfish-actions.pod:3719
15071 "The file contents are returned as a list of lines. Trailing C<LF> and "
15072 "C<CRLF> character sequences are I<not> returned."
15076 #: ../src/guestfs-actions.pod:5608
15078 "Note that this function cannot correctly handle binary files (specifically, "
15079 "files containing C<\\0> character which is treated as end of line). For "
15080 "those you need to use the C<guestfs_read_file> function which has a more "
15081 "complex interface."
15085 #: ../src/guestfs-actions.pod:5619
15086 msgid "guestfs_readdir"
15090 #: ../src/guestfs-actions.pod:5621
15093 " struct guestfs_dirent_list *\n"
15094 " guestfs_readdir (guestfs_h *g,\n"
15095 " const char *dir);\n"
15100 #: ../src/guestfs-actions.pod:5625 ../fish/guestfish-actions.pod:3731
15101 msgid "This returns the list of directory entries in directory C<dir>."
15105 #: ../src/guestfs-actions.pod:5627 ../fish/guestfish-actions.pod:3733
15107 "All entries in the directory are returned, including C<.> and C<..>. The "
15108 "entries are I<not> sorted, but returned in the same order as the underlying "
15113 #: ../src/guestfs-actions.pod:5631 ../fish/guestfish-actions.pod:3737
15115 "Also this call returns basic file type information about each file. The "
15116 "C<ftyp> field will contain one of the following characters:"
15120 #: ../src/guestfs-actions.pod:5636 ../fish/guestfish-actions.pod:3742
15125 #: ../src/guestfs-actions.pod:5638 ../fish/guestfish-actions.pod:3744
15126 msgid "Block special"
15130 #: ../src/guestfs-actions.pod:5640 ../fish/guestfish-actions.pod:3746
15135 #: ../src/guestfs-actions.pod:5642 ../fish/guestfish-actions.pod:3748
15136 msgid "Char special"
15140 #: ../src/guestfs-actions.pod:5644 ../fish/guestfish-actions.pod:3750
15145 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3752
15150 #: ../src/guestfs-actions.pod:5648 ../fish/guestfish-actions.pod:3754
15155 #: ../src/guestfs-actions.pod:5650 ../fish/guestfish-actions.pod:3756
15156 msgid "FIFO (named pipe)"
15160 #: ../src/guestfs-actions.pod:5652 ../fish/guestfish-actions.pod:3758
15165 #: ../src/guestfs-actions.pod:5654 ../fish/guestfish-actions.pod:3760
15166 msgid "Symbolic link"
15170 #: ../src/guestfs-actions.pod:5656 ../fish/guestfish-actions.pod:3762
15175 #: ../src/guestfs-actions.pod:5658 ../fish/guestfish-actions.pod:3764
15176 msgid "Regular file"
15180 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3766
15185 #: ../src/guestfs-actions.pod:5662 ../fish/guestfish-actions.pod:3768
15190 #: ../src/guestfs-actions.pod:5664 ../fish/guestfish-actions.pod:3770
15195 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3772
15196 msgid "Unknown file type"
15200 #: ../src/guestfs-actions.pod:5668 ../fish/guestfish-actions.pod:3774
15205 #: ../src/guestfs-actions.pod:5670 ../fish/guestfish-actions.pod:3776
15206 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
15210 #: ../src/guestfs-actions.pod:5675
15212 "This function is primarily intended for use by programs. To get a simple "
15213 "list of names, use C<guestfs_ls>. To get a printable directory for human "
15214 "consumption, use C<guestfs_ll>."
15218 #: ../src/guestfs-actions.pod:5679
15220 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
15221 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
15226 #: ../src/guestfs-actions.pod:5685
15227 msgid "guestfs_readlink"
15231 #: ../src/guestfs-actions.pod:5687
15235 " guestfs_readlink (guestfs_h *g,\n"
15236 " const char *path);\n"
15241 #: ../src/guestfs-actions.pod:5691 ../fish/guestfish-actions.pod:3789
15242 msgid "This command reads the target of a symbolic link."
15246 #: ../src/guestfs-actions.pod:5698
15247 msgid "guestfs_readlinklist"
15251 #: ../src/guestfs-actions.pod:5700
15255 " guestfs_readlinklist (guestfs_h *g,\n"
15256 " const char *path,\n"
15257 " char *const *names);\n"
15262 #: ../src/guestfs-actions.pod:5705 ../fish/guestfish-actions.pod:3795
15264 "This call allows you to do a C<readlink> operation on multiple files, where "
15265 "all files are in the directory C<path>. C<names> is the list of files from "
15270 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3799
15272 "On return you get a list of strings, with a one-to-one correspondence to the "
15273 "C<names> list. Each string is the value of the symbolic link."
15277 #: ../src/guestfs-actions.pod:5713 ../fish/guestfish-actions.pod:3803
15279 "If the C<readlink(2)> operation fails on any name, then the corresponding "
15280 "result string is the empty string C<\"\">. However the whole operation is "
15281 "completed even if there were C<readlink(2)> errors, and so you can call this "
15282 "function with names where you don't know if they are symbolic links already "
15283 "(albeit slightly less efficient)."
15287 #: ../src/guestfs-actions.pod:5720 ../fish/guestfish-actions.pod:3810
15289 "This call is intended for programs that want to efficiently list a directory "
15290 "contents without making many round-trips. Very long directory listings "
15291 "might cause the protocol message size to be exceeded, causing this call to "
15292 "fail. The caller must split up such requests into smaller groups of names."
15296 #: ../src/guestfs-actions.pod:5733
15297 msgid "guestfs_realpath"
15301 #: ../src/guestfs-actions.pod:5735
15305 " guestfs_realpath (guestfs_h *g,\n"
15306 " const char *path);\n"
15311 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3821
15313 "Return the canonicalized absolute pathname of C<path>. The returned path "
15314 "has no C<.>, C<..> or symbolic link path elements."
15318 #: ../src/guestfs-actions.pod:5747
15319 msgid "guestfs_removexattr"
15323 #: ../src/guestfs-actions.pod:5749
15327 " guestfs_removexattr (guestfs_h *g,\n"
15328 " const char *xattr,\n"
15329 " const char *path);\n"
15334 #: ../src/guestfs-actions.pod:5754 ../fish/guestfish-actions.pod:3828
15335 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
15339 #: ../src/guestfs-actions.pod:5757
15340 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
15344 #: ../src/guestfs-actions.pod:5763
15345 msgid "guestfs_resize2fs"
15349 #: ../src/guestfs-actions.pod:5765
15353 " guestfs_resize2fs (guestfs_h *g,\n"
15354 " const char *device);\n"
15359 #: ../src/guestfs-actions.pod:5769 ../fish/guestfish-actions.pod:3837
15361 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
15362 "underlying device."
15366 #: ../src/guestfs-actions.pod:5772
15368 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
15369 "C<device> before calling this command. For unknown reasons C<resize2fs> "
15370 "sometimes gives an error about this and sometimes not. In any case, it is "
15371 "always safe to call C<guestfs_e2fsck_f> before calling this function."
15375 #: ../src/guestfs-actions.pod:5782
15376 msgid "guestfs_resize2fs_M"
15380 #: ../src/guestfs-actions.pod:5784
15384 " guestfs_resize2fs_M (guestfs_h *g,\n"
15385 " const char *device);\n"
15390 #: ../src/guestfs-actions.pod:5788
15392 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
15393 "resized to its minimum size. This works like the I<-M> option to the "
15394 "C<resize2fs> command."
15398 #: ../src/guestfs-actions.pod:5792
15400 "To get the resulting size of the filesystem you should call "
15401 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
15402 "These two numbers, multiplied together, give the resulting size of the "
15403 "minimal filesystem in bytes."
15407 #: ../src/guestfs-actions.pod:5799
15408 msgid "guestfs_resize2fs_size"
15412 #: ../src/guestfs-actions.pod:5801
15416 " guestfs_resize2fs_size (guestfs_h *g,\n"
15417 " const char *device,\n"
15418 " int64_t size);\n"
15423 #: ../src/guestfs-actions.pod:5806
15425 "This command is the same as C<guestfs_resize2fs> except that it allows you "
15426 "to specify the new size (in bytes) explicitly."
15430 #: ../src/guestfs-actions.pod:5813
15435 #: ../src/guestfs-actions.pod:5815
15439 " guestfs_rm (guestfs_h *g,\n"
15440 " const char *path);\n"
15445 #: ../src/guestfs-actions.pod:5819 ../fish/guestfish-actions.pod:3870
15446 msgid "Remove the single file C<path>."
15450 #: ../src/guestfs-actions.pod:5825
15451 msgid "guestfs_rm_rf"
15455 #: ../src/guestfs-actions.pod:5827
15459 " guestfs_rm_rf (guestfs_h *g,\n"
15460 " const char *path);\n"
15465 #: ../src/guestfs-actions.pod:5831 ../fish/guestfish-actions.pod:3876
15467 "Remove the file or directory C<path>, recursively removing the contents if "
15468 "its a directory. This is like the C<rm -rf> shell command."
15472 #: ../src/guestfs-actions.pod:5839
15473 msgid "guestfs_rmdir"
15477 #: ../src/guestfs-actions.pod:5841
15481 " guestfs_rmdir (guestfs_h *g,\n"
15482 " const char *path);\n"
15487 #: ../src/guestfs-actions.pod:5845 ../fish/guestfish-actions.pod:3884
15488 msgid "Remove the single directory C<path>."
15492 #: ../src/guestfs-actions.pod:5851
15493 msgid "guestfs_rmmountpoint"
15497 #: ../src/guestfs-actions.pod:5853
15501 " guestfs_rmmountpoint (guestfs_h *g,\n"
15502 " const char *exemptpath);\n"
15507 #: ../src/guestfs-actions.pod:5857
15509 "This calls removes a mountpoint that was previously created with "
15510 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
15514 #: ../src/guestfs-actions.pod:5865
15515 msgid "guestfs_scrub_device"
15519 #: ../src/guestfs-actions.pod:5867
15523 " guestfs_scrub_device (guestfs_h *g,\n"
15524 " const char *device);\n"
15529 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3898
15531 "This command writes patterns over C<device> to make data retrieval more "
15536 #: ../src/guestfs-actions.pod:5874 ../src/guestfs-actions.pod:5895 ../src/guestfs-actions.pod:5914 ../fish/guestfish-actions.pod:3901 ../fish/guestfish-actions.pod:3916 ../fish/guestfish-actions.pod:3929
15538 "It is an interface to the L<scrub(1)> program. See that manual page for "
15543 #: ../src/guestfs-actions.pod:5882 ../src/guestfs-actions.pod:5900 ../src/guestfs-actions.pod:5919
15544 msgid "(Added in 1.0.52)"
15548 #: ../src/guestfs-actions.pod:5884
15549 msgid "guestfs_scrub_file"
15553 #: ../src/guestfs-actions.pod:5886
15557 " guestfs_scrub_file (guestfs_h *g,\n"
15558 " const char *file);\n"
15563 #: ../src/guestfs-actions.pod:5890 ../fish/guestfish-actions.pod:3911
15565 "This command writes patterns over a file to make data retrieval more "
15570 #: ../src/guestfs-actions.pod:5893 ../fish/guestfish-actions.pod:3914
15571 msgid "The file is I<removed> after scrubbing."
15575 #: ../src/guestfs-actions.pod:5902
15576 msgid "guestfs_scrub_freespace"
15580 #: ../src/guestfs-actions.pod:5904
15584 " guestfs_scrub_freespace (guestfs_h *g,\n"
15585 " const char *dir);\n"
15590 #: ../src/guestfs-actions.pod:5908
15592 "This command creates the directory C<dir> and then fills it with files until "
15593 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
15594 "and deletes them. The intention is to scrub any free space on the partition "
15595 "containing C<dir>."
15599 #: ../src/guestfs-actions.pod:5921
15600 msgid "guestfs_set_append"
15604 #: ../src/guestfs-actions.pod:5923
15608 " guestfs_set_append (guestfs_h *g,\n"
15609 " const char *append);\n"
15614 #: ../src/guestfs-actions.pod:5927 ../fish/guestfish-actions.pod:3938
15616 "This function is used to add additional options to the guest kernel command "
15621 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3941
15623 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
15624 "environment variable."
15628 #: ../src/guestfs-actions.pod:5933 ../fish/guestfish-actions.pod:3944
15630 "Setting C<append> to C<NULL> means I<no> additional options are passed "
15631 "(libguestfs always adds a few of its own)."
15635 #: ../src/guestfs-actions.pod:5940
15636 msgid "guestfs_set_attach_method"
15640 #: ../src/guestfs-actions.pod:5942
15644 " guestfs_set_attach_method (guestfs_h *g,\n"
15645 " const char *attachmethod);\n"
15650 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3953
15652 "Set the method that libguestfs uses to connect to the back end guestfsd "
15653 "daemon. Possible methods are:"
15657 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3960
15659 "Launch an appliance and connect to it. This is the ordinary method and the "
15664 #: ../src/guestfs-actions.pod:5956 ../fish/guestfish-actions.pod:3963
15665 msgid "C<unix:I<path>>"
15669 #: ../src/guestfs-actions.pod:5958 ../fish/guestfish-actions.pod:3965
15670 msgid "Connect to the Unix domain socket I<path>."
15674 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:3967
15676 "This method lets you connect to an existing daemon or (using virtio-serial) "
15677 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
15678 "RUNNING DAEMONS>."
15682 #: ../src/guestfs-actions.pod:5968
15683 msgid "guestfs_set_autosync"
15687 #: ../src/guestfs-actions.pod:5970
15691 " guestfs_set_autosync (guestfs_h *g,\n"
15692 " int autosync);\n"
15697 #: ../src/guestfs-actions.pod:5974 ../fish/guestfish-actions.pod:3979
15699 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
15700 "effort attempt to make filesystems consistent and synchronized when the "
15701 "handle is closed (also if the program exits without closing handles)."
15705 #: ../src/guestfs-actions.pod:5979 ../fish/guestfish-actions.pod:3984
15707 "This is enabled by default (since libguestfs 1.5.24, previously it was "
15708 "disabled by default)."
15712 #: ../src/guestfs-actions.pod:5986
15713 msgid "guestfs_set_direct"
15717 #: ../src/guestfs-actions.pod:5988
15721 " guestfs_set_direct (guestfs_h *g,\n"
15727 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:3993
15729 "If the direct appliance mode flag is enabled, then stdin and stdout are "
15730 "passed directly through to the appliance once it is launched."
15734 #: ../src/guestfs-actions.pod:5996
15736 "One consequence of this is that log messages aren't caught by the library "
15737 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
15742 #: ../src/guestfs-actions.pod:6000 ../fish/guestfish-actions.pod:4001
15743 msgid "You probably don't want to use this unless you know what you are doing."
15747 #: ../src/guestfs-actions.pod:6003 ../fish/guestfish-actions.pod:4004
15748 msgid "The default is disabled."
15752 #: ../src/guestfs-actions.pod:6009
15753 msgid "guestfs_set_e2label"
15757 #: ../src/guestfs-actions.pod:6011
15761 " guestfs_set_e2label (guestfs_h *g,\n"
15762 " const char *device,\n"
15763 " const char *label);\n"
15768 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4010
15770 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
15771 "C<label>. Filesystem labels are limited to 16 characters."
15775 #: ../src/guestfs-actions.pod:6020
15777 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
15778 "the existing label on a filesystem."
15782 #: ../src/guestfs-actions.pod:6027
15783 msgid "guestfs_set_e2uuid"
15787 #: ../src/guestfs-actions.pod:6029
15791 " guestfs_set_e2uuid (guestfs_h *g,\n"
15792 " const char *device,\n"
15793 " const char *uuid);\n"
15798 #: ../src/guestfs-actions.pod:6034 ../fish/guestfish-actions.pod:4021
15800 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
15801 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
15802 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
15806 #: ../src/guestfs-actions.pod:6039
15808 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
15809 "the existing UUID of a filesystem."
15813 #: ../src/guestfs-actions.pod:6046
15814 msgid "guestfs_set_memsize"
15818 #: ../src/guestfs-actions.pod:6048
15822 " guestfs_set_memsize (guestfs_h *g,\n"
15828 #: ../src/guestfs-actions.pod:6052
15830 "This sets the memory size in megabytes allocated to the qemu subprocess. "
15831 "This only has any effect if called before C<guestfs_launch>."
15835 #: ../src/guestfs-actions.pod:6056 ../fish/guestfish-actions.pod:4039
15837 "You can also change this by setting the environment variable "
15838 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
15842 #: ../src/guestfs-actions.pod:6067
15843 msgid "guestfs_set_network"
15847 #: ../src/guestfs-actions.pod:6069
15851 " guestfs_set_network (guestfs_h *g,\n"
15857 #: ../src/guestfs-actions.pod:6073 ../fish/guestfish-actions.pod:4052
15859 "If C<network> is true, then the network is enabled in the libguestfs "
15860 "appliance. The default is false."
15864 #: ../src/guestfs-actions.pod:6076 ../fish/guestfish-actions.pod:4055
15866 "This affects whether commands are able to access the network (see "
15867 "L<guestfs(3)/RUNNING COMMANDS>)."
15871 #: ../src/guestfs-actions.pod:6079
15873 "You must call this before calling C<guestfs_launch>, otherwise it has no "
15878 #: ../src/guestfs-actions.pod:6086
15879 msgid "guestfs_set_path"
15883 #: ../src/guestfs-actions.pod:6088
15887 " guestfs_set_path (guestfs_h *g,\n"
15888 " const char *searchpath);\n"
15893 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4067
15894 msgid "Set the path that libguestfs searches for kernel and initrd.img."
15898 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4069
15900 "The default is C<$libdir/guestfs> unless overridden by setting "
15901 "C<LIBGUESTFS_PATH> environment variable."
15905 #: ../src/guestfs-actions.pod:6097 ../fish/guestfish-actions.pod:4072
15906 msgid "Setting C<path> to C<NULL> restores the default path."
15910 #: ../src/guestfs-actions.pod:6103
15911 msgid "guestfs_set_qemu"
15915 #: ../src/guestfs-actions.pod:6105
15919 " guestfs_set_qemu (guestfs_h *g,\n"
15920 " const char *qemu);\n"
15925 #: ../src/guestfs-actions.pod:6109 ../fish/guestfish-actions.pod:4080
15926 msgid "Set the qemu binary that we will use."
15930 #: ../src/guestfs-actions.pod:6111 ../fish/guestfish-actions.pod:4082
15931 msgid "The default is chosen when the library was compiled by the configure script."
15935 #: ../src/guestfs-actions.pod:6114 ../fish/guestfish-actions.pod:4085
15937 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
15942 #: ../src/guestfs-actions.pod:6117 ../fish/guestfish-actions.pod:4088
15943 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
15947 #: ../src/guestfs-actions.pod:6119 ../fish/guestfish-actions.pod:4090
15949 "Note that you should call this function as early as possible after creating "
15950 "the handle. This is because some pre-launch operations depend on testing "
15951 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
15952 "don't retest features, and so you might see inconsistent results. Using the "
15953 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
15954 "the qemu binary at the same time as the handle is created."
15958 #: ../src/guestfs-actions.pod:6131
15959 msgid "guestfs_set_recovery_proc"
15963 #: ../src/guestfs-actions.pod:6133
15967 " guestfs_set_recovery_proc (guestfs_h *g,\n"
15968 " int recoveryproc);\n"
15973 #: ../src/guestfs-actions.pod:6137
15975 "If this is called with the parameter C<false> then C<guestfs_launch> does "
15976 "not create a recovery process. The purpose of the recovery process is to "
15977 "stop runaway qemu processes in the case where the main program aborts "
15982 #: ../src/guestfs-actions.pod:6142
15984 "This only has any effect if called before C<guestfs_launch>, and the default "
15989 #: ../src/guestfs-actions.pod:6145 ../fish/guestfish-actions.pod:4112
15991 "About the only time when you would want to disable this is if the main "
15992 "process will fork itself into the background (\"daemonize\" itself). In "
15993 "this case the recovery process thinks that the main program has disappeared "
15994 "and so kills qemu, which is not very helpful."
15998 #: ../src/guestfs-actions.pod:6155
15999 msgid "guestfs_set_selinux"
16003 #: ../src/guestfs-actions.pod:6157
16007 " guestfs_set_selinux (guestfs_h *g,\n"
16013 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4124
16015 "This sets the selinux flag that is passed to the appliance at boot time. "
16016 "The default is C<selinux=0> (disabled)."
16020 #: ../src/guestfs-actions.pod:6164 ../fish/guestfish-actions.pod:4127
16022 "Note that if SELinux is enabled, it is always in Permissive mode "
16023 "(C<enforcing=0>)."
16027 #: ../src/guestfs-actions.pod:6174
16028 msgid "guestfs_set_trace"
16032 #: ../src/guestfs-actions.pod:6176
16036 " guestfs_set_trace (guestfs_h *g,\n"
16042 #: ../src/guestfs-actions.pod:6180 ../fish/guestfish-actions.pod:4139
16044 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
16045 "return values are traced."
16049 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4142
16051 "If you want to trace C API calls into libguestfs (and other libraries) then "
16052 "possibly a better way is to use the external ltrace(1) command."
16056 #: ../src/guestfs-actions.pod:6187 ../fish/guestfish-actions.pod:4146
16058 "Command traces are disabled unless the environment variable "
16059 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16063 #: ../src/guestfs-actions.pod:6190
16065 "Trace messages are normally sent to C<stderr>, unless you register a "
16066 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16070 #: ../src/guestfs-actions.pod:6198
16071 msgid "guestfs_set_verbose"
16075 #: ../src/guestfs-actions.pod:6200
16079 " guestfs_set_verbose (guestfs_h *g,\n"
16085 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4159
16086 msgid "If C<verbose> is true, this turns on verbose messages."
16090 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4161
16092 "Verbose messages are disabled unless the environment variable "
16093 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16097 #: ../src/guestfs-actions.pod:6209
16099 "Verbose messages are normally sent to C<stderr>, unless you register a "
16100 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
16104 #: ../src/guestfs-actions.pod:6217
16105 msgid "guestfs_setcon"
16109 #: ../src/guestfs-actions.pod:6219
16113 " guestfs_setcon (guestfs_h *g,\n"
16114 " const char *context);\n"
16119 #: ../src/guestfs-actions.pod:6223 ../fish/guestfish-actions.pod:4172
16121 "This sets the SELinux security context of the daemon to the string "
16126 #: ../src/guestfs-actions.pod:6226 ../fish/guestfish-actions.pod:4175
16127 msgid "See the documentation about SELINUX in L<guestfs(3)>."
16131 #: ../src/guestfs-actions.pod:6232
16132 msgid "guestfs_setxattr"
16136 #: ../src/guestfs-actions.pod:6234
16140 " guestfs_setxattr (guestfs_h *g,\n"
16141 " const char *xattr,\n"
16142 " const char *val,\n"
16144 " const char *path);\n"
16149 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4181
16151 "This call sets the extended attribute named C<xattr> of the file C<path> to "
16152 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
16156 #: ../src/guestfs-actions.pod:6245
16157 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
16161 #: ../src/guestfs-actions.pod:6251
16162 msgid "guestfs_sfdisk"
16166 #: ../src/guestfs-actions.pod:6253
16170 " guestfs_sfdisk (guestfs_h *g,\n"
16171 " const char *device,\n"
16175 " char *const *lines);\n"
16180 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4191
16182 "This is a direct interface to the L<sfdisk(8)> program for creating "
16183 "partitions on block devices."
16187 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4194
16188 msgid "C<device> should be a block device, for example C</dev/sda>."
16192 #: ../src/guestfs-actions.pod:6266 ../fish/guestfish-actions.pod:4196
16194 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
16195 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
16196 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
16197 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
16198 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
16199 "the kernel) cannot work out the right geometry and you will need to tell it."
16203 #: ../src/guestfs-actions.pod:6274 ../fish/guestfish-actions.pod:4204
16205 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
16206 "refer to the L<sfdisk(8)> manpage."
16210 #: ../src/guestfs-actions.pod:6277 ../fish/guestfish-actions.pod:4207
16212 "To create a single partition occupying the whole disk, you would pass "
16213 "C<lines> as a single element list, when the single element being the string "
16218 #: ../src/guestfs-actions.pod:6281
16219 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
16223 #: ../src/guestfs-actions.pod:6289 ../src/guestfs-actions.pod:6319 ../src/guestfs-actions.pod:6352 ../fish/guestfish-actions.pod:4217 ../fish/guestfish-actions.pod:4240 ../fish/guestfish-actions.pod:4262
16224 msgid "This function is deprecated. In new code, use the C<part_add> call instead."
16228 #: ../src/guestfs-actions.pod:6298
16229 msgid "guestfs_sfdiskM"
16233 #: ../src/guestfs-actions.pod:6300
16237 " guestfs_sfdiskM (guestfs_h *g,\n"
16238 " const char *device,\n"
16239 " char *const *lines);\n"
16244 #: ../src/guestfs-actions.pod:6305
16246 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
16247 "partition sizes are specified in megabytes only (rounded to the nearest "
16248 "cylinder) and you don't need to specify the cyls, heads and sectors "
16249 "parameters which were rarely if ever used anyway."
16253 #: ../src/guestfs-actions.pod:6311
16255 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
16256 "C<guestfs_part_disk>"
16260 #: ../src/guestfs-actions.pod:6328
16261 msgid "guestfs_sfdisk_N"
16265 #: ../src/guestfs-actions.pod:6330
16269 " guestfs_sfdisk_N (guestfs_h *g,\n"
16270 " const char *device,\n"
16275 " const char *line);\n"
16280 #: ../src/guestfs-actions.pod:6339 ../fish/guestfish-actions.pod:4251
16282 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
16283 "(note: C<n> counts from 1)."
16287 #: ../src/guestfs-actions.pod:6342
16289 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
16290 "for the cyls/heads/sectors parameters."
16294 #: ../src/guestfs-actions.pod:6345
16295 msgid "See also: C<guestfs_part_add>"
16299 #: ../src/guestfs-actions.pod:6361
16300 msgid "guestfs_sfdisk_disk_geometry"
16304 #: ../src/guestfs-actions.pod:6363
16308 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
16309 " const char *device);\n"
16314 #: ../src/guestfs-actions.pod:6367
16316 "This displays the disk geometry of C<device> read from the partition table. "
16317 "Especially in the case where the underlying block device has been resized, "
16318 "this can be different from the kernel's idea of the geometry (see "
16319 "C<guestfs_sfdisk_kernel_geometry>)."
16323 #: ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4278 ../fish/guestfish-actions.pod:4287
16324 msgid "The result is in human-readable format, and not designed to be parsed."
16328 #: ../src/guestfs-actions.pod:6380
16329 msgid "guestfs_sfdisk_kernel_geometry"
16333 #: ../src/guestfs-actions.pod:6382
16337 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
16338 " const char *device);\n"
16343 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4285
16344 msgid "This displays the kernel's idea of the geometry of C<device>."
16348 #: ../src/guestfs-actions.pod:6396
16349 msgid "guestfs_sfdisk_l"
16353 #: ../src/guestfs-actions.pod:6398
16357 " guestfs_sfdisk_l (guestfs_h *g,\n"
16358 " const char *device);\n"
16363 #: ../src/guestfs-actions.pod:6402 ../fish/guestfish-actions.pod:4294
16365 "This displays the partition table on C<device>, in the human-readable output "
16366 "of the L<sfdisk(8)> command. It is not intended to be parsed."
16370 #: ../src/guestfs-actions.pod:6406
16371 msgid "See also: C<guestfs_part_list>"
16375 #: ../src/guestfs-actions.pod:6411 ../fish/guestfish-actions.pod:4300
16377 "This function is deprecated. In new code, use the C<part_list> call "
16382 #: ../src/guestfs-actions.pod:6420
16387 #: ../src/guestfs-actions.pod:6422
16391 " guestfs_sh (guestfs_h *g,\n"
16392 " const char *command);\n"
16397 #: ../src/guestfs-actions.pod:6426 ../fish/guestfish-actions.pod:4311
16399 "This call runs a command from the guest filesystem via the guest's "
16404 #: ../src/guestfs-actions.pod:6429
16405 msgid "This is like C<guestfs_command>, but passes the command to:"
16409 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4316
16412 " /bin/sh -c \"command\"\n"
16417 #: ../src/guestfs-actions.pod:6433 ../fish/guestfish-actions.pod:4318
16419 "Depending on the guest's shell, this usually results in wildcards being "
16420 "expanded, shell expressions being interpolated and so on."
16424 #: ../src/guestfs-actions.pod:6437
16425 msgid "All the provisos about C<guestfs_command> apply to this call."
16429 #: ../src/guestfs-actions.pod:6444
16430 msgid "guestfs_sh_lines"
16434 #: ../src/guestfs-actions.pod:6446
16438 " guestfs_sh_lines (guestfs_h *g,\n"
16439 " const char *command);\n"
16444 #: ../src/guestfs-actions.pod:6450
16446 "This is the same as C<guestfs_sh>, but splits the result into a list of "
16451 #: ../src/guestfs-actions.pod:6453
16452 msgid "See also: C<guestfs_command_lines>"
16456 #: ../src/guestfs-actions.pod:6461
16457 msgid "guestfs_sleep"
16461 #: ../src/guestfs-actions.pod:6463
16465 " guestfs_sleep (guestfs_h *g,\n"
16471 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4337
16472 msgid "Sleep for C<secs> seconds."
16476 #: ../src/guestfs-actions.pod:6471
16477 msgid "(Added in 1.0.41)"
16481 #: ../src/guestfs-actions.pod:6473 ../src/guestfs-structs.pod:109
16482 msgid "guestfs_stat"
16486 #: ../src/guestfs-actions.pod:6475
16489 " struct guestfs_stat *\n"
16490 " guestfs_stat (guestfs_h *g,\n"
16491 " const char *path);\n"
16496 #: ../src/guestfs-actions.pod:6481 ../fish/guestfish-actions.pod:4345
16497 msgid "This is the same as the C<stat(2)> system call."
16501 #: ../src/guestfs-actions.pod:6489 ../src/guestfs-structs.pod:135
16502 msgid "guestfs_statvfs"
16506 #: ../src/guestfs-actions.pod:6491
16509 " struct guestfs_statvfs *\n"
16510 " guestfs_statvfs (guestfs_h *g,\n"
16511 " const char *path);\n"
16516 #: ../src/guestfs-actions.pod:6495 ../fish/guestfish-actions.pod:4351
16518 "Returns file system statistics for any mounted file system. C<path> should "
16519 "be a file or directory in the mounted file system (typically it is the mount "
16520 "point itself, but it doesn't need to be)."
16524 #: ../src/guestfs-actions.pod:6499 ../fish/guestfish-actions.pod:4355
16525 msgid "This is the same as the C<statvfs(2)> system call."
16529 #: ../src/guestfs-actions.pod:6501
16531 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
16532 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
16536 #: ../src/guestfs-actions.pod:6507
16537 msgid "guestfs_strings"
16541 #: ../src/guestfs-actions.pod:6509
16545 " guestfs_strings (guestfs_h *g,\n"
16546 " const char *path);\n"
16551 #: ../src/guestfs-actions.pod:6513 ../fish/guestfish-actions.pod:4361
16553 "This runs the L<strings(1)> command on a file and returns the list of "
16554 "printable strings found."
16558 #: ../src/guestfs-actions.pod:6525
16559 msgid "guestfs_strings_e"
16563 #: ../src/guestfs-actions.pod:6527
16567 " guestfs_strings_e (guestfs_h *g,\n"
16568 " const char *encoding,\n"
16569 " const char *path);\n"
16574 #: ../src/guestfs-actions.pod:6532
16576 "This is like the C<guestfs_strings> command, but allows you to specify the "
16577 "encoding of strings that are looked for in the source file C<path>."
16581 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4375
16582 msgid "Allowed encodings are:"
16586 #: ../src/guestfs-actions.pod:6540 ../fish/guestfish-actions.pod:4379
16591 #: ../src/guestfs-actions.pod:6542
16593 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
16594 "ISO-8859-X (this is what C<guestfs_strings> uses)."
16598 #: ../src/guestfs-actions.pod:6545 ../fish/guestfish-actions.pod:4384
16603 #: ../src/guestfs-actions.pod:6547 ../fish/guestfish-actions.pod:4386
16604 msgid "Single 8-bit-byte characters."
16608 #: ../src/guestfs-actions.pod:6549 ../fish/guestfish-actions.pod:4388
16613 #: ../src/guestfs-actions.pod:6551 ../fish/guestfish-actions.pod:4390
16614 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
16618 #: ../src/guestfs-actions.pod:6554 ../fish/guestfish-actions.pod:4393
16619 msgid "l (lower case letter L)"
16623 #: ../src/guestfs-actions.pod:6556 ../fish/guestfish-actions.pod:4395
16625 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
16626 "examining binaries in Windows guests."
16630 #: ../src/guestfs-actions.pod:6559 ../fish/guestfish-actions.pod:4398
16635 #: ../src/guestfs-actions.pod:6561 ../fish/guestfish-actions.pod:4400
16636 msgid "32-bit big endian such as UCS-4BE."
16640 #: ../src/guestfs-actions.pod:6563 ../fish/guestfish-actions.pod:4402
16645 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4404
16646 msgid "32-bit little endian such as UCS-4LE."
16650 #: ../src/guestfs-actions.pod:6569 ../fish/guestfish-actions.pod:4408
16651 msgid "The returned strings are transcoded to UTF-8."
16655 #: ../src/guestfs-actions.pod:6580
16656 msgid "guestfs_swapoff_device"
16660 #: ../src/guestfs-actions.pod:6582
16664 " guestfs_swapoff_device (guestfs_h *g,\n"
16665 " const char *device);\n"
16670 #: ../src/guestfs-actions.pod:6586
16672 "This command disables the libguestfs appliance swap device or partition "
16673 "named C<device>. See C<guestfs_swapon_device>."
16677 #: ../src/guestfs-actions.pod:6594
16678 msgid "guestfs_swapoff_file"
16682 #: ../src/guestfs-actions.pod:6596
16686 " guestfs_swapoff_file (guestfs_h *g,\n"
16687 " const char *file);\n"
16692 #: ../src/guestfs-actions.pod:6600 ../fish/guestfish-actions.pod:4425
16693 msgid "This command disables the libguestfs appliance swap on file."
16697 #: ../src/guestfs-actions.pod:6606
16698 msgid "guestfs_swapoff_label"
16702 #: ../src/guestfs-actions.pod:6608
16706 " guestfs_swapoff_label (guestfs_h *g,\n"
16707 " const char *label);\n"
16712 #: ../src/guestfs-actions.pod:6612 ../fish/guestfish-actions.pod:4431
16714 "This command disables the libguestfs appliance swap on labeled swap "
16719 #: ../src/guestfs-actions.pod:6619
16720 msgid "guestfs_swapoff_uuid"
16724 #: ../src/guestfs-actions.pod:6621
16728 " guestfs_swapoff_uuid (guestfs_h *g,\n"
16729 " const char *uuid);\n"
16734 #: ../src/guestfs-actions.pod:6625 ../fish/guestfish-actions.pod:4438
16736 "This command disables the libguestfs appliance swap partition with the given "
16741 #: ../src/guestfs-actions.pod:6632
16742 msgid "guestfs_swapon_device"
16746 #: ../src/guestfs-actions.pod:6634
16750 " guestfs_swapon_device (guestfs_h *g,\n"
16751 " const char *device);\n"
16756 #: ../src/guestfs-actions.pod:6638
16758 "This command enables the libguestfs appliance to use the swap device or "
16759 "partition named C<device>. The increased memory is made available for all "
16760 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
16764 #: ../src/guestfs-actions.pod:6643 ../fish/guestfish-actions.pod:4450
16766 "Note that you should not swap to existing guest swap partitions unless you "
16767 "know what you are doing. They may contain hibernation information, or other "
16768 "information that the guest doesn't want you to trash. You also risk leaking "
16769 "information about the host to the guest this way. Instead, attach a new "
16770 "host device to the guest and swap on that."
16774 #: ../src/guestfs-actions.pod:6654
16775 msgid "guestfs_swapon_file"
16779 #: ../src/guestfs-actions.pod:6656
16783 " guestfs_swapon_file (guestfs_h *g,\n"
16784 " const char *file);\n"
16789 #: ../src/guestfs-actions.pod:6660
16791 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
16796 #: ../src/guestfs-actions.pod:6667
16797 msgid "guestfs_swapon_label"
16801 #: ../src/guestfs-actions.pod:6669
16805 " guestfs_swapon_label (guestfs_h *g,\n"
16806 " const char *label);\n"
16811 #: ../src/guestfs-actions.pod:6673
16813 "This command enables swap to a labeled swap partition. See "
16814 "C<guestfs_swapon_device> for other notes."
16818 #: ../src/guestfs-actions.pod:6680
16819 msgid "guestfs_swapon_uuid"
16823 #: ../src/guestfs-actions.pod:6682
16827 " guestfs_swapon_uuid (guestfs_h *g,\n"
16828 " const char *uuid);\n"
16833 #: ../src/guestfs-actions.pod:6686
16835 "This command enables swap to a swap partition with the given UUID. See "
16836 "C<guestfs_swapon_device> for other notes."
16840 #: ../src/guestfs-actions.pod:6693
16841 msgid "guestfs_sync"
16845 #: ../src/guestfs-actions.pod:6695
16849 " guestfs_sync (guestfs_h *g);\n"
16854 #: ../src/guestfs-actions.pod:6698 ../fish/guestfish-actions.pod:4482
16856 "This syncs the disk, so that any writes are flushed through to the "
16857 "underlying disk image."
16861 #: ../src/guestfs-actions.pod:6701 ../fish/guestfish-actions.pod:4485
16863 "You should always call this if you have modified a disk image, before "
16864 "closing the handle."
16868 #: ../src/guestfs-actions.pod:6708
16869 msgid "guestfs_tail"
16873 #: ../src/guestfs-actions.pod:6710
16877 " guestfs_tail (guestfs_h *g,\n"
16878 " const char *path);\n"
16883 #: ../src/guestfs-actions.pod:6714 ../fish/guestfish-actions.pod:4492
16884 msgid "This command returns up to the last 10 lines of a file as a list of strings."
16888 #: ../src/guestfs-actions.pod:6726
16889 msgid "guestfs_tail_n"
16893 #: ../src/guestfs-actions.pod:6728
16897 " guestfs_tail_n (guestfs_h *g,\n"
16899 " const char *path);\n"
16904 #: ../src/guestfs-actions.pod:6733 ../fish/guestfish-actions.pod:4502
16906 "If the parameter C<nrlines> is a positive number, this returns the last "
16907 "C<nrlines> lines of the file C<path>."
16911 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4505
16913 "If the parameter C<nrlines> is a negative number, this returns lines from "
16914 "the file C<path>, starting with the C<-nrlines>th line."
16918 #: ../src/guestfs-actions.pod:6750
16919 msgid "guestfs_tar_in"
16923 #: ../src/guestfs-actions.pod:6752
16927 " guestfs_tar_in (guestfs_h *g,\n"
16928 " const char *tarfile,\n"
16929 " const char *directory);\n"
16934 #: ../src/guestfs-actions.pod:6757 ../fish/guestfish-actions.pod:4517
16936 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
16937 "tar file) into C<directory>."
16941 #: ../src/guestfs-actions.pod:6760
16942 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
16946 #: ../src/guestfs-actions.pod:6765 ../src/guestfs-actions.pod:6782 ../src/guestfs-actions.pod:6798 ../src/guestfs-actions.pod:6814
16947 msgid "(Added in 1.0.3)"
16951 #: ../src/guestfs-actions.pod:6767
16952 msgid "guestfs_tar_out"
16956 #: ../src/guestfs-actions.pod:6769
16960 " guestfs_tar_out (guestfs_h *g,\n"
16961 " const char *directory,\n"
16962 " const char *tarfile);\n"
16967 #: ../src/guestfs-actions.pod:6774 ../fish/guestfish-actions.pod:4529
16969 "This command packs the contents of C<directory> and downloads it to local "
16974 #: ../src/guestfs-actions.pod:6777
16976 "To download a compressed tarball, use C<guestfs_tgz_out> or "
16977 "C<guestfs_txz_out>."
16981 #: ../src/guestfs-actions.pod:6784
16982 msgid "guestfs_tgz_in"
16986 #: ../src/guestfs-actions.pod:6786
16990 " guestfs_tgz_in (guestfs_h *g,\n"
16991 " const char *tarball,\n"
16992 " const char *directory);\n"
16997 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4541
16999 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
17000 "tar file) into C<directory>."
17004 #: ../src/guestfs-actions.pod:6794
17005 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
17009 #: ../src/guestfs-actions.pod:6800
17010 msgid "guestfs_tgz_out"
17014 #: ../src/guestfs-actions.pod:6802
17018 " guestfs_tgz_out (guestfs_h *g,\n"
17019 " const char *directory,\n"
17020 " const char *tarball);\n"
17025 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4552
17027 "This command packs the contents of C<directory> and downloads it to local "
17032 #: ../src/guestfs-actions.pod:6810
17033 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
17037 #: ../src/guestfs-actions.pod:6816
17038 msgid "guestfs_touch"
17042 #: ../src/guestfs-actions.pod:6818
17046 " guestfs_touch (guestfs_h *g,\n"
17047 " const char *path);\n"
17052 #: ../src/guestfs-actions.pod:6822 ../fish/guestfish-actions.pod:4563
17054 "Touch acts like the L<touch(1)> command. It can be used to update the "
17055 "timestamps on a file, or, if the file does not exist, to create a new "
17056 "zero-length file."
17060 #: ../src/guestfs-actions.pod:6826 ../fish/guestfish-actions.pod:4567
17062 "This command only works on regular files, and will fail on other file types "
17063 "such as directories, symbolic links, block special etc."
17067 #: ../src/guestfs-actions.pod:6833
17068 msgid "guestfs_truncate"
17072 #: ../src/guestfs-actions.pod:6835
17076 " guestfs_truncate (guestfs_h *g,\n"
17077 " const char *path);\n"
17082 #: ../src/guestfs-actions.pod:6839 ../fish/guestfish-actions.pod:4574
17084 "This command truncates C<path> to a zero-length file. The file must exist "
17089 #: ../src/guestfs-actions.pod:6846
17090 msgid "guestfs_truncate_size"
17094 #: ../src/guestfs-actions.pod:6848
17098 " guestfs_truncate_size (guestfs_h *g,\n"
17099 " const char *path,\n"
17100 " int64_t size);\n"
17105 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4581
17107 "This command truncates C<path> to size C<size> bytes. The file must exist "
17112 #: ../src/guestfs-actions.pod:6856
17114 "If the current file size is less than C<size> then the file is extended to "
17115 "the required size with zero bytes. This creates a sparse file (ie. disk "
17116 "blocks are not allocated for the file until you write to it). To create a "
17117 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
17121 #: ../src/guestfs-actions.pod:6866
17122 msgid "guestfs_tune2fs_l"
17126 #: ../src/guestfs-actions.pod:6868
17130 " guestfs_tune2fs_l (guestfs_h *g,\n"
17131 " const char *device);\n"
17136 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4594
17138 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
17143 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4597
17145 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
17146 "for more details. The list of fields returned isn't clearly defined, and "
17147 "depends on both the version of C<tune2fs> that libguestfs was built against, "
17148 "and the filesystem itself."
17152 #: ../src/guestfs-actions.pod:6888
17153 msgid "guestfs_txz_in"
17157 #: ../src/guestfs-actions.pod:6890
17161 " guestfs_txz_in (guestfs_h *g,\n"
17162 " const char *tarball,\n"
17163 " const char *directory);\n"
17168 #: ../src/guestfs-actions.pod:6895 ../fish/guestfish-actions.pod:4606
17170 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
17171 "tar file) into C<directory>."
17175 #: ../src/guestfs-actions.pod:6902
17176 msgid "guestfs_txz_out"
17180 #: ../src/guestfs-actions.pod:6904
17184 " guestfs_txz_out (guestfs_h *g,\n"
17185 " const char *directory,\n"
17186 " const char *tarball);\n"
17191 #: ../src/guestfs-actions.pod:6909 ../fish/guestfish-actions.pod:4615
17193 "This command packs the contents of C<directory> and downloads it to local "
17194 "file C<tarball> (as an xz compressed tar archive)."
17198 #: ../src/guestfs-actions.pod:6916
17199 msgid "guestfs_umask"
17203 #: ../src/guestfs-actions.pod:6918
17207 " guestfs_umask (guestfs_h *g,\n"
17213 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4624
17215 "This function sets the mask used for creating new files and device nodes to "
17220 #: ../src/guestfs-actions.pod:6925 ../fish/guestfish-actions.pod:4627
17222 "Typical umask values would be C<022> which creates new files with "
17223 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
17224 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
17228 #: ../src/guestfs-actions.pod:6930 ../fish/guestfish-actions.pod:4632
17230 "The default umask is C<022>. This is important because it means that "
17231 "directories and device nodes will be created with C<0644> or C<0755> mode "
17232 "even if you specify C<0777>."
17236 #: ../src/guestfs-actions.pod:6934
17238 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
17239 "C<guestfs_mkdir>."
17243 #: ../src/guestfs-actions.pod:6937 ../fish/guestfish-actions.pod:4639
17244 msgid "This call returns the previous umask."
17248 #: ../src/guestfs-actions.pod:6943
17249 msgid "guestfs_umount"
17253 #: ../src/guestfs-actions.pod:6945
17257 " guestfs_umount (guestfs_h *g,\n"
17258 " const char *pathordevice);\n"
17263 #: ../src/guestfs-actions.pod:6949 ../fish/guestfish-actions.pod:4647
17265 "This unmounts the given filesystem. The filesystem may be specified either "
17266 "by its mountpoint (path) or the device which contains the filesystem."
17270 #: ../src/guestfs-actions.pod:6957
17271 msgid "guestfs_umount_all"
17275 #: ../src/guestfs-actions.pod:6959
17279 " guestfs_umount_all (guestfs_h *g);\n"
17284 #: ../src/guestfs-actions.pod:6962 ../fish/guestfish-actions.pod:4657
17285 msgid "This unmounts all mounted filesystems."
17289 #: ../src/guestfs-actions.pod:6964 ../fish/guestfish-actions.pod:4659
17290 msgid "Some internal mounts are not unmounted by this call."
17294 #: ../src/guestfs-actions.pod:6970
17295 msgid "guestfs_upload"
17299 #: ../src/guestfs-actions.pod:6972
17303 " guestfs_upload (guestfs_h *g,\n"
17304 " const char *filename,\n"
17305 " const char *remotefilename);\n"
17310 #: ../src/guestfs-actions.pod:6977 ../src/guestfs-actions.pod:7001 ../fish/guestfish-actions.pod:4665 ../fish/guestfish-actions.pod:4678
17311 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
17315 #: ../src/guestfs-actions.pod:6982
17316 msgid "See also C<guestfs_download>."
17320 #: ../src/guestfs-actions.pod:6993
17321 msgid "guestfs_upload_offset"
17325 #: ../src/guestfs-actions.pod:6995
17329 " guestfs_upload_offset (guestfs_h *g,\n"
17330 " const char *filename,\n"
17331 " const char *remotefilename,\n"
17332 " int64_t offset);\n"
17337 #: ../src/guestfs-actions.pod:7004 ../fish/guestfish-actions.pod:4681
17339 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
17340 "The intention is to overwrite parts of existing files or devices, although "
17341 "if a non-existant file is specified then it is created with a \"hole\" "
17342 "before C<offset>. The size of the data written is implicit in the size of "
17343 "the source C<filename>."
17347 #: ../src/guestfs-actions.pod:7011
17349 "Note that there is no limit on the amount of data that can be uploaded with "
17350 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
17351 "full amount unless an error occurs."
17355 #: ../src/guestfs-actions.pod:7016
17356 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
17360 #: ../src/guestfs-actions.pod:7027
17361 msgid "guestfs_utimens"
17365 #: ../src/guestfs-actions.pod:7029
17369 " guestfs_utimens (guestfs_h *g,\n"
17370 " const char *path,\n"
17371 " int64_t atsecs,\n"
17372 " int64_t atnsecs,\n"
17373 " int64_t mtsecs,\n"
17374 " int64_t mtnsecs);\n"
17379 #: ../src/guestfs-actions.pod:7037 ../fish/guestfish-actions.pod:4701
17380 msgid "This command sets the timestamps of a file with nanosecond precision."
17384 #: ../src/guestfs-actions.pod:7040 ../fish/guestfish-actions.pod:4704
17386 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
17391 #: ../src/guestfs-actions.pod:7043 ../fish/guestfish-actions.pod:4707
17393 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
17394 "nanoseconds from the epoch."
17398 #: ../src/guestfs-actions.pod:7046 ../fish/guestfish-actions.pod:4710
17400 "If the C<*nsecs> field contains the special value C<-1> then the "
17401 "corresponding timestamp is set to the current time. (The C<*secs> field is "
17402 "ignored in this case)."
17406 #: ../src/guestfs-actions.pod:7050 ../fish/guestfish-actions.pod:4714
17408 "If the C<*nsecs> field contains the special value C<-2> then the "
17409 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
17414 #: ../src/guestfs-actions.pod:7058 ../src/guestfs-structs.pod:175
17415 msgid "guestfs_version"
17419 #: ../src/guestfs-actions.pod:7060
17422 " struct guestfs_version *\n"
17423 " guestfs_version (guestfs_h *g);\n"
17428 #: ../src/guestfs-actions.pod:7063 ../fish/guestfish-actions.pod:4722
17429 msgid "Return the libguestfs version number that the program is linked against."
17433 #: ../src/guestfs-actions.pod:7066 ../fish/guestfish-actions.pod:4725
17435 "Note that because of dynamic linking this is not necessarily the version of "
17436 "libguestfs that you compiled against. You can compile the program, and then "
17437 "at runtime dynamically link against a completely different C<libguestfs.so> "
17442 #: ../src/guestfs-actions.pod:7071 ../fish/guestfish-actions.pod:4730
17444 "This call was added in version C<1.0.58>. In previous versions of "
17445 "libguestfs there was no way to get the version number. From C code you can "
17446 "use dynamic linker functions to find out if this symbol exists (if it "
17447 "doesn't, then it's an earlier version)."
17451 #: ../src/guestfs-actions.pod:7077 ../fish/guestfish-actions.pod:4736
17453 "The call returns a structure with four elements. The first three (C<major>, "
17454 "C<minor> and C<release>) are numbers and correspond to the usual version "
17455 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
17456 "but may be used for distro-specific information."
17460 #: ../src/guestfs-actions.pod:7083 ../fish/guestfish-actions.pod:4742
17461 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
17465 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4745
17466 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
17470 #: ../src/guestfs-actions.pod:7088
17472 "I<Note:> Don't use this call to test for availability of features. In "
17473 "enterprise distributions we backport features from later versions into "
17474 "earlier versions, making this an unreliable way to test for features. Use "
17475 "C<guestfs_available> instead."
17479 #: ../src/guestfs-actions.pod:7094
17481 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
17482 "error. I<The caller must call C<guestfs_free_version> after use>."
17486 #: ../src/guestfs-actions.pod:7098
17487 msgid "(Added in 1.0.58)"
17491 #: ../src/guestfs-actions.pod:7100
17492 msgid "guestfs_vfs_label"
17496 #: ../src/guestfs-actions.pod:7102
17500 " guestfs_vfs_label (guestfs_h *g,\n"
17501 " const char *device);\n"
17506 #: ../src/guestfs-actions.pod:7106 ../fish/guestfish-actions.pod:4757
17507 msgid "This returns the filesystem label of the filesystem on C<device>."
17511 #: ../src/guestfs-actions.pod:7109 ../fish/guestfish-actions.pod:4760
17512 msgid "If the filesystem is unlabeled, this returns the empty string."
17516 #: ../src/guestfs-actions.pod:7111
17517 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
17521 #: ../src/guestfs-actions.pod:7116 ../src/guestfs-actions.pod:7153
17522 msgid "(Added in 1.3.18)"
17526 #: ../src/guestfs-actions.pod:7118
17527 msgid "guestfs_vfs_type"
17531 #: ../src/guestfs-actions.pod:7120
17535 " guestfs_vfs_type (guestfs_h *g,\n"
17536 " const char *device);\n"
17541 #: ../src/guestfs-actions.pod:7124 ../fish/guestfish-actions.pod:4768
17543 "This command gets the filesystem type corresponding to the filesystem on "
17548 #: ../src/guestfs-actions.pod:7127 ../fish/guestfish-actions.pod:4771
17550 "For most filesystems, the result is the name of the Linux VFS module which "
17551 "would be used to mount this filesystem if you mounted it without specifying "
17552 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
17556 #: ../src/guestfs-actions.pod:7137
17557 msgid "guestfs_vfs_uuid"
17561 #: ../src/guestfs-actions.pod:7139
17565 " guestfs_vfs_uuid (guestfs_h *g,\n"
17566 " const char *device);\n"
17571 #: ../src/guestfs-actions.pod:7143 ../fish/guestfish-actions.pod:4780
17572 msgid "This returns the filesystem UUID of the filesystem on C<device>."
17576 #: ../src/guestfs-actions.pod:7146 ../fish/guestfish-actions.pod:4783
17577 msgid "If the filesystem does not have a UUID, this returns the empty string."
17581 #: ../src/guestfs-actions.pod:7148
17582 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
17586 #: ../src/guestfs-actions.pod:7155
17587 msgid "guestfs_vg_activate"
17591 #: ../src/guestfs-actions.pod:7157
17595 " guestfs_vg_activate (guestfs_h *g,\n"
17597 " char *const *volgroups);\n"
17602 #: ../src/guestfs-actions.pod:7162 ../fish/guestfish-actions.pod:4791
17604 "This command activates or (if C<activate> is false) deactivates all logical "
17605 "volumes in the listed volume groups C<volgroups>. If activated, then they "
17606 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
17607 "deactivated, then those devices disappear."
17611 #: ../src/guestfs-actions.pod:7168 ../fish/guestfish-actions.pod:4797
17612 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
17616 #: ../src/guestfs-actions.pod:7170 ../fish/guestfish-actions.pod:4799
17618 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
17619 "activated or deactivated."
17623 #: ../src/guestfs-actions.pod:7177
17624 msgid "guestfs_vg_activate_all"
17628 #: ../src/guestfs-actions.pod:7179
17632 " guestfs_vg_activate_all (guestfs_h *g,\n"
17633 " int activate);\n"
17638 #: ../src/guestfs-actions.pod:7183 ../fish/guestfish-actions.pod:4806
17640 "This command activates or (if C<activate> is false) deactivates all logical "
17641 "volumes in all volume groups. If activated, then they are made known to the "
17642 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
17643 "those devices disappear."
17647 #: ../src/guestfs-actions.pod:7189 ../fish/guestfish-actions.pod:4812
17648 msgid "This command is the same as running C<vgchange -a y|n>"
17652 #: ../src/guestfs-actions.pod:7195
17653 msgid "guestfs_vgcreate"
17657 #: ../src/guestfs-actions.pod:7197
17661 " guestfs_vgcreate (guestfs_h *g,\n"
17662 " const char *volgroup,\n"
17663 " char *const *physvols);\n"
17668 #: ../src/guestfs-actions.pod:7202 ../fish/guestfish-actions.pod:4818
17670 "This creates an LVM volume group called C<volgroup> from the non-empty list "
17671 "of physical volumes C<physvols>."
17675 #: ../src/guestfs-actions.pod:7209
17676 msgid "guestfs_vglvuuids"
17680 #: ../src/guestfs-actions.pod:7211
17684 " guestfs_vglvuuids (guestfs_h *g,\n"
17685 " const char *vgname);\n"
17690 #: ../src/guestfs-actions.pod:7215 ../fish/guestfish-actions.pod:4825
17692 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
17693 "volumes created in this volume group."
17697 #: ../src/guestfs-actions.pod:7218
17699 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
17700 "associate logical volumes and volume groups."
17704 #: ../src/guestfs-actions.pod:7221
17705 msgid "See also C<guestfs_vgpvuuids>."
17709 #: ../src/guestfs-actions.pod:7229
17710 msgid "guestfs_vgpvuuids"
17714 #: ../src/guestfs-actions.pod:7231
17718 " guestfs_vgpvuuids (guestfs_h *g,\n"
17719 " const char *vgname);\n"
17724 #: ../src/guestfs-actions.pod:7235 ../fish/guestfish-actions.pod:4837
17726 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
17727 "volumes that this volume group resides on."
17731 #: ../src/guestfs-actions.pod:7238
17733 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
17734 "associate physical volumes and volume groups."
17738 #: ../src/guestfs-actions.pod:7241
17739 msgid "See also C<guestfs_vglvuuids>."
17743 #: ../src/guestfs-actions.pod:7249
17744 msgid "guestfs_vgremove"
17748 #: ../src/guestfs-actions.pod:7251
17752 " guestfs_vgremove (guestfs_h *g,\n"
17753 " const char *vgname);\n"
17758 #: ../src/guestfs-actions.pod:7255 ../fish/guestfish-actions.pod:4849
17759 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
17763 #: ../src/guestfs-actions.pod:7257 ../fish/guestfish-actions.pod:4851
17764 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
17768 #: ../src/guestfs-actions.pod:7264
17769 msgid "guestfs_vgrename"
17773 #: ../src/guestfs-actions.pod:7266
17777 " guestfs_vgrename (guestfs_h *g,\n"
17778 " const char *volgroup,\n"
17779 " const char *newvolgroup);\n"
17784 #: ../src/guestfs-actions.pod:7271 ../fish/guestfish-actions.pod:4858
17785 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
17789 #: ../src/guestfs-actions.pod:7277
17790 msgid "guestfs_vgs"
17794 #: ../src/guestfs-actions.pod:7279
17798 " guestfs_vgs (guestfs_h *g);\n"
17803 #: ../src/guestfs-actions.pod:7282 ../fish/guestfish-actions.pod:4864
17805 "List all the volumes groups detected. This is the equivalent of the "
17806 "L<vgs(8)> command."
17810 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4867
17812 "This returns a list of just the volume group names that were detected "
17813 "(eg. C<VolGroup00>)."
17817 #: ../src/guestfs-actions.pod:7288
17818 msgid "See also C<guestfs_vgs_full>."
17822 #: ../src/guestfs-actions.pod:7296
17823 msgid "guestfs_vgs_full"
17827 #: ../src/guestfs-actions.pod:7298
17830 " struct guestfs_lvm_vg_list *\n"
17831 " guestfs_vgs_full (guestfs_h *g);\n"
17836 #: ../src/guestfs-actions.pod:7301 ../fish/guestfish-actions.pod:4876
17838 "List all the volumes groups detected. This is the equivalent of the "
17839 "L<vgs(8)> command. The \"full\" version includes all fields."
17843 #: ../src/guestfs-actions.pod:7304
17845 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
17846 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
17851 #: ../src/guestfs-actions.pod:7310
17852 msgid "guestfs_vgscan"
17856 #: ../src/guestfs-actions.pod:7312
17860 " guestfs_vgscan (guestfs_h *g);\n"
17865 #: ../src/guestfs-actions.pod:7315 ../fish/guestfish-actions.pod:4883
17867 "This rescans all block devices and rebuilds the list of LVM physical "
17868 "volumes, volume groups and logical volumes."
17872 #: ../src/guestfs-actions.pod:7322
17873 msgid "guestfs_vguuid"
17877 #: ../src/guestfs-actions.pod:7324
17881 " guestfs_vguuid (guestfs_h *g,\n"
17882 " const char *vgname);\n"
17887 #: ../src/guestfs-actions.pod:7328 ../fish/guestfish-actions.pod:4890
17888 msgid "This command returns the UUID of the LVM VG named C<vgname>."
17892 #: ../src/guestfs-actions.pod:7335
17893 msgid "guestfs_wait_ready"
17897 #: ../src/guestfs-actions.pod:7337
17901 " guestfs_wait_ready (guestfs_h *g);\n"
17906 #: ../src/guestfs-actions.pod:7340
17907 msgid "This function is a no op."
17911 #: ../src/guestfs-actions.pod:7342
17913 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
17914 "calling C<guestfs_launch> to wait for the launch to complete. However this "
17915 "is no longer necessary because C<guestfs_launch> now does the waiting."
17919 #: ../src/guestfs-actions.pod:7347
17921 "If you see any calls to this function in code then you can just remove them, "
17922 "unless you want to retain compatibility with older versions of the API."
17926 #: ../src/guestfs-actions.pod:7353
17927 msgid "This function is deprecated. In new code, use the C<launch> call instead."
17931 #: ../src/guestfs-actions.pod:7362
17932 msgid "guestfs_wc_c"
17936 #: ../src/guestfs-actions.pod:7364
17940 " guestfs_wc_c (guestfs_h *g,\n"
17941 " const char *path);\n"
17946 #: ../src/guestfs-actions.pod:7368 ../fish/guestfish-actions.pod:4896
17948 "This command counts the characters in a file, using the C<wc -c> external "
17953 #: ../src/guestfs-actions.pod:7375
17954 msgid "guestfs_wc_l"
17958 #: ../src/guestfs-actions.pod:7377
17962 " guestfs_wc_l (guestfs_h *g,\n"
17963 " const char *path);\n"
17968 #: ../src/guestfs-actions.pod:7381 ../fish/guestfish-actions.pod:4903
17970 "This command counts the lines in a file, using the C<wc -l> external "
17975 #: ../src/guestfs-actions.pod:7388
17976 msgid "guestfs_wc_w"
17980 #: ../src/guestfs-actions.pod:7390
17984 " guestfs_wc_w (guestfs_h *g,\n"
17985 " const char *path);\n"
17990 #: ../src/guestfs-actions.pod:7394 ../fish/guestfish-actions.pod:4910
17992 "This command counts the words in a file, using the C<wc -w> external "
17997 #: ../src/guestfs-actions.pod:7401
17998 msgid "guestfs_write"
18002 #: ../src/guestfs-actions.pod:7403
18006 " guestfs_write (guestfs_h *g,\n"
18007 " const char *path,\n"
18008 " const char *content,\n"
18009 " size_t content_size);\n"
18014 #: ../src/guestfs-actions.pod:7409 ../fish/guestfish-actions.pod:4917
18016 "This call creates a file called C<path>. The content of the file is the "
18017 "string C<content> (which can contain any 8 bit data)."
18021 #: ../src/guestfs-actions.pod:7419
18022 msgid "guestfs_write_file"
18026 #: ../src/guestfs-actions.pod:7421
18030 " guestfs_write_file (guestfs_h *g,\n"
18031 " const char *path,\n"
18032 " const char *content,\n"
18038 #: ../src/guestfs-actions.pod:7427 ../fish/guestfish-actions.pod:4927
18040 "This call creates a file called C<path>. The contents of the file is the "
18041 "string C<content> (which can contain any 8 bit data), with length C<size>."
18045 #: ../src/guestfs-actions.pod:7431 ../fish/guestfish-actions.pod:4931
18047 "As a special case, if C<size> is C<0> then the length is calculated using "
18048 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
18052 #: ../src/guestfs-actions.pod:7435 ../fish/guestfish-actions.pod:4935
18054 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
18055 "I<not> work, even if the length is specified."
18059 #: ../src/guestfs-actions.pod:7443 ../fish/guestfish-actions.pod:4941
18060 msgid "This function is deprecated. In new code, use the C<write> call instead."
18064 #: ../src/guestfs-actions.pod:7452
18065 msgid "guestfs_zegrep"
18069 #: ../src/guestfs-actions.pod:7454
18073 " guestfs_zegrep (guestfs_h *g,\n"
18074 " const char *regex,\n"
18075 " const char *path);\n"
18080 #: ../src/guestfs-actions.pod:7459 ../fish/guestfish-actions.pod:4952
18081 msgid "This calls the external C<zegrep> program and returns the matching lines."
18085 #: ../src/guestfs-actions.pod:7471
18086 msgid "guestfs_zegrepi"
18090 #: ../src/guestfs-actions.pod:7473
18094 " guestfs_zegrepi (guestfs_h *g,\n"
18095 " const char *regex,\n"
18096 " const char *path);\n"
18101 #: ../src/guestfs-actions.pod:7478 ../fish/guestfish-actions.pod:4962
18102 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
18106 #: ../src/guestfs-actions.pod:7490
18107 msgid "guestfs_zero"
18111 #: ../src/guestfs-actions.pod:7492
18115 " guestfs_zero (guestfs_h *g,\n"
18116 " const char *device);\n"
18121 #: ../src/guestfs-actions.pod:7496 ../fish/guestfish-actions.pod:4972
18122 msgid "This command writes zeroes over the first few blocks of C<device>."
18126 #: ../src/guestfs-actions.pod:7498 ../fish/guestfish-actions.pod:4974
18128 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
18129 "securely wipe the device). It should be sufficient to remove any partition "
18130 "tables, filesystem superblocks and so on."
18134 #: ../src/guestfs-actions.pod:7502
18136 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
18137 "C<guestfs_is_zero_device>"
18141 #: ../src/guestfs-actions.pod:7514
18142 msgid "guestfs_zero_device"
18146 #: ../src/guestfs-actions.pod:7516
18150 " guestfs_zero_device (guestfs_h *g,\n"
18151 " const char *device);\n"
18156 #: ../src/guestfs-actions.pod:7520
18158 "This command writes zeroes over the entire C<device>. Compare with "
18159 "C<guestfs_zero> which just zeroes the first few blocks of a device."
18163 #: ../src/guestfs-actions.pod:7534
18164 msgid "(Added in 1.3.1)"
18168 #: ../src/guestfs-actions.pod:7536
18169 msgid "guestfs_zerofree"
18173 #: ../src/guestfs-actions.pod:7538
18177 " guestfs_zerofree (guestfs_h *g,\n"
18178 " const char *device);\n"
18183 #: ../src/guestfs-actions.pod:7542 ../fish/guestfish-actions.pod:4996
18185 "This runs the I<zerofree> program on C<device>. This program claims to zero "
18186 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
18187 "possible to compress the filesystem more effectively."
18191 #: ../src/guestfs-actions.pod:7547 ../fish/guestfish-actions.pod:5001
18192 msgid "You should B<not> run this program if the filesystem is mounted."
18196 #: ../src/guestfs-actions.pod:7550 ../fish/guestfish-actions.pod:5004
18198 "It is possible that using this program can damage the filesystem or data on "
18203 #: ../src/guestfs-actions.pod:7557
18204 msgid "guestfs_zfgrep"
18208 #: ../src/guestfs-actions.pod:7559
18212 " guestfs_zfgrep (guestfs_h *g,\n"
18213 " const char *pattern,\n"
18214 " const char *path);\n"
18219 #: ../src/guestfs-actions.pod:7564 ../fish/guestfish-actions.pod:5011
18220 msgid "This calls the external C<zfgrep> program and returns the matching lines."
18224 #: ../src/guestfs-actions.pod:7576
18225 msgid "guestfs_zfgrepi"
18229 #: ../src/guestfs-actions.pod:7578
18233 " guestfs_zfgrepi (guestfs_h *g,\n"
18234 " const char *pattern,\n"
18235 " const char *path);\n"
18240 #: ../src/guestfs-actions.pod:7583 ../fish/guestfish-actions.pod:5021
18241 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
18245 #: ../src/guestfs-actions.pod:7595
18246 msgid "guestfs_zfile"
18250 #: ../src/guestfs-actions.pod:7597
18254 " guestfs_zfile (guestfs_h *g,\n"
18255 " const char *meth,\n"
18256 " const char *path);\n"
18261 #: ../src/guestfs-actions.pod:7602 ../fish/guestfish-actions.pod:5031
18262 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
18266 #: ../src/guestfs-actions.pod:7605 ../fish/guestfish-actions.pod:5034
18267 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
18271 #: ../src/guestfs-actions.pod:7607
18273 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
18278 #: ../src/guestfs-actions.pod:7613 ../fish/guestfish-actions.pod:5039
18279 msgid "This function is deprecated. In new code, use the C<file> call instead."
18283 #: ../src/guestfs-actions.pod:7622
18284 msgid "guestfs_zgrep"
18288 #: ../src/guestfs-actions.pod:7624
18292 " guestfs_zgrep (guestfs_h *g,\n"
18293 " const char *regex,\n"
18294 " const char *path);\n"
18299 #: ../src/guestfs-actions.pod:7629 ../fish/guestfish-actions.pod:5050
18300 msgid "This calls the external C<zgrep> program and returns the matching lines."
18304 #: ../src/guestfs-actions.pod:7641
18305 msgid "guestfs_zgrepi"
18309 #: ../src/guestfs-actions.pod:7643
18313 " guestfs_zgrepi (guestfs_h *g,\n"
18314 " const char *regex,\n"
18315 " const char *path);\n"
18320 #: ../src/guestfs-actions.pod:7648 ../fish/guestfish-actions.pod:5060
18321 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
18325 #: ../src/guestfs-availability.pod:3
18330 #: ../src/guestfs-availability.pod:5
18332 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
18333 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
18334 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
18335 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
18336 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
18340 #: ../src/guestfs-availability.pod:21
18345 #: ../src/guestfs-availability.pod:23
18347 "The following functions: L</guestfs_inotify_add_watch> "
18348 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
18349 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
18353 #: ../src/guestfs-availability.pod:31
18354 msgid "B<linuxfsuuid>"
18358 #: ../src/guestfs-availability.pod:33
18360 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
18361 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
18365 #: ../src/guestfs-availability.pod:40
18366 msgid "B<linuxmodules>"
18370 #: ../src/guestfs-availability.pod:42
18371 msgid "The following functions: L</guestfs_modprobe>"
18375 #: ../src/guestfs-availability.pod:45
18376 msgid "B<linuxxattrs>"
18380 #: ../src/guestfs-availability.pod:47
18382 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
18383 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
18384 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
18385 "L</guestfs_setxattr>"
18389 #: ../src/guestfs-availability.pod:58
18394 #: ../src/guestfs-availability.pod:60
18396 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
18397 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
18398 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
18402 #: ../src/guestfs-availability.pod:69
18407 #: ../src/guestfs-availability.pod:71
18409 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
18410 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
18411 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
18412 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
18413 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
18414 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
18415 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
18416 "L</guestfs_vgs_full>"
18420 #: ../src/guestfs-availability.pod:94
18425 #: ../src/guestfs-availability.pod:96
18427 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
18428 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
18432 #: ../src/guestfs-availability.pod:102
18437 #: ../src/guestfs-availability.pod:104
18438 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
18442 #: ../src/guestfs-availability.pod:107
18443 msgid "B<ntfsprogs>"
18447 #: ../src/guestfs-availability.pod:109
18448 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
18452 #: ../src/guestfs-availability.pod:113
18453 msgid "B<realpath>"
18457 #: ../src/guestfs-availability.pod:115
18458 msgid "The following functions: L</guestfs_realpath>"
18462 #: ../src/guestfs-availability.pod:118
18467 #: ../src/guestfs-availability.pod:120
18469 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
18470 "L</guestfs_scrub_freespace>"
18474 #: ../src/guestfs-availability.pod:125
18479 #: ../src/guestfs-availability.pod:127
18480 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
18484 #: ../src/guestfs-availability.pod:131
18489 #: ../src/guestfs-availability.pod:133
18490 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
18494 #: ../src/guestfs-availability.pod:137
18495 msgid "B<zerofree>"
18499 #: ../src/guestfs-availability.pod:139
18500 msgid "The following functions: L</guestfs_zerofree>"
18504 #: ../src/guestfs-structs.pod:1
18505 msgid "guestfs_int_bool"
18509 #: ../src/guestfs-structs.pod:3
18512 " struct guestfs_int_bool {\n"
18520 #: ../src/guestfs-structs.pod:8
18523 " struct guestfs_int_bool_list {\n"
18524 " uint32_t len; /* Number of elements in list. */\n"
18525 " struct guestfs_int_bool *val; /* Elements. */\n"
18531 #: ../src/guestfs-structs.pod:13
18534 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
18535 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
18540 #: ../src/guestfs-structs.pod:16
18541 msgid "guestfs_lvm_pv"
18545 #: ../src/guestfs-structs.pod:18
18548 " struct guestfs_lvm_pv {\n"
18549 " char *pv_name;\n"
18550 " /* The next field is NOT nul-terminated, be careful when printing it: "
18552 " char pv_uuid[32];\n"
18554 " uint64_t pv_size;\n"
18555 " uint64_t dev_size;\n"
18556 " uint64_t pv_free;\n"
18557 " uint64_t pv_used;\n"
18558 " char *pv_attr;\n"
18559 " int64_t pv_pe_count;\n"
18560 " int64_t pv_pe_alloc_count;\n"
18561 " char *pv_tags;\n"
18562 " uint64_t pe_start;\n"
18563 " int64_t pv_mda_count;\n"
18564 " uint64_t pv_mda_free;\n"
18570 #: ../src/guestfs-structs.pod:36
18573 " struct guestfs_lvm_pv_list {\n"
18574 " uint32_t len; /* Number of elements in list. */\n"
18575 " struct guestfs_lvm_pv *val; /* Elements. */\n"
18581 #: ../src/guestfs-structs.pod:41
18584 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
18585 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
18590 #: ../src/guestfs-structs.pod:44
18591 msgid "guestfs_lvm_vg"
18595 #: ../src/guestfs-structs.pod:46
18598 " struct guestfs_lvm_vg {\n"
18599 " char *vg_name;\n"
18600 " /* The next field is NOT nul-terminated, be careful when printing it: "
18602 " char vg_uuid[32];\n"
18604 " char *vg_attr;\n"
18605 " uint64_t vg_size;\n"
18606 " uint64_t vg_free;\n"
18607 " char *vg_sysid;\n"
18608 " uint64_t vg_extent_size;\n"
18609 " int64_t vg_extent_count;\n"
18610 " int64_t vg_free_count;\n"
18611 " int64_t max_lv;\n"
18612 " int64_t max_pv;\n"
18613 " int64_t pv_count;\n"
18614 " int64_t lv_count;\n"
18615 " int64_t snap_count;\n"
18616 " int64_t vg_seqno;\n"
18617 " char *vg_tags;\n"
18618 " int64_t vg_mda_count;\n"
18619 " uint64_t vg_mda_free;\n"
18625 #: ../src/guestfs-structs.pod:69
18628 " struct guestfs_lvm_vg_list {\n"
18629 " uint32_t len; /* Number of elements in list. */\n"
18630 " struct guestfs_lvm_vg *val; /* Elements. */\n"
18636 #: ../src/guestfs-structs.pod:74
18639 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
18640 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
18645 #: ../src/guestfs-structs.pod:77
18646 msgid "guestfs_lvm_lv"
18650 #: ../src/guestfs-structs.pod:79
18653 " struct guestfs_lvm_lv {\n"
18654 " char *lv_name;\n"
18655 " /* The next field is NOT nul-terminated, be careful when printing it: "
18657 " char lv_uuid[32];\n"
18658 " char *lv_attr;\n"
18659 " int64_t lv_major;\n"
18660 " int64_t lv_minor;\n"
18661 " int64_t lv_kernel_major;\n"
18662 " int64_t lv_kernel_minor;\n"
18663 " uint64_t lv_size;\n"
18664 " int64_t seg_count;\n"
18666 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18667 " float snap_percent;\n"
18668 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
18669 " float copy_percent;\n"
18670 " char *move_pv;\n"
18671 " char *lv_tags;\n"
18672 " char *mirror_log;\n"
18673 " char *modules;\n"
18679 #: ../src/guestfs-structs.pod:101
18682 " struct guestfs_lvm_lv_list {\n"
18683 " uint32_t len; /* Number of elements in list. */\n"
18684 " struct guestfs_lvm_lv *val; /* Elements. */\n"
18690 #: ../src/guestfs-structs.pod:106
18693 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
18694 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
18699 #: ../src/guestfs-structs.pod:111
18702 " struct guestfs_stat {\n"
18706 " int64_t nlink;\n"
18711 " int64_t blksize;\n"
18712 " int64_t blocks;\n"
18713 " int64_t atime;\n"
18714 " int64_t mtime;\n"
18715 " int64_t ctime;\n"
18721 #: ../src/guestfs-structs.pod:127
18724 " struct guestfs_stat_list {\n"
18725 " uint32_t len; /* Number of elements in list. */\n"
18726 " struct guestfs_stat *val; /* Elements. */\n"
18732 #: ../src/guestfs-structs.pod:132
18735 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
18736 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
18741 #: ../src/guestfs-structs.pod:137
18744 " struct guestfs_statvfs {\n"
18745 " int64_t bsize;\n"
18746 " int64_t frsize;\n"
18747 " int64_t blocks;\n"
18748 " int64_t bfree;\n"
18749 " int64_t bavail;\n"
18750 " int64_t files;\n"
18751 " int64_t ffree;\n"
18752 " int64_t favail;\n"
18755 " int64_t namemax;\n"
18761 #: ../src/guestfs-structs.pod:151
18764 " struct guestfs_statvfs_list {\n"
18765 " uint32_t len; /* Number of elements in list. */\n"
18766 " struct guestfs_statvfs *val; /* Elements. */\n"
18772 #: ../src/guestfs-structs.pod:156
18775 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
18776 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
18781 #: ../src/guestfs-structs.pod:159
18782 msgid "guestfs_dirent"
18786 #: ../src/guestfs-structs.pod:161
18789 " struct guestfs_dirent {\n"
18798 #: ../src/guestfs-structs.pod:167
18801 " struct guestfs_dirent_list {\n"
18802 " uint32_t len; /* Number of elements in list. */\n"
18803 " struct guestfs_dirent *val; /* Elements. */\n"
18809 #: ../src/guestfs-structs.pod:172
18812 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
18813 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
18818 #: ../src/guestfs-structs.pod:177
18821 " struct guestfs_version {\n"
18822 " int64_t major;\n"
18823 " int64_t minor;\n"
18824 " int64_t release;\n"
18831 #: ../src/guestfs-structs.pod:184
18834 " struct guestfs_version_list {\n"
18835 " uint32_t len; /* Number of elements in list. */\n"
18836 " struct guestfs_version *val; /* Elements. */\n"
18842 #: ../src/guestfs-structs.pod:189
18845 " void guestfs_free_version (struct guestfs_free_version *);\n"
18846 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
18851 #: ../src/guestfs-structs.pod:192
18852 msgid "guestfs_xattr"
18856 #: ../src/guestfs-structs.pod:194
18859 " struct guestfs_xattr {\n"
18860 " char *attrname;\n"
18861 " /* The next two fields describe a byte array. */\n"
18862 " uint32_t attrval_len;\n"
18863 " char *attrval;\n"
18869 #: ../src/guestfs-structs.pod:201
18872 " struct guestfs_xattr_list {\n"
18873 " uint32_t len; /* Number of elements in list. */\n"
18874 " struct guestfs_xattr *val; /* Elements. */\n"
18880 #: ../src/guestfs-structs.pod:206
18883 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
18884 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
18889 #: ../src/guestfs-structs.pod:209
18890 msgid "guestfs_inotify_event"
18894 #: ../src/guestfs-structs.pod:211
18897 " struct guestfs_inotify_event {\n"
18898 " int64_t in_wd;\n"
18899 " uint32_t in_mask;\n"
18900 " uint32_t in_cookie;\n"
18901 " char *in_name;\n"
18907 #: ../src/guestfs-structs.pod:218
18910 " struct guestfs_inotify_event_list {\n"
18911 " uint32_t len; /* Number of elements in list. */\n"
18912 " struct guestfs_inotify_event *val; /* Elements. */\n"
18918 #: ../src/guestfs-structs.pod:223
18921 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
18922 " void guestfs_free_inotify_event_list (struct "
18923 "guestfs_free_inotify_event_list *);\n"
18928 #: ../src/guestfs-structs.pod:226
18929 msgid "guestfs_partition"
18933 #: ../src/guestfs-structs.pod:228
18936 " struct guestfs_partition {\n"
18937 " int32_t part_num;\n"
18938 " uint64_t part_start;\n"
18939 " uint64_t part_end;\n"
18940 " uint64_t part_size;\n"
18946 #: ../src/guestfs-structs.pod:235
18949 " struct guestfs_partition_list {\n"
18950 " uint32_t len; /* Number of elements in list. */\n"
18951 " struct guestfs_partition *val; /* Elements. */\n"
18957 #: ../src/guestfs-structs.pod:240
18960 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
18961 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
18966 #: ../src/guestfs-structs.pod:243
18967 msgid "guestfs_application"
18971 #: ../src/guestfs-structs.pod:245
18974 " struct guestfs_application {\n"
18975 " char *app_name;\n"
18976 " char *app_display_name;\n"
18977 " int32_t app_epoch;\n"
18978 " char *app_version;\n"
18979 " char *app_release;\n"
18980 " char *app_install_path;\n"
18981 " char *app_trans_path;\n"
18982 " char *app_publisher;\n"
18983 " char *app_url;\n"
18984 " char *app_source_package;\n"
18985 " char *app_summary;\n"
18986 " char *app_description;\n"
18992 #: ../src/guestfs-structs.pod:260
18995 " struct guestfs_application_list {\n"
18996 " uint32_t len; /* Number of elements in list. */\n"
18997 " struct guestfs_application *val; /* Elements. */\n"
19003 #: ../src/guestfs-structs.pod:265
19006 " void guestfs_free_application (struct guestfs_free_application *);\n"
19007 " void guestfs_free_application_list (struct guestfs_free_application_list "
19013 #: ../fish/guestfish.pod:5
19014 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
19018 #: ../fish/guestfish.pod:9
19021 " guestfish [--options] [commands]\n"
19026 #: ../fish/guestfish.pod:11
19034 #: ../fish/guestfish.pod:13
19037 " guestfish [--ro|--rw] -a disk.img\n"
19042 #: ../fish/guestfish.pod:15
19045 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
19050 #: ../fish/guestfish.pod:17
19053 " guestfish -d libvirt-domain\n"
19058 #: ../fish/guestfish.pod:19
19061 " guestfish [--ro|--rw] -a disk.img -i\n"
19066 #: ../fish/guestfish.pod:21
19069 " guestfish -d libvirt-domain -i\n"
19074 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
19079 #: ../fish/guestfish.pod:25
19081 "Using guestfish in read/write mode on live virtual machines can be "
19082 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
19083 "option to use guestfish safely if the disk image or virtual machine might be "
19088 #: ../fish/guestfish.pod:32
19090 "Guestfish is a shell and command-line tool for examining and modifying "
19091 "virtual machine filesystems. It uses libguestfs and exposes all of the "
19092 "functionality of the guestfs API, see L<guestfs(3)>."
19096 #: ../fish/guestfish.pod:36
19098 "Guestfish gives you structured access to the libguestfs API, from shell "
19099 "scripts or the command line or interactively. If you want to rescue a "
19100 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
19105 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:949 ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
19110 #: ../fish/guestfish.pod:43
19111 msgid "As an interactive shell"
19115 #: ../fish/guestfish.pod:45
19123 #: ../fish/guestfish.pod:47
19126 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
19127 " editing virtual machine filesystems.\n"
19132 #: ../fish/guestfish.pod:50
19135 " Type: 'help' for a list of commands\n"
19136 " 'man' to read the manual\n"
19137 " 'quit' to quit the shell\n"
19142 #: ../fish/guestfish.pod:54
19145 " ><fs> add-ro disk.img\n"
19147 " ><fs> list-filesystems\n"
19148 " /dev/sda1: ext4\n"
19149 " /dev/vg_guest/lv_root: ext4\n"
19150 " /dev/vg_guest/lv_swap: swap\n"
19151 " ><fs> mount /dev/vg_guest/lv_root /\n"
19152 " ><fs> cat /etc/fstab\n"
19154 " # Created by anaconda\n"
19161 #: ../fish/guestfish.pod:67
19162 msgid "From shell scripts"
19166 #: ../fish/guestfish.pod:69
19167 msgid "Create a new C</etc/motd> file in a guest or disk image:"
19171 #: ../fish/guestfish.pod:71
19174 " guestfish <<_EOF_\n"
19177 " mount /dev/vg_guest/lv_root /\n"
19178 " write /etc/motd \"Welcome, new users\"\n"
19184 #: ../fish/guestfish.pod:78
19185 msgid "List the LVM logical volumes in a disk image:"
19189 #: ../fish/guestfish.pod:80
19192 " guestfish -a disk.img --ro <<_EOF_\n"
19200 #: ../fish/guestfish.pod:85
19201 msgid "List all the filesystems in a disk image:"
19205 #: ../fish/guestfish.pod:87
19208 " guestfish -a disk.img --ro <<_EOF_\n"
19210 " list-filesystems\n"
19216 #: ../fish/guestfish.pod:92
19217 msgid "On one command line"
19221 #: ../fish/guestfish.pod:94
19222 msgid "Update C</etc/resolv.conf> in a guest:"
19226 #: ../fish/guestfish.pod:96
19230 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
19231 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
19236 #: ../fish/guestfish.pod:100
19237 msgid "Edit C</boot/grub/grub.conf> interactively:"
19241 #: ../fish/guestfish.pod:102
19244 " guestfish --rw --add disk.img \\\n"
19245 " --mount /dev/vg_guest/lv_root \\\n"
19246 " --mount /dev/sda1:/boot \\\n"
19247 " edit /boot/grub/grub.conf\n"
19252 #: ../fish/guestfish.pod:107
19253 msgid "Mount disks automatically"
19257 #: ../fish/guestfish.pod:109
19259 "Use the I<-i> option to automatically mount the disks from a virtual "
19264 #: ../fish/guestfish.pod:112
19267 " guestfish --ro -a disk.img -i cat /etc/group\n"
19272 #: ../fish/guestfish.pod:114
19275 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
19280 #: ../fish/guestfish.pod:116
19281 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
19285 #: ../fish/guestfish.pod:118
19288 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
19293 #: ../fish/guestfish.pod:120
19294 msgid "As a script interpreter"
19298 #: ../fish/guestfish.pod:122
19299 msgid "Create a 100MB disk containing an ext2-formatted partition:"
19303 #: ../fish/guestfish.pod:124
19306 " #!/usr/bin/guestfish -f\n"
19307 " sparse test1.img 100M\n"
19309 " part-disk /dev/sda mbr\n"
19310 " mkfs ext2 /dev/sda1\n"
19315 #: ../fish/guestfish.pod:130
19316 msgid "Start with a prepared disk"
19320 #: ../fish/guestfish.pod:132
19322 "An alternate way to create a 100MB disk called C<test1.img> containing a "
19323 "single ext2-formatted partition:"
19327 #: ../fish/guestfish.pod:135
19330 " guestfish -N fs\n"
19335 #: ../fish/guestfish.pod:137
19336 msgid "To list what is available do:"
19340 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:940
19343 " guestfish -N help | less\n"
19348 #: ../fish/guestfish.pod:141
19349 msgid "Remote control"
19353 #: ../fish/guestfish.pod:143
19356 " eval \"`guestfish --listen`\"\n"
19357 " guestfish --remote add-ro disk.img\n"
19358 " guestfish --remote run\n"
19359 " guestfish --remote lvs\n"
19364 #: ../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
19369 #: ../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
19374 #: ../fish/guestfish.pod:154
19375 msgid "Displays general help on options."
19379 #: ../fish/guestfish.pod:156
19384 #: ../fish/guestfish.pod:158
19385 msgid "B<--cmd-help>"
19389 #: ../fish/guestfish.pod:160
19390 msgid "Lists all available guestfish commands."
19394 #: ../fish/guestfish.pod:162
19399 #: ../fish/guestfish.pod:164
19400 msgid "B<--cmd-help cmd>"
19404 #: ../fish/guestfish.pod:166
19405 msgid "Displays detailed help on a single command C<cmd>."
19409 #: ../fish/guestfish.pod:168
19410 msgid "B<-a image>"
19414 #: ../fish/guestfish.pod:170
19415 msgid "B<--add image>"
19419 #: ../fish/guestfish.pod:172
19420 msgid "Add a block device or virtual machine image to the shell."
19424 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
19426 "The format of the disk image is auto-detected. To override this and force a "
19427 "particular format use the I<--format=..> option."
19431 #: ../fish/guestfish.pod:177
19433 "Using this flag is mostly equivalent to using the C<add> command, with "
19434 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
19435 "the I<--format=...> flag was given."
19439 #: ../fish/guestfish.pod:181
19444 #: ../fish/guestfish.pod:183
19445 msgid "B<--connect URI>"
19449 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
19451 "When used in conjunction with the I<-d> option, this specifies the libvirt "
19452 "URI to use. The default is to use the default libvirt connection."
19456 #: ../fish/guestfish.pod:189
19461 #: ../fish/guestfish.pod:191
19463 "If using the I<--listen> option and a csh-like shell, use this option. See "
19464 "section L</REMOTE CONTROL AND CSH> below."
19468 #: ../fish/guestfish.pod:194
19469 msgid "B<-d libvirt-domain>"
19473 #: ../fish/guestfish.pod:196
19474 msgid "B<--domain libvirt-domain>"
19478 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
19480 "Add disks from the named libvirt domain. If the I<--ro> option is also "
19481 "used, then any libvirt domain can be used. However in write mode, only "
19482 "libvirt domains which are shut down can be named here."
19486 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
19487 msgid "Domain UUIDs can be used instead of names."
19491 #: ../fish/guestfish.pod:204
19493 "Using this flag is mostly equivalent to using the C<add-domain> command, "
19494 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
19495 "if the I<--format:...> flag was given."
19499 #: ../fish/guestfish.pod:208
19504 #: ../fish/guestfish.pod:210
19505 msgid "B<--no-dest-paths>"
19509 #: ../fish/guestfish.pod:212
19511 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
19512 "to hit the tab key to complete paths on the guest filesystem, but this "
19513 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
19514 "allow this feature to be disabled."
19518 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
19519 msgid "B<--echo-keys>"
19523 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
19525 "When prompting for keys and passphrases, guestfish normally turns echoing "
19526 "off so you cannot see what you are typing. If you are not worried about "
19527 "Tempest attacks and there is no one else in the room you can specify this "
19528 "flag to see what you are typing."
19532 #: ../fish/guestfish.pod:224
19537 #: ../fish/guestfish.pod:226
19538 msgid "B<--file file>"
19542 #: ../fish/guestfish.pod:228
19543 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
19547 #: ../fish/guestfish.pod:231
19550 " #!/usr/bin/guestfish -f\n"
19555 #: ../fish/guestfish.pod:233
19556 msgid "B<--format=raw|qcow2|..>"
19560 #: ../fish/guestfish.pod:235
19561 msgid "B<--format>"
19565 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
19567 "The default for the I<-a> option is to auto-detect the format of the disk "
19568 "image. Using this forces the disk format for I<-a> options which follow on "
19569 "the command line. Using I<--format> with no argument switches back to "
19570 "auto-detection for subsequent I<-a> options."
19574 #: ../fish/guestfish.pod:244
19577 " guestfish --format=raw -a disk.img\n"
19582 #: ../fish/guestfish.pod:246
19583 msgid "forces raw format (no auto-detection) for C<disk.img>."
19587 #: ../fish/guestfish.pod:248
19590 " guestfish --format=raw -a disk.img --format -a another.img\n"
19595 #: ../fish/guestfish.pod:250
19597 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
19598 "auto-detection for C<another.img>."
19602 #: ../fish/guestfish.pod:253
19604 "If you have untrusted raw-format guest disk images, you should use this "
19605 "option to specify the disk format. This avoids a possible security problem "
19606 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
19610 #: ../fish/guestfish.pod:258
19615 #: ../fish/guestfish.pod:260
19616 msgid "B<--inspector>"
19620 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
19622 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
19623 "system and mount filesystems as they would be mounted on the real virtual "
19628 #: ../fish/guestfish.pod:266
19629 msgid "Typical usage is either:"
19633 #: ../fish/guestfish.pod:268
19636 " guestfish -d myguest -i\n"
19641 #: ../fish/guestfish.pod:270
19642 msgid "(for an inactive libvirt domain called I<myguest>), or:"
19646 #: ../fish/guestfish.pod:272
19649 " guestfish --ro -d myguest -i\n"
19654 #: ../fish/guestfish.pod:274
19655 msgid "(for active domains, readonly), or specify the block device directly:"
19659 #: ../fish/guestfish.pod:276
19662 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
19667 #: ../fish/guestfish.pod:278
19669 "Note that the command line syntax changed slightly over older versions of "
19670 "guestfish. You can still use the old syntax:"
19674 #: ../fish/guestfish.pod:281
19677 " guestfish [--ro] -i disk.img\n"
19682 #: ../fish/guestfish.pod:283
19685 " guestfish [--ro] -i libvirt-domain\n"
19690 #: ../fish/guestfish.pod:285
19692 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
19693 "then using other commands to mount the filesystems that were found."
19697 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
19698 msgid "B<--keys-from-stdin>"
19702 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
19704 "Read key or passphrase parameters from stdin. The default is to try to read "
19705 "passphrases from the user by opening C</dev/tty>."
19709 #: ../fish/guestfish.pod:294
19710 msgid "B<--listen>"
19714 #: ../fish/guestfish.pod:296
19716 "Fork into the background and listen for remote commands. See section "
19717 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
19721 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
19726 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
19728 "Connect to a live virtual machine. (Experimental, see "
19729 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
19733 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
19734 msgid "B<-m dev[:mountpoint[:options]]>"
19738 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
19739 msgid "B<--mount dev[:mountpoint[:options]]>"
19743 #: ../fish/guestfish.pod:308
19744 msgid "Mount the named partition or logical volume on the given mountpoint."
19748 #: ../fish/guestfish.pod:310
19749 msgid "If the mountpoint is omitted, it defaults to C</>."
19753 #: ../fish/guestfish.pod:312
19754 msgid "You have to mount something on C</> before most commands will work."
19758 #: ../fish/guestfish.pod:314
19760 "If any I<-m> or I<--mount> options are given, the guest is automatically "
19765 #: ../fish/guestfish.pod:317
19767 "If you don't know what filesystems a disk image contains, you can either run "
19768 "guestfish without this option, then list the partitions, filesystems and LVs "
19769 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
19770 "commands), or you can use the L<virt-filesystems(1)> program."
19774 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
19776 "The third (and rarely used) part of the mount parameter is the list of mount "
19777 "options used to mount the underlying filesystem. If this is not given, then "
19778 "the mount options are either the empty string or C<ro> (the latter if the "
19779 "I<--ro> flag is used). By specifying the mount options, you override this "
19780 "default choice. Probably the only time you would use this is to enable ACLs "
19781 "and/or extended attributes if the filesystem can support them:"
19785 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
19788 " -m /dev/sda1:/:acl,user_xattr\n"
19793 #: ../fish/guestfish.pod:333
19794 msgid "Using this flag is equivalent to using the C<mount-options> command."
19798 #: ../fish/guestfish.pod:335
19803 #: ../fish/guestfish.pod:337
19804 msgid "B<--no-sync>"
19808 #: ../fish/guestfish.pod:339
19810 "Disable autosync. This is enabled by default. See the discussion of "
19811 "autosync in the L<guestfs(3)> manpage."
19815 #: ../fish/guestfish.pod:342
19820 #: ../fish/guestfish.pod:344
19821 msgid "B<--new type>"
19825 #: ../fish/guestfish.pod:346
19830 #: ../fish/guestfish.pod:348
19832 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
19833 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
19834 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
19839 #: ../fish/guestfish.pod:353
19840 msgid "B<--progress-bars>"
19844 #: ../fish/guestfish.pod:355
19845 msgid "Enable progress bars, even when guestfish is used non-interactively."
19849 #: ../fish/guestfish.pod:357
19851 "Progress bars are enabled by default when guestfish is used as an "
19852 "interactive shell."
19856 #: ../fish/guestfish.pod:360
19857 msgid "B<--no-progress-bars>"
19861 #: ../fish/guestfish.pod:362
19862 msgid "Disable progress bars."
19866 #: ../fish/guestfish.pod:364
19867 msgid "B<--remote[=pid]>"
19871 #: ../fish/guestfish.pod:366
19873 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
19874 "CONTROL GUESTFISH OVER A SOCKET> below."
19878 #: ../fish/guestfish.pod:369
19883 #: ../fish/guestfish.pod:371
19888 #: ../fish/guestfish.pod:373
19890 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19891 "mounts are done read-only."
19895 #: ../fish/guestfish.pod:376
19897 "The option must always be used if the disk image or virtual machine might be "
19898 "running, and is generally recommended in cases where you don't need write "
19899 "access to the disk."
19903 #: ../fish/guestfish.pod:380
19905 "Note that prepared disk images created with I<-N> are not affected by this "
19906 "option. Also commands like C<add> are not affected - you have to specify "
19907 "the C<readonly:true> option explicitly if you need it."
19911 #: ../fish/guestfish.pod:384
19912 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
19916 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
19917 msgid "B<--selinux>"
19921 #: ../fish/guestfish.pod:388
19922 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
19926 #: ../fish/guestfish.pod:390
19931 #: ../fish/guestfish.pod:392
19932 msgid "B<--verbose>"
19936 #: ../fish/guestfish.pod:394
19938 "Enable very verbose messages. This is particularly useful if you find a "
19943 #: ../fish/guestfish.pod:397
19948 #: ../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
19949 msgid "B<--version>"
19953 #: ../fish/guestfish.pod:401
19954 msgid "Display the guestfish / libguestfs version number and exit."
19958 #: ../fish/guestfish.pod:403
19963 #: ../fish/guestfish.pod:405
19968 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
19970 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
19971 "mounts are done read-write."
19975 #: ../fish/guestfish.pod:410
19976 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
19980 #: ../fish/guestfish.pod:412
19985 #: ../fish/guestfish.pod:414
19986 msgid "Echo each command before executing it."
19990 #: ../fish/guestfish.pod:418
19991 msgid "COMMANDS ON COMMAND LINE"
19995 #: ../fish/guestfish.pod:420
19996 msgid "Any additional (non-option) arguments are treated as commands to execute."
20000 #: ../fish/guestfish.pod:423
20002 "Commands to execute should be separated by a colon (C<:>), where the colon "
20003 "is a separate parameter. Thus:"
20007 #: ../fish/guestfish.pod:426
20010 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
20015 #: ../fish/guestfish.pod:428
20017 "If there are no additional arguments, then we enter a shell, either an "
20018 "interactive shell with a prompt (if the input is a terminal) or a "
20019 "non-interactive shell."
20023 #: ../fish/guestfish.pod:432
20025 "In either command line mode or non-interactive shell, the first command that "
20026 "gives an error causes the whole shell to exit. In interactive mode (with a "
20027 "prompt) if a command fails, you can continue to enter commands."
20031 #: ../fish/guestfish.pod:437
20032 msgid "USING launch (OR run)"
20036 #: ../fish/guestfish.pod:439
20038 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
20039 "then launch it, then mount any disks you need, and finally issue "
20040 "actions/commands. So the general order of the day is:"
20044 #: ../fish/guestfish.pod:447
20045 msgid "add or -a/--add"
20049 #: ../fish/guestfish.pod:451
20050 msgid "launch (aka run)"
20054 #: ../fish/guestfish.pod:455
20055 msgid "mount or -m/--mount"
20059 #: ../fish/guestfish.pod:459
20060 msgid "any other commands"
20064 #: ../fish/guestfish.pod:463
20066 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
20067 "guest before mounting or performing any other commands."
20071 #: ../fish/guestfish.pod:466
20073 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
20074 "I<--new> options were given then C<run> is done automatically, simply "
20075 "because guestfish can't perform the action you asked for without doing this."
20079 #: ../fish/guestfish.pod:471
20080 msgid "OPENING DISKS FOR READ AND WRITE"
20084 #: ../fish/guestfish.pod:473
20086 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
20087 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
20088 "I<-i> and I<-m> open disk images read-only or for writing."
20092 #: ../fish/guestfish.pod:478
20094 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
20095 "opening disk images supplied on the command line for write. To open a disk "
20096 "image read-only you have to do I<-a image --ro>."
20100 #: ../fish/guestfish.pod:482
20102 "This matters: If you accidentally open a live VM disk image writable then "
20103 "you will cause irreversible disk corruption."
20107 #: ../fish/guestfish.pod:485
20109 "By libguestfs 1.12 we intend to change the default the other way. Disk "
20110 "images will be opened read-only. You will have to either specify "
20111 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
20112 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
20113 "access for disk images specified by those other command line options."
20117 #: ../fish/guestfish.pod:492
20119 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
20120 "which does nothing (it is already the default). However it is highly "
20121 "recommended that you use this option to indicate that you need write access, "
20122 "and prepare your scripts for the day when this option will be required for "
20127 #: ../fish/guestfish.pod:498
20129 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
20130 "other libguestfs program apart from guestfish and guestmount."
20134 #: ../fish/guestfish.pod:501
20139 #: ../fish/guestfish.pod:503
20141 "You can quote ordinary parameters using either single or double quotes. For "
20146 #: ../fish/guestfish.pod:506
20149 " add \"file with a space.img\"\n"
20154 #: ../fish/guestfish.pod:508
20157 " rm '/file name'\n"
20162 #: ../fish/guestfish.pod:510
20170 #: ../fish/guestfish.pod:512
20172 "A few commands require a list of strings to be passed. For these, use a "
20173 "whitespace-separated list, enclosed in quotes. Strings containing "
20174 "whitespace to be passed through must be enclosed in single quotes. A "
20175 "literal single quote must be escaped with a backslash."
20179 #: ../fish/guestfish.pod:517
20182 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
20183 " command \"/bin/echo 'foo bar'\"\n"
20184 " command \"/bin/echo \\'foo\\'\"\n"
20189 #: ../fish/guestfish.pod:521
20190 msgid "OPTIONAL ARGUMENTS"
20194 #: ../fish/guestfish.pod:523
20196 "Some commands take optional arguments. These arguments appear in this "
20197 "documentation as C<[argname:..]>. You can use them as in these examples:"
20201 #: ../fish/guestfish.pod:527
20204 " add-drive-opts filename\n"
20209 #: ../fish/guestfish.pod:529
20212 " add-drive-opts filename readonly:true\n"
20217 #: ../fish/guestfish.pod:531
20220 " add-drive-opts filename format:qcow2 readonly:false\n"
20225 #: ../fish/guestfish.pod:533
20227 "Each optional argument can appear at most once. All optional arguments must "
20228 "appear after the required ones."
20232 #: ../fish/guestfish.pod:536
20237 #: ../fish/guestfish.pod:538
20238 msgid "This section applies to all commands which can take integers as parameters."
20242 #: ../fish/guestfish.pod:541
20243 msgid "SIZE SUFFIX"
20247 #: ../fish/guestfish.pod:543
20249 "When the command takes a parameter measured in bytes, you can use one of the "
20250 "following suffixes to specify kilobytes, megabytes and larger sizes:"
20254 #: ../fish/guestfish.pod:549
20255 msgid "B<k> or B<K> or B<KiB>"
20259 #: ../fish/guestfish.pod:551
20260 msgid "The size in kilobytes (multiplied by 1024)."
20264 #: ../fish/guestfish.pod:553
20269 #: ../fish/guestfish.pod:555
20270 msgid "The size in SI 1000 byte units."
20274 #: ../fish/guestfish.pod:557
20275 msgid "B<M> or B<MiB>"
20279 #: ../fish/guestfish.pod:559
20280 msgid "The size in megabytes (multiplied by 1048576)."
20284 #: ../fish/guestfish.pod:561
20289 #: ../fish/guestfish.pod:563
20290 msgid "The size in SI 1000000 byte units."
20294 #: ../fish/guestfish.pod:565
20295 msgid "B<G> or B<GiB>"
20299 #: ../fish/guestfish.pod:567
20300 msgid "The size in gigabytes (multiplied by 2**30)."
20304 #: ../fish/guestfish.pod:569
20309 #: ../fish/guestfish.pod:571
20310 msgid "The size in SI 10**9 byte units."
20314 #: ../fish/guestfish.pod:573
20315 msgid "B<T> or B<TiB>"
20319 #: ../fish/guestfish.pod:575
20320 msgid "The size in terabytes (multiplied by 2**40)."
20324 #: ../fish/guestfish.pod:577
20329 #: ../fish/guestfish.pod:579
20330 msgid "The size in SI 10**12 byte units."
20334 #: ../fish/guestfish.pod:581
20335 msgid "B<P> or B<PiB>"
20339 #: ../fish/guestfish.pod:583
20340 msgid "The size in petabytes (multiplied by 2**50)."
20344 #: ../fish/guestfish.pod:585
20349 #: ../fish/guestfish.pod:587
20350 msgid "The size in SI 10**15 byte units."
20354 #: ../fish/guestfish.pod:589
20355 msgid "B<E> or B<EiB>"
20359 #: ../fish/guestfish.pod:591
20360 msgid "The size in exabytes (multiplied by 2**60)."
20364 #: ../fish/guestfish.pod:593
20369 #: ../fish/guestfish.pod:595
20370 msgid "The size in SI 10**18 byte units."
20374 #: ../fish/guestfish.pod:597
20375 msgid "B<Z> or B<ZiB>"
20379 #: ../fish/guestfish.pod:599
20380 msgid "The size in zettabytes (multiplied by 2**70)."
20384 #: ../fish/guestfish.pod:601
20389 #: ../fish/guestfish.pod:603
20390 msgid "The size in SI 10**21 byte units."
20394 #: ../fish/guestfish.pod:605
20395 msgid "B<Y> or B<YiB>"
20399 #: ../fish/guestfish.pod:607
20400 msgid "The size in yottabytes (multiplied by 2**80)."
20404 #: ../fish/guestfish.pod:609
20409 #: ../fish/guestfish.pod:611
20410 msgid "The size in SI 10**24 byte units."
20414 #: ../fish/guestfish.pod:617
20417 " truncate-size /file 1G\n"
20422 #: ../fish/guestfish.pod:619
20423 msgid "would truncate the file to 1 gigabyte."
20427 #: ../fish/guestfish.pod:621
20429 "Be careful because a few commands take sizes in kilobytes or megabytes "
20430 "(eg. the parameter to L</memsize> is specified in megabytes already). "
20431 "Adding a suffix will probably not do what you expect."
20435 #: ../fish/guestfish.pod:625
20436 msgid "OCTAL AND HEXADECIMAL NUMBERS"
20440 #: ../fish/guestfish.pod:627
20442 "For specifying the radix (base) use the C convention: C<0> to prefix an "
20443 "octal number or C<0x> to prefix a hexadecimal number. For example:"
20447 #: ../fish/guestfish.pod:630
20450 " 1234 decimal number 1234\n"
20451 " 02322 octal number, equivalent to decimal 1234\n"
20452 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
20457 #: ../fish/guestfish.pod:634
20459 "When using the C<chmod> command, you almost always want to specify an octal "
20460 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
20461 "L<chmod(1)> program):"
20465 #: ../fish/guestfish.pod:638
20468 " chmod 0777 /public # OK\n"
20469 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
20474 #: ../fish/guestfish.pod:641
20476 "Commands that return numbers usually print them in decimal, but some "
20477 "commands print numbers in other radices (eg. C<umask> prints the mode in "
20478 "octal, preceeded by C<0>)."
20482 #: ../fish/guestfish.pod:645
20483 msgid "WILDCARDS AND GLOBBING"
20487 #: ../fish/guestfish.pod:647
20489 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
20490 "(globbing) by default. So for example the following will not do what you "
20495 #: ../fish/guestfish.pod:651
20503 #: ../fish/guestfish.pod:653
20505 "Assuming you don't have a directory called literally C</home/*> then the "
20506 "above command will return an error."
20510 #: ../fish/guestfish.pod:656
20511 msgid "To perform wildcard expansion, use the C<glob> command."
20515 #: ../fish/guestfish.pod:658
20518 " glob rm-rf /home/*\n"
20523 #: ../fish/guestfish.pod:660
20525 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
20526 "many times), equivalent to:"
20530 #: ../fish/guestfish.pod:663
20533 " rm-rf /home/jim\n"
20534 " rm-rf /home/joe\n"
20535 " rm-rf /home/mary\n"
20540 #: ../fish/guestfish.pod:667
20541 msgid "C<glob> only works on simple guest paths and not on device names."
20545 #: ../fish/guestfish.pod:669
20547 "If you have several parameters, each containing a wildcard, then glob will "
20548 "perform a Cartesian product."
20552 #: ../fish/guestfish.pod:672
20557 #: ../fish/guestfish.pod:674
20559 "Any line which starts with a I<#> character is treated as a comment and "
20560 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
20561 "a command. For example:"
20565 #: ../fish/guestfish.pod:678
20568 " # this is a comment\n"
20569 " # this is a comment\n"
20570 " foo # NOT a comment\n"
20575 #: ../fish/guestfish.pod:682
20576 msgid "Blank lines are also ignored."
20580 #: ../fish/guestfish.pod:684
20581 msgid "RUNNING COMMANDS LOCALLY"
20585 #: ../fish/guestfish.pod:686
20587 "Any line which starts with a I<!> character is treated as a command sent to "
20588 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
20592 #: ../fish/guestfish.pod:690
20596 " tgz-out /remote local/remote-data.tar.gz\n"
20601 #: ../fish/guestfish.pod:693
20603 "will create a directory C<local> on the host, and then export the contents "
20604 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
20605 "(See C<tgz-out>)."
20609 #: ../fish/guestfish.pod:697
20611 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
20612 "effect, due to the way that subprocesses work in Unix."
20616 #: ../fish/guestfish.pod:700
20617 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
20621 #: ../fish/guestfish.pod:702
20623 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
20624 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
20625 "and executed as guestfish commands."
20629 #: ../fish/guestfish.pod:706
20631 "Thus you can use shell script to construct arbitrary guestfish commands "
20632 "which are then parsed by guestfish."
20636 #: ../fish/guestfish.pod:709
20638 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
20639 "through C</foo.100>) using guestfish commands alone. However this is simple "
20640 "if we use a shell script to create the guestfish commands for us:"
20644 #: ../fish/guestfish.pod:714
20647 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
20652 #: ../fish/guestfish.pod:716
20653 msgid "or with names like C</foo.001>:"
20657 #: ../fish/guestfish.pod:718
20660 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
20665 #: ../fish/guestfish.pod:720
20667 "When using guestfish interactively it can be helpful to just run the shell "
20668 "script first (ie. remove the initial C<E<lt>> character so it is just an "
20669 "ordinary I<!> local command), see what guestfish commands it would run, and "
20670 "when you are happy with those prepend the C<E<lt>> character to run the "
20671 "guestfish commands for real."
20675 #: ../fish/guestfish.pod:726
20680 #: ../fish/guestfish.pod:728
20682 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
20683 "command (a guestfish command) to the second command (any host command). For "
20688 #: ../fish/guestfish.pod:732
20691 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
20696 #: ../fish/guestfish.pod:734
20698 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
20699 "program). The above command would list all accounts in the guest filesystem "
20700 "which have UID 0, ie. root accounts including backdoors. Other examples:"
20704 #: ../fish/guestfish.pod:739
20707 " hexdump /bin/ls | head\n"
20708 " list-devices | tail -1\n"
20709 " tgz-out / - | tar ztf -\n"
20714 #: ../fish/guestfish.pod:743
20716 "The space before the pipe symbol is required, any space after the pipe "
20717 "symbol is optional. Everything after the pipe symbol is just passed "
20718 "straight to the host shell, so it can contain redirections, globs and "
20719 "anything else that makes sense on the host side."
20723 #: ../fish/guestfish.pod:748
20725 "To use a literal argument which begins with a pipe symbol, you have to quote "
20730 #: ../fish/guestfish.pod:751
20738 #: ../fish/guestfish.pod:753
20739 msgid "HOME DIRECTORIES"
20743 #: ../fish/guestfish.pod:755
20745 "If a parameter starts with the character C<~> then the tilde may be expanded "
20746 "as a home directory path (either C<~> for the current user's home directory, "
20747 "or C<~user> for another user)."
20751 #: ../fish/guestfish.pod:759
20753 "Note that home directory expansion happens for users known I<on the host>, "
20754 "not in the guest filesystem."
20758 #: ../fish/guestfish.pod:762
20760 "To use a literal argument which begins with a tilde, you have to quote it, "
20765 #: ../fish/guestfish.pod:765
20773 #: ../fish/guestfish.pod:769
20775 "Libguestfs has some support for Linux guests encrypted according to the "
20776 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
20777 "disk encryption systems used by modern Linux guests. Currently only "
20778 "LVM-on-LUKS is supported."
20782 #: ../fish/guestfish.pod:774
20783 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
20787 #: ../fish/guestfish.pod:776
20790 " ><fs> vfs-type /dev/sda2\n"
20796 #: ../fish/guestfish.pod:779
20798 "Then open those devices using L</luks-open>. This creates a device-mapper "
20799 "device called C</dev/mapper/luksdev>."
20803 #: ../fish/guestfish.pod:782
20806 " ><fs> luks-open /dev/sda2 luksdev\n"
20807 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
20812 #: ../fish/guestfish.pod:785
20814 "Finally you have to tell LVM to scan for volume groups on the newly created "
20819 #: ../fish/guestfish.pod:788
20823 " vg-activate-all true\n"
20828 #: ../fish/guestfish.pod:791
20829 msgid "The logical volume(s) can now be mounted in the usual way."
20833 #: ../fish/guestfish.pod:793
20835 "Before closing a LUKS device you must unmount any logical volumes on it and "
20836 "deactivate the volume groups by calling C<vg-activate false VG> on each "
20837 "one. Then you can close the mapper device:"
20841 #: ../fish/guestfish.pod:797
20844 " vg-activate false /dev/VG\n"
20845 " luks-close /dev/mapper/luksdev\n"
20850 #: ../fish/guestfish.pod:800
20851 msgid "WINDOWS PATHS"
20855 #: ../fish/guestfish.pod:802
20857 "If a path is prefixed with C<win:> then you can use Windows-style drive "
20858 "letters and paths (with some limitations). The following commands are "
20863 #: ../fish/guestfish.pod:806
20866 " file /WINDOWS/system32/config/system.LOG\n"
20871 #: ../fish/guestfish.pod:808
20874 " file win:\\windows\\system32\\config\\system.log\n"
20879 #: ../fish/guestfish.pod:810
20882 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
20887 #: ../fish/guestfish.pod:812
20889 "The parameter is rewritten \"behind the scenes\" by looking up the position "
20890 "where the drive is mounted, prepending that to the path, changing all "
20891 "backslash characters to forward slash, then resolving the result using "
20892 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
20893 "then the parameter might be rewritten like this:"
20897 #: ../fish/guestfish.pod:818
20900 " win:e:\\foo\\bar => /e/FOO/bar\n"
20905 #: ../fish/guestfish.pod:820
20906 msgid "This only works in argument positions that expect a path."
20910 #: ../fish/guestfish.pod:822
20911 msgid "UPLOADING AND DOWNLOADING FILES"
20915 #: ../fish/guestfish.pod:824
20917 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
20918 "others which upload from or download to a local file, you can use the "
20919 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
20923 #: ../fish/guestfish.pod:828
20931 #: ../fish/guestfish.pod:830
20932 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
20936 #: ../fish/guestfish.pod:833
20939 " tar-out /etc - | tar tf -\n"
20944 #: ../fish/guestfish.pod:835
20946 "writes the tarball to stdout and then pipes that into the external \"tar\" "
20947 "command (see L</PIPES>)."
20951 #: ../fish/guestfish.pod:838
20953 "When using C<-> to read from stdin, the input is read up to the end of "
20954 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
20955 "some arbitrary end marker:"
20959 #: ../fish/guestfish.pod:842
20962 " upload -<<END /foo\n"
20971 #: ../fish/guestfish.pod:848
20973 "Any string of characters can be used instead of C<END>. The end marker must "
20974 "appear on a line of its own, without any preceeding or following characters "
20975 "(not even spaces)."
20979 #: ../fish/guestfish.pod:852
20981 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
20982 "upload local files (so-called \"FileIn\" parameters in the generator)."
20986 #: ../fish/guestfish.pod:855
20987 msgid "EXIT ON ERROR BEHAVIOUR"
20991 #: ../fish/guestfish.pod:857
20993 "By default, guestfish will ignore any errors when in interactive mode "
20994 "(ie. taking commands from a human over a tty), and will exit on the first "
20995 "error in non-interactive mode (scripts, commands given on the command line)."
20999 #: ../fish/guestfish.pod:862
21001 "If you prefix a command with a I<-> character, then that command will not "
21002 "cause guestfish to exit, even if that (one) command returns an error."
21006 #: ../fish/guestfish.pod:866
21007 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
21011 #: ../fish/guestfish.pod:868
21013 "Guestfish can be remote-controlled over a socket. This is useful "
21014 "particularly in shell scripts where you want to make several different "
21015 "changes to a filesystem, but you don't want the overhead of starting up a "
21016 "guestfish process each time."
21020 #: ../fish/guestfish.pod:873
21021 msgid "Start a guestfish server process using:"
21025 #: ../fish/guestfish.pod:875
21028 " eval \"`guestfish --listen`\"\n"
21033 #: ../fish/guestfish.pod:877
21034 msgid "and then send it commands by doing:"
21038 #: ../fish/guestfish.pod:879
21041 " guestfish --remote cmd [...]\n"
21046 #: ../fish/guestfish.pod:881
21047 msgid "To cause the server to exit, send it the exit command:"
21051 #: ../fish/guestfish.pod:883
21054 " guestfish --remote exit\n"
21059 #: ../fish/guestfish.pod:885
21061 "Note that the server will normally exit if there is an error in a command. "
21062 "You can change this in the usual way. See section L</EXIT ON ERROR "
21067 #: ../fish/guestfish.pod:889
21068 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
21072 #: ../fish/guestfish.pod:891
21074 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
21075 "is how the I<--remote> option knows where to send the commands. You can "
21076 "have several guestfish listener processes running using:"
21080 #: ../fish/guestfish.pod:895
21083 " eval \"`guestfish --listen`\"\n"
21084 " pid1=$GUESTFISH_PID\n"
21085 " eval \"`guestfish --listen`\"\n"
21086 " pid2=$GUESTFISH_PID\n"
21088 " guestfish --remote=$pid1 cmd\n"
21089 " guestfish --remote=$pid2 cmd\n"
21094 #: ../fish/guestfish.pod:903
21095 msgid "REMOTE CONTROL AND CSH"
21099 #: ../fish/guestfish.pod:905
21101 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
21106 #: ../fish/guestfish.pod:908
21109 " eval \"`guestfish --listen --csh`\"\n"
21114 #: ../fish/guestfish.pod:910
21115 msgid "REMOTE CONTROL DETAILS"
21119 #: ../fish/guestfish.pod:912
21121 "Remote control happens over a Unix domain socket called "
21122 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
21123 "of the process, and C<$PID> is the process ID of the server."
21127 #: ../fish/guestfish.pod:916
21128 msgid "Guestfish client and server versions must match exactly."
21132 #: ../fish/guestfish.pod:918
21133 msgid "PREPARED DISK IMAGES"
21137 #: ../fish/guestfish.pod:920
21139 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
21140 "preformatted disk images that guestfish can make for you to save typing. "
21141 "This is particularly useful for testing purposes. This option is used "
21142 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
21143 "can be mixed with I<-a>)."
21147 #: ../fish/guestfish.pod:926
21149 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
21150 "the second and so on. Existing files in the current directory are "
21155 #: ../fish/guestfish.pod:930
21157 "The type briefly describes how the disk should be sized, partitioned, how "
21158 "filesystem(s) should be created, and how content should be added. "
21159 "Optionally the type can be followed by extra parameters, separated by C<:> "
21160 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
21161 "sparsely-allocated disk, containing a single partition, with the partition "
21162 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
21163 "on a 1GB disk instead."
21167 #: ../fish/guestfish.pod:938
21168 msgid "To list the available types and any extra parameters they take, run:"
21172 #: ../fish/guestfish.pod:942
21174 "Note that the prepared filesystem is not mounted. You would usually have to "
21175 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
21179 #: ../fish/guestfish.pod:946
21181 "If any I<-N> or I<--new> options are given, the guest is automatically "
21186 #: ../fish/guestfish.pod:951
21187 msgid "Create a 100MB disk with an ext4-formatted partition:"
21191 #: ../fish/guestfish.pod:953
21194 " guestfish -N fs:ext4\n"
21199 #: ../fish/guestfish.pod:955
21200 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
21204 #: ../fish/guestfish.pod:957
21207 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
21212 #: ../fish/guestfish.pod:959
21213 msgid "Create a blank 200MB disk:"
21217 #: ../fish/guestfish.pod:961
21220 " guestfish -N disk:200M\n"
21225 #: ../fish/guestfish.pod:963
21226 msgid "PROGRESS BARS"
21230 #: ../fish/guestfish.pod:965
21232 "Some (not all) long-running commands send progress notification messages as "
21233 "they are running. Guestfish turns these messages into progress bars."
21237 #: ../fish/guestfish.pod:969
21239 "When a command that supports progress bars takes longer than two seconds to "
21240 "run, and if progress bars are enabled, then you will see one appearing below "
21245 #: ../fish/guestfish.pod:973
21248 " ><fs> copy-size /large-file /another-file 2048M\n"
21249 " / 10% [#####-----------------------------------------] 00:30\n"
21254 #: ../fish/guestfish.pod:976
21256 "The spinner on the left hand side moves round once for every progress "
21257 "notification received from the backend. This is a (reasonably) golden "
21258 "assurance that the command is \"doing something\" even if the progress bar "
21259 "is not moving, because the command is able to send the progress "
21260 "notifications. When the bar reaches 100% and the command finishes, the "
21261 "spinner disappears."
21265 #: ../fish/guestfish.pod:983
21267 "Progress bars are enabled by default when guestfish is used interactively. "
21268 "You can enable them even for non-interactive modes using I<--progress-bars>, "
21269 "and you can disable them completely using I<--no-progress-bars>."
21273 #: ../fish/guestfish.pod:988
21274 msgid "GUESTFISH COMMANDS"
21278 #: ../fish/guestfish.pod:990
21280 "The commands in this section are guestfish convenience commands, in other "
21281 "words, they are not part of the L<guestfs(3)> API."
21285 #: ../fish/guestfish.pod:993
21290 #: ../fish/guestfish.pod:995
21299 #: ../fish/guestfish.pod:998
21300 msgid "Without any parameter, this provides general help."
21304 #: ../fish/guestfish.pod:1000
21305 msgid "With a C<cmd> parameter, this displays detailed help for that command."
21309 #: ../fish/guestfish.pod:1002
21310 msgid "quit | exit"
21314 #: ../fish/guestfish.pod:1004
21315 msgid "This exits guestfish. You can also use C<^D> key."
21319 #: ../fish/guestfish.pod:1006
21320 msgid "@FISH_COMMANDS@"
21324 #: ../fish/guestfish.pod:1008
21329 #: ../fish/guestfish.pod:1012 ../test-tool/libguestfs-test-tool.pod:77
21334 #: ../fish/guestfish.pod:1014
21336 "guestfish returns 0 if the commands completed without error, or 1 if there "
21341 #: ../fish/guestfish.pod:1021
21346 #: ../fish/guestfish.pod:1023
21348 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
21353 #: ../fish/guestfish.pod:1026
21354 msgid "GUESTFISH_DISPLAY_IMAGE"
21358 #: ../fish/guestfish.pod:1028
21360 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
21361 "If not set, it uses L<display(1)>."
21365 #: ../fish/guestfish.pod:1031
21366 msgid "GUESTFISH_PID"
21370 #: ../fish/guestfish.pod:1033
21372 "Used with the I<--remote> option to specify the remote guestfish process to "
21373 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
21377 #: ../fish/guestfish.pod:1037
21382 #: ../fish/guestfish.pod:1039
21384 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
21385 "not specified, the external L<hexedit(1)> program is used."
21389 #: ../fish/guestfish.pod:1043
21394 #: ../fish/guestfish.pod:1045
21396 "If compiled with GNU readline support, various files in the home directory "
21397 "can be used. See L</FILES>."
21401 #: ../fish/guestfish.pod:1054
21403 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
21404 "effect as using the B<-v> option."
21408 #: ../fish/guestfish.pod:1066
21410 "Set the path that guestfish uses to search for kernel and initrd.img. See "
21411 "the discussion of paths in L<guestfs(3)>."
21415 #: ../fish/guestfish.pod:1077
21416 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
21420 #: ../fish/guestfish.pod:1079
21425 #: ../fish/guestfish.pod:1081
21427 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
21432 #: ../fish/guestfish.pod:1097 ../fuse/guestmount.pod:264
21437 #: ../fish/guestfish.pod:1101 ../fuse/guestmount.pod:268
21438 msgid "$HOME/.libguestfs-tools.rc"
21442 #: ../fish/guestfish.pod:1103 ../fuse/guestmount.pod:270
21443 msgid "/etc/libguestfs-tools.conf"
21447 #: ../fish/guestfish.pod:1105 ../fuse/guestmount.pod:272
21449 "This configuration file controls the default read-only or read-write mode "
21450 "(I<--ro> or I<--rw>)."
21454 #: ../fish/guestfish.pod:1108
21455 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
21459 #: ../fish/guestfish.pod:1110
21460 msgid "$HOME/.guestfish"
21464 #: ../fish/guestfish.pod:1112
21466 "If compiled with GNU readline support, then the command history is saved in "
21471 #: ../fish/guestfish.pod:1115
21472 msgid "$HOME/.inputrc"
21476 #: ../fish/guestfish.pod:1117
21477 msgid "/etc/inputrc"
21481 #: ../fish/guestfish.pod:1119
21483 "If compiled with GNU readline support, then these files can be used to "
21484 "configure readline. For further information, please see "
21485 "L<readline(3)/INITIALIZATION FILE>."
21489 #: ../fish/guestfish.pod:1123
21490 msgid "To write rules which only apply to guestfish, use:"
21494 #: ../fish/guestfish.pod:1125
21504 #: ../fish/guestfish.pod:1129
21506 "Variables that you can set in inputrc that change the behaviour of guestfish "
21507 "in useful ways include:"
21511 #: ../fish/guestfish.pod:1134
21512 msgid "completion-ignore-case (default: on)"
21516 #: ../fish/guestfish.pod:1136
21518 "By default, guestfish will ignore case when tab-completing paths on the "
21523 #: ../fish/guestfish.pod:1139
21526 " set completion-ignore-case off\n"
21531 #: ../fish/guestfish.pod:1141
21532 msgid "to make guestfish case sensitive."
21536 #: ../fish/guestfish.pod:1145
21541 #: ../fish/guestfish.pod:1147
21542 msgid "test2.img (etc)"
21546 #: ../fish/guestfish.pod:1149
21548 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
21549 "will be created in the file C<test1.img> in the current directory. The "
21550 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
21551 "the same name will be overwritten."
21555 #: ../fish/guestfish.pod:1158
21557 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
21558 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
21559 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
21560 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
21561 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
21562 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>."
21566 #: ../fish/guestfish.pod:1189 ../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
21568 "This program is free software; you can redistribute it and/or modify it "
21569 "under the terms of the GNU General Public License as published by the Free "
21570 "Software Foundation; either version 2 of the License, or (at your option) "
21571 "any later version."
21575 #: ../fish/guestfish.pod:1194 ../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
21577 "This program is distributed in the hope that it will be useful, but WITHOUT "
21578 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
21579 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
21584 #: ../fish/guestfish.pod:1199 ../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
21586 "You should have received a copy of the GNU General Public License along with "
21587 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
21588 "Ave, Cambridge, MA 02139, USA."
21592 #: ../fish/guestfish-actions.pod:1
21597 #: ../fish/guestfish-actions.pod:3
21600 " add-cdrom filename\n"
21605 #: ../fish/guestfish-actions.pod:15
21607 "This call checks for the existence of C<filename>. This stops you from "
21608 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21609 "and C<http:> URLs. To specify those, use the general L</config> call "
21614 #: ../fish/guestfish-actions.pod:22
21616 "If you just want to add an ISO file (often you use this as an efficient way "
21617 "to transfer large files into the guest), then you should probably use "
21618 "L</add-drive-ro> instead."
21622 #: ../fish/guestfish-actions.pod:35
21627 #: ../fish/guestfish-actions.pod:37
21632 #: ../fish/guestfish-actions.pod:39
21635 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
21641 #: ../fish/guestfish-actions.pod:41
21643 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21644 "It works by connecting to libvirt, requesting the domain and domain XML from "
21645 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
21649 #: ../fish/guestfish-actions.pod:76
21651 "The other optional parameters are passed directly through to "
21652 "L</add-drive-opts>."
21656 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:1937 ../fish/guestfish-actions.pod:3077 ../fish/guestfish-actions.pod:3250
21658 "This command has one or more optional arguments. See L</OPTIONAL "
21663 #: ../fish/guestfish-actions.pod:81
21668 #: ../fish/guestfish-actions.pod:83
21671 " add-drive filename\n"
21676 #: ../fish/guestfish-actions.pod:85
21678 "This function is the equivalent of calling L</add-drive-opts> with no "
21679 "optional parameters, so the disk is added writable, with the format being "
21680 "detected automatically."
21684 #: ../fish/guestfish-actions.pod:89
21686 "Automatic detection of the format opens you up to a potential security hole "
21687 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21688 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21689 "you should think about replacing calls to this function with calls to "
21690 "L</add-drive-opts>, and specifying the format."
21694 #: ../fish/guestfish-actions.pod:96
21695 msgid "add-drive-opts"
21699 #: ../fish/guestfish-actions.pod:98
21704 #: ../fish/guestfish-actions.pod:100
21707 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
21712 #: ../fish/guestfish-actions.pod:127
21714 "This forces the image format. If you omit this (or use L</add-drive> or "
21715 "L</add-drive-ro>) then the format is automatically detected. Possible "
21716 "formats include C<raw> and C<qcow2>."
21720 #: ../fish/guestfish-actions.pod:138
21722 "This rarely-used option lets you emulate the behaviour of the deprecated "
21723 "L</add-drive-with-if> call (q.v.)"
21727 #: ../fish/guestfish-actions.pod:145
21728 msgid "add-drive-ro"
21732 #: ../fish/guestfish-actions.pod:147
21737 #: ../fish/guestfish-actions.pod:149
21740 " add-drive-ro filename\n"
21745 #: ../fish/guestfish-actions.pod:151
21747 "This function is the equivalent of calling L</add-drive-opts> with the "
21748 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
21749 "is added read-only, with the format being detected automatically."
21753 #: ../fish/guestfish-actions.pod:156
21754 msgid "add-drive-ro-with-if"
21758 #: ../fish/guestfish-actions.pod:158
21761 " add-drive-ro-with-if filename iface\n"
21766 #: ../fish/guestfish-actions.pod:160
21768 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
21769 "interface emulation to use at run time."
21773 #: ../fish/guestfish-actions.pod:170
21774 msgid "add-drive-with-if"
21778 #: ../fish/guestfish-actions.pod:172
21781 " add-drive-with-if filename iface\n"
21786 #: ../fish/guestfish-actions.pod:174
21788 "This is the same as L</add-drive> but it allows you to specify the QEMU "
21789 "interface emulation to use at run time."
21793 #: ../fish/guestfish-actions.pod:184
21798 #: ../fish/guestfish-actions.pod:186
21801 " aug-clear augpath\n"
21806 #: ../fish/guestfish-actions.pod:191
21811 #: ../fish/guestfish-actions.pod:193
21819 #: ../fish/guestfish-actions.pod:195
21821 "Close the current Augeas handle and free up any resources used by it. After "
21822 "calling this, you have to call L</aug-init> again before you can use any "
21823 "other Augeas functions."
21827 #: ../fish/guestfish-actions.pod:200
21828 msgid "aug-defnode"
21832 #: ../fish/guestfish-actions.pod:202
21835 " aug-defnode name expr val\n"
21840 #: ../fish/guestfish-actions.pod:207
21842 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21843 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
21844 "containing that single node."
21848 #: ../fish/guestfish-actions.pod:215
21853 #: ../fish/guestfish-actions.pod:217
21856 " aug-defvar name expr\n"
21861 #: ../fish/guestfish-actions.pod:226
21866 #: ../fish/guestfish-actions.pod:228
21869 " aug-get augpath\n"
21874 #: ../fish/guestfish-actions.pod:233
21879 #: ../fish/guestfish-actions.pod:235
21882 " aug-init root flags\n"
21887 #: ../fish/guestfish-actions.pod:241
21888 msgid "You must call this before using any other L</aug-*> commands."
21892 #: ../fish/guestfish-actions.pod:276
21893 msgid "Do not load the tree in L</aug-init>."
21897 #: ../fish/guestfish-actions.pod:280
21898 msgid "To close the handle, you can call L</aug-close>."
21902 #: ../fish/guestfish-actions.pod:284
21907 #: ../fish/guestfish-actions.pod:286
21910 " aug-insert augpath label true|false\n"
21915 #: ../fish/guestfish-actions.pod:296
21920 #: ../fish/guestfish-actions.pod:298
21928 #: ../fish/guestfish-actions.pod:305
21933 #: ../fish/guestfish-actions.pod:307
21936 " aug-ls augpath\n"
21941 #: ../fish/guestfish-actions.pod:309
21943 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
21944 "resulting nodes into alphabetical order."
21948 #: ../fish/guestfish-actions.pod:312
21953 #: ../fish/guestfish-actions.pod:314
21956 " aug-match augpath\n"
21961 #: ../fish/guestfish-actions.pod:320
21966 #: ../fish/guestfish-actions.pod:322
21969 " aug-mv src dest\n"
21974 #: ../fish/guestfish-actions.pod:327
21979 #: ../fish/guestfish-actions.pod:329
21982 " aug-rm augpath\n"
21987 #: ../fish/guestfish-actions.pod:335
21992 #: ../fish/guestfish-actions.pod:337
22000 #: ../fish/guestfish-actions.pod:341
22002 "The flags which were passed to L</aug-init> affect exactly how files are "
22007 #: ../fish/guestfish-actions.pod:344
22012 #: ../fish/guestfish-actions.pod:346
22015 " aug-set augpath val\n"
22020 #: ../fish/guestfish-actions.pod:350
22022 "In the Augeas API, it is possible to clear a node by setting the value to "
22023 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22024 "this call. Instead you must use the L</aug-clear> call."
22028 #: ../fish/guestfish-actions.pod:355
22033 #: ../fish/guestfish-actions.pod:357
22036 " available 'groups ...'\n"
22041 #: ../fish/guestfish-actions.pod:363
22043 "The libguestfs groups, and the functions that those groups correspond to, "
22044 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22045 "runtime by calling L</available-all-groups>."
22049 #: ../fish/guestfish-actions.pod:387
22050 msgid "You must call L</launch> before calling this function."
22054 #: ../fish/guestfish-actions.pod:409
22056 "This call was added in version C<1.0.80>. In previous versions of "
22057 "libguestfs all you could do would be to speculatively execute a command to "
22058 "find out if the daemon implemented it. See also L</version>."
22062 #: ../fish/guestfish-actions.pod:416
22063 msgid "available-all-groups"
22067 #: ../fish/guestfish-actions.pod:418
22070 " available-all-groups\n"
22075 #: ../fish/guestfish-actions.pod:420
22077 "This command returns a list of all optional groups that this daemon knows "
22078 "about. Note this returns both supported and unsupported groups. To find "
22079 "out which ones the daemon can actually support you have to call "
22080 "L</available> on each member of the returned list."
22084 #: ../fish/guestfish-actions.pod:426
22085 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
22089 #: ../fish/guestfish-actions.pod:428
22094 #: ../fish/guestfish-actions.pod:430
22097 " base64-in (base64file|-) filename\n"
22102 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444 ../fish/guestfish-actions.pod:668 ../fish/guestfish-actions.pod:837 ../fish/guestfish-actions.pod:856 ../fish/guestfish-actions.pod:1230 ../fish/guestfish-actions.pod:4523 ../fish/guestfish-actions.pod:4535 ../fish/guestfish-actions.pod:4546 ../fish/guestfish-actions.pod:4557 ../fish/guestfish-actions.pod:4609 ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4672 ../fish/guestfish-actions.pod:4695
22103 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
22107 #: ../fish/guestfish-actions.pod:437
22112 #: ../fish/guestfish-actions.pod:439
22115 " base64-out filename (base64file|-)\n"
22120 #: ../fish/guestfish-actions.pod:446
22121 msgid "blockdev-flushbufs"
22125 #: ../fish/guestfish-actions.pod:448
22128 " blockdev-flushbufs device\n"
22133 #: ../fish/guestfish-actions.pod:455
22134 msgid "blockdev-getbsz"
22138 #: ../fish/guestfish-actions.pod:457
22141 " blockdev-getbsz device\n"
22146 #: ../fish/guestfish-actions.pod:466
22147 msgid "blockdev-getro"
22151 #: ../fish/guestfish-actions.pod:468
22154 " blockdev-getro device\n"
22159 #: ../fish/guestfish-actions.pod:475
22160 msgid "blockdev-getsize64"
22164 #: ../fish/guestfish-actions.pod:477
22167 " blockdev-getsize64 device\n"
22172 #: ../fish/guestfish-actions.pod:481
22173 msgid "See also L</blockdev-getsz>."
22177 #: ../fish/guestfish-actions.pod:485
22178 msgid "blockdev-getss"
22182 #: ../fish/guestfish-actions.pod:487
22185 " blockdev-getss device\n"
22190 #: ../fish/guestfish-actions.pod:492
22191 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
22195 #: ../fish/guestfish-actions.pod:497
22196 msgid "blockdev-getsz"
22200 #: ../fish/guestfish-actions.pod:499
22203 " blockdev-getsz device\n"
22208 #: ../fish/guestfish-actions.pod:504
22210 "See also L</blockdev-getss> for the real sector size of the device, and "
22211 "L</blockdev-getsize64> for the more useful I<size in bytes>."
22215 #: ../fish/guestfish-actions.pod:510
22216 msgid "blockdev-rereadpt"
22220 #: ../fish/guestfish-actions.pod:512
22223 " blockdev-rereadpt device\n"
22228 #: ../fish/guestfish-actions.pod:518
22229 msgid "blockdev-setbsz"
22233 #: ../fish/guestfish-actions.pod:520
22236 " blockdev-setbsz device blocksize\n"
22241 #: ../fish/guestfish-actions.pod:529
22242 msgid "blockdev-setro"
22246 #: ../fish/guestfish-actions.pod:531
22249 " blockdev-setro device\n"
22254 #: ../fish/guestfish-actions.pod:537
22255 msgid "blockdev-setrw"
22259 #: ../fish/guestfish-actions.pod:539
22262 " blockdev-setrw device\n"
22267 #: ../fish/guestfish-actions.pod:545
22268 msgid "case-sensitive-path"
22272 #: ../fish/guestfish-actions.pod:547
22275 " case-sensitive-path path\n"
22280 #: ../fish/guestfish-actions.pod:571
22282 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
22283 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22284 "how the directories were originally created under Windows)."
22288 #: ../fish/guestfish-actions.pod:579
22289 msgid "See also L</realpath>."
22293 #: ../fish/guestfish-actions.pod:581
22298 #: ../fish/guestfish-actions.pod:583
22306 #: ../fish/guestfish-actions.pod:587
22308 "Note that this function cannot correctly handle binary files (specifically, "
22309 "files containing C<\\0> character which is treated as end of string). For "
22310 "those you need to use the L</read-file> or L</download> functions which have "
22311 "a more complex interface."
22315 #: ../fish/guestfish-actions.pod:595
22320 #: ../fish/guestfish-actions.pod:597
22323 " checksum csumtype path\n"
22328 #: ../fish/guestfish-actions.pod:640
22329 msgid "To get the checksum for a device, use L</checksum-device>."
22333 #: ../fish/guestfish-actions.pod:642
22334 msgid "To get the checksums for many files, use L</checksums-out>."
22338 #: ../fish/guestfish-actions.pod:644
22339 msgid "checksum-device"
22343 #: ../fish/guestfish-actions.pod:646
22346 " checksum-device csumtype device\n"
22351 #: ../fish/guestfish-actions.pod:648
22353 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22354 "device named C<device>. For the types of checksums supported see the "
22355 "L</checksum> command."
22359 #: ../fish/guestfish-actions.pod:652
22360 msgid "checksums-out"
22364 #: ../fish/guestfish-actions.pod:654
22367 " checksums-out csumtype directory (sumsfile|-)\n"
22372 #: ../fish/guestfish-actions.pod:670
22377 #: ../fish/guestfish-actions.pod:672
22380 " chmod mode path\n"
22385 #: ../fish/guestfish-actions.pod:683
22390 #: ../fish/guestfish-actions.pod:685
22393 " chown owner group path\n"
22398 #: ../fish/guestfish-actions.pod:693
22403 #: ../fish/guestfish-actions.pod:695
22406 " command 'arguments ...'\n"
22411 #: ../fish/guestfish-actions.pod:702
22413 "The single parameter is an argv-style list of arguments. The first element "
22414 "is the name of the program to run. Subsequent elements are parameters. The "
22415 "list must be non-empty (ie. must contain a program name). Note that the "
22416 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
22420 #: ../fish/guestfish-actions.pod:730
22421 msgid "command-lines"
22425 #: ../fish/guestfish-actions.pod:732
22428 " command-lines 'arguments ...'\n"
22433 #: ../fish/guestfish-actions.pod:734
22434 msgid "This is the same as L</command>, but splits the result into a list of lines."
22438 #: ../fish/guestfish-actions.pod:737
22439 msgid "See also: L</sh-lines>"
22443 #: ../fish/guestfish-actions.pod:742
22448 #: ../fish/guestfish-actions.pod:744
22451 " config qemuparam qemuvalue\n"
22456 #: ../fish/guestfish-actions.pod:755
22461 #: ../fish/guestfish-actions.pod:757
22464 " copy-size src dest size\n"
22469 #: ../fish/guestfish-actions.pod:765
22474 #: ../fish/guestfish-actions.pod:767
22482 #: ../fish/guestfish-actions.pod:772
22487 #: ../fish/guestfish-actions.pod:774
22495 #: ../fish/guestfish-actions.pod:779
22500 #: ../fish/guestfish-actions.pod:781
22508 #: ../fish/guestfish-actions.pod:788
22510 "If the destination is a device, it must be as large or larger than the "
22511 "source file or device, otherwise the copy will fail. This command cannot do "
22512 "partial copies (see L</copy-size>)."
22516 #: ../fish/guestfish-actions.pod:792
22521 #: ../fish/guestfish-actions.pod:794
22529 #: ../fish/guestfish-actions.pod:798 ../fish/guestfish-actions.pod:809
22531 "This command is mostly useful for interactive sessions. It is I<not> "
22532 "intended that you try to parse the output string. Use L</statvfs> from "
22537 #: ../fish/guestfish-actions.pod:802
22542 #: ../fish/guestfish-actions.pod:804
22550 #: ../fish/guestfish-actions.pod:813
22555 #: ../fish/guestfish-actions.pod:815
22563 #: ../fish/guestfish-actions.pod:821
22565 "Another way to get the same information is to enable verbose messages with "
22566 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
22567 "before running the program."
22571 #: ../fish/guestfish-actions.pod:826
22576 #: ../fish/guestfish-actions.pod:828
22579 " download remotefilename (filename|-)\n"
22584 #: ../fish/guestfish-actions.pod:835
22585 msgid "See also L</upload>, L</cat>."
22589 #: ../fish/guestfish-actions.pod:839
22590 msgid "download-offset"
22594 #: ../fish/guestfish-actions.pod:841
22597 " download-offset remotefilename (filename|-) offset size\n"
22602 #: ../fish/guestfish-actions.pod:849
22604 "Note that there is no limit on the amount of data that can be downloaded "
22605 "with this call, unlike with L</pread>, and this call always reads the full "
22606 "amount unless an error occurs."
22610 #: ../fish/guestfish-actions.pod:854
22611 msgid "See also L</download>, L</pread>."
22615 #: ../fish/guestfish-actions.pod:858
22616 msgid "drop-caches"
22620 #: ../fish/guestfish-actions.pod:860
22623 " drop-caches whattodrop\n"
22628 #: ../fish/guestfish-actions.pod:872
22633 #: ../fish/guestfish-actions.pod:874
22641 #: ../fish/guestfish-actions.pod:886
22646 #: ../fish/guestfish-actions.pod:888
22649 " e2fsck-f device\n"
22654 #: ../fish/guestfish-actions.pod:894
22656 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
22657 "should use L</fsck>."
22661 #: ../fish/guestfish-actions.pod:897
22662 msgid "echo-daemon"
22666 #: ../fish/guestfish-actions.pod:899
22669 " echo-daemon 'words ...'\n"
22674 #: ../fish/guestfish-actions.pod:906
22675 msgid "See also L</ping-daemon>."
22679 #: ../fish/guestfish-actions.pod:908
22684 #: ../fish/guestfish-actions.pod:910
22687 " egrep regex path\n"
22692 #: ../fish/guestfish-actions.pod:918
22697 #: ../fish/guestfish-actions.pod:920
22700 " egrepi regex path\n"
22705 #: ../fish/guestfish-actions.pod:928
22710 #: ../fish/guestfish-actions.pod:930
22713 " equal file1 file2\n"
22718 #: ../fish/guestfish-actions.pod:937
22723 #: ../fish/guestfish-actions.pod:939
22731 #: ../fish/guestfish-actions.pod:944
22732 msgid "See also L</is-file>, L</is-dir>, L</stat>."
22736 #: ../fish/guestfish-actions.pod:946
22741 #: ../fish/guestfish-actions.pod:948
22744 " fallocate path len\n"
22749 #: ../fish/guestfish-actions.pod:965
22750 msgid "fallocate64"
22754 #: ../fish/guestfish-actions.pod:967
22757 " fallocate64 path len\n"
22762 #: ../fish/guestfish-actions.pod:973
22764 "Note that this call allocates disk blocks for the file. To create a sparse "
22765 "file use L</truncate-size> instead."
22769 #: ../fish/guestfish-actions.pod:976
22771 "The deprecated call L</fallocate> does the same, but owing to an oversight "
22772 "it only allowed 30 bit lengths to be specified, effectively limiting the "
22773 "maximum size of files created through that call to 1GB."
22777 #: ../fish/guestfish-actions.pod:985
22782 #: ../fish/guestfish-actions.pod:987
22785 " fgrep pattern path\n"
22790 #: ../fish/guestfish-actions.pod:995
22795 #: ../fish/guestfish-actions.pod:997
22798 " fgrepi pattern path\n"
22803 #: ../fish/guestfish-actions.pod:1005
22808 #: ../fish/guestfish-actions.pod:1007
22816 #: ../fish/guestfish-actions.pod:1023
22818 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
22819 "(etc), L</is-zero>."
22823 #: ../fish/guestfish-actions.pod:1026
22824 msgid "file-architecture"
22828 #: ../fish/guestfish-actions.pod:1028
22831 " file-architecture filename\n"
22836 #: ../fish/guestfish-actions.pod:1131
22841 #: ../fish/guestfish-actions.pod:1133
22849 #: ../fish/guestfish-actions.pod:1137
22851 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
22852 "L</is-file> etc. To get the size of block devices, use "
22853 "L</blockdev-getsize64>."
22857 #: ../fish/guestfish-actions.pod:1141
22862 #: ../fish/guestfish-actions.pod:1143
22865 " fill c len path\n"
22870 #: ../fish/guestfish-actions.pod:1149
22872 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
22873 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
22874 "L</fill-pattern>."
22878 #: ../fish/guestfish-actions.pod:1154
22879 msgid "fill-pattern"
22883 #: ../fish/guestfish-actions.pod:1156
22886 " fill-pattern pattern len path\n"
22891 #: ../fish/guestfish-actions.pod:1158
22893 "This function is like L</fill> except that it creates a new file of length "
22894 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
22895 "is truncated if necessary to ensure the length of the file is exactly C<len> "
22900 #: ../fish/guestfish-actions.pod:1163
22905 #: ../fish/guestfish-actions.pod:1165
22908 " find directory\n"
22913 #: ../fish/guestfish-actions.pod:1179
22914 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
22918 #: ../fish/guestfish-actions.pod:1192
22919 msgid "See also L</find0>."
22923 #: ../fish/guestfish-actions.pod:1197
22928 #: ../fish/guestfish-actions.pod:1199
22931 " find0 directory (files|-)\n"
22936 #: ../fish/guestfish-actions.pod:1205
22937 msgid "This command works the same way as L</find> with the following exceptions:"
22941 #: ../fish/guestfish-actions.pod:1232
22942 msgid "findfs-label"
22946 #: ../fish/guestfish-actions.pod:1234
22949 " findfs-label label\n"
22954 #: ../fish/guestfish-actions.pod:1240
22955 msgid "To find the label of a filesystem, use L</vfs-label>."
22959 #: ../fish/guestfish-actions.pod:1242
22960 msgid "findfs-uuid"
22964 #: ../fish/guestfish-actions.pod:1244
22967 " findfs-uuid uuid\n"
22972 #: ../fish/guestfish-actions.pod:1250
22973 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
22977 #: ../fish/guestfish-actions.pod:1252
22982 #: ../fish/guestfish-actions.pod:1254
22985 " fsck fstype device\n"
22990 #: ../fish/guestfish-actions.pod:1284
22995 #: ../fish/guestfish-actions.pod:1286
23003 #: ../fish/guestfish-actions.pod:1293
23004 msgid "get-attach-method"
23008 #: ../fish/guestfish-actions.pod:1295
23011 " get-attach-method\n"
23016 #: ../fish/guestfish-actions.pod:1297
23017 msgid "Return the current attach method. See L</set-attach-method>."
23021 #: ../fish/guestfish-actions.pod:1299
23022 msgid "get-autosync"
23026 #: ../fish/guestfish-actions.pod:1301
23034 #: ../fish/guestfish-actions.pod:1305
23039 #: ../fish/guestfish-actions.pod:1307
23047 #: ../fish/guestfish-actions.pod:1311
23048 msgid "get-e2label"
23052 #: ../fish/guestfish-actions.pod:1313
23055 " get-e2label device\n"
23060 #: ../fish/guestfish-actions.pod:1325
23065 #: ../fish/guestfish-actions.pod:1327
23068 " get-e2uuid device\n"
23073 #: ../fish/guestfish-actions.pod:1339
23074 msgid "get-memsize"
23078 #: ../fish/guestfish-actions.pod:1341
23086 #: ../fish/guestfish-actions.pod:1346
23088 "If L</set-memsize> was not called on this handle, and if "
23089 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23090 "value for memsize."
23094 #: ../fish/guestfish-actions.pod:1353
23095 msgid "get-network"
23099 #: ../fish/guestfish-actions.pod:1355
23107 #: ../fish/guestfish-actions.pod:1359
23112 #: ../fish/guestfish-actions.pod:1361
23120 #: ../fish/guestfish-actions.pod:1368
23125 #: ../fish/guestfish-actions.pod:1370
23130 #: ../fish/guestfish-actions.pod:1372
23138 #: ../fish/guestfish-actions.pod:1379
23143 #: ../fish/guestfish-actions.pod:1381
23151 #: ../fish/guestfish-actions.pod:1388
23152 msgid "get-recovery-proc"
23156 #: ../fish/guestfish-actions.pod:1390
23159 " get-recovery-proc\n"
23164 #: ../fish/guestfish-actions.pod:1394
23165 msgid "get-selinux"
23169 #: ../fish/guestfish-actions.pod:1396
23177 #: ../fish/guestfish-actions.pod:1398
23179 "This returns the current setting of the selinux flag which is passed to the "
23180 "appliance at boot time. See L</set-selinux>."
23184 #: ../fish/guestfish-actions.pod:1404
23189 #: ../fish/guestfish-actions.pod:1406
23197 #: ../fish/guestfish-actions.pod:1413
23202 #: ../fish/guestfish-actions.pod:1415
23210 #: ../fish/guestfish-actions.pod:1419
23215 #: ../fish/guestfish-actions.pod:1421
23223 #: ../fish/guestfish-actions.pod:1423
23225 "Return the current umask. By default the umask is C<022> unless it has been "
23226 "set by calling L</umask>."
23230 #: ../fish/guestfish-actions.pod:1426
23231 msgid "get-verbose"
23235 #: ../fish/guestfish-actions.pod:1428
23243 #: ../fish/guestfish-actions.pod:1432
23248 #: ../fish/guestfish-actions.pod:1434
23256 #: ../fish/guestfish-actions.pod:1438
23257 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
23261 #: ../fish/guestfish-actions.pod:1441
23266 #: ../fish/guestfish-actions.pod:1443
23269 " getxattr path name\n"
23274 #: ../fish/guestfish-actions.pod:1445
23276 "Get a single extended attribute from file C<path> named C<name>. This call "
23277 "follows symlinks. If you want to lookup an extended attribute for the "
23278 "symlink itself, use L</lgetxattr>."
23282 #: ../fish/guestfish-actions.pod:1449 ../fish/guestfish-actions.pod:2476
23284 "Normally it is better to get all extended attributes from a file in one go "
23285 "by calling L</getxattrs>. However some Linux filesystem implementations are "
23286 "buggy and do not provide a way to list out attributes. For these "
23287 "filesystems (notably ntfs-3g) you have to know the names of the extended "
23288 "attributes you want in advance and call this function."
23292 #: ../fish/guestfish-actions.pod:1459
23293 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
23297 #: ../fish/guestfish-actions.pod:1461
23302 #: ../fish/guestfish-actions.pod:1463
23305 " getxattrs path\n"
23310 #: ../fish/guestfish-actions.pod:1471
23311 msgid "See also: L</lgetxattrs>, L<attr(5)>."
23315 #: ../fish/guestfish-actions.pod:1473
23316 msgid "glob-expand"
23320 #: ../fish/guestfish-actions.pod:1475
23323 " glob-expand pattern\n"
23328 #: ../fish/guestfish-actions.pod:1488
23333 #: ../fish/guestfish-actions.pod:1490
23336 " grep regex path\n"
23341 #: ../fish/guestfish-actions.pod:1498
23346 #: ../fish/guestfish-actions.pod:1500
23349 " grepi regex path\n"
23354 #: ../fish/guestfish-actions.pod:1508
23355 msgid "grub-install"
23359 #: ../fish/guestfish-actions.pod:1510
23362 " grub-install root device\n"
23367 #: ../fish/guestfish-actions.pod:1526
23372 #: ../fish/guestfish-actions.pod:1528
23380 #: ../fish/guestfish-actions.pod:1536
23385 #: ../fish/guestfish-actions.pod:1538
23388 " head-n nrlines path\n"
23393 #: ../fish/guestfish-actions.pod:1551
23398 #: ../fish/guestfish-actions.pod:1553
23406 #: ../fish/guestfish-actions.pod:1561
23411 #: ../fish/guestfish-actions.pod:1563
23414 " initrd-cat initrdpath filename\n"
23419 #: ../fish/guestfish-actions.pod:1575
23420 msgid "See also L</initrd-list>."
23424 #: ../fish/guestfish-actions.pod:1580
23425 msgid "initrd-list"
23429 #: ../fish/guestfish-actions.pod:1582
23432 " initrd-list path\n"
23437 #: ../fish/guestfish-actions.pod:1594
23438 msgid "inotify-add-watch"
23442 #: ../fish/guestfish-actions.pod:1596
23445 " inotify-add-watch path mask\n"
23450 #: ../fish/guestfish-actions.pod:1608
23451 msgid "inotify-close"
23455 #: ../fish/guestfish-actions.pod:1610
23463 #: ../fish/guestfish-actions.pod:1616
23464 msgid "inotify-files"
23468 #: ../fish/guestfish-actions.pod:1618
23476 #: ../fish/guestfish-actions.pod:1620
23478 "This function is a helpful wrapper around L</inotify-read> which just "
23479 "returns a list of pathnames of objects that were touched. The returned "
23480 "pathnames are sorted and deduplicated."
23484 #: ../fish/guestfish-actions.pod:1624
23485 msgid "inotify-init"
23489 #: ../fish/guestfish-actions.pod:1626
23492 " inotify-init maxevents\n"
23497 #: ../fish/guestfish-actions.pod:1632
23499 "C<maxevents> is the maximum number of events which will be queued up between "
23500 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
23501 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
23502 "default was 16384 events. Beyond this limit, the kernel throws away events, "
23503 "but records the fact that it threw them away by setting a flag "
23504 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
23508 #: ../fish/guestfish-actions.pod:1642
23510 "Before any events are generated, you have to add some watches to the "
23511 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
23512 "L</inotify-watch-all>."
23516 #: ../fish/guestfish-actions.pod:1648
23518 "Queued up events should be read periodically by calling L</inotify-read> (or "
23519 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
23520 "If you don't read the events out often enough then you risk the internal "
23521 "queue overflowing."
23525 #: ../fish/guestfish-actions.pod:1655
23527 "The handle should be closed after use by calling L</inotify-close>. This "
23528 "also removes any watches automatically."
23532 #: ../fish/guestfish-actions.pod:1664
23533 msgid "inotify-read"
23537 #: ../fish/guestfish-actions.pod:1666
23545 #: ../fish/guestfish-actions.pod:1679
23546 msgid "inotify-rm-watch"
23550 #: ../fish/guestfish-actions.pod:1681
23553 " inotify-rm-watch wd\n"
23558 #: ../fish/guestfish-actions.pod:1683
23559 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
23563 #: ../fish/guestfish-actions.pod:1686
23564 msgid "inspect-get-arch"
23568 #: ../fish/guestfish-actions.pod:1688
23571 " inspect-get-arch root\n"
23576 #: ../fish/guestfish-actions.pod:1690
23578 "This returns the architecture of the inspected operating system. The "
23579 "possible return values are listed under L</file-architecture>."
23583 #: ../fish/guestfish-actions.pod:1699
23584 msgid "inspect-get-distro"
23588 #: ../fish/guestfish-actions.pod:1701
23591 " inspect-get-distro root\n"
23596 #: ../fish/guestfish-actions.pod:1782
23597 msgid "inspect-get-drive-mappings"
23601 #: ../fish/guestfish-actions.pod:1784
23604 " inspect-get-drive-mappings root\n"
23609 #: ../fish/guestfish-actions.pod:1811
23611 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23612 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
23616 #: ../fish/guestfish-actions.pod:1815
23617 msgid "inspect-get-filesystems"
23621 #: ../fish/guestfish-actions.pod:1817
23624 " inspect-get-filesystems root\n"
23629 #: ../fish/guestfish-actions.pod:1827
23631 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23632 "L</inspect-get-mountpoints>."
23636 #: ../fish/guestfish-actions.pod:1830
23637 msgid "inspect-get-format"
23641 #: ../fish/guestfish-actions.pod:1832
23644 " inspect-get-format root\n"
23649 #: ../fish/guestfish-actions.pod:1861
23650 msgid "inspect-get-hostname"
23654 #: ../fish/guestfish-actions.pod:1863
23657 " inspect-get-hostname root\n"
23662 #: ../fish/guestfish-actions.pod:1873
23663 msgid "inspect-get-icon"
23667 #: ../fish/guestfish-actions.pod:1875
23670 " inspect-get-icon root [favicon:..] [highquality:..]\n"
23675 #: ../fish/guestfish-actions.pod:1939
23676 msgid "inspect-get-major-version"
23680 #: ../fish/guestfish-actions.pod:1941
23683 " inspect-get-major-version root\n"
23688 #: ../fish/guestfish-actions.pod:1957
23689 msgid "inspect-get-minor-version"
23693 #: ../fish/guestfish-actions.pod:1959
23696 " inspect-get-minor-version root\n"
23701 #: ../fish/guestfish-actions.pod:1966
23703 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23704 "L</inspect-get-major-version>."
23708 #: ../fish/guestfish-actions.pod:1969
23709 msgid "inspect-get-mountpoints"
23713 #: ../fish/guestfish-actions.pod:1971
23716 " inspect-get-mountpoints root\n"
23721 #: ../fish/guestfish-actions.pod:1990
23723 "For operating systems like Windows which still use drive letters, this call "
23724 "will only return an entry for the first drive \"mounted on\" C</>. For "
23725 "information about the mapping of drive letters to partitions, see "
23726 "L</inspect-get-drive-mappings>."
23730 #: ../fish/guestfish-actions.pod:1996
23732 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23733 "L</inspect-get-filesystems>."
23737 #: ../fish/guestfish-actions.pod:1999
23738 msgid "inspect-get-package-format"
23742 #: ../fish/guestfish-actions.pod:2001
23745 " inspect-get-package-format root\n"
23750 #: ../fish/guestfish-actions.pod:2003
23752 "This function and L</inspect-get-package-management> return the package "
23753 "format and package management tool used by the inspected operating system. "
23754 "For example for Fedora these functions would return C<rpm> (package format) "
23755 "and C<yum> (package management)."
23759 #: ../fish/guestfish-actions.pod:2018
23760 msgid "inspect-get-package-management"
23764 #: ../fish/guestfish-actions.pod:2020
23767 " inspect-get-package-management root\n"
23772 #: ../fish/guestfish-actions.pod:2022
23774 "L</inspect-get-package-format> and this function return the package format "
23775 "and package management tool used by the inspected operating system. For "
23776 "example for Fedora these functions would return C<rpm> (package format) and "
23777 "C<yum> (package management)."
23781 #: ../fish/guestfish-actions.pod:2039
23782 msgid "inspect-get-product-name"
23786 #: ../fish/guestfish-actions.pod:2041
23789 " inspect-get-product-name root\n"
23794 #: ../fish/guestfish-actions.pod:2053
23795 msgid "inspect-get-product-variant"
23799 #: ../fish/guestfish-actions.pod:2055
23802 " inspect-get-product-variant root\n"
23807 #: ../fish/guestfish-actions.pod:2076
23809 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23810 "L</inspect-get-product-name>, L</inspect-get-major-version>."
23814 #: ../fish/guestfish-actions.pod:2080
23815 msgid "inspect-get-roots"
23819 #: ../fish/guestfish-actions.pod:2082
23822 " inspect-get-roots\n"
23827 #: ../fish/guestfish-actions.pod:2084
23829 "This function is a convenient way to get the list of root devices, as "
23830 "returned from a previous call to L</inspect-os>, but without redoing the "
23831 "whole inspection process."
23835 #: ../fish/guestfish-actions.pod:2088
23837 "This returns an empty list if either no root devices were found or the "
23838 "caller has not called L</inspect-os>."
23842 #: ../fish/guestfish-actions.pod:2093
23843 msgid "inspect-get-type"
23847 #: ../fish/guestfish-actions.pod:2095
23850 " inspect-get-type root\n"
23855 #: ../fish/guestfish-actions.pod:2125
23856 msgid "inspect-get-windows-current-control-set"
23860 #: ../fish/guestfish-actions.pod:2127
23863 " inspect-get-windows-current-control-set root\n"
23868 #: ../fish/guestfish-actions.pod:2138
23869 msgid "inspect-get-windows-systemroot"
23873 #: ../fish/guestfish-actions.pod:2140
23876 " inspect-get-windows-systemroot root\n"
23881 #: ../fish/guestfish-actions.pod:2151
23882 msgid "inspect-is-live"
23886 #: ../fish/guestfish-actions.pod:2153
23889 " inspect-is-live root\n"
23894 #: ../fish/guestfish-actions.pod:2155
23896 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23897 "then this returns true if a live image was detected on the disk."
23901 #: ../fish/guestfish-actions.pod:2161
23902 msgid "inspect-is-multipart"
23906 #: ../fish/guestfish-actions.pod:2163
23909 " inspect-is-multipart root\n"
23914 #: ../fish/guestfish-actions.pod:2165
23916 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23917 "then this returns true if the disk is part of a set."
23921 #: ../fish/guestfish-actions.pod:2171
23922 msgid "inspect-is-netinst"
23926 #: ../fish/guestfish-actions.pod:2173
23929 " inspect-is-netinst root\n"
23934 #: ../fish/guestfish-actions.pod:2175
23936 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
23937 "then this returns true if the disk is a network installer, ie. not a "
23938 "self-contained install CD but one which is likely to require network access "
23939 "to complete the install."
23943 #: ../fish/guestfish-actions.pod:2183
23944 msgid "inspect-list-applications"
23948 #: ../fish/guestfish-actions.pod:2185
23951 " inspect-list-applications root\n"
23956 #: ../fish/guestfish-actions.pod:2189
23958 "I<Note:> This call works differently from other parts of the inspection "
23959 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
23960 "then mount up the disks, before calling this. Listing applications is a "
23961 "significantly more difficult operation which requires access to the full "
23962 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
23963 "are just returning data cached in the libguestfs handle, this call actually "
23964 "reads parts of the mounted filesystems during the call."
23968 #: ../fish/guestfish-actions.pod:2279
23973 #: ../fish/guestfish-actions.pod:2281
23981 #: ../fish/guestfish-actions.pod:2296
23983 "You can pass the root string(s) returned to other L</inspect-get-*> "
23984 "functions in order to query further information about each operating system, "
23985 "such as the name and version."
23989 #: ../fish/guestfish-actions.pod:2301
23991 "This function uses other libguestfs features such as L</mount-ro> and "
23992 "L</umount-all> in order to mount and unmount filesystems and look at the "
23993 "contents. This should be called with no disks currently mounted. The "
23994 "function may also use Augeas, so any existing Augeas handle will be closed."
23998 #: ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2511 ../fish/guestfish-actions.pod:2557
23999 msgid "See also L</list-filesystems>."
24003 #: ../fish/guestfish-actions.pod:2315
24004 msgid "is-blockdev"
24008 #: ../fish/guestfish-actions.pod:2317
24011 " is-blockdev path\n"
24016 #: ../fish/guestfish-actions.pod:2322 ../fish/guestfish-actions.pod:2340 ../fish/guestfish-actions.pod:2359 ../fish/guestfish-actions.pod:2368 ../fish/guestfish-actions.pod:2378 ../fish/guestfish-actions.pod:2412 ../fish/guestfish-actions.pod:2421
24017 msgid "See also L</stat>."
24021 #: ../fish/guestfish-actions.pod:2324
24026 #: ../fish/guestfish-actions.pod:2326
24034 #: ../fish/guestfish-actions.pod:2333
24039 #: ../fish/guestfish-actions.pod:2335
24042 " is-chardev path\n"
24047 #: ../fish/guestfish-actions.pod:2342
24052 #: ../fish/guestfish-actions.pod:2344
24060 #: ../fish/guestfish-actions.pod:2351
24065 #: ../fish/guestfish-actions.pod:2353
24073 #: ../fish/guestfish-actions.pod:2361
24078 #: ../fish/guestfish-actions.pod:2363
24086 #: ../fish/guestfish-actions.pod:2370
24091 #: ../fish/guestfish-actions.pod:2372
24099 #: ../fish/guestfish-actions.pod:2380
24100 msgid "is-launching"
24104 #: ../fish/guestfish-actions.pod:2382
24112 #: ../fish/guestfish-actions.pod:2389
24117 #: ../fish/guestfish-actions.pod:2391
24125 #: ../fish/guestfish-actions.pod:2396
24130 #: ../fish/guestfish-actions.pod:2398
24138 #: ../fish/guestfish-actions.pod:2405
24143 #: ../fish/guestfish-actions.pod:2407
24146 " is-socket path\n"
24151 #: ../fish/guestfish-actions.pod:2414
24156 #: ../fish/guestfish-actions.pod:2416
24159 " is-symlink path\n"
24164 #: ../fish/guestfish-actions.pod:2423
24169 #: ../fish/guestfish-actions.pod:2425
24177 #: ../fish/guestfish-actions.pod:2430
24178 msgid "is-zero-device"
24182 #: ../fish/guestfish-actions.pod:2432
24185 " is-zero-device device\n"
24190 #: ../fish/guestfish-actions.pod:2438
24191 msgid "kill-subprocess"
24195 #: ../fish/guestfish-actions.pod:2440
24198 " kill-subprocess\n"
24203 #: ../fish/guestfish-actions.pod:2444
24208 #: ../fish/guestfish-actions.pod:2446
24213 #: ../fish/guestfish-actions.pod:2448
24221 #: ../fish/guestfish-actions.pod:2456
24226 #: ../fish/guestfish-actions.pod:2458
24229 " lchown owner group path\n"
24234 #: ../fish/guestfish-actions.pod:2460
24236 "Change the file owner to C<owner> and group to C<group>. This is like "
24237 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
24242 #: ../fish/guestfish-actions.pod:2468
24247 #: ../fish/guestfish-actions.pod:2470
24250 " lgetxattr path name\n"
24255 #: ../fish/guestfish-actions.pod:2486
24256 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
24260 #: ../fish/guestfish-actions.pod:2488
24265 #: ../fish/guestfish-actions.pod:2490
24268 " lgetxattrs path\n"
24273 #: ../fish/guestfish-actions.pod:2492
24275 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
24276 "it returns the extended attributes of the link itself."
24280 #: ../fish/guestfish-actions.pod:2496
24285 #: ../fish/guestfish-actions.pod:2498
24293 #: ../fish/guestfish-actions.pod:2503
24294 msgid "list-devices"
24298 #: ../fish/guestfish-actions.pod:2505
24306 #: ../fish/guestfish-actions.pod:2513
24307 msgid "list-filesystems"
24311 #: ../fish/guestfish-actions.pod:2515
24314 " list-filesystems\n"
24319 #: ../fish/guestfish-actions.pod:2534
24321 "This command runs other libguestfs commands, which might include L</mount> "
24322 "and L</umount>, and therefore you should use this soon after launch and only "
24323 "when nothing is mounted."
24327 #: ../fish/guestfish-actions.pod:2538
24329 "Not all of the filesystems returned will be mountable. In particular, swap "
24330 "partitions are returned in the list. Also this command does not check that "
24331 "each filesystem found is valid and mountable, and some filesystems might be "
24332 "mountable but require special options. Filesystems may not all belong to a "
24333 "single logical operating system (use L</inspect-os> to look for OSes)."
24337 #: ../fish/guestfish-actions.pod:2546
24338 msgid "list-partitions"
24342 #: ../fish/guestfish-actions.pod:2548
24345 " list-partitions\n"
24350 #: ../fish/guestfish-actions.pod:2554
24352 "This does not return logical volumes. For that you will need to call "
24357 #: ../fish/guestfish-actions.pod:2559
24362 #: ../fish/guestfish-actions.pod:2561
24370 #: ../fish/guestfish-actions.pod:2569
24375 #: ../fish/guestfish-actions.pod:2571
24378 " ln target linkname\n"
24383 #: ../fish/guestfish-actions.pod:2575
24388 #: ../fish/guestfish-actions.pod:2577
24391 " ln-f target linkname\n"
24396 #: ../fish/guestfish-actions.pod:2582
24401 #: ../fish/guestfish-actions.pod:2584
24404 " ln-s target linkname\n"
24409 #: ../fish/guestfish-actions.pod:2588
24414 #: ../fish/guestfish-actions.pod:2590
24417 " ln-sf target linkname\n"
24422 #: ../fish/guestfish-actions.pod:2595
24423 msgid "lremovexattr"
24427 #: ../fish/guestfish-actions.pod:2597
24430 " lremovexattr xattr path\n"
24435 #: ../fish/guestfish-actions.pod:2599
24437 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
24438 "it removes an extended attribute of the link itself."
24442 #: ../fish/guestfish-actions.pod:2603
24447 #: ../fish/guestfish-actions.pod:2605
24455 #: ../fish/guestfish-actions.pod:2611
24457 "This command is mostly useful for interactive sessions. Programs should "
24458 "probably use L</readdir> instead."
24462 #: ../fish/guestfish-actions.pod:2614
24467 #: ../fish/guestfish-actions.pod:2616
24470 " lsetxattr xattr val vallen path\n"
24475 #: ../fish/guestfish-actions.pod:2618
24477 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
24478 "sets an extended attribute of the link itself."
24482 #: ../fish/guestfish-actions.pod:2622
24487 #: ../fish/guestfish-actions.pod:2624
24495 #: ../fish/guestfish-actions.pod:2628
24497 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
24498 "the link is stat-ed, not the file it refers to."
24502 #: ../fish/guestfish-actions.pod:2634
24507 #: ../fish/guestfish-actions.pod:2636
24510 " lstatlist path 'names ...'\n"
24515 #: ../fish/guestfish-actions.pod:2638
24517 "This call allows you to perform the L</lstat> operation on multiple files, "
24518 "where all files are in the directory C<path>. C<names> is the list of files "
24519 "from this directory."
24523 #: ../fish/guestfish-actions.pod:2647
24525 "This call is intended for programs that want to efficiently list a directory "
24526 "contents without making many round-trips. See also L</lxattrlist> for a "
24527 "similarly efficient call for getting extended attributes. Very long "
24528 "directory listings might cause the protocol message size to be exceeded, "
24529 "causing this call to fail. The caller must split up such requests into "
24530 "smaller groups of names."
24534 #: ../fish/guestfish-actions.pod:2655
24535 msgid "luks-add-key"
24539 #: ../fish/guestfish-actions.pod:2657
24542 " luks-add-key device keyslot\n"
24547 #: ../fish/guestfish-actions.pod:2664
24549 "Note that if C<keyslot> already contains a key, then this command will "
24550 "fail. You have to use L</luks-kill-slot> first to remove that key."
24554 #: ../fish/guestfish-actions.pod:2668 ../fish/guestfish-actions.pod:2690 ../fish/guestfish-actions.pod:2703 ../fish/guestfish-actions.pod:2717 ../fish/guestfish-actions.pod:2740 ../fish/guestfish-actions.pod:2750
24556 "This command has one or more key or passphrase parameters. Guestfish will "
24557 "prompt for these separately."
24561 #: ../fish/guestfish-actions.pod:2671
24566 #: ../fish/guestfish-actions.pod:2673
24569 " luks-close device\n"
24574 #: ../fish/guestfish-actions.pod:2675
24576 "This closes a LUKS device that was created earlier by L</luks-open> or "
24577 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
24578 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
24579 "underlying block device."
24583 #: ../fish/guestfish-actions.pod:2681
24584 msgid "luks-format"
24588 #: ../fish/guestfish-actions.pod:2683
24591 " luks-format device keyslot\n"
24596 #: ../fish/guestfish-actions.pod:2696
24597 msgid "luks-format-cipher"
24601 #: ../fish/guestfish-actions.pod:2698
24604 " luks-format-cipher device keyslot cipher\n"
24609 #: ../fish/guestfish-actions.pod:2700
24611 "This command is the same as L</luks-format> but it also allows you to set "
24612 "the C<cipher> used."
24616 #: ../fish/guestfish-actions.pod:2709
24617 msgid "luks-kill-slot"
24621 #: ../fish/guestfish-actions.pod:2711
24624 " luks-kill-slot device keyslot\n"
24629 #: ../fish/guestfish-actions.pod:2720
24634 #: ../fish/guestfish-actions.pod:2722
24637 " luks-open device mapname\n"
24642 #: ../fish/guestfish-actions.pod:2736
24644 "If this block device contains LVM volume groups, then calling L</vgscan> "
24645 "followed by L</vg-activate-all> will make them visible."
24649 #: ../fish/guestfish-actions.pod:2743
24650 msgid "luks-open-ro"
24654 #: ../fish/guestfish-actions.pod:2745
24657 " luks-open-ro device mapname\n"
24662 #: ../fish/guestfish-actions.pod:2747
24664 "This is the same as L</luks-open> except that a read-only mapping is "
24669 #: ../fish/guestfish-actions.pod:2753
24674 #: ../fish/guestfish-actions.pod:2755
24677 " lvcreate logvol volgroup mbytes\n"
24682 #: ../fish/guestfish-actions.pod:2760
24683 msgid "lvm-canonical-lv-name"
24687 #: ../fish/guestfish-actions.pod:2762
24690 " lvm-canonical-lv-name lvname\n"
24695 #: ../fish/guestfish-actions.pod:2771
24696 msgid "See also L</is-lv>."
24700 #: ../fish/guestfish-actions.pod:2773
24701 msgid "lvm-clear-filter"
24705 #: ../fish/guestfish-actions.pod:2775
24708 " lvm-clear-filter\n"
24713 #: ../fish/guestfish-actions.pod:2777
24715 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
24720 #: ../fish/guestfish-actions.pod:2783
24721 msgid "lvm-remove-all"
24725 #: ../fish/guestfish-actions.pod:2785
24728 " lvm-remove-all\n"
24733 #: ../fish/guestfish-actions.pod:2793
24734 msgid "lvm-set-filter"
24738 #: ../fish/guestfish-actions.pod:2795
24741 " lvm-set-filter 'devices ...'\n"
24746 #: ../fish/guestfish-actions.pod:2820
24751 #: ../fish/guestfish-actions.pod:2822
24754 " lvremove device\n"
24759 #: ../fish/guestfish-actions.pod:2830
24764 #: ../fish/guestfish-actions.pod:2832
24767 " lvrename logvol newlogvol\n"
24772 #: ../fish/guestfish-actions.pod:2836
24777 #: ../fish/guestfish-actions.pod:2838
24780 " lvresize device mbytes\n"
24785 #: ../fish/guestfish-actions.pod:2844
24786 msgid "lvresize-free"
24790 #: ../fish/guestfish-actions.pod:2846
24793 " lvresize-free lv percent\n"
24798 #: ../fish/guestfish-actions.pod:2854
24803 #: ../fish/guestfish-actions.pod:2856
24811 #: ../fish/guestfish-actions.pod:2864
24812 msgid "See also L</lvs-full>, L</list-filesystems>."
24816 #: ../fish/guestfish-actions.pod:2866
24821 #: ../fish/guestfish-actions.pod:2868
24829 #: ../fish/guestfish-actions.pod:2873
24834 #: ../fish/guestfish-actions.pod:2875
24842 #: ../fish/guestfish-actions.pod:2879
24847 #: ../fish/guestfish-actions.pod:2881
24850 " lxattrlist path 'names ...'\n"
24855 #: ../fish/guestfish-actions.pod:2897
24857 "This call is intended for programs that want to efficiently list a directory "
24858 "contents without making many round-trips. See also L</lstatlist> for a "
24859 "similarly efficient call for getting standard stats. Very long directory "
24860 "listings might cause the protocol message size to be exceeded, causing this "
24861 "call to fail. The caller must split up such requests into smaller groups of "
24866 #: ../fish/guestfish-actions.pod:2905
24871 #: ../fish/guestfish-actions.pod:2907
24879 #: ../fish/guestfish-actions.pod:2911
24884 #: ../fish/guestfish-actions.pod:2913
24887 " mkdir-mode path mode\n"
24892 #: ../fish/guestfish-actions.pod:2922
24893 msgid "See also L</mkdir>, L</umask>"
24897 #: ../fish/guestfish-actions.pod:2924
24902 #: ../fish/guestfish-actions.pod:2926
24910 #: ../fish/guestfish-actions.pod:2931
24915 #: ../fish/guestfish-actions.pod:2933
24918 " mkdtemp template\n"
24923 #: ../fish/guestfish-actions.pod:2954
24928 #: ../fish/guestfish-actions.pod:2956
24931 " mke2fs-J fstype blocksize device journal\n"
24936 #: ../fish/guestfish-actions.pod:2964
24937 msgid "See also L</mke2journal>."
24941 #: ../fish/guestfish-actions.pod:2966
24946 #: ../fish/guestfish-actions.pod:2968
24949 " mke2fs-JL fstype blocksize device label\n"
24954 #: ../fish/guestfish-actions.pod:2973
24955 msgid "See also L</mke2journal-L>."
24959 #: ../fish/guestfish-actions.pod:2975
24964 #: ../fish/guestfish-actions.pod:2977
24967 " mke2fs-JU fstype blocksize device uuid\n"
24972 #: ../fish/guestfish-actions.pod:2982
24973 msgid "See also L</mke2journal-U>."
24977 #: ../fish/guestfish-actions.pod:2984
24978 msgid "mke2journal"
24982 #: ../fish/guestfish-actions.pod:2986
24985 " mke2journal blocksize device\n"
24990 #: ../fish/guestfish-actions.pod:2993
24991 msgid "mke2journal-L"
24995 #: ../fish/guestfish-actions.pod:2995
24998 " mke2journal-L blocksize label device\n"
25003 #: ../fish/guestfish-actions.pod:2999
25004 msgid "mke2journal-U"
25008 #: ../fish/guestfish-actions.pod:3001
25011 " mke2journal-U blocksize uuid device\n"
25016 #: ../fish/guestfish-actions.pod:3005
25021 #: ../fish/guestfish-actions.pod:3007
25024 " mkfifo mode path\n"
25029 #: ../fish/guestfish-actions.pod:3009
25031 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25032 "is just a convenient wrapper around L</mknod>."
25036 #: ../fish/guestfish-actions.pod:3015
25041 #: ../fish/guestfish-actions.pod:3017
25044 " mkfs fstype device\n"
25049 #: ../fish/guestfish-actions.pod:3023
25054 #: ../fish/guestfish-actions.pod:3025
25057 " mkfs-b fstype blocksize device\n"
25062 #: ../fish/guestfish-actions.pod:3027
25064 "This call is similar to L</mkfs>, but it allows you to control the block "
25065 "size of the resulting filesystem. Supported block sizes depend on the "
25066 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25070 #: ../fish/guestfish-actions.pod:3042
25075 #: ../fish/guestfish-actions.pod:3044
25078 " mkfs-opts fstype device [blocksize:..] [features:..]\n"
25083 #: ../fish/guestfish-actions.pod:3079
25084 msgid "mkmountpoint"
25088 #: ../fish/guestfish-actions.pod:3081
25091 " mkmountpoint exemptpath\n"
25096 #: ../fish/guestfish-actions.pod:3083
25098 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
25099 "to create extra mountpoints before mounting the first filesystem."
25103 #: ../fish/guestfish-actions.pod:3107
25105 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
25106 "unexpected errors if you try to mix these calls. It is safest to manually "
25107 "unmount filesystems and remove mountpoints after use."
25111 #: ../fish/guestfish-actions.pod:3111
25113 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
25114 "for this to work for manual mountpoints, you must ensure that the innermost "
25115 "mountpoints have the longest pathnames, as in the example code above."
25119 #: ../fish/guestfish-actions.pod:3118
25121 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
25122 "L</umount-all> to be called when the handle is closed which can also trigger "
25127 #: ../fish/guestfish-actions.pod:3122
25132 #: ../fish/guestfish-actions.pod:3124
25135 " mknod mode devmajor devminor path\n"
25140 #: ../fish/guestfish-actions.pod:3134
25142 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
25143 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
25144 "regular file). These constants are available in the standard Linux header "
25145 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
25146 "wrappers around this command which bitwise OR in the appropriate constant "
25151 #: ../fish/guestfish-actions.pod:3144
25156 #: ../fish/guestfish-actions.pod:3146
25159 " mknod-b mode devmajor devminor path\n"
25164 #: ../fish/guestfish-actions.pod:3148
25166 "This call creates a block device node called C<path> with mode C<mode> and "
25167 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25168 "wrapper around L</mknod>."
25172 #: ../fish/guestfish-actions.pod:3154
25177 #: ../fish/guestfish-actions.pod:3156
25180 " mknod-c mode devmajor devminor path\n"
25185 #: ../fish/guestfish-actions.pod:3158
25187 "This call creates a char device node called C<path> with mode C<mode> and "
25188 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
25189 "wrapper around L</mknod>."
25193 #: ../fish/guestfish-actions.pod:3164
25198 #: ../fish/guestfish-actions.pod:3166
25206 #: ../fish/guestfish-actions.pod:3170
25211 #: ../fish/guestfish-actions.pod:3172
25214 " mkswap-L label device\n"
25219 #: ../fish/guestfish-actions.pod:3180
25224 #: ../fish/guestfish-actions.pod:3182
25227 " mkswap-U uuid device\n"
25232 #: ../fish/guestfish-actions.pod:3186
25233 msgid "mkswap-file"
25237 #: ../fish/guestfish-actions.pod:3188
25240 " mkswap-file path\n"
25245 #: ../fish/guestfish-actions.pod:3192
25247 "This command just writes a swap file signature to an existing file. To "
25248 "create the file itself, use something like L</fallocate>."
25252 #: ../fish/guestfish-actions.pod:3195
25257 #: ../fish/guestfish-actions.pod:3197
25260 " modprobe modulename\n"
25265 #: ../fish/guestfish-actions.pod:3204
25270 #: ../fish/guestfish-actions.pod:3206
25273 " mount device mountpoint\n"
25278 #: ../fish/guestfish-actions.pod:3222
25280 "B<Important note:> When you use this call, the filesystem options C<sync> "
25281 "and C<noatime> are set implicitly. This was originally done because we "
25282 "thought it would improve reliability, but it turns out that I<-o sync> has a "
25283 "very large negative performance impact and negligible effect on "
25284 "reliability. Therefore we recommend that you avoid using L</mount> in any "
25285 "code that needs performance, and instead use L</mount-options> (use an empty "
25286 "string for the first parameter if you don't want any options)."
25290 #: ../fish/guestfish-actions.pod:3239
25295 #: ../fish/guestfish-actions.pod:3241
25298 " mount-9p mounttag mountpoint [options:..]\n"
25303 #: ../fish/guestfish-actions.pod:3252
25308 #: ../fish/guestfish-actions.pod:3254
25311 " mount-loop file mountpoint\n"
25316 #: ../fish/guestfish-actions.pod:3260
25317 msgid "mount-options"
25321 #: ../fish/guestfish-actions.pod:3262
25324 " mount-options options device mountpoint\n"
25329 #: ../fish/guestfish-actions.pod:3264
25331 "This is the same as the L</mount> command, but it allows you to set the "
25332 "mount options as for the L<mount(8)> I<-o> flag."
25336 #: ../fish/guestfish-actions.pod:3272
25341 #: ../fish/guestfish-actions.pod:3274
25344 " mount-ro device mountpoint\n"
25349 #: ../fish/guestfish-actions.pod:3276
25351 "This is the same as the L</mount> command, but it mounts the filesystem with "
25352 "the read-only (I<-o ro>) flag."
25356 #: ../fish/guestfish-actions.pod:3279
25361 #: ../fish/guestfish-actions.pod:3281
25364 " mount-vfs options vfstype device mountpoint\n"
25369 #: ../fish/guestfish-actions.pod:3283
25371 "This is the same as the L</mount> command, but it allows you to set both the "
25372 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
25376 #: ../fish/guestfish-actions.pod:3287
25377 msgid "mountpoints"
25381 #: ../fish/guestfish-actions.pod:3289
25389 #: ../fish/guestfish-actions.pod:3291
25391 "This call is similar to L</mounts>. That call returns a list of devices. "
25392 "This one returns a hash table (map) of device name to directory where the "
25393 "device is mounted."
25397 #: ../fish/guestfish-actions.pod:3295
25402 #: ../fish/guestfish-actions.pod:3297
25410 #: ../fish/guestfish-actions.pod:3304
25411 msgid "See also: L</mountpoints>"
25415 #: ../fish/guestfish-actions.pod:3306
25420 #: ../fish/guestfish-actions.pod:3308
25428 #: ../fish/guestfish-actions.pod:3313
25429 msgid "ntfs-3g-probe"
25433 #: ../fish/guestfish-actions.pod:3315
25436 " ntfs-3g-probe true|false device\n"
25441 #: ../fish/guestfish-actions.pod:3329
25446 #: ../fish/guestfish-actions.pod:3331
25449 " ntfsresize device\n"
25454 #: ../fish/guestfish-actions.pod:3337
25455 msgid "ntfsresize-size"
25459 #: ../fish/guestfish-actions.pod:3339
25462 " ntfsresize-size device size\n"
25467 #: ../fish/guestfish-actions.pod:3341
25469 "This command is the same as L</ntfsresize> except that it allows you to "
25470 "specify the new size (in bytes) explicitly."
25474 #: ../fish/guestfish-actions.pod:3344
25479 #: ../fish/guestfish-actions.pod:3346
25482 " part-add device prlogex startsect endsect\n"
25487 #: ../fish/guestfish-actions.pod:3348
25489 "This command adds a partition to C<device>. If there is no partition table "
25490 "on the device, call L</part-init> first."
25494 #: ../fish/guestfish-actions.pod:3360
25496 "Creating a partition which covers the whole disk is not so easy. Use "
25497 "L</part-disk> to do that."
25501 #: ../fish/guestfish-actions.pod:3363
25506 #: ../fish/guestfish-actions.pod:3365
25509 " part-del device partnum\n"
25514 #: ../fish/guestfish-actions.pod:3373
25519 #: ../fish/guestfish-actions.pod:3375
25522 " part-disk device parttype\n"
25527 #: ../fish/guestfish-actions.pod:3377
25529 "This command is simply a combination of L</part-init> followed by "
25530 "L</part-add> to create a single primary partition covering the whole disk."
25534 #: ../fish/guestfish-actions.pod:3381
25536 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
25537 "possible values are described in L</part-init>."
25541 #: ../fish/guestfish-actions.pod:3387
25542 msgid "part-get-bootable"
25546 #: ../fish/guestfish-actions.pod:3389
25549 " part-get-bootable device partnum\n"
25554 #: ../fish/guestfish-actions.pod:3394
25555 msgid "See also L</part-set-bootable>."
25559 #: ../fish/guestfish-actions.pod:3396
25560 msgid "part-get-mbr-id"
25564 #: ../fish/guestfish-actions.pod:3398
25567 " part-get-mbr-id device partnum\n"
25572 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3541
25574 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
25575 "undefined results for other partition table types (see "
25576 "L</part-get-parttype>)."
25580 #: ../fish/guestfish-actions.pod:3407
25581 msgid "part-get-parttype"
25585 #: ../fish/guestfish-actions.pod:3409
25588 " part-get-parttype device\n"
25593 #: ../fish/guestfish-actions.pod:3414
25595 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
25596 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
25597 "possible, although unusual. See L</part-init> for a full list."
25601 #: ../fish/guestfish-actions.pod:3419
25606 #: ../fish/guestfish-actions.pod:3421
25609 " part-init device parttype\n"
25614 #: ../fish/guestfish-actions.pod:3427
25616 "Initially there are no partitions. Following this, you should call "
25617 "L</part-add> for each partition required."
25621 #: ../fish/guestfish-actions.pod:3490
25626 #: ../fish/guestfish-actions.pod:3492
25629 " part-list device\n"
25634 #: ../fish/guestfish-actions.pod:3507
25636 "Start of the partition I<in bytes>. To get sectors you have to divide by "
25637 "the device's sector size, see L</blockdev-getss>."
25641 #: ../fish/guestfish-actions.pod:3520
25642 msgid "part-set-bootable"
25646 #: ../fish/guestfish-actions.pod:3522
25649 " part-set-bootable device partnum true|false\n"
25654 #: ../fish/guestfish-actions.pod:3531
25655 msgid "part-set-mbr-id"
25659 #: ../fish/guestfish-actions.pod:3533
25662 " part-set-mbr-id device partnum idbyte\n"
25667 #: ../fish/guestfish-actions.pod:3545
25668 msgid "part-set-name"
25672 #: ../fish/guestfish-actions.pod:3547
25675 " part-set-name device partnum name\n"
25680 #: ../fish/guestfish-actions.pod:3555
25681 msgid "part-to-dev"
25685 #: ../fish/guestfish-actions.pod:3557
25688 " part-to-dev partition\n"
25693 #: ../fish/guestfish-actions.pod:3563
25695 "The named partition must exist, for example as a string returned from "
25696 "L</list-partitions>."
25700 #: ../fish/guestfish-actions.pod:3566
25701 msgid "ping-daemon"
25705 #: ../fish/guestfish-actions.pod:3568
25713 #: ../fish/guestfish-actions.pod:3575
25718 #: ../fish/guestfish-actions.pod:3577
25721 " pread path count offset\n"
25726 #: ../fish/guestfish-actions.pod:3585
25727 msgid "See also L</pwrite>, L</pread-device>."
25731 #: ../fish/guestfish-actions.pod:3590
25732 msgid "pread-device"
25736 #: ../fish/guestfish-actions.pod:3592
25739 " pread-device device count offset\n"
25744 #: ../fish/guestfish-actions.pod:3600
25745 msgid "See also L</pread>."
25749 #: ../fish/guestfish-actions.pod:3605
25754 #: ../fish/guestfish-actions.pod:3607
25757 " pvcreate device\n"
25762 #: ../fish/guestfish-actions.pod:3613
25767 #: ../fish/guestfish-actions.pod:3615
25770 " pvremove device\n"
25775 #: ../fish/guestfish-actions.pod:3624
25780 #: ../fish/guestfish-actions.pod:3626
25783 " pvresize device\n"
25788 #: ../fish/guestfish-actions.pod:3631
25789 msgid "pvresize-size"
25793 #: ../fish/guestfish-actions.pod:3633
25796 " pvresize-size device size\n"
25801 #: ../fish/guestfish-actions.pod:3635
25803 "This command is the same as L</pvresize> except that it allows you to "
25804 "specify the new size (in bytes) explicitly."
25808 #: ../fish/guestfish-actions.pod:3638
25813 #: ../fish/guestfish-actions.pod:3640
25821 #: ../fish/guestfish-actions.pod:3648
25822 msgid "See also L</pvs-full>."
25826 #: ../fish/guestfish-actions.pod:3650
25831 #: ../fish/guestfish-actions.pod:3652
25839 #: ../fish/guestfish-actions.pod:3657
25844 #: ../fish/guestfish-actions.pod:3659
25852 #: ../fish/guestfish-actions.pod:3663
25857 #: ../fish/guestfish-actions.pod:3665
25860 " pwrite path content offset\n"
25865 #: ../fish/guestfish-actions.pod:3676
25866 msgid "See also L</pread>, L</pwrite-device>."
25870 #: ../fish/guestfish-actions.pod:3681
25871 msgid "pwrite-device"
25875 #: ../fish/guestfish-actions.pod:3683
25878 " pwrite-device device content offset\n"
25883 #: ../fish/guestfish-actions.pod:3693
25884 msgid "See also L</pwrite>."
25888 #: ../fish/guestfish-actions.pod:3698
25893 #: ../fish/guestfish-actions.pod:3700
25896 " read-file path\n"
25901 #: ../fish/guestfish-actions.pod:3705
25903 "Unlike L</cat>, this function can correctly handle files that contain "
25904 "embedded ASCII NUL characters. However unlike L</download>, this function "
25905 "is limited in the total size of file that can be handled."
25909 #: ../fish/guestfish-actions.pod:3713
25914 #: ../fish/guestfish-actions.pod:3715
25917 " read-lines path\n"
25922 #: ../fish/guestfish-actions.pod:3722
25924 "Note that this function cannot correctly handle binary files (specifically, "
25925 "files containing C<\\0> character which is treated as end of line). For "
25926 "those you need to use the L</read-file> function which has a more complex "
25931 #: ../fish/guestfish-actions.pod:3727
25936 #: ../fish/guestfish-actions.pod:3729
25944 #: ../fish/guestfish-actions.pod:3781
25946 "This function is primarily intended for use by programs. To get a simple "
25947 "list of names, use L</ls>. To get a printable directory for human "
25948 "consumption, use L</ll>."
25952 #: ../fish/guestfish-actions.pod:3785
25957 #: ../fish/guestfish-actions.pod:3787
25965 #: ../fish/guestfish-actions.pod:3791
25966 msgid "readlinklist"
25970 #: ../fish/guestfish-actions.pod:3793
25973 " readlinklist path 'names ...'\n"
25978 #: ../fish/guestfish-actions.pod:3817
25983 #: ../fish/guestfish-actions.pod:3819
25991 #: ../fish/guestfish-actions.pod:3824
25992 msgid "removexattr"
25996 #: ../fish/guestfish-actions.pod:3826
25999 " removexattr xattr path\n"
26004 #: ../fish/guestfish-actions.pod:3831
26005 msgid "See also: L</lremovexattr>, L<attr(5)>."
26009 #: ../fish/guestfish-actions.pod:3833
26014 #: ../fish/guestfish-actions.pod:3835
26017 " resize2fs device\n"
26022 #: ../fish/guestfish-actions.pod:3840
26024 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
26025 "before calling this command. For unknown reasons C<resize2fs> sometimes "
26026 "gives an error about this and sometimes not. In any case, it is always safe "
26027 "to call L</e2fsck-f> before calling this function."
26031 #: ../fish/guestfish-actions.pod:3846
26032 msgid "resize2fs-M"
26036 #: ../fish/guestfish-actions.pod:3848
26039 " resize2fs-M device\n"
26044 #: ../fish/guestfish-actions.pod:3850
26046 "This command is the same as L</resize2fs>, but the filesystem is resized to "
26047 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
26052 #: ../fish/guestfish-actions.pod:3854
26054 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
26055 "and read the C<Block size> and C<Block count> values. These two numbers, "
26056 "multiplied together, give the resulting size of the minimal filesystem in "
26061 #: ../fish/guestfish-actions.pod:3859
26062 msgid "resize2fs-size"
26066 #: ../fish/guestfish-actions.pod:3861
26069 " resize2fs-size device size\n"
26074 #: ../fish/guestfish-actions.pod:3863
26076 "This command is the same as L</resize2fs> except that it allows you to "
26077 "specify the new size (in bytes) explicitly."
26081 #: ../fish/guestfish-actions.pod:3866
26086 #: ../fish/guestfish-actions.pod:3868
26094 #: ../fish/guestfish-actions.pod:3872
26099 #: ../fish/guestfish-actions.pod:3874
26107 #: ../fish/guestfish-actions.pod:3880
26112 #: ../fish/guestfish-actions.pod:3882
26120 #: ../fish/guestfish-actions.pod:3886
26121 msgid "rmmountpoint"
26125 #: ../fish/guestfish-actions.pod:3888
26128 " rmmountpoint exemptpath\n"
26133 #: ../fish/guestfish-actions.pod:3890
26135 "This calls removes a mountpoint that was previously created with "
26136 "L</mkmountpoint>. See L</mkmountpoint> for full details."
26140 #: ../fish/guestfish-actions.pod:3894
26141 msgid "scrub-device"
26145 #: ../fish/guestfish-actions.pod:3896
26148 " scrub-device device\n"
26153 #: ../fish/guestfish-actions.pod:3907
26158 #: ../fish/guestfish-actions.pod:3909
26161 " scrub-file file\n"
26166 #: ../fish/guestfish-actions.pod:3919
26167 msgid "scrub-freespace"
26171 #: ../fish/guestfish-actions.pod:3921
26174 " scrub-freespace dir\n"
26179 #: ../fish/guestfish-actions.pod:3923
26181 "This command creates the directory C<dir> and then fills it with files until "
26182 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
26183 "deletes them. The intention is to scrub any free space on the partition "
26184 "containing C<dir>."
26188 #: ../fish/guestfish-actions.pod:3932
26193 #: ../fish/guestfish-actions.pod:3934
26198 #: ../fish/guestfish-actions.pod:3936
26201 " set-append append\n"
26206 #: ../fish/guestfish-actions.pod:3947
26207 msgid "set-attach-method"
26211 #: ../fish/guestfish-actions.pod:3949
26212 msgid "attach-method"
26216 #: ../fish/guestfish-actions.pod:3951
26219 " set-attach-method attachmethod\n"
26224 #: ../fish/guestfish-actions.pod:3973
26225 msgid "set-autosync"
26229 #: ../fish/guestfish-actions.pod:3975
26234 #: ../fish/guestfish-actions.pod:3977
26237 " set-autosync true|false\n"
26242 #: ../fish/guestfish-actions.pod:3987
26247 #: ../fish/guestfish-actions.pod:3989
26252 #: ../fish/guestfish-actions.pod:3991
26255 " set-direct true|false\n"
26260 #: ../fish/guestfish-actions.pod:3997
26262 "One consequence of this is that log messages aren't caught by the library "
26263 "and handled by L</set-log-message-callback>, but go straight to stdout."
26267 #: ../fish/guestfish-actions.pod:4006
26268 msgid "set-e2label"
26272 #: ../fish/guestfish-actions.pod:4008
26275 " set-e2label device label\n"
26280 #: ../fish/guestfish-actions.pod:4014
26282 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
26283 "label on a filesystem."
26287 #: ../fish/guestfish-actions.pod:4017
26292 #: ../fish/guestfish-actions.pod:4019
26295 " set-e2uuid device uuid\n"
26300 #: ../fish/guestfish-actions.pod:4026
26302 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
26303 "UUID of a filesystem."
26307 #: ../fish/guestfish-actions.pod:4029
26308 msgid "set-memsize"
26312 #: ../fish/guestfish-actions.pod:4031
26317 #: ../fish/guestfish-actions.pod:4033
26320 " set-memsize memsize\n"
26325 #: ../fish/guestfish-actions.pod:4035
26327 "This sets the memory size in megabytes allocated to the qemu subprocess. "
26328 "This only has any effect if called before L</launch>."
26332 #: ../fish/guestfish-actions.pod:4046
26333 msgid "set-network"
26337 #: ../fish/guestfish-actions.pod:4048
26342 #: ../fish/guestfish-actions.pod:4050
26345 " set-network true|false\n"
26350 #: ../fish/guestfish-actions.pod:4058
26351 msgid "You must call this before calling L</launch>, otherwise it has no effect."
26355 #: ../fish/guestfish-actions.pod:4061
26360 #: ../fish/guestfish-actions.pod:4063
26365 #: ../fish/guestfish-actions.pod:4065
26368 " set-path searchpath\n"
26373 #: ../fish/guestfish-actions.pod:4074
26378 #: ../fish/guestfish-actions.pod:4076
26383 #: ../fish/guestfish-actions.pod:4078
26391 #: ../fish/guestfish-actions.pod:4098
26392 msgid "set-recovery-proc"
26396 #: ../fish/guestfish-actions.pod:4100
26397 msgid "recovery-proc"
26401 #: ../fish/guestfish-actions.pod:4102
26404 " set-recovery-proc true|false\n"
26409 #: ../fish/guestfish-actions.pod:4104
26411 "If this is called with the parameter C<false> then L</launch> does not "
26412 "create a recovery process. The purpose of the recovery process is to stop "
26413 "runaway qemu processes in the case where the main program aborts abruptly."
26417 #: ../fish/guestfish-actions.pod:4109
26419 "This only has any effect if called before L</launch>, and the default is "
26424 #: ../fish/guestfish-actions.pod:4118
26425 msgid "set-selinux"
26429 #: ../fish/guestfish-actions.pod:4120
26434 #: ../fish/guestfish-actions.pod:4122
26437 " set-selinux true|false\n"
26442 #: ../fish/guestfish-actions.pod:4133
26447 #: ../fish/guestfish-actions.pod:4135
26452 #: ../fish/guestfish-actions.pod:4137
26455 " set-trace true|false\n"
26460 #: ../fish/guestfish-actions.pod:4149
26462 "Trace messages are normally sent to C<stderr>, unless you register a "
26463 "callback to send them somewhere else (see L</set-event-callback>)."
26467 #: ../fish/guestfish-actions.pod:4153
26468 msgid "set-verbose"
26472 #: ../fish/guestfish-actions.pod:4155
26477 #: ../fish/guestfish-actions.pod:4157
26480 " set-verbose true|false\n"
26485 #: ../fish/guestfish-actions.pod:4164
26487 "Verbose messages are normally sent to C<stderr>, unless you register a "
26488 "callback to send them somewhere else (see L</set-event-callback>)."
26492 #: ../fish/guestfish-actions.pod:4168
26497 #: ../fish/guestfish-actions.pod:4170
26500 " setcon context\n"
26505 #: ../fish/guestfish-actions.pod:4177
26510 #: ../fish/guestfish-actions.pod:4179
26513 " setxattr xattr val vallen path\n"
26518 #: ../fish/guestfish-actions.pod:4185
26519 msgid "See also: L</lsetxattr>, L<attr(5)>."
26523 #: ../fish/guestfish-actions.pod:4187
26528 #: ../fish/guestfish-actions.pod:4189
26531 " sfdisk device cyls heads sectors 'lines ...'\n"
26536 #: ../fish/guestfish-actions.pod:4211
26537 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
26541 #: ../fish/guestfish-actions.pod:4224
26546 #: ../fish/guestfish-actions.pod:4226
26549 " sfdiskM device 'lines ...'\n"
26554 #: ../fish/guestfish-actions.pod:4228
26556 "This is a simplified interface to the L</sfdisk> command, where partition "
26557 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
26558 "you don't need to specify the cyls, heads and sectors parameters which were "
26559 "rarely if ever used anyway."
26563 #: ../fish/guestfish-actions.pod:4234
26564 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
26568 #: ../fish/guestfish-actions.pod:4247
26573 #: ../fish/guestfish-actions.pod:4249
26576 " sfdisk-N device partnum cyls heads sectors line\n"
26581 #: ../fish/guestfish-actions.pod:4254
26583 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
26584 "cyls/heads/sectors parameters."
26588 #: ../fish/guestfish-actions.pod:4257
26589 msgid "See also: L</part-add>"
26593 #: ../fish/guestfish-actions.pod:4269
26594 msgid "sfdisk-disk-geometry"
26598 #: ../fish/guestfish-actions.pod:4271
26601 " sfdisk-disk-geometry device\n"
26606 #: ../fish/guestfish-actions.pod:4273
26608 "This displays the disk geometry of C<device> read from the partition table. "
26609 "Especially in the case where the underlying block device has been resized, "
26610 "this can be different from the kernel's idea of the geometry (see "
26611 "L</sfdisk-kernel-geometry>)."
26615 #: ../fish/guestfish-actions.pod:4281
26616 msgid "sfdisk-kernel-geometry"
26620 #: ../fish/guestfish-actions.pod:4283
26623 " sfdisk-kernel-geometry device\n"
26628 #: ../fish/guestfish-actions.pod:4290
26633 #: ../fish/guestfish-actions.pod:4292
26636 " sfdisk-l device\n"
26641 #: ../fish/guestfish-actions.pod:4298
26642 msgid "See also: L</part-list>"
26646 #: ../fish/guestfish-actions.pod:4307
26651 #: ../fish/guestfish-actions.pod:4309
26659 #: ../fish/guestfish-actions.pod:4314
26660 msgid "This is like L</command>, but passes the command to:"
26664 #: ../fish/guestfish-actions.pod:4322
26665 msgid "All the provisos about L</command> apply to this call."
26669 #: ../fish/guestfish-actions.pod:4324
26674 #: ../fish/guestfish-actions.pod:4326
26677 " sh-lines command\n"
26682 #: ../fish/guestfish-actions.pod:4328
26683 msgid "This is the same as L</sh>, but splits the result into a list of lines."
26687 #: ../fish/guestfish-actions.pod:4331
26688 msgid "See also: L</command-lines>"
26692 #: ../fish/guestfish-actions.pod:4333
26697 #: ../fish/guestfish-actions.pod:4335
26705 #: ../fish/guestfish-actions.pod:4339
26710 #: ../fish/guestfish-actions.pod:4341
26718 #: ../fish/guestfish-actions.pod:4347
26723 #: ../fish/guestfish-actions.pod:4349
26731 #: ../fish/guestfish-actions.pod:4357
26736 #: ../fish/guestfish-actions.pod:4359
26744 #: ../fish/guestfish-actions.pod:4367
26749 #: ../fish/guestfish-actions.pod:4369
26752 " strings-e encoding path\n"
26757 #: ../fish/guestfish-actions.pod:4371
26759 "This is like the L</strings> command, but allows you to specify the encoding "
26760 "of strings that are looked for in the source file C<path>."
26764 #: ../fish/guestfish-actions.pod:4381
26766 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
26767 "ISO-8859-X (this is what L</strings> uses)."
26771 #: ../fish/guestfish-actions.pod:4413
26772 msgid "swapoff-device"
26776 #: ../fish/guestfish-actions.pod:4415
26779 " swapoff-device device\n"
26784 #: ../fish/guestfish-actions.pod:4417
26786 "This command disables the libguestfs appliance swap device or partition "
26787 "named C<device>. See L</swapon-device>."
26791 #: ../fish/guestfish-actions.pod:4421
26792 msgid "swapoff-file"
26796 #: ../fish/guestfish-actions.pod:4423
26799 " swapoff-file file\n"
26804 #: ../fish/guestfish-actions.pod:4427
26805 msgid "swapoff-label"
26809 #: ../fish/guestfish-actions.pod:4429
26812 " swapoff-label label\n"
26817 #: ../fish/guestfish-actions.pod:4434
26818 msgid "swapoff-uuid"
26822 #: ../fish/guestfish-actions.pod:4436
26825 " swapoff-uuid uuid\n"
26830 #: ../fish/guestfish-actions.pod:4441
26831 msgid "swapon-device"
26835 #: ../fish/guestfish-actions.pod:4443
26838 " swapon-device device\n"
26843 #: ../fish/guestfish-actions.pod:4445
26845 "This command enables the libguestfs appliance to use the swap device or "
26846 "partition named C<device>. The increased memory is made available for all "
26847 "commands, for example those run using L</command> or L</sh>."
26851 #: ../fish/guestfish-actions.pod:4457
26852 msgid "swapon-file"
26856 #: ../fish/guestfish-actions.pod:4459
26859 " swapon-file file\n"
26864 #: ../fish/guestfish-actions.pod:4461
26865 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
26869 #: ../fish/guestfish-actions.pod:4464
26870 msgid "swapon-label"
26874 #: ../fish/guestfish-actions.pod:4466
26877 " swapon-label label\n"
26882 #: ../fish/guestfish-actions.pod:4468
26884 "This command enables swap to a labeled swap partition. See "
26885 "L</swapon-device> for other notes."
26889 #: ../fish/guestfish-actions.pod:4471
26890 msgid "swapon-uuid"
26894 #: ../fish/guestfish-actions.pod:4473
26897 " swapon-uuid uuid\n"
26902 #: ../fish/guestfish-actions.pod:4475
26904 "This command enables swap to a swap partition with the given UUID. See "
26905 "L</swapon-device> for other notes."
26909 #: ../fish/guestfish-actions.pod:4478
26914 #: ../fish/guestfish-actions.pod:4480
26922 #: ../fish/guestfish-actions.pod:4488
26927 #: ../fish/guestfish-actions.pod:4490
26935 #: ../fish/guestfish-actions.pod:4498
26940 #: ../fish/guestfish-actions.pod:4500
26943 " tail-n nrlines path\n"
26948 #: ../fish/guestfish-actions.pod:4513
26953 #: ../fish/guestfish-actions.pod:4515
26956 " tar-in (tarfile|-) directory\n"
26961 #: ../fish/guestfish-actions.pod:4520
26962 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
26966 #: ../fish/guestfish-actions.pod:4525
26971 #: ../fish/guestfish-actions.pod:4527
26974 " tar-out directory (tarfile|-)\n"
26979 #: ../fish/guestfish-actions.pod:4532
26980 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
26984 #: ../fish/guestfish-actions.pod:4537
26989 #: ../fish/guestfish-actions.pod:4539
26992 " tgz-in (tarball|-) directory\n"
26997 #: ../fish/guestfish-actions.pod:4544
26998 msgid "To upload an uncompressed tarball, use L</tar-in>."
27002 #: ../fish/guestfish-actions.pod:4548
27007 #: ../fish/guestfish-actions.pod:4550
27010 " tgz-out directory (tarball|-)\n"
27015 #: ../fish/guestfish-actions.pod:4555
27016 msgid "To download an uncompressed tarball, use L</tar-out>."
27020 #: ../fish/guestfish-actions.pod:4559
27025 #: ../fish/guestfish-actions.pod:4561
27033 #: ../fish/guestfish-actions.pod:4570
27038 #: ../fish/guestfish-actions.pod:4572
27046 #: ../fish/guestfish-actions.pod:4577
27047 msgid "truncate-size"
27051 #: ../fish/guestfish-actions.pod:4579
27054 " truncate-size path size\n"
27059 #: ../fish/guestfish-actions.pod:4584
27061 "If the current file size is less than C<size> then the file is extended to "
27062 "the required size with zero bytes. This creates a sparse file (ie. disk "
27063 "blocks are not allocated for the file until you write to it). To create a "
27064 "non-sparse file of zeroes, use L</fallocate64> instead."
27068 #: ../fish/guestfish-actions.pod:4590
27073 #: ../fish/guestfish-actions.pod:4592
27076 " tune2fs-l device\n"
27081 #: ../fish/guestfish-actions.pod:4602
27086 #: ../fish/guestfish-actions.pod:4604
27089 " txz-in (tarball|-) directory\n"
27094 #: ../fish/guestfish-actions.pod:4611
27099 #: ../fish/guestfish-actions.pod:4613
27102 " txz-out directory (tarball|-)\n"
27107 #: ../fish/guestfish-actions.pod:4620
27112 #: ../fish/guestfish-actions.pod:4622
27120 #: ../fish/guestfish-actions.pod:4636
27121 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
27125 #: ../fish/guestfish-actions.pod:4641
27130 #: ../fish/guestfish-actions.pod:4643
27135 #: ../fish/guestfish-actions.pod:4645
27138 " umount pathordevice\n"
27143 #: ../fish/guestfish-actions.pod:4651
27148 #: ../fish/guestfish-actions.pod:4653
27149 msgid "unmount-all"
27153 #: ../fish/guestfish-actions.pod:4655
27161 #: ../fish/guestfish-actions.pod:4661
27166 #: ../fish/guestfish-actions.pod:4663
27169 " upload (filename|-) remotefilename\n"
27174 #: ../fish/guestfish-actions.pod:4670
27175 msgid "See also L</download>."
27179 #: ../fish/guestfish-actions.pod:4674
27180 msgid "upload-offset"
27184 #: ../fish/guestfish-actions.pod:4676
27187 " upload-offset (filename|-) remotefilename offset\n"
27192 #: ../fish/guestfish-actions.pod:4688
27194 "Note that there is no limit on the amount of data that can be uploaded with "
27195 "this call, unlike with L</pwrite>, and this call always writes the full "
27196 "amount unless an error occurs."
27200 #: ../fish/guestfish-actions.pod:4693
27201 msgid "See also L</upload>, L</pwrite>."
27205 #: ../fish/guestfish-actions.pod:4697
27210 #: ../fish/guestfish-actions.pod:4699
27213 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
27218 #: ../fish/guestfish-actions.pod:4718
27223 #: ../fish/guestfish-actions.pod:4720
27231 #: ../fish/guestfish-actions.pod:4747
27233 "I<Note:> Don't use this call to test for availability of features. In "
27234 "enterprise distributions we backport features from later versions into "
27235 "earlier versions, making this an unreliable way to test for features. Use "
27236 "L</available> instead."
27240 #: ../fish/guestfish-actions.pod:4753
27245 #: ../fish/guestfish-actions.pod:4755
27248 " vfs-label device\n"
27253 #: ../fish/guestfish-actions.pod:4762
27254 msgid "To find a filesystem from the label, use L</findfs-label>."
27258 #: ../fish/guestfish-actions.pod:4764
27263 #: ../fish/guestfish-actions.pod:4766
27266 " vfs-type device\n"
27271 #: ../fish/guestfish-actions.pod:4776
27276 #: ../fish/guestfish-actions.pod:4778
27279 " vfs-uuid device\n"
27284 #: ../fish/guestfish-actions.pod:4785
27285 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
27289 #: ../fish/guestfish-actions.pod:4787
27290 msgid "vg-activate"
27294 #: ../fish/guestfish-actions.pod:4789
27297 " vg-activate true|false 'volgroups ...'\n"
27302 #: ../fish/guestfish-actions.pod:4802
27303 msgid "vg-activate-all"
27307 #: ../fish/guestfish-actions.pod:4804
27310 " vg-activate-all true|false\n"
27315 #: ../fish/guestfish-actions.pod:4814
27320 #: ../fish/guestfish-actions.pod:4816
27323 " vgcreate volgroup 'physvols ...'\n"
27328 #: ../fish/guestfish-actions.pod:4821
27333 #: ../fish/guestfish-actions.pod:4823
27336 " vglvuuids vgname\n"
27341 #: ../fish/guestfish-actions.pod:4828
27343 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
27344 "logical volumes and volume groups."
27348 #: ../fish/guestfish-actions.pod:4831
27349 msgid "See also L</vgpvuuids>."
27353 #: ../fish/guestfish-actions.pod:4833
27358 #: ../fish/guestfish-actions.pod:4835
27361 " vgpvuuids vgname\n"
27366 #: ../fish/guestfish-actions.pod:4840
27368 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
27369 "physical volumes and volume groups."
27373 #: ../fish/guestfish-actions.pod:4843
27374 msgid "See also L</vglvuuids>."
27378 #: ../fish/guestfish-actions.pod:4845
27383 #: ../fish/guestfish-actions.pod:4847
27386 " vgremove vgname\n"
27391 #: ../fish/guestfish-actions.pod:4854
27396 #: ../fish/guestfish-actions.pod:4856
27399 " vgrename volgroup newvolgroup\n"
27404 #: ../fish/guestfish-actions.pod:4860
27409 #: ../fish/guestfish-actions.pod:4862
27417 #: ../fish/guestfish-actions.pod:4870
27418 msgid "See also L</vgs-full>."
27422 #: ../fish/guestfish-actions.pod:4872
27427 #: ../fish/guestfish-actions.pod:4874
27435 #: ../fish/guestfish-actions.pod:4879
27440 #: ../fish/guestfish-actions.pod:4881
27448 #: ../fish/guestfish-actions.pod:4886
27453 #: ../fish/guestfish-actions.pod:4888
27461 #: ../fish/guestfish-actions.pod:4892
27466 #: ../fish/guestfish-actions.pod:4894
27474 #: ../fish/guestfish-actions.pod:4899
27479 #: ../fish/guestfish-actions.pod:4901
27487 #: ../fish/guestfish-actions.pod:4906
27492 #: ../fish/guestfish-actions.pod:4908
27500 #: ../fish/guestfish-actions.pod:4913
27505 #: ../fish/guestfish-actions.pod:4915
27508 " write path content\n"
27513 #: ../fish/guestfish-actions.pod:4923
27518 #: ../fish/guestfish-actions.pod:4925
27521 " write-file path content size\n"
27526 #: ../fish/guestfish-actions.pod:4948
27531 #: ../fish/guestfish-actions.pod:4950
27534 " zegrep regex path\n"
27539 #: ../fish/guestfish-actions.pod:4958
27544 #: ../fish/guestfish-actions.pod:4960
27547 " zegrepi regex path\n"
27552 #: ../fish/guestfish-actions.pod:4968
27557 #: ../fish/guestfish-actions.pod:4970
27565 #: ../fish/guestfish-actions.pod:4978
27566 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
27570 #: ../fish/guestfish-actions.pod:4981
27571 msgid "zero-device"
27575 #: ../fish/guestfish-actions.pod:4983
27578 " zero-device device\n"
27583 #: ../fish/guestfish-actions.pod:4985
27585 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
27586 "which just zeroes the first few blocks of a device."
27590 #: ../fish/guestfish-actions.pod:4992
27595 #: ../fish/guestfish-actions.pod:4994
27598 " zerofree device\n"
27603 #: ../fish/guestfish-actions.pod:5007
27608 #: ../fish/guestfish-actions.pod:5009
27611 " zfgrep pattern path\n"
27616 #: ../fish/guestfish-actions.pod:5017
27621 #: ../fish/guestfish-actions.pod:5019
27624 " zfgrepi pattern path\n"
27629 #: ../fish/guestfish-actions.pod:5027
27634 #: ../fish/guestfish-actions.pod:5029
27637 " zfile meth path\n"
27642 #: ../fish/guestfish-actions.pod:5036
27643 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
27647 #: ../fish/guestfish-actions.pod:5046
27652 #: ../fish/guestfish-actions.pod:5048
27655 " zgrep regex path\n"
27660 #: ../fish/guestfish-actions.pod:5056
27665 #: ../fish/guestfish-actions.pod:5058
27668 " zgrepi regex path\n"
27673 #: ../fish/guestfish-commands.pod:1
27678 #: ../fish/guestfish-commands.pod:3
27683 #: ../fish/guestfish-commands.pod:5
27686 " alloc filename size\n"
27691 #: ../fish/guestfish-commands.pod:7
27693 "This creates an empty (zeroed) file of the given size, and then adds so it "
27694 "can be further examined."
27698 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
27699 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
27703 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
27704 msgid "Size can be specified using standard suffixes, eg. C<1M>."
27708 #: ../fish/guestfish-commands.pod:14
27710 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
27711 "image, see L</PREPARED DISK IMAGES>."
27715 #: ../fish/guestfish-commands.pod:17
27720 #: ../fish/guestfish-commands.pod:19
27723 " copy-in local [local ...] /remotedir\n"
27728 #: ../fish/guestfish-commands.pod:21
27730 "C<copy-in> copies local files or directories recursively into the disk "
27731 "image, placing them in the directory called C</remotedir> (which must "
27732 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
27733 "other commands as necessary."
27737 #: ../fish/guestfish-commands.pod:26
27739 "Multiple local files and directories can be specified, but the last "
27740 "parameter must always be a remote directory. Wildcards cannot be used."
27744 #: ../fish/guestfish-commands.pod:30
27749 #: ../fish/guestfish-commands.pod:32
27752 " copy-out remote [remote ...] localdir\n"
27757 #: ../fish/guestfish-commands.pod:34
27759 "C<copy-out> copies remote files or directories recursively out of the disk "
27760 "image, placing them on the host disk in a local directory called C<localdir> "
27761 "(which must exist). This guestfish meta-command turns into a sequence of "
27762 "L</download>, L</tar-out> and other commands as necessary."
27766 #: ../fish/guestfish-commands.pod:40
27768 "Multiple remote files and directories can be specified, but the last "
27769 "parameter must always be a local directory. To download to the current "
27770 "directory, use C<.> as in:"
27774 #: ../fish/guestfish-commands.pod:44
27777 " copy-out /home .\n"
27782 #: ../fish/guestfish-commands.pod:46
27784 "Wildcards cannot be used in the ordinary command, but you can use them with "
27785 "the help of L</glob> like this:"
27789 #: ../fish/guestfish-commands.pod:49
27792 " glob copy-out /home/* .\n"
27797 #: ../fish/guestfish-commands.pod:51
27802 #: ../fish/guestfish-commands.pod:53
27805 " display filename\n"
27810 #: ../fish/guestfish-commands.pod:55
27812 "Use C<display> (a graphical display program) to display an image file. It "
27813 "downloads the file, and runs C<display> on it."
27817 #: ../fish/guestfish-commands.pod:58
27819 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
27820 "environment variable. For example to use the GNOME display program:"
27824 #: ../fish/guestfish-commands.pod:61
27827 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
27832 #: ../fish/guestfish-commands.pod:63
27833 msgid "See also L<display(1)>."
27837 #: ../fish/guestfish-commands.pod:65
27842 #: ../fish/guestfish-commands.pod:67
27845 " echo [params ...]\n"
27850 #: ../fish/guestfish-commands.pod:69
27851 msgid "This echos the parameters to the terminal."
27855 #: ../fish/guestfish-commands.pod:71
27860 #: ../fish/guestfish-commands.pod:73
27865 #: ../fish/guestfish-commands.pod:75
27870 #: ../fish/guestfish-commands.pod:77
27878 #: ../fish/guestfish-commands.pod:79
27880 "This is used to edit a file. It downloads the file, edits it locally using "
27881 "your editor, then uploads the result."
27885 #: ../fish/guestfish-commands.pod:82
27887 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
27888 "or C<emacs> you will get those corresponding editors."
27892 #: ../fish/guestfish-commands.pod:86
27897 #: ../fish/guestfish-commands.pod:88
27900 " glob command args...\n"
27905 #: ../fish/guestfish-commands.pod:90
27907 "Expand wildcards in any paths in the args list, and run C<command> "
27908 "repeatedly on each matching path."
27912 #: ../fish/guestfish-commands.pod:93
27913 msgid "See L</WILDCARDS AND GLOBBING>."
27917 #: ../fish/guestfish-commands.pod:95
27922 #: ../fish/guestfish-commands.pod:97
27925 " hexedit <filename|device>\n"
27926 " hexedit <filename|device> <max>\n"
27927 " hexedit <filename|device> <start> <max>\n"
27932 #: ../fish/guestfish-commands.pod:101
27934 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
27939 #: ../fish/guestfish-commands.pod:104
27941 "This command works by downloading potentially the whole file or device, "
27942 "editing it locally, then uploading it. If the file or device is large, you "
27943 "have to specify which part you wish to edit by using C<max> and/or C<start> "
27944 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
27945 "usual modifiers allowed such as C<1M> (1 megabyte)."
27949 #: ../fish/guestfish-commands.pod:111
27950 msgid "For example to edit the first few sectors of a disk you might do:"
27954 #: ../fish/guestfish-commands.pod:114
27957 " hexedit /dev/sda 1M\n"
27962 #: ../fish/guestfish-commands.pod:116
27964 "which would allow you to edit anywhere within the first megabyte of the "
27969 #: ../fish/guestfish-commands.pod:119
27970 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
27974 #: ../fish/guestfish-commands.pod:121
27977 " hexedit /dev/sda1 0x400 0x400\n"
27982 #: ../fish/guestfish-commands.pod:123
27983 msgid "(assuming the superblock is in the standard location)."
27987 #: ../fish/guestfish-commands.pod:125
27989 "This command requires the external L<hexedit(1)> program. You can specify "
27990 "another program to use by setting the C<HEXEDITOR> environment variable."
27994 #: ../fish/guestfish-commands.pod:129
27995 msgid "See also L</hexdump>."
27999 #: ../fish/guestfish-commands.pod:131
28004 #: ../fish/guestfish-commands.pod:133
28012 #: ../fish/guestfish-commands.pod:135
28013 msgid "Change the local directory, ie. the current directory of guestfish itself."
28017 #: ../fish/guestfish-commands.pod:138
28018 msgid "Note that C<!cd> won't do what you might expect."
28022 #: ../fish/guestfish-commands.pod:140
28027 #: ../fish/guestfish-commands.pod:142
28032 #: ../fish/guestfish-commands.pod:144
28040 #: ../fish/guestfish-commands.pod:146
28041 msgid "Opens the manual page for guestfish."
28045 #: ../fish/guestfish-commands.pod:148
28050 #: ../fish/guestfish-commands.pod:150
28055 #: ../fish/guestfish-commands.pod:152
28063 #: ../fish/guestfish-commands.pod:154
28071 #: ../fish/guestfish-commands.pod:156
28072 msgid "This is used to view a file."
28076 #: ../fish/guestfish-commands.pod:158
28078 "The default viewer is C<$PAGER>. However if you use the alternate command "
28079 "C<less> you will get the C<less> command specifically."
28083 #: ../fish/guestfish-commands.pod:161
28088 #: ../fish/guestfish-commands.pod:163
28096 #: ../fish/guestfish-commands.pod:165
28098 "Close and reopen the libguestfs handle. It is not necessary to use this "
28099 "normally, because the handle is closed properly when guestfish exits. "
28100 "However this is occasionally useful for testing."
28104 #: ../fish/guestfish-commands.pod:169
28109 #: ../fish/guestfish-commands.pod:171
28112 " sparse filename size\n"
28117 #: ../fish/guestfish-commands.pod:173
28119 "This creates an empty sparse file of the given size, and then adds so it can "
28120 "be further examined."
28124 #: ../fish/guestfish-commands.pod:176
28126 "In all respects it works the same as the L</alloc> command, except that the "
28127 "image file is allocated sparsely, which means that disk blocks are not "
28128 "assigned to the file until they are needed. Sparse disk files only use "
28129 "space when written to, but they are slower and there is a danger you could "
28130 "run out of real disk space during a write operation."
28134 #: ../fish/guestfish-commands.pod:186
28139 #: ../fish/guestfish-commands.pod:188
28147 #: ../fish/guestfish-commands.pod:190
28149 "This command returns a list of the optional groups known to the daemon, and "
28150 "indicates which ones are supported by this build of the libguestfs "
28155 #: ../fish/guestfish-commands.pod:194
28156 msgid "See also L<guestfs(3)/AVAILABILITY>."
28160 #: ../fish/guestfish-commands.pod:196
28165 #: ../fish/guestfish-commands.pod:198
28168 " time command args...\n"
28173 #: ../fish/guestfish-commands.pod:200
28175 "Run the command as usual, but print the elapsed time afterwards. This can "
28176 "be useful for benchmarking operations."
28180 #: ../test-tool/libguestfs-test-tool.pod:5
28181 msgid "libguestfs-test-tool - End user tests for libguestfs"
28185 #: ../test-tool/libguestfs-test-tool.pod:9
28188 " libguestfs-test-tool [--options]\n"
28193 #: ../test-tool/libguestfs-test-tool.pod:13
28195 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
28196 "and developers, to allow them to check basic libguestfs functionality is "
28197 "working. This is needed because libguestfs occasionally breaks for reasons "
28198 "beyond our control: usually because of changes in the underlying qemu or "
28199 "kernel packages, or the host environment."
28203 #: ../test-tool/libguestfs-test-tool.pod:20
28204 msgid "If you suspect a problem in libguestfs, then just run:"
28208 #: ../test-tool/libguestfs-test-tool.pod:22
28211 " libguestfs-test-tool\n"
28216 #: ../test-tool/libguestfs-test-tool.pod:24
28217 msgid "It will print lots of diagnostic messages."
28221 #: ../test-tool/libguestfs-test-tool.pod:26
28222 msgid "If it runs to completion successfully, you will see this near the end:"
28226 #: ../test-tool/libguestfs-test-tool.pod:28
28229 " ===== TEST FINISHED OK =====\n"
28234 #: ../test-tool/libguestfs-test-tool.pod:30
28235 msgid "and the test tool will exit with code 0."
28239 #: ../test-tool/libguestfs-test-tool.pod:32
28241 "If it fails (and/or exits with non-zero error code), please paste the "
28242 "B<complete, unedited> output of the test tool into a bug report. More "
28243 "information about reporting bugs can be found on the "
28244 "L<http://libguestfs.org/> website."
28248 #: ../test-tool/libguestfs-test-tool.pod:41
28253 #: ../test-tool/libguestfs-test-tool.pod:43
28254 msgid "Display short usage information and exit."
28258 #: ../test-tool/libguestfs-test-tool.pod:45
28259 msgid "I<--qemu qemu_binary>"
28263 #: ../test-tool/libguestfs-test-tool.pod:47
28265 "If you have downloaded another qemu binary, point this option at the full "
28266 "path of the binary to try it."
28270 #: ../test-tool/libguestfs-test-tool.pod:50
28271 msgid "I<--qemudir qemu_source_dir>"
28275 #: ../test-tool/libguestfs-test-tool.pod:52
28277 "If you have compiled qemu from source, point this option at the source "
28278 "directory to try it."
28282 #: ../test-tool/libguestfs-test-tool.pod:55
28283 msgid "I<--timeout N>"
28287 #: ../test-tool/libguestfs-test-tool.pod:57
28289 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
28290 "does not usually need to be adjusted unless your machine is very slow."
28294 #: ../test-tool/libguestfs-test-tool.pod:63
28295 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
28299 #: ../test-tool/libguestfs-test-tool.pod:65
28301 "If you have compiled another version of qemu from source and would like to "
28302 "try that, then you can use the I<--qemudir> option to point to the qemu "
28303 "source directory."
28307 #: ../test-tool/libguestfs-test-tool.pod:69
28309 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
28310 "option to point to the binary."
28314 #: ../test-tool/libguestfs-test-tool.pod:72
28316 "When using an alternate qemu with libguestfs, usually you would need to "
28317 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
28318 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
28319 "when you use either of the I<--qemudir> or I<--qemu> options."
28323 #: ../test-tool/libguestfs-test-tool.pod:79
28325 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
28326 "I<1> if there was an error."
28330 #: ../test-tool/libguestfs-test-tool.pod:84
28332 "For the full list of environment variables which may affect libguestfs, "
28333 "please see the L<guestfs(3)> manual page."
28337 #: ../test-tool/libguestfs-test-tool.pod:89
28338 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
28342 #: ../fuse/guestmount.pod:5
28343 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
28347 #: ../fuse/guestmount.pod:9
28350 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
28355 #: ../fuse/guestmount.pod:11
28358 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
28363 #: ../fuse/guestmount.pod:13
28366 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
28371 #: ../fuse/guestmount.pod:17
28373 "You must I<not> use C<guestmount> in read-write mode on live virtual "
28374 "machines. If you do this, you risk disk corruption in the VM."
28378 #: ../fuse/guestmount.pod:22
28380 "The guestmount program can be used to mount virtual machine filesystems and "
28381 "other disk images on the host. It uses libguestfs for access to the guest "
28382 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
28383 "a mountable device."
28387 #: ../fuse/guestmount.pod:27
28389 "Along with other options, you have to give at least one device (I<-a> "
28390 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
28391 "option) or use the I<-i> inspection option. How this works is better "
28392 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
28397 #: ../fuse/guestmount.pod:33
28399 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
28400 "by you, and the filesystem will not be visible to any other users unless you "
28401 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
28402 "the filesystem, use the C<fusermount -u> command."
28406 #: ../fuse/guestmount.pod:41
28408 "For a typical Windows guest which has its main filesystem on the first "
28413 #: ../fuse/guestmount.pod:44
28416 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
28421 #: ../fuse/guestmount.pod:46
28423 "For a typical Linux guest which has a /boot filesystem on the first "
28424 "partition, and the root filesystem on a logical volume:"
28428 #: ../fuse/guestmount.pod:49
28431 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
28436 #: ../fuse/guestmount.pod:51
28437 msgid "To get libguestfs to detect guest mountpoints for you:"
28441 #: ../fuse/guestmount.pod:53
28444 " guestmount -a guest.img -i --ro /mnt\n"
28449 #: ../fuse/guestmount.pod:55
28450 msgid "For a libvirt guest called \"Guest\" you could do:"
28454 #: ../fuse/guestmount.pod:57
28457 " guestmount -d Guest -i --ro /mnt\n"
28462 #: ../fuse/guestmount.pod:59
28464 "If you don't know what filesystems are contained in a guest or disk image, "
28465 "use L<virt-filesystems(1)> first:"
28469 #: ../fuse/guestmount.pod:62
28472 " virt-filesystems MyGuest\n"
28477 #: ../fuse/guestmount.pod:64
28479 "If you want to trace the libguestfs calls but without excessive debugging "
28480 "information, we recommend:"
28484 #: ../fuse/guestmount.pod:67
28487 " guestmount [...] --trace /mnt\n"
28492 #: ../fuse/guestmount.pod:69
28493 msgid "If you want to debug the program, we recommend:"
28497 #: ../fuse/guestmount.pod:71
28500 " guestmount [...] --trace --verbose /mnt\n"
28505 #: ../fuse/guestmount.pod:73
28510 #: ../fuse/guestmount.pod:75
28511 msgid "Other users cannot see the filesystem by default"
28515 #: ../fuse/guestmount.pod:77
28517 "If you mount a filesystem as one user (eg. root), then other users will not "
28518 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
28519 "option when mounting:"
28523 #: ../fuse/guestmount.pod:81
28526 " sudo guestmount [...] -o allow_other /mnt\n"
28531 #: ../fuse/guestmount.pod:87
28532 msgid "B<-a image> | B<--add image>"
28536 #: ../fuse/guestmount.pod:89
28537 msgid "Add a block device or virtual machine image."
28541 #: ../fuse/guestmount.pod:94
28542 msgid "B<-c URI> | B<--connect URI>"
28546 #: ../fuse/guestmount.pod:100
28547 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
28551 #: ../fuse/guestmount.pod:108
28552 msgid "B<--dir-cache-timeout N>"
28556 #: ../fuse/guestmount.pod:110
28558 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
28559 "seconds. The readdir cache [actually, there are several semi-independent "
28560 "caches] is populated after a readdir(2) call with the stat and extended "
28561 "attributes of the files in the directory, in anticipation that they will be "
28562 "requested soon after."
28566 #: ../fuse/guestmount.pod:116
28568 "There is also a different attribute cache implemented by FUSE (see the FUSE "
28569 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
28570 "requests, only cache existing ones."
28574 #: ../fuse/guestmount.pod:127
28575 msgid "B<--format=raw|qcow2|..> | B<--format>"
28579 #: ../fuse/guestmount.pod:134
28581 "If you have untrusted raw-format guest disk images, you should use this "
28582 "option to specify the disk format. This avoids a possible security problem "
28583 "with malicious guests (CVE-2010-3851). See also "
28584 "L<guestfs(3)/guestfs_add_drive_opts>."
28588 #: ../fuse/guestmount.pod:139
28589 msgid "B<--fuse-help>"
28593 #: ../fuse/guestmount.pod:141
28594 msgid "Display help on special FUSE options (see I<-o> below)."
28598 #: ../fuse/guestmount.pod:145
28599 msgid "Display brief help and exit."
28603 #: ../fuse/guestmount.pod:147
28604 msgid "B<-i> | B<--inspector>"
28608 #: ../fuse/guestmount.pod:167
28610 "Mount the named partition or logical volume on the given mountpoint B<in the "
28611 "guest> (this has nothing to do with mountpoints in the host)."
28615 #: ../fuse/guestmount.pod:170
28617 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
28618 "something on C</>."
28622 #: ../fuse/guestmount.pod:183
28623 msgid "B<-n> | B<--no-sync>"
28627 #: ../fuse/guestmount.pod:185
28629 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
28630 "unmounted. If you specify this option, then we don't attempt to sync the "
28631 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
28635 #: ../fuse/guestmount.pod:190
28636 msgid "B<-o option> | B<--option option>"
28640 #: ../fuse/guestmount.pod:192
28641 msgid "Pass extra options to FUSE."
28645 #: ../fuse/guestmount.pod:194
28647 "To get a list of all the extra options supported by FUSE, use the command "
28648 "below. Note that only the FUSE I<-o> options can be passed, and only some "
28649 "of them are a good idea."
28653 #: ../fuse/guestmount.pod:198
28656 " guestmount --fuse-help\n"
28661 #: ../fuse/guestmount.pod:200
28662 msgid "Some potentially useful FUSE options:"
28666 #: ../fuse/guestmount.pod:204
28667 msgid "B<-o allow_other>"
28671 #: ../fuse/guestmount.pod:206
28672 msgid "Allow other users to see the filesystem."
28676 #: ../fuse/guestmount.pod:208
28677 msgid "B<-o attr_timeout=N>"
28681 #: ../fuse/guestmount.pod:210
28682 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
28686 #: ../fuse/guestmount.pod:212
28687 msgid "B<-o kernel_cache>"
28691 #: ../fuse/guestmount.pod:214
28693 "Allow the kernel to cache files (reduces the number of reads that have to go "
28694 "through the L<guestfs(3)> API). This is generally a good idea if you can "
28695 "afford the extra memory usage."
28699 #: ../fuse/guestmount.pod:218
28700 msgid "B<-o uid=N> B<-o gid=N>"
28704 #: ../fuse/guestmount.pod:220
28706 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
28707 "the chosen values."
28711 #: ../fuse/guestmount.pod:225
28712 msgid "B<-r> | B<--ro>"
28716 #: ../fuse/guestmount.pod:227
28718 "Add devices and mount everything read-only. Also disallow writes and make "
28719 "the disk appear read-only to FUSE."
28723 #: ../fuse/guestmount.pod:230
28725 "This is highly recommended if you are not going to edit the guest disk. If "
28726 "the guest is running and this option is I<not> supplied, then there is a "
28727 "strong risk of disk corruption in the guest. We try to prevent this from "
28728 "happening, but it is not always possible."
28732 #: ../fuse/guestmount.pod:235
28733 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28737 #: ../fuse/guestmount.pod:239
28738 msgid "Enable SELinux support for the guest."
28742 #: ../fuse/guestmount.pod:241
28743 msgid "B<-v> | B<--verbose>"
28747 #: ../fuse/guestmount.pod:243
28748 msgid "Enable verbose messages from underlying libguestfs."
28752 #: ../fuse/guestmount.pod:245
28753 msgid "B<-V> | B<--version>"
28757 #: ../fuse/guestmount.pod:247
28758 msgid "Display the program version and exit."
28762 #: ../fuse/guestmount.pod:249
28763 msgid "B<-w> | B<--rw>"
28767 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
28768 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
28772 #: ../fuse/guestmount.pod:256
28773 msgid "B<-x> | B<--trace>"
28777 #: ../fuse/guestmount.pod:258
28778 msgid "Trace libguestfs calls and entry into each FUSE function."
28782 #: ../fuse/guestmount.pod:260
28783 msgid "This also stops the daemon from forking into the background."
28787 #: ../fuse/guestmount.pod:281
28789 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28790 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
28791 "L<http://fuse.sf.net/>."
28795 #: ../fuse/guestmount.pod:296
28796 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
28800 #: ../tools/virt-win-reg.pl:37
28802 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
28807 #: ../tools/virt-win-reg.pl:41
28810 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
28815 #: ../tools/virt-win-reg.pl:43
28818 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
28823 #: ../tools/virt-win-reg.pl:45
28826 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
28831 #: ../tools/virt-win-reg.pl:47
28834 " virt-win-reg --merge domname [input.reg ...]\n"
28839 #: ../tools/virt-win-reg.pl:49
28842 " virt-win-reg [--options] disk.img ... # instead of domname\n"
28847 #: ../tools/virt-win-reg.pl:53
28849 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
28850 "virtual machines. If you do this, you I<will> get irreversible disk "
28851 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
28852 "but doesn't catch all cases."
28856 #: ../tools/virt-win-reg.pl:58
28858 "Modifying the Windows Registry is an inherently risky operation. The format "
28859 "is deliberately obscure and undocumented, and Registry changes can leave the "
28860 "system unbootable. Therefore when using the I<--merge> option, make sure "
28861 "you have a reliable backup first."
28865 #: ../tools/virt-win-reg.pl:65
28867 "This program can export and merge Windows Registry entries from a Windows "
28872 #: ../tools/virt-win-reg.pl:68
28874 "The first parameter is the libvirt guest name or the raw disk image of a "
28879 #: ../tools/virt-win-reg.pl:71
28881 "If I<--merge> is I<not> specified, then the chosen registry key is "
28882 "displayed/exported (recursively). For example:"
28886 #: ../tools/virt-win-reg.pl:74
28889 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
28894 #: ../tools/virt-win-reg.pl:76
28895 msgid "You can also display single values from within registry keys, for example:"
28899 #: ../tools/virt-win-reg.pl:79
28902 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
28903 " $ virt-win-reg Windows7 $cvkey ProductName\n"
28904 " Windows 7 Enterprise\n"
28909 #: ../tools/virt-win-reg.pl:83
28911 "With I<--merge>, you can merge a textual regedit file into the Windows "
28916 #: ../tools/virt-win-reg.pl:86
28919 " $ virt-win-reg --merge Windows7 changes.reg\n"
28924 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
28929 #: ../tools/virt-win-reg.pl:90
28931 "This program is only meant for simple access to the registry. If you want "
28932 "to do complicated things with the registry, we suggest you download the "
28933 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
28934 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
28935 "L<hivexregedit(1)>."
28939 #: ../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
28940 msgid "Display brief help."
28944 #: ../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
28945 msgid "Display version number and exit."
28949 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
28954 #: ../tools/virt-win-reg.pl:122
28955 msgid "Enable debugging messages."
28959 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
28960 msgid "B<--connect URI> | B<-c URI>"
28964 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
28966 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
28967 "to the default libvirt hypervisor."
28971 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
28973 "If you specify guest block devices directly, then libvirt is not used at "
28978 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
28979 msgid "B<--format> raw"
28983 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
28985 "Specify the format of disk images given on the command line. If this is "
28986 "omitted then the format is autodetected from the content of the disk image."
28990 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
28992 "If disk images are requested from libvirt, then this program asks libvirt "
28993 "for this information. In this case, the value of the format parameter is "
28998 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
29000 "If working with untrusted raw-format guest disk images, you should ensure "
29001 "the format is always specified."
29005 #: ../tools/virt-win-reg.pl:157
29010 #: ../tools/virt-win-reg.pl:159
29012 "In merge mode, this merges a textual regedit file into the Windows Registry "
29013 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
29014 "displays or exports Registry entries instead."
29018 #: ../tools/virt-win-reg.pl:163
29020 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
29021 "result in disk corruption. However exporting (without this flag) is always "
29026 #: ../tools/virt-win-reg.pl:171
29027 msgid "B<--encoding> UTF-16LE|ASCII"
29031 #: ../tools/virt-win-reg.pl:173
29033 "When merging (only), you may need to specify the encoding for strings to be "
29034 "used in the hive file. This is explained in detail in "
29035 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
29039 #: ../tools/virt-win-reg.pl:177
29041 "The default is to use UTF-16LE, which should work with recent versions of "
29046 #: ../tools/virt-win-reg.pl:184
29047 msgid "B<--unsafe-printable-strings>"
29051 #: ../tools/virt-win-reg.pl:186
29053 "When exporting (only), assume strings are UTF-16LE and print them as strings "
29054 "instead of hex sequences. Remove the final zero codepoint from strings if "
29059 #: ../tools/virt-win-reg.pl:190
29061 "This is unsafe and does not preserve the fidelity of strings in the original "
29062 "Registry for various reasons:"
29066 #: ../tools/virt-win-reg.pl:197
29068 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
29069 "other encodings will be corrupted by this transformation."
29073 #: ../tools/virt-win-reg.pl:202
29075 "Assumes that everything which has type 1 or 2 is really a string and that "
29076 "everything else is not a string, but the type field in real Registries is "
29081 #: ../tools/virt-win-reg.pl:208
29083 "Loses information about whether a zero codepoint followed the string in the "
29088 #: ../tools/virt-win-reg.pl:213
29090 "This all happens because the Registry itself contains no information about "
29091 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
29095 #: ../tools/virt-win-reg.pl:217
29097 "You should only use this option for quick hacking and debugging of the "
29098 "Registry contents, and I<never> use it if the output is going to be passed "
29099 "into another program or stored in another Registry."
29103 #: ../tools/virt-win-reg.pl:554
29104 msgid "SUPPORTED SYSTEMS"
29108 #: ../tools/virt-win-reg.pl:556
29110 "The program currently supports Windows NT-derived guests starting with "
29111 "Windows XP through to at least Windows 7."
29115 #: ../tools/virt-win-reg.pl:559
29116 msgid "The following Registry keys are supported:"
29120 #: ../tools/virt-win-reg.pl:563
29121 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
29125 #: ../tools/virt-win-reg.pl:565
29126 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
29130 #: ../tools/virt-win-reg.pl:567
29131 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
29135 #: ../tools/virt-win-reg.pl:569
29136 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
29140 #: ../tools/virt-win-reg.pl:571
29141 msgid "C<HKEY_USERS\\.DEFAULT>"
29145 #: ../tools/virt-win-reg.pl:573
29146 msgid "C<HKEY_USERS\\I<SID>>"
29150 #: ../tools/virt-win-reg.pl:575
29151 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
29155 #: ../tools/virt-win-reg.pl:577
29156 msgid "C<HKEY_USERS\\I<username>>"
29160 #: ../tools/virt-win-reg.pl:579
29161 msgid "where I<username> is a local user name (this is a libguestfs extension)."
29165 #: ../tools/virt-win-reg.pl:583
29167 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
29172 #: ../tools/virt-win-reg.pl:586
29174 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
29175 "supported (there is no \"current user\")."
29179 #: ../tools/virt-win-reg.pl:589
29184 #: ../tools/virt-win-reg.pl:591
29186 "C<virt-win-reg> expects that regedit files have already been reencoded in "
29187 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
29188 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
29189 "with Windows-style line endings, you may need to reencode the whole file "
29190 "before or after processing."
29194 #: ../tools/virt-win-reg.pl:597
29196 "To reencode a file from Windows format to Linux (before processing it with "
29197 "the I<--merge> option), you would do something like this:"
29201 #: ../tools/virt-win-reg.pl:600
29204 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
29209 #: ../tools/virt-win-reg.pl:602
29211 "To go in the opposite direction, after exporting and before sending the file "
29212 "to a Windows user, do something like this:"
29216 #: ../tools/virt-win-reg.pl:605
29219 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
29224 #: ../tools/virt-win-reg.pl:607
29225 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
29229 #: ../tools/virt-win-reg.pl:609
29231 "If you are unsure about the current encoding, use the L<file(1)> command. "
29232 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
29233 "Windows-style (CRLF) line endings, like this:"
29237 #: ../tools/virt-win-reg.pl:613
29240 " $ file software.reg\n"
29241 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
29242 " with CRLF line terminators\n"
29247 #: ../tools/virt-win-reg.pl:617
29248 msgid "This file would need conversion before you could I<--merge> it."
29252 #: ../tools/virt-win-reg.pl:619
29253 msgid "CurrentControlSet etc."
29257 #: ../tools/virt-win-reg.pl:621
29259 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
29260 "Registry at the level of the hive file, and therefore you cannot modify "
29265 #: ../tools/virt-win-reg.pl:625
29267 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
29268 "circumstances it might refer to another control set. The way to find out is "
29269 "to look at the C<HKLM\\SYSTEM\\Select> key:"
29273 #: ../tools/virt-win-reg.pl:629
29276 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
29277 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
29278 " \"Current\"=dword:00000001\n"
29279 " \"Default\"=dword:00000001\n"
29280 " \"Failed\"=dword:00000000\n"
29281 " \"LastKnownGood\"=dword:00000002\n"
29286 #: ../tools/virt-win-reg.pl:636
29287 msgid "\"Current\" is the one which Windows will choose when it boots."
29291 #: ../tools/virt-win-reg.pl:638
29292 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
29296 #: ../tools/virt-win-reg.pl:641
29297 msgid "WINDOWS TIPS"
29301 #: ../tools/virt-win-reg.pl:643
29303 "Note that some of these tips modify the guest disk image. The guest I<must> "
29304 "be shut off, else you will get disk corruption."
29308 #: ../tools/virt-win-reg.pl:646
29309 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
29313 #: ../tools/virt-win-reg.pl:648
29315 "Prepare a DOS batch script, VBScript or executable. Upload this using "
29316 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
29317 "is uploaded into C<C:\\>:"
29321 #: ../tools/virt-win-reg.pl:652
29324 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
29329 #: ../tools/virt-win-reg.pl:654
29330 msgid "Prepare a regedit file containing the registry change:"
29334 #: ../tools/virt-win-reg.pl:656
29337 " cat > test.reg <<'EOF'\n"
29338 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
29339 " \"Test\"=\"c:\\\\test.bat\"\n"
29345 #: ../tools/virt-win-reg.pl:661
29347 "In this example we use the key C<RunOnce> which means that the script will "
29348 "run precisely once when the first user logs in. If you want it to run every "
29349 "time a user logs in, replace C<RunOnce> with C<Run>."
29353 #: ../tools/virt-win-reg.pl:665
29354 msgid "Now update the registry:"
29358 #: ../tools/virt-win-reg.pl:667
29361 " virt-win-reg --merge WindowsGuest test.reg\n"
29366 #: ../tools/virt-win-reg.pl:669
29367 msgid "INSTALLING A SERVICE"
29371 #: ../tools/virt-win-reg.pl:671
29373 "This section assumes you are familiar with Windows services, and you either "
29374 "have a program which handles the Windows Service Control Protocol directly "
29375 "or you want to run any program using a service wrapper like SrvAny or the "
29380 #: ../tools/virt-win-reg.pl:676
29382 "First upload the program and optionally the service wrapper. In this case "
29383 "the test program is called C<test.exe> and we are using the RHSrvAny "
29388 #: ../tools/virt-win-reg.pl:680
29391 " guestfish -i -d WindowsGuest <<EOF\n"
29392 " upload rhsrvany.exe /rhsrvany.exe\n"
29393 " upload test.exe /test.exe\n"
29399 #: ../tools/virt-win-reg.pl:685
29401 "Prepare a regedit file containing the registry changes. In this example, "
29402 "the first registry change is needed for the service itself or the service "
29403 "wrapper (if used). The second registry change is only needed because I am "
29404 "using the RHSrvAny service wrapper."
29408 #: ../tools/virt-win-reg.pl:690
29411 " cat > service.reg <<'EOF'\n"
29412 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
29413 " \"Type\"=dword:00000010\n"
29414 " \"Start\"=dword:00000002\n"
29415 " \"ErrorControl\"=dword:00000001\n"
29416 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
29417 " \"DisplayName\"=\"RHSrvAny\"\n"
29418 " \"ObjectName\"=\"NetworkService\"\n"
29423 #: ../tools/virt-win-reg.pl:699
29426 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
29427 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
29428 " \"PWD\"=\"c:\\\\Temp\"\n"
29434 #: ../tools/virt-win-reg.pl:710
29436 "For use of C<ControlSet001> see the section above in this manual page. You "
29437 "may need to adjust this according to the control set that is in use by the "
29442 #: ../tools/virt-win-reg.pl:716
29444 "C<\"ObjectName\"> controls the privileges that the service will have. An "
29445 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
29446 "privileged account."
29450 #: ../tools/virt-win-reg.pl:722
29452 "For the meaning of the magic numbers, see this Microsoft KB article: "
29453 "L<http://support.microsoft.com/kb/103000>."
29457 #: ../tools/virt-win-reg.pl:727
29458 msgid "Update the registry:"
29462 #: ../tools/virt-win-reg.pl:729
29465 " virt-win-reg --merge WindowsGuest service.reg\n"
29470 #: ../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
29471 msgid "SHELL QUOTING"
29475 #: ../tools/virt-win-reg.pl:733
29477 "Be careful when passing parameters containing C<\\> (backslash) in the "
29478 "shell. Usually you will have to use 'single quotes' or double backslashes "
29479 "(but not both) to protect them from the shell."
29483 #: ../tools/virt-win-reg.pl:737
29484 msgid "Paths and value names are case-insensitive."
29488 #: ../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
29490 "Libvirt guest names can contain arbitrary characters, some of which have "
29491 "meaning to the shell such as C<#> and space. You may need to quote or "
29492 "escape these characters on the command line. See the shell manual page "
29493 "L<sh(1)> for details."
29497 #: ../tools/virt-win-reg.pl:746
29499 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
29500 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
29501 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
29502 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29506 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
29508 "When reporting bugs, please enable debugging and capture the I<complete> "
29513 #: ../tools/virt-win-reg.pl:764
29516 " export LIBGUESTFS_DEBUG=1\n"
29517 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
29522 #: ../tools/virt-win-reg.pl:767
29524 "Attach /tmp/virt-win-reg.log to a new bug report at "
29525 "L<https://bugzilla.redhat.com/>"
29529 #: ../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
29534 #: ../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
29535 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
29539 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
29540 msgid "Copyright (C) 2010 Red Hat Inc."
29544 #: ../tools/virt-list-filesystems.pl:32
29545 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
29549 #: ../tools/virt-list-filesystems.pl:36
29552 " virt-list-filesystems [--options] domname\n"
29557 #: ../tools/virt-list-filesystems.pl:38
29560 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
29565 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
29567 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
29572 #: ../tools/virt-list-filesystems.pl:45
29574 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
29575 "are contained in a virtual machine or disk image."
29579 #: ../tools/virt-list-filesystems.pl:49
29581 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
29582 "functionality. For more complex cases you should look at the "
29583 "L<guestfish(1)> tool."
29587 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
29588 msgid "B<-l> | B<--long>"
29592 #: ../tools/virt-list-filesystems.pl:108
29594 "With this option, C<virt-list-filesystems> displays the type of each "
29595 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
29599 #: ../tools/virt-list-filesystems.pl:115
29600 msgid "B<-a> | B<--all>"
29604 #: ../tools/virt-list-filesystems.pl:117
29606 "Normally we only show mountable filesystems. If this option is given then "
29607 "swap devices are shown too."
29611 #: ../tools/virt-list-filesystems.pl:191
29613 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
29614 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
29615 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29619 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
29620 msgid "Copyright (C) 2009 Red Hat Inc."
29624 #: ../tools/virt-tar.pl:33
29625 msgid "virt-tar - Extract or upload files to a virtual machine"
29629 #: ../tools/virt-tar.pl:37
29632 " virt-tar [--options] -x domname directory tarball\n"
29637 #: ../tools/virt-tar.pl:39
29640 " virt-tar [--options] -u domname tarball directory\n"
29645 #: ../tools/virt-tar.pl:41
29648 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
29653 #: ../tools/virt-tar.pl:43
29656 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
29661 #: ../tools/virt-tar.pl:47
29663 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
29664 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
29668 #: ../tools/virt-tar.pl:52
29669 msgid "Download C</home> from the VM into a local tarball:"
29673 #: ../tools/virt-tar.pl:54
29676 " virt-tar -x domname /home home.tar\n"
29681 #: ../tools/virt-tar.pl:56
29684 " virt-tar -zx domname /home home.tar.gz\n"
29689 #: ../tools/virt-tar.pl:58
29690 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
29694 #: ../tools/virt-tar.pl:60
29697 " virt-tar -u domname uploadstuff.tar /tmp\n"
29702 #: ../tools/virt-tar.pl:62
29705 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
29710 #: ../tools/virt-tar.pl:66
29712 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
29713 "virtual machines. If you do this, you risk disk corruption in the VM. "
29714 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
29718 #: ../tools/virt-tar.pl:71
29720 "You can use I<-x> (extract) on live virtual machines, but you might get "
29721 "inconsistent results or errors if there is filesystem activity inside the "
29722 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
29723 "work, but the only way to guarantee consistent results is if the virtual "
29724 "machine is shut down."
29728 #: ../tools/virt-tar.pl:79
29730 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
29731 "parts of a guest filesystem. There are many possibilities: making backups, "
29732 "uploading data files, snooping on guest activity, fixing or customizing "
29737 #: ../tools/virt-tar.pl:84
29739 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
29740 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
29741 "should look at the L<guestfish(1)> tool."
29745 #: ../tools/virt-tar.pl:88
29747 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
29748 "its contents (recursively) from the virtual machine into a local tarball. "
29749 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
29750 "virtual machine. You cannot use these two options together."
29754 #: ../tools/virt-tar.pl:94
29756 "In addition, you may need to use the I<-z> (gZip) option to enable "
29757 "compression. When uploading, you have to specify I<-z> if the upload file "
29758 "is compressed because virt-tar won't detect this on its own."
29762 #: ../tools/virt-tar.pl:98
29764 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
29765 "example it cannot do PKZip files or bzip2 compression. If you want that "
29766 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
29767 "the L<libguestfs(3)> API)."
29771 #: ../tools/virt-tar.pl:156
29772 msgid "B<-x> | B<--extract> | B<--download>"
29776 #: ../tools/virt-tar.pl:158
29777 msgid "B<-u> | B<--upload>"
29781 #: ../tools/virt-tar.pl:160
29783 "Use I<-x> to extract (download) a directory from a virtual machine to a "
29788 #: ../tools/virt-tar.pl:163
29790 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
29791 "Please read the L</WARNING> section above before using this option."
29795 #: ../tools/virt-tar.pl:167
29796 msgid "You must specify exactly one of these options."
29800 #: ../tools/virt-tar.pl:173
29801 msgid "B<-z> | B<--gzip>"
29805 #: ../tools/virt-tar.pl:175
29806 msgid "Specify that the input or output tarball is gzip-compressed."
29810 #: ../tools/virt-tar.pl:288
29812 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
29813 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
29814 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
29815 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
29819 #: ../tools/virt-make-fs.pl:37
29820 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
29824 #: ../tools/virt-make-fs.pl:41
29827 " virt-make-fs [--options] input.tar output.img\n"
29832 #: ../tools/virt-make-fs.pl:43
29835 " virt-make-fs [--options] input.tar.gz output.img\n"
29840 #: ../tools/virt-make-fs.pl:45
29843 " virt-make-fs [--options] directory output.img\n"
29848 #: ../tools/virt-make-fs.pl:49
29850 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
29851 "archive or some files in a directory. It is similar to tools like "
29852 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
29853 "it can create common filesystem types like ext2/3 or NTFS, which can be "
29854 "useful if you want to attach these filesystems to existing virtual machines "
29855 "(eg. to import large amounts of read-only data to a VM)."
29859 #: ../tools/virt-make-fs.pl:57
29860 msgid "Basic usage is:"
29864 #: ../tools/virt-make-fs.pl:59
29867 " virt-make-fs input output\n"
29872 #: ../tools/virt-make-fs.pl:61
29874 "where C<input> is either a directory containing files that you want to add, "
29875 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
29876 "C<output> is a disk image. The input type is detected automatically. The "
29877 "output disk image defaults to a raw ext2 image unless you specify extra "
29878 "flags (see L</OPTIONS> below)."
29882 #: ../tools/virt-make-fs.pl:67
29883 msgid "EXTRA SPACE"
29887 #: ../tools/virt-make-fs.pl:69
29889 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
29890 "the files that it contains, but might have extra space. Depending on how "
29891 "you are going to use the output, you might think this extra space is wasted "
29892 "and want to minimize it, or you might want to leave space so that more files "
29893 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
29894 "but you can use the I<--size> flag to leave space in the filesystem if you "
29899 #: ../tools/virt-make-fs.pl:77
29901 "An alternative way to leave extra space but not make the output image any "
29902 "bigger is to use an alternative disk image format (instead of the default "
29903 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
29904 "image format (check your hypervisor supports this before using it). This "
29905 "allows you to choose a large I<--size> but the extra space won't actually be "
29906 "allocated in the image until you try to store something in it."
29910 #: ../tools/virt-make-fs.pl:85
29912 "Don't forget that you can also use local commands including L<resize2fs(8)> "
29913 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
29914 "to build another image from scratch."
29918 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
29923 #: ../tools/virt-make-fs.pl:91
29926 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
29931 #: ../tools/virt-make-fs.pl:93
29932 msgid "FILESYSTEM TYPE"
29936 #: ../tools/virt-make-fs.pl:95
29938 "The default filesystem type is C<ext2>. Just about any filesystem type that "
29939 "libguestfs supports can be used (but I<not> read-only formats like "
29940 "ISO9660). Here are some of the more common choices:"
29944 #: ../tools/virt-make-fs.pl:101
29949 #: ../tools/virt-make-fs.pl:103
29951 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
29952 "you are not going to use the filesystem in a way that requires the journal, "
29953 "then this is just wasted overhead."
29957 #: ../tools/virt-make-fs.pl:107
29958 msgid "I<ntfs> or I<vfat>"
29962 #: ../tools/virt-make-fs.pl:109
29963 msgid "Useful if exporting data to a Windows guest."
29967 #: ../tools/virt-make-fs.pl:111
29969 "I<Note for vfat>: The tar archive or local directory must only contain files "
29970 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
29971 "program running within libguestfs is unable to change the ownership of "
29972 "non-root files, since vfat itself does not support this."
29976 #: ../tools/virt-make-fs.pl:116
29981 #: ../tools/virt-make-fs.pl:118
29983 "Lower overhead than C<ext2>, but certain limitations on filename length and "
29984 "total filesystem size."
29988 #: ../tools/virt-make-fs.pl:125
29991 " virt-make-fs --type=minix input minixfs.img\n"
29996 #: ../tools/virt-make-fs.pl:127
29997 msgid "TO PARTITION OR NOT TO PARTITION"
30001 #: ../tools/virt-make-fs.pl:129
30002 msgid "Optionally virt-make-fs can add a partition table to the output disk."
30006 #: ../tools/virt-make-fs.pl:131
30008 "Adding a partition can make the disk image more compatible with certain "
30009 "virtualized operating systems which don't expect to see a filesystem "
30010 "directly located on a block device (Linux doesn't care and will happily "
30011 "handle both types)."
30015 #: ../tools/virt-make-fs.pl:136
30017 "On the other hand, if you have a partition table then the output image is no "
30018 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
30019 "directly on a partitioned disk image. (However libguestfs tools such as "
30020 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
30024 #: ../tools/virt-make-fs.pl:144
30025 msgid "Add an MBR partition:"
30029 #: ../tools/virt-make-fs.pl:146
30032 " virt-make-fs --partition -- input disk.img\n"
30037 #: ../tools/virt-make-fs.pl:148
30039 "If the output disk image could be terabyte-sized or larger, it's better to "
30040 "use an EFI/GPT-compatible partition table:"
30044 #: ../tools/virt-make-fs.pl:151
30047 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
30052 #: ../tools/virt-make-fs.pl:179
30053 msgid "Enable debugging information."
30057 #: ../tools/virt-make-fs.pl:185
30058 msgid "B<--size=E<lt>NE<gt>>"
30062 #: ../tools/virt-make-fs.pl:187
30063 msgid "B<--size=+E<lt>NE<gt>>"
30067 #: ../tools/virt-make-fs.pl:189
30068 msgid "B<-s E<lt>NE<gt>>"
30072 #: ../tools/virt-make-fs.pl:191
30073 msgid "B<-s +E<lt>NE<gt>>"
30077 #: ../tools/virt-make-fs.pl:193
30078 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
30082 #: ../tools/virt-make-fs.pl:196
30084 "If this option is I<not> given, then the output image will be just large "
30085 "enough to contain all the files, with not much wasted space."
30089 #: ../tools/virt-make-fs.pl:199
30091 "To choose a fixed size output disk, specify an absolute number followed by "
30092 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30093 "Petabytes or Exabytes. This must be large enough to contain all the input "
30094 "files, else you will get an error."
30098 #: ../tools/virt-make-fs.pl:204
30100 "To leave extra space, specify C<+> (plus sign) and a number followed by "
30101 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
30102 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
30103 "the input files, and (approximately) an extra 200 MB free space."
30107 #: ../tools/virt-make-fs.pl:210
30109 "Note that virt-make-fs estimates free space, and therefore will not produce "
30110 "filesystems containing precisely the free space requested. (It is much more "
30111 "expensive and time-consuming to produce a filesystem which has precisely the "
30112 "desired free space)."
30116 #: ../tools/virt-make-fs.pl:219
30117 msgid "B<--format=E<lt>fmtE<gt>>"
30121 #: ../tools/virt-make-fs.pl:221
30122 msgid "B<-F E<lt>fmtE<gt>>"
30126 #: ../tools/virt-make-fs.pl:223
30127 msgid "Choose the output disk image format."
30131 #: ../tools/virt-make-fs.pl:225
30132 msgid "The default is C<raw> (raw disk image)."
30136 #: ../tools/virt-make-fs.pl:227
30138 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
30139 "that would really make sense here is C<qcow2>."
30143 #: ../tools/virt-make-fs.pl:234
30144 msgid "B<--type=E<lt>fsE<gt>>"
30148 #: ../tools/virt-make-fs.pl:236
30149 msgid "B<-t E<lt>fsE<gt>>"
30153 #: ../tools/virt-make-fs.pl:238
30154 msgid "Choose the output filesystem type."
30158 #: ../tools/virt-make-fs.pl:240
30159 msgid "The default is C<ext2>."
30163 #: ../tools/virt-make-fs.pl:242
30164 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
30168 #: ../tools/virt-make-fs.pl:249
30169 msgid "B<--partition>"
30173 #: ../tools/virt-make-fs.pl:251
30174 msgid "B<--partition=E<lt>parttypeE<gt>>"
30178 #: ../tools/virt-make-fs.pl:253
30180 "If specified, this flag adds an MBR partition table to the output disk "
30185 #: ../tools/virt-make-fs.pl:256
30187 "You can change the partition table type, eg. I<--partition=gpt> for large "
30192 #: ../tools/virt-make-fs.pl:259
30194 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
30195 "might consider the next parameter to be the partition type. For example:"
30199 #: ../tools/virt-make-fs.pl:263
30202 " virt-make-fs --partition input.tar ...\n"
30207 #: ../tools/virt-make-fs.pl:265
30209 "would cause virt-make-fs to think you wanted to use a partition type of "
30210 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
30211 "dash) between options and the input file argument:"
30215 #: ../tools/virt-make-fs.pl:269
30218 " virt-make-fs --partition -- input.tar ...\n"
30223 #: ../tools/virt-make-fs.pl:541
30225 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
30226 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
30227 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
30231 #: ../tools/virt-make-fs.pl:558
30234 " export LIBGUESTFS_DEBUG=1\n"
30235 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
30240 #: ../tools/virt-make-fs.pl:561
30242 "Attach /tmp/virt-make-fs.log to a new bug report at "
30243 "L<https://bugzilla.redhat.com/>"
30247 #: ../tools/virt-list-partitions.pl:32
30248 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
30252 #: ../tools/virt-list-partitions.pl:36
30255 " virt-list-partitions [--options] domname\n"
30260 #: ../tools/virt-list-partitions.pl:38
30263 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
30268 #: ../tools/virt-list-partitions.pl:45
30270 "C<virt-list-partitions> is a command line tool to list the partitions that "
30271 "are contained in a virtual machine or disk image. It is mainly useful as a "
30272 "first step to using L<virt-resize(1)>."
30276 #: ../tools/virt-list-partitions.pl:50
30278 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
30279 "functionality. For more complex cases you should look at the "
30280 "L<guestfish(1)> tool."
30284 #: ../tools/virt-list-partitions.pl:107
30285 msgid "B<-h> | B<--human-readable>"
30289 #: ../tools/virt-list-partitions.pl:109
30290 msgid "Show sizes in human-readable form (eg. \"1G\")."
30294 #: ../tools/virt-list-partitions.pl:117
30296 "With this option, C<virt-list-partitions> displays the type and size of each "
30297 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
30301 #: ../tools/virt-list-partitions.pl:124
30302 msgid "B<-t> | B<--total>"
30306 #: ../tools/virt-list-partitions.pl:126
30307 msgid "Display the total size of each block device (as a separate row or rows)."
30311 #: ../tools/virt-list-partitions.pl:259
30313 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
30314 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
30315 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30319 #: ../tools/virt-list-partitions.pl:275
30320 msgid "Copyright (C) 2009-2010 Red Hat Inc."